Struct XChaCha20Poly1305Key

pub struct XChaCha20Poly1305Key {
    pub(crate) key_id: [u8; 16],
    pub(crate) enc_key: Pin<Box<GenericArray<u8, U32>>>,
    pub(crate) supported_operations: Vec<KeyOperation>,
}

XChaCha20Poly1305Key is a symmetric encryption key consisting of one 256-bit key, and contains a key id. In contrast to the Aes256CbcKey and Aes256CbcHmacKey, this key type is used to create CoseEncrypt0 messages.

Fields

key_id: [u8; 16]

enc_key: Pin<Box<GenericArray<u8, U32>>>

supported_operations: Vec<KeyOperation>

Controls which key operations are allowed with this key. Note: Only checking decrypt is implemented right now, and implementing is tracked here https://bitwarden.atlassian.net/browse/PM-27513. Further, disabling decrypt will also disable unwrap. The only use-case so far is DataEnvelope.

Implementations

impl XChaCha20Poly1305Key

pub fn make() -> Self

Creates a new XChaCha20Poly1305Key with a securely sampled cryptographic key and key id.

pub(crate) fn disable_key_operation(&mut self, op: KeyOperation) -> &mut Self

Trait Implementations

impl Clone for XChaCha20Poly1305Key

fn clone(&self) -> XChaCha20Poly1305Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for XChaCha20Poly1305Key

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for XChaCha20Poly1305Key

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

Formats the value using the given formatter.

impl PartialEq for XChaCha20Poly1305Key

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Zeroize for XChaCha20Poly1305Key

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.