Struct hpke::AeadCtxR

pub struct AeadCtxR<A: Aead, K: Kdf>(_);

The HPKE receiver's context. This is what you use to open ciphertexts.

Implementations

impl<A: Aead, K: Kdf> AeadCtxR<A, K>

pub fn open(
    &mut self,
    ciphertext: &mut [u8],
    aad: &[u8],
    tag: &AeadTag<A>
) -> Result<(), HpkeError>

Does a "detached open in place", meaning it overwrites ciphertext with the resulting plaintext, and takes the tag as a separate input.

Return Value

Returns Ok(()) on success. If this context has been used for so many encryptions that the sequence number overflowed, returns Err(HpkeError::SeqOverflow). If this happens, plaintext will be unmodified. If the tag fails to validate, returns Err(HpkeError::InvalidTag). If this happens, plaintext is in an undefined state.

pub fn export(&self, info: &[u8], out_buf: &mut [u8]) -> Result<(), HpkeError>

Fills a given buffer with secret bytes derived from this encryption context. This value does not depend on sequence number, so it is constant for the lifetime of this context.

Return Value

Returns Ok(()) on success. If the buffer length is more than 255x the digest size of the underlying hash function, returns an Err(HpkeError::InvalidKdfLength).