adameunson / identity.rs Goto Github PK

Introduction ◈ Bindings ◈ Documentation & Resources ◈ Getting Started ◈ Example ◈ Roadmap ◈ Contributing

IOTA Identity is a Rust implementation of decentralized digital identity, also known as Self-Sovereign Identity (SSI). It implements standards such as the W3C Decentralized Identifiers (DID) and Verifiable Credentials and the DIF DIDComm Messaging specifications alongside supporting methods. This framework can be used to create and authenticate digital identities, creating a trusted connection and sharing verifiable information, establishing trust in the digital world.

The individual libraries are developed to be agnostic about the utilized Distributed Ledger Technology (DLT), with the exception of the IOTA integration and higher level libraries. Written in stable Rust, it has strong guarantees of memory safety and process integrity while maintaining exceptional performance.

⚠️ WARNING #1 ⚠️

The Framework only works on the Chrysalis Phase 2 network, use v0.2 or older for pre-chrysalis phase 2 networks.

⚠️ WARNING #2 ⚠️

This library is currently in its alpha stage and under development and might undergo large changes! Until a formal third-party security audit has taken place, the IOTA Foundation makes no guarantees to the fitness of this library. As such, it is to be seen as experimental and not ready for real-world applications. Nevertheless, we are very interested in feedback about user experience, design and implementation, and encourage you to reach out with any concerns or suggestions you may have.

Foreign Function Interface (FFI) Bindings of this Rust library to other programming languages are a work in progress (see Roadmap below). Currently available bindings are:

• Web Assembly (JavaScript/TypeScript)

• API Reference: Package documentation (cargo docs).
• Identity Documentation Pages: Supplementing documentation with context around identity and simple examples on library usage.
• Examples in /examples folder: Practical code snippets to get you started with the library.
• IOTA Identity Experience Team Website: Website for a collaborative effort to provide help, guidance and spotlight to the IOTA Identity Community through offering feedback and introducing consistent workflows around IOTA Identity.

If you want to include IOTA Identity in your project, simply add it as a dependency in your cargo.toml:

[dependencies]
identity = { git = "https://github.com/iotaledger/identity.rs", branch = "main"}

To try out the examples, you can also do this:

1. Clone the repository, e.g. through git clone https://github.com/iotaledger/identity.rs
2. Build the repository with cargo build
3. Run your first example using cargo run --example getting_started

If you would like to build the API Reference yourself from source, you can do so using:

cargo doc --document-private-items --no-deps --open

Cargo.toml

[package]
name = "iota_identity_example"
version = "1.0.0"
edition = "2018"

[dependencies]
identity = { git = "https://github.com/iotaledger/identity.rs", branch = "main"}
smol = { version = "0.1", features = ["tokio02"] }
smol-potat = { version = "0.3" }

main.rs

use identity::crypto::KeyPair;
use identity::iota::{Client, Document, Network, Result, TangleRef};

#[smol_potat::main] // Using this allows us to have an async main function.
async fn main() -> Result<()> {

  // Create a DID Document (an identity).
  let keypair: KeyPair = KeyPair::new_ed25519()?;
  let mut document: Document = Document::from_keypair(&keypair)?;

  // Sign the DID Document with the default authentication key.
  document.sign(keypair.secret())?;

  // Create a client to interact with the IOTA Tangle.
  let client: Client = Client::new()?;

  // Use the client to publish the DID Document to the IOTA Tangle.
  document.publish(&client).await?;

  // Print the DID Document IOTA transaction link.
  let network: Network = document.id().into();
  let explore: String = format!("{}/transaction/{}", network.explorer_url(), document.message_id());
  println!("DID Document Transaction > {}", explore);

  Ok(())
}

Example output

DID Document Transaction > https://explorer.iota.org/mainnet/transaction/YARETIQBJLER9BC9U9MOAXEBWVIHXYRMJAYFQSJDCPQXXWSEKQOFKGFMXYCNXPLTRAYQZTCLJJRXZ9999

The output link points towards the DID Document transaction, viewable through the IOTA Tangle Explorer, see here. You can see the full DID Document as transaction payload.

For detailed development progress, see also the IOTA Identity development canban board.

IOTA Identity is in heavy development, and will naturally change as it matures and people use it. The chart below isn't meant to be exhaustive, but rather helps to give an idea for some of the areas of development and their relative completion:

At the current state, the framework is in alpha. As the framework matures we expect to support more and more types of applications. We recommend no use in real-world applications until the consumed libraries are audited, but experimentation and Proof-of-Concept projects are encouraged at the different stages.

We would love to have you help us with the development of IOTA Identity. Each and every contribution is greatly valued!

To contribute directly to the repository, simply fork the project, push your changes to your fork and create a pull request to get them included!

The best place to get involved in discussions about this framework or to look for support at is the #identity-discussion channel on the IOTA Discord. You can also ask questions on our Stack Exchange.