Struct fog_crypto::identity::IdentityKey

pub struct IdentityKey { /* fields omitted */ }

Identity Key that allows signing hashes as a given Identity.

This acts as a wrapper for a specific cryptographic private key, and it is only be used for a specific corresponding signature algorithm. The underlying private key may be located in a hardware module or some other private keystore; in this case, it may be impossible to export the key.

Example

// Make a new temporary key
let mut csprng = rand::rngs::OsRng {};
let key = IdentityKey::new_temp(&mut csprng);

// Sign some data with it
let hash = Hash::new(b"I am data, about to be signed");
let signature = key.sign(&hash);

Implementations

impl IdentityKey

pub fn new_temp<R>(csprng: &mut R) -> IdentityKey where
    R: CryptoRng + RngCore, 

Generate a temporary IdentityKey that exists in program memory.

pub fn new_temp_with_version<R>(
    csprng: &mut R,
    version: u8
) -> Result<IdentityKey, CryptoError> where
    R: CryptoRng + RngCore, 

Generate a temporary IdentityKey that exists in program memory. Uses the specified version instead of the default, and fails if the version is unsupported.

pub fn version(&self) -> u8

Get the signature algorithm version used by this key.

pub fn id(&self) -> &Identity

Get the associated Identity for this key.

pub fn sign(&self, hash: &Hash) -> Signature

Sign a hash. Signing should be fast and always succeed.

pub fn export_for_lock<R: CryptoRng + RngCore>(
    &self,
    csprng: &mut R,
    lock: &LockId
) -> Option<IdentityLockbox>

Pack this key into a Lockbox, meant for the recipient specified by lock. Returns None if this key cannot be exported.

pub fn export_for_stream<R: CryptoRng + RngCore>(
    &self,
    csprng: &mut R,
    stream: &StreamKey
) -> Option<IdentityLockbox>

Pack this key into a Lockbox, meant for the recipient specified by stream. Returns None if this key cannot be exported.

Trait Implementations

impl Clone for IdentityKey

fn clone(&self) -> IdentityKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityKey

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

Formats the value using the given formatter.

impl Display for IdentityKey

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

Display just the Identity (never the underlying key).