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

#7 in #stronghold

Download history 1889/week @ 2024-07-20 2980/week @ 2024-07-27 3703/week @ 2024-08-03 3925/week @ 2024-08-10 3901/week @ 2024-08-17 2603/week @ 2024-08-24 3264/week @ 2024-08-31 1314/week @ 2024-09-07 2064/week @ 2024-09-14 2202/week @ 2024-09-21 1886/week @ 2024-09-28 1744/week @ 2024-10-05 2100/week @ 2024-10-12 2496/week @ 2024-10-19 1626/week @ 2024-10-26 1140/week @ 2024-11-02

7,690 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

~8–37MB
~513K SLoC