lair_keystore_api

Crates.iolair_keystore_api
lib.rslair_keystore_api
version0.4.5
sourcesrc
created_at2020-09-01 19:25:23.910677
updated_at2024-06-06 16:11:39.920351
descriptionsecret lair private keystore API library
homepage
repositoryhttps://github.com/holochain/lair
max_upload_size
id283552
size313,409
Core Dev (github:holochain:core-dev)

documentation

https://docs.rs/lair_keystore_api

README

lair_keystore_api

Secret lair private keystore API library.

Project Forum Chat

License: MIT License: Apache-2.0

This library crate contains most of the logic for dealing with lair.

  • If you wish to run an in-process / in-memory keystore, or connect to an external lair keystore as a client, this is the library for you.
  • If you want to run the canonical lair-keystore, see the lair_keystore crate.
  • If you want to run a canonical lair-keystore in-process, using the canonical sqlcipher database, see the lair_keystore crate.
  • See the [lair_api] module for information about the lair_keystore_api protocol.
  • See [LairClient] for the client struct api.
Establishing a client connection to a canonical ipc keystore binary:
use lair_keystore_api::prelude::*;
use lair_keystore_api::ipc_keystore::*;

// create a client connection
let client =
    ipc_keystore_connect(connection_url, passphrase)
        .await
        .unwrap();

// create a new seed
let seed_info = client.new_seed(
    "test-seed".into(),
    None,
    false,
).await.unwrap();

// sign some data
let sig = client.sign_by_pub_key(
    seed_info.ed25519_pub_key.clone(),
    None,
    b"test-data".to_vec().into(),
).await.unwrap();

// verify the signature
assert!(seed_info.ed25519_pub_key.verify_detached(
    sig,
    b"test-data".to_vec(),
).await.unwrap());

License: MIT OR Apache-2.0

Commit count: 467

cargo fmt