Struct LocalKeystore

pub struct LocalKeystore(/* private fields */);

A local based keystore that is either memory-based or filesystem-based.

Implementations

impl LocalKeystore

pub fn open<T: Into<PathBuf>>( path: T, password: Option<SecretString>, ) -> Result<Self>

Create a local keystore from filesystem.

The keystore will be created at path. The keystore optionally supports to encrypt/decrypt the keys in the keystore using password.

NOTE: Even when passing a password, the keys on disk appear to look like normal secret uris. However, without having the correct password the secret uri will not generate the correct private key. See SecretUri for more information.

pub fn in_memory() -> Self

Create a local keystore in memory.

pub fn key_pair<Pair: AppPair>( &self, public: &<Pair as AppCrypto>::Public, ) -> Result<Option<Pair>>

Get a key pair for the given public key.

Returns Ok(None) if the key doesn’t exist, Ok(Some(_)) if the key exists and Err(_) when something failed.

Trait Implementations

impl Into<Arc<dyn Keystore>> for LocalKeystore

fn into(self) -> KeystorePtr

Converts this type into the (usually inferred) input type.

impl Keystore for LocalKeystore

fn insert( &self, key_type: KeyTypeId, suri: &str, public: &[u8], ) -> Result<(), ()>

Insert a new secret key.

WARNING: if the secret keypair has been manually generated using a password (e.g. using methods such as [sp_core::crypto::Pair::from_phrase]) then such a password must match the one used to open the keystore via LocalKeystore::open. If the passwords doesn’t match then the inserted key ends up being unusable under the current keystore instance.

fn sr25519_generate_new( &self, key_type: KeyTypeId, seed: Option<&str>, ) -> Result<Public, TraitError>

Generate a new pair compatible with the ‘ed25519’ signature scheme.

If [seed] is Some then the key will be ephemeral and stored in memory.

fn ed25519_generate_new( &self, key_type: KeyTypeId, seed: Option<&str>, ) -> Result<Public, TraitError>

Generate a new pair compatible with the ‘sr25519’ signature scheme.

If [seed] is Some then the key will be ephemeral and stored in memory.

fn ecdsa_generate_new( &self, key_type: KeyTypeId, seed: Option<&str>, ) -> Result<Public, TraitError>

Generate a new pair compatible with the ‘ecdsa’ signature scheme.

If [seed] is Some then the key will be ephemeral and stored in memory.

fn bandersnatch_generate_new( &self, key_type: KeyTypeId, seed: Option<&str>, ) -> Result<Public, TraitError>

Generate a new pair compatible with the ‘bandersnatch’ signature scheme.

If [seed] is Some then the key will be ephemeral and stored in memory.

fn bls381_generate_new( &self, key_type: KeyTypeId, seed: Option<&str>, ) -> Result<Public, TraitError>

Generate a new pair compatible with the ‘bls381’ signature scheme.

If [seed] is Some then the key will be ephemeral and stored in memory.

fn ecdsa_bls381_generate_new( &self, key_type: KeyTypeId, seed: Option<&str>, ) -> Result<Public, TraitError>

Generate a new pair of paired-keys compatible with the ‘(ecdsa,bls381)’ signature scheme.

If [seed] is Some then the key will be ephemeral and stored in memory.

fn keys(&self, key_type: KeyTypeId) -> Result<Vec<Vec<u8>>, TraitError>

List all supported keys of a given type.

fn has_keys(&self, public_keys: &[(Vec<u8>, KeyTypeId)]) -> bool

Checks if the private keys for the given public key and key type combinations exist.

fn sr25519_public_keys(&self, key_type: KeyTypeId) -> Vec<Public>

Returns all the sr25519 public keys for the given key type.

fn sr25519_sign( &self, key_type: KeyTypeId, public: &Public, msg: &[u8], ) -> Result<Option<Signature>, TraitError>

Generate an sr25519 signature for a given message.

