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

#8 in #stronghold

Download history 3101/week @ 2024-08-28 2713/week @ 2024-09-04 1718/week @ 2024-09-11 1855/week @ 2024-09-18 2169/week @ 2024-09-25 1772/week @ 2024-10-02 1792/week @ 2024-10-09 2577/week @ 2024-10-16 1808/week @ 2024-10-23 1238/week @ 2024-10-30 1922/week @ 2024-11-06 2106/week @ 2024-11-13 1518/week @ 2024-11-20 1652/week @ 2024-11-27 2407/week @ 2024-12-04 2061/week @ 2024-12-11

8,069 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
~512K SLoC