14 releases (5 stable)

2.0.1 May 13, 2024
2.0.0 Jul 27, 2023
1.1.0 May 3, 2023
1.0.2 Nov 16, 2022
0.1.0 Jul 29, 2020

#6 in #stronghold

Download history 2417/week @ 2024-12-08 2065/week @ 2024-12-15 540/week @ 2024-12-22 1113/week @ 2024-12-29 3442/week @ 2025-01-05 2222/week @ 2025-01-12 2068/week @ 2025-01-19 3523/week @ 2025-01-26 2791/week @ 2025-02-02 3304/week @ 2025-02-09 4348/week @ 2025-02-16 3635/week @ 2025-02-23 3301/week @ 2025-03-02 3463/week @ 2025-03-09 3282/week @ 2025-03-16 2541/week @ 2025-03-23

12,805 downloads per month
Used in 9 crates (via iota_stronghold)

Apache-2.0

255KB
6K SLoC

Engine

Engine is the collection of low-level module with which application architects can build higher-level implementations of Strongholds for a variety of purposes. It is platform agnostic, in that it should run anywhere a Rust Compiler will work.

It is composed of 4 primary module:

  • snapshot
  • vault
  • store
  • runtime

Snapshot

The snapshot protocol follows a fairly simple transparent pattern. Each Snapshot file follows a simple structure:

Header
Magic Bytes
Version Bytes
Body
Ephemeral Key
xchacha20 tag
Cipher Text

lib.rs:

A system for securely managing secrets.

This top-level crate contains references to the others that make up the IOTA Stronghold's low-level crates known as "Stronghold-Engine".

Layout

This framework is divided into the following crates:

  • vault: logic and abstractions for the storage layer
  • snapshot: method for storing the state of the vault in a file
  • store: a simple unencrypted storage protocol

WARNING

This library has not yet been audited for security, so use at your own peril. Until a formal third-party security audit has taken place, the IOTA Foundation makes no guarantees to the fitness of this library for any purposes.

Dependencies

~9–36MB
~479K SLoC