Struct lock_keeper::crypto::signing_key::SigningKeyPair

pub struct SigningKeyPair {
    signing_key: SigningPrivateKey,
    context: AssociatedData,
}

An ECDSA signing key pair, including a public component for verifying signatures, a private component for creating them, and context about the key pair.

This can be generated locally by the client or remotely by the server.

Fields

signing_key: SigningPrivateKey

context: AssociatedData

Implementations

impl SigningKeyPair

fn generate( rng: &mut (impl CryptoRng + RngCore), context: &AssociatedData ) -> Self

Create a new SigningKeyPair with the given associated data.

fn domain_separator() -> &'static str

Domain separator for use in serializing signing keypairs.

pub fn public_key(&self) -> SigningPublicKey

Retrieve the public portion of the key.

pub(super) fn context(&self) -> &AssociatedData

Retrieve the context associated with the signing key.

pub fn remote_generate( rng: &mut (impl CryptoRng + RngCore), user_id: &UserId, key_id: &KeyId ) -> Self

Create a new SigningKeyPair. This must be run by the server.

pub fn import_and_encrypt( key_material: &[u8], rng: &mut (impl CryptoRng + RngCore), storage_key: &StorageKey, user_id: &UserId, key_id: &KeyId ) -> Result<(Self, Encrypted<Self>), LockKeeperError>

Create a SigningKeyPair from an imported key and encrypt it for storage at a server, under a key known only to the client.

This is part of the local import with remote backup flow and must be run by the client. In this flow, the key server will only receive an Encrypted<SigningKeyPair>, not the cleartext.

key_material should be a scalar value formatted in big endian. See k256 documentation for details.

This function takes the following steps:

1. Format the key_material as a signing key
2. Encrypt it under the StorageKey, using an AEAD scheme

pub fn create_and_encrypt( rng: &mut (impl CryptoRng + RngCore), storage_key: &StorageKey, user_id: &UserId, key_id: &KeyId ) -> Result<(Self, Encrypted<Self>), LockKeeperError>

Create and encrypt a new signing key for storage at a server, under a key known only to the client.

This is part of the local signing key generation flow and must be run by the client. In this flow the key server will only receive an Encrypted<SigningKeyPair>, not the cleartext.

This function takes the following steps:

1. Generates a new signing key
2. Encrypt it under the StorageKey, using an AEAD scheme

Trait Implementations

impl Clone for SigningKeyPair

fn clone(&self) -> SigningKeyPair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SigningKeyPair

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<SigningKeyPair> for Export

fn from(key_pair: SigningKeyPair) -> Self

Converts to this type from the input type.

impl PartialEq for SigningKeyPair

fn eq(&self, other: &SigningKeyPair) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<RetrievedSecret> for SigningKeyPair

type Error = LockKeeperError

The type returned in the event of a conversion error.

fn try_from(secret: RetrievedSecret) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<SigningKeyPair> for Vec<u8>

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(key_pair: SigningKeyPair) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for SigningKeyPair

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SigningKeyPair

impl StructuralPartialEq for SigningKeyPair