Struct SymmetricKey 

pub struct SymmetricKey { /* private fields */ }

A 256-bit symmetric encryption key for ChaCha20-Poly1305

Implementations

impl SymmetricKey

pub fn generate() -> SymmetricKey

Generate a new random 256-bit symmetric key

Uses the OS random number generator to create a cryptographically secure key.

Example

use saorsa_pqc::symmetric::SymmetricKey;

let key = SymmetricKey::generate();

pub const fn from_bytes(key_bytes: [u8; 32]) -> SymmetricKey

Create a symmetric key from raw bytes

Arguments

• key_bytes - A 32-byte array containing the key material

Example

use saorsa_pqc::symmetric::SymmetricKey;

let key_bytes = [0u8; 32]; // Not recommended for production!
let key = SymmetricKey::from_bytes(key_bytes);

pub fn from_slice(key_bytes: &[u8]) -> Result<SymmetricKey, SymmetricError>

Create a symmetric key from a byte slice

Arguments

• key_bytes - A byte slice containing exactly 32 bytes

Errors

Returns SymmetricError::InvalidKeyLength if the slice is not exactly 32 bytes.

Example

use saorsa_pqc::symmetric::SymmetricKey;

let key_vec = vec![0u8; 32];
let key = SymmetricKey::from_slice(&key_vec)?;

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

Get the raw key bytes

Security Note

Be careful when using this method as it exposes the raw key material. Ensure the returned bytes are properly zeroized after use.

pub fn to_bytes(&self) -> Vec<u8>

Export the key as a byte vector

This creates a copy of the key bytes. The caller is responsible for securely handling and zeroizing the returned vector.

Trait Implementations

impl Clone for SymmetricKey

fn clone(&self) -> SymmetricKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymmetricKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SymmetricKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SymmetricKey

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for SymmetricKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroize for SymmetricKey

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.