Struct fog_crypto::stream::ContainedStreamKey

pub struct ContainedStreamKey { /* fields omitted */ }

A self-contained implementor of StreamInterface. It’s expected this will be used unless the symmetric key is being managed by the OS or a hardware module.

Implementations

impl ContainedStreamKey

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

Generate a new key, given a cryptographic RNG.

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

Generate a new key with a specific version, given a cryptographic RNG. Fails if the version isn’t supported.

pub fn encode_vec(&self, buf: &mut Vec<u8>)

Encode directly to a byte vector. The resulting vector should be zeroized or overwritten before being dropped.

Trait Implementations

impl Drop for ContainedStreamKey

fn drop(&mut self)

Executes the destructor for this type.

impl StreamInterface for ContainedStreamKey

fn id(&self) -> &StreamId

Get the corresponding StreamId for the symmetric key.

fn encrypt(
    &self,
    csprng: &mut dyn CryptoSrc,
    lock_type: LockboxType,
    content: &[u8]
) -> Vec<u8>

Encrypt raw data into a lockbox, following the StreamKey-recipient lockbox format (see lockbox.

fn decrypt_lock_key(
    &self,
    lockbox: &LockLockboxRef
) -> Result<LockKey, CryptoError>

Decrypt a LockLockboxRef and return a temporary (not stored in Vault) LockKey on success.

fn decrypt_identity_key(
    &self,
    lockbox: &IdentityLockboxRef
) -> Result<IdentityKey, CryptoError>

Decrypt a IdentityLockboxRef and return a temporary (not stored in Vault) IdentityKey on success.

fn decrypt_stream_key(
    &self,
    lockbox: &StreamLockboxRef
) -> Result<StreamKey, CryptoError>

Decrypt a StreamLockboxRef and return a temporary (not stored in Vault) StreamKey on success.

fn decrypt_data(&self, lockbox: &DataLockboxRef) -> Result<Vec<u8>, CryptoError>

Decrypt a DataLockboxRef and return a the decoded raw data on success.

fn self_export_lock(
    &self,
    csprng: &mut dyn CryptoSrc,
    receive_lock: &LockId
) -> Option<StreamLockbox>

Export the symmetric key in a StreamLockbox, with receive_lock as the recipient. If the key cannot be exported, this should return None.

fn self_export_stream(
    &self,
    csprng: &mut dyn CryptoSrc,
    receive_stream: &StreamKey
) -> Option<StreamLockbox>

Export the symmetric key in a StreamLockbox, with receive_stream as the recipient. If the key cannot be exported, this should return None. Additionally, if the underlying implementation does not allow moving the raw key into memory (i.e. it cannot call StreamInterface::encrypt or lock_id_encrypt) then None can also be returned.

impl TryFrom<&'_ [u8]> for ContainedStreamKey

type Error = CryptoError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.