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

#1020 in Magic Beans

Download history 1860/week @ 2024-03-13 1419/week @ 2024-03-20 1296/week @ 2024-03-27 1058/week @ 2024-04-03 1281/week @ 2024-04-10 2424/week @ 2024-04-17 2160/week @ 2024-04-24 1129/week @ 2024-05-01 1938/week @ 2024-05-08 3694/week @ 2024-05-15 2882/week @ 2024-05-22 5104/week @ 2024-05-29 2091/week @ 2024-06-05 3133/week @ 2024-06-12 2842/week @ 2024-06-19 3816/week @ 2024-06-26

12,642 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–33MB
~493K SLoC