Struct SealingKey

pub struct SealingKey<N: NonceSequence> { /* private fields */ }

An AEAD key for encrypting and signing (“sealing”), bound to a nonce sequence.

Intentionally not Clone or Copy since cloning would allow duplication of the nonce sequence.

Prefer RandomizedNonceKey for sealing operations.

Implementations

impl<N: NonceSequence> SealingKey<N>

pub fn seal_in_place<A, InOut>( &mut self, aad: Aad<A>, in_out: &mut InOut, ) -> Result<(), Unspecified>

where A: AsRef<[u8]>, InOut: AsMut<[u8]> + for<'in_out> Extend<&'in_out u8>,

👎Deprecated: Renamed to seal_in_place_append_tag.

Deprecated. Renamed to seal_in_place_append_tag.

Prefer RandomizedNonceKey::seal_in_place_append_tag.

Errors

See seal_in_place_append_tag

pub fn seal_in_place_append_tag<A, InOut>( &mut self, aad: Aad<A>, in_out: &mut InOut, ) -> Result<(), Unspecified>

where A: AsRef<[u8]>, InOut: AsMut<[u8]> + for<'in_out> Extend<&'in_out u8>,

Encrypts and signs (“seals”) data in place, appending the tag to the resulting ciphertext.

key.seal_in_place_append_tag(aad, in_out) is equivalent to:

key.seal_in_place_separate_tag(aad, in_out.as_mut())
    .map(|tag| in_out.extend(tag.as_ref()))

Prefer RandomizedNonceKey::seal_in_place_append_tag.

Errors

error::Unspecified when nonce_sequence cannot be advanced.

pub fn seal_in_place_separate_tag<A>( &mut self, aad: Aad<A>, in_out: &mut [u8], ) -> Result<Tag, Unspecified>

where A: AsRef<[u8]>,

Encrypts and signs (“seals”) data in place.

aad is the additional authenticated data (AAD), if any. This is authenticated but not encrypted. The type A could be a byte slice &[u8], a byte array [u8; N] for some constant N, Vec<u8>, etc. If there is no AAD then use Aad::empty().

The plaintext is given as the input value of in_out. seal_in_place() will overwrite the plaintext with the ciphertext and return the tag. For most protocols, the caller must append the tag to the ciphertext. The tag will be self.algorithm.tag_len() bytes long.

Prefer RandomizedNonceKey::seal_in_place_separate_tag.

Errors

error::Unspecified when nonce_sequence cannot be advanced.

pub fn prepare_nonce( &mut self, ) -> Result<SealingKeyPreparedNonce<'_, N>, Unspecified>

Returns a SealingKeyPreparedNonce containing the next computed Nonce consumed from NonceSequence.

The encapsulated Nonce will be used if and only if either SealingKeyPreparedNonce::seal_in_place_append_tag or SealingKeyPreparedNonce::seal_in_place_separate_tag are invoked. Dropping SealingKeyPreparedNonce without invoking either method results in the nonce remaining consumed and unused within the associated NonceSequence. Subsequent calls to SealingKey methods will always use a proceeding nonce from the NonceSequence regardless of whether a SealingKeyPreparedNonce is consumed or not.

Errors

Unspecified if there is a failure computing the nonce for the next operation, i.e. NonceSequence exhausted.

Trait Implementations

impl<N: NonceSequence> BoundKey<N> for SealingKey<N>

fn new(key: UnboundKey, nonce_sequence: N) -> Self

Constructs a new key from the given UnboundKey and NonceSequence.

fn algorithm(&self) -> &'static Algorithm

The key’s AEAD algorithm.

impl<N: NonceSequence> Debug for SealingKey<N>

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

Formats the value using the given formatter.