Struct SecretKey 

pub struct SecretKey<const N: usize> { /* private fields */ }

A fixed-size secret key that is automatically zeroed when dropped.

SecretKey<N> wraps a [u8; N] and implements Zeroize + ZeroizeOnDrop, ensuring that key material does not linger in memory after the value goes out of scope.

Examples

use oxicrypto_core::SecretKey;

let key = SecretKey::<32>::from_slice(&[0xAA; 32]).expect("wrong length");
assert_eq!(key.as_bytes().len(), 32);
// key is zeroed automatically when dropped

Implementations

impl<const N: usize> SecretKey<N>

pub fn new(bytes: [u8; N]) -> Self

Create a SecretKey from a raw byte array.

pub fn from_slice(slice: &[u8]) -> Result<Self, CryptoError>

Create a SecretKey from a byte slice.

Returns CryptoError::InvalidKey if slice.len() != N.

pub fn as_bytes(&self) -> &[u8; N]

Borrow the secret bytes.

Callers should take care not to log or persist this value.

Trait Implementations

impl<const N: usize> Clone for SecretKey<N>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for SecretKey<N>

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

Formats the value using the given formatter.

impl<const N: usize> Drop for SecretKey<N>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<const N: usize> Zeroize for SecretKey<N>

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.