Skip to main content

KekEnvelope

Struct KekEnvelope 

Source
pub struct KekEnvelope {
    pub key_identifier: Vec<u8>,
    pub wrapped_cek: Vec<u8>,
    pub nonce: Vec<u8>,
    pub ciphertext: Vec<u8>,
    pub tag: Vec<u8>,
}
Expand description

The parts of an AuthEnvelopedData addressed to one symmetric key.

Carried as a struct rather than assembled in place because the same fields are written on the way out and read on the way back, and a field the two sides disagree about is the defect this shape makes impossible.

The crypto is the caller’s: this module puts bytes in a structure and takes them out again, and never holds a key.

use rite_sdk::cms::{self, KekEnvelope};

// Values a backend produces: the CEK wrapped under the KEK, and the
// content under that CEK.
let envelope = KekEnvelope {
    key_identifier: vec![0x76, 0x3c, 0xbc],
    wrapped_cek: vec![0x11; 40],
    nonce: vec![0x22; 12],
    ciphertext: vec![0x33; 64],
    tag: vec![0x44; cms::GCM_ICV_LEN],
};

let der = cms::write_kek_enveloped(&envelope)?;
assert_eq!(cms::read_kek_enveloped(&der)?, envelope);

// And the same bytes describe the wrap that produced them.
let facts = cms::describe(&der)?;
assert_eq!(
    facts.recipient_key_identifier.as_deref(),
    Some(&[0x76, 0x3c, 0xbc][..])
);

Fields§

§key_identifier: Vec<u8>

What names the key-encryption key, going in kekid.keyIdentifier.

§wrapped_cek: Vec<u8>

The content-encryption key, wrapped under the KEK with AES-KW.

§nonce: Vec<u8>

The 12-byte AES-GCM nonce.

§ciphertext: Vec<u8>

The content under AES-256-GCM.

§tag: Vec<u8>

The AES-GCM authentication tag. Its length is what GCMParameters.aes-ICVlen names, so the two cannot disagree.

Trait Implementations§

Source§

impl Clone for KekEnvelope

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KekEnvelope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for KekEnvelope

Source§

impl PartialEq for KekEnvelope

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for KekEnvelope

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.