fn sr25519_vrf_sign( &self, key_type: KeyTypeId, public: &Public, data: &VrfSignData, ) -> Result<Option<VrfSignature>, TraitError>

Generate an sr25519 VRF signature for the given data.

fn sr25519_vrf_pre_output( &self, key_type: KeyTypeId, public: &Public, input: &VrfInput, ) -> Result<Option<VrfPreOutput>, TraitError>

Generate an sr25519 VRF pre-output for a given input data.

fn ed25519_public_keys(&self, key_type: KeyTypeId) -> Vec<Public>

Returns all ed25519 public keys for the given key type.

fn ed25519_sign( &self, key_type: KeyTypeId, public: &Public, msg: &[u8], ) -> Result<Option<Signature>, TraitError>

Generate an ed25519 signature for a given message.

fn ecdsa_public_keys(&self, key_type: KeyTypeId) -> Vec<Public>

Returns all ecdsa public keys for the given key type.

fn ecdsa_sign( &self, key_type: KeyTypeId, public: &Public, msg: &[u8], ) -> Result<Option<Signature>, TraitError>

Generate an ecdsa signature for a given message.

fn ecdsa_sign_prehashed( &self, key_type: KeyTypeId, public: &Public, msg: &[u8; 32], ) -> Result<Option<Signature>, TraitError>

Generate an ecdsa signature for a given pre-hashed message.

fn bandersnatch_public_keys(&self, key_type: KeyTypeId) -> Vec<Public>

Returns all the bandersnatch public keys for the given key type.

fn bandersnatch_sign( &self, key_type: KeyTypeId, public: &Public, msg: &[u8], ) -> Result<Option<Signature>, TraitError>

Generate an bandersnatch signature for a given message.

fn bandersnatch_vrf_sign( &self, key_type: KeyTypeId, public: &Public, data: &VrfSignData, ) -> Result<Option<VrfSignature>, TraitError>

Generate a bandersnatch VRF signature for the given data.

fn bandersnatch_vrf_pre_output( &self, key_type: KeyTypeId, public: &Public, input: &VrfInput, ) -> Result<Option<VrfPreOutput>, TraitError>

Generate a bandersnatch VRF pre-output for a given input data.

fn bandersnatch_ring_vrf_sign( &self, key_type: KeyTypeId, public: &Public, data: &VrfSignData, prover: &RingProver, ) -> Result<Option<RingVrfSignature>, TraitError>

Generate a bandersnatch ring-VRF signature for the given data.

fn bls381_public_keys(&self, key_type: KeyTypeId) -> Vec<Public>

Returns all bls12-381 public keys for the given key type.

fn bls381_sign( &self, key_type: KeyTypeId, public: &Public, msg: &[u8], ) -> Result<Option<Signature>, TraitError>

Generate a bls381 signature for a given message.

fn bls381_generate_proof_of_possession( &self, key_type: KeyTypeId, public: &Public, owner: &[u8], ) -> Result<Option<ProofOfPossession>, TraitError>

Generate a bls381 Proof of Possession for a given public key

fn ecdsa_bls381_public_keys(&self, key_type: KeyTypeId) -> Vec<Public>

Returns all (ecdsa,bls12-381) paired public keys for the given key type.

fn ecdsa_bls381_sign( &self, key_type: KeyTypeId, public: &Public, msg: &[u8], ) -> Result<Option<Signature>, TraitError>

Generate a (ecdsa,bls381) signature pair for a given message.

fn ecdsa_bls381_sign_with_keccak256( &self, key_type: KeyTypeId, public: &Public, msg: &[u8], ) -> Result<Option<Signature>, TraitError>

Hashes the message using keccak256 and then signs it using ECDSA algorithm. It does not affect the behavior of BLS12-381 component. It generates BLS12-381 Signature according to IETF standard.

fn sign_with( &self, id: KeyTypeId, crypto_id: CryptoTypeId, public: &[u8], msg: &[u8], ) -> Result<Option<Vec<u8>>, Error>

Convenience method to sign a message using the given key type and a raw public key for secret lookup.