KeyMaterial

Struct KeyMaterial 

Source
pub struct KeyMaterial {
    pub key: Vec<u8>,
    pub nonce: Vec<u8>,
    pub salt: Vec<u8>,
    pub algorithm: EncryptionAlgorithm,
    pub created_at: DateTime<Utc>,
    pub expires_at: Option<DateTime<Utc>>,
}
Expand description

Key material for encryption/decryption operations with secure memory management

This struct contains all cryptographic material needed for encryption and decryption operations. It implements secure memory management through the Zeroize trait to ensure sensitive data is properly cleared from memory when no longer needed.

§Security Features

  • Automatic Zeroization: Keys are securely wiped from memory on drop
  • Expiration Support: Keys can have expiration times for security policies
  • Algorithm Binding: Keys are bound to specific algorithms
  • Timestamp Tracking: Creation time tracking for audit and compliance

§Key Material Components

  • Key: The actual encryption/decryption key
  • Nonce: Unique number used once per encryption operation
  • Salt: Random data used in key derivation
  • Algorithm: The encryption algorithm this key is for
  • Created At: When the key material was generated
  • Expires At: Optional expiration time for key rotation

§Examples

§Memory Security

The key material implements Zeroize to ensure sensitive data is securely cleared from memory:

§Serialization

Key material can be serialized for storage, but care must be taken to:

  • Encrypt serialized key material
  • Use secure storage mechanisms
  • Implement proper access controls
  • Follow key management best practices

Fields§

§key: Vec<u8>

The encryption/decryption key (sensitive data)

§nonce: Vec<u8>

Nonce/initialization vector for encryption operations

§salt: Vec<u8>

Salt used in key derivation (if applicable)

§algorithm: EncryptionAlgorithm

The encryption algorithm this key material is for

§created_at: DateTime<Utc>

When this key material was created (RFC3339 format)

§expires_at: Option<DateTime<Utc>>

Optional expiration time for key rotation (RFC3339 format)

Implementations§

Source§

impl KeyMaterial

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn new( key: Vec<u8>, nonce: Vec<u8>, salt: Vec<u8>, algorithm: EncryptionAlgorithm, ) -> Self

Source§

impl KeyMaterial

Source

pub fn with_expiration(self, expires_at: DateTime<Utc>) -> Self

Sets expiration time

Source

pub fn is_expired(&self) -> bool

Checks if key material is expired

Source

pub fn clear(&mut self)

Securely clears key material

Source

pub fn key_size(&self) -> usize

Gets key size in bytes

Source

pub fn nonce_size(&self) -> usize

Gets nonce size in bytes

Source

pub fn salt_size(&self) -> usize

Gets salt size in bytes

Trait Implementations§

Source§

impl Clone for KeyMaterial

Source§

fn clone(&self) -> KeyMaterial

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyMaterial

Source§

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

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

impl<'de> Deserialize<'de> for KeyMaterial

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Drop for KeyMaterial

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Serialize for KeyMaterial

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Zeroize for KeyMaterial

Source§

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.
Source§

impl ZeroizeOnDrop for KeyMaterial

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,