hartl3y94 / stronghold.rs

Stronghold is a secret management engine written in rust.

Introduction

IOTA Stronghold is a secure software implementation with the sole purpose of isolating digital secrets from exposure to hackers and accidental leaks. It uses encrypted snapshots that can be easily backed up and securely shared between devices. Written in stable rust, it has strong guarantees of memory safety and process integrity.

There are four main components of Stronghold:

1. Client: The high-level interface to Stronghold (prefers Riker, functional integration also available)
2. Engine: Combines a persistence store (Snapshot) with an in-memory state interface (Vault), a read/write key:value system (Store) and memory protection services (Runtime).
3. Communication: Enables Strongholds in different processes or on different devices to communicate with each other securely.

WARNING

These libraries have been reviewed internally and are being prepared for a full external security audit in mid 2021, so they are not yet verifiably safe. Until this warning is removed, the IOTA Foundation makes no guarantees to the fitness of these libraries for use by third parties.

Nevertheless, we are very interested in feedback about the design and implementation, and encourage you to reach out with any concerns or suggestions you may have.

Roadmap

Here are some of the features and tasks that we are working on.

Components

• Engine
• Client (with dual interfaces)
• peer-to-peer communications
• Secure runtime zone
• Integration with crypto.rs

Documentation and Specification

• User Handbooks
• Specification Documentation
• Tutorials

Performance and Testing

• Unit Tests
• Lowlevel Library Fuzzing
• Realworld tests
• Multiplatform benchmarks
• Continuous Fuzzing

Applications

• CLI binary
• Standalone Desktop Application
• Portable Daemon (for nodes, etc)
• Dynamic high-performance store
• C FFI bindings

Hardware Integrations

• Works with USB Armory Mk II
• Works with Yubikey
• Works with Ledger Nano X
• Use Secure Element to generate private keys for decryption
• Move entirely to FPGA

API Reference

RUSTDOCS

• client
• engine
• communication

Do it yourself

cargo doc --workspace --no-deps --open

Running Tests

cargo test --all --all-features

Joining the discussion

If you want to get involved in discussions about this technology, or you're looking for support, go to the #stronghold-discussion channel on Discord.

If you wish to join the Stronghold X-Team, please fill out this form.

License