Struct KeytoolStorage

pub struct KeytoolStorage { /* private fields */ }

Implementations

impl KeytoolStorage

pub fn new() -> KeytoolStorage

Returns a new KeytoolStorage that will use the IOTA binary in PATH.

pub fn new_with_custom_bin(iota_bin: impl AsRef<Path>) -> KeytoolStorage

Returns a new KeytoolStorage that will use the provided IOTA binary.

pub fn signer(&self) -> KeytoolSignerBuilder

Returns a KeytoolSignerBuilder to construct a super::KeytoolSigner after selecting an address.

pub fn generate_key( &self, key_scheme: SignatureScheme, ) -> Result<(PublicKey, String), Error>

Generates a new keypair of type key_scheme. Returns the resulting [PublicKey] together with its alias.

pub fn insert_key(&self, key: IotaKeyPair) -> Result<String, Error>

Inserts a new key in this keytool. Returns the alias assigned to the inserted key.

pub fn sign_raw( &self, address: IotaAddress, data: impl AsRef<[u8]>, ) -> Result<Vec<u8>, Error>

Uses the private key corresponding to [IotaAddress] address to sign data.

Notes

• SHA-512 is used to produce signatures when the key is ed25519.
• SHA-256 is used otherwise.

pub fn update_alias( &self, old_alias: &str, new_alias: Option<&str>, ) -> Result<(), Error>

Updates an alias from old_alias to new_alias If no value for new_alias is provided, a randomly generated one will be used.

pub fn get_key( &self, address: IotaAddress, ) -> Result<Option<(PublicKey, String)>, Error>

Returns the [PublicKey] for the given [IotaAddress] together with its alias.

pub fn get_key_by_alias(&self, alias: &str) -> Result<Option<PublicKey>, Error>

Returns the [PublicKey] that has the given alias, if any.

Trait Implementations

impl Clone for KeytoolStorage

fn clone(&self) -> KeytoolStorage

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for KeytoolStorage

fn default() -> KeytoolStorage

Returns the “default value” for a type.

impl From<KeytoolStorage> for Storage<KeytoolStorage, KeytoolStorage>

fn from(keytool: KeytoolStorage) -> Storage<KeytoolStorage, KeytoolStorage>

Converts to this type from the input type.

impl JwkStorage for KeytoolStorage

fn generate<'life0, 'async_trait>( &'life0 self, key_type: KeyType, alg: JwsAlgorithm, ) -> Pin<Box<dyn Future<Output = Result<JwkGenOutput, SingleStructError<KeyStorageErrorKind>>> + Send + 'async_trait>>

where 'life0: 'async_trait, KeytoolStorage: 'async_trait,

Generate a new key represented as a JSON Web Key.

fn insert<'life0, 'async_trait>( &'life0 self, jwk: Jwk, ) -> Pin<Box<dyn Future<Output = Result<KeyId, SingleStructError<KeyStorageErrorKind>>> + Send + 'async_trait>>

where 'life0: 'async_trait, KeytoolStorage: 'async_trait,

Insert an existing JSON Web Key into the storage.

fn sign<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, key_id: &'life1 KeyId, data: &'life2 [u8], _pk_jwk: &'life3 Jwk, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, SingleStructError<KeyStorageErrorKind>>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, KeytoolStorage: 'async_trait,

Sign the provided data using the private key identified by key_id according to the requirements of the corresponding public_key (see Jwk::alg etc.).

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, _key_id: &'life1 KeyId, ) -> Pin<Box<dyn Future<Output = Result<(), SingleStructError<KeyStorageErrorKind>>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, KeytoolStorage: 'async_trait,

Deletes the key identified by key_id.

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, key_id: &'life1 KeyId, ) -> Pin<Box<dyn Future<Output = Result<bool, SingleStructError<KeyStorageErrorKind>>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, KeytoolStorage: 'async_trait,

Returns true if the key with the given key_id exists in storage, false otherwise.

impl KeyIdStorage for KeytoolStorage

fn insert_key_id<'life0, 'async_trait>( &'life0 self, method_digest: MethodDigest, key_id: KeyId, ) -> Pin<Box<dyn Future<Output = Result<(), SingleStructError<KeyIdStorageErrorKind>>> + Send + 'async_trait>>

where 'life0: 'async_trait, KeytoolStorage: 'async_trait,

Insert a KeyId into the KeyIdStorage under the given MethodDigest.

fn get_key_id<'life0, 'life1, 'async_trait>( &'life0 self, method_digest: &'life1 MethodDigest, ) -> Pin<Box<dyn Future<Output = Result<KeyId, SingleStructError<KeyIdStorageErrorKind>>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, KeytoolStorage: 'async_trait,

Obtain the KeyId associated with the given MethodDigest.

fn delete_key_id<'life0, 'life1, 'async_trait>( &'life0 self, method_digest: &'life1 MethodDigest, ) -> Pin<Box<dyn Future<Output = Result<(), SingleStructError<KeyIdStorageErrorKind>>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, KeytoolStorage: 'async_trait,

Delete the KeyId associated with the given MethodDigest from the KeyIdStorage.