Struct classic_mceliece_rust::SecretKey

pub struct SecretKey<'a>(_);

A Classic McEliece secret key.

Should be kept on the device where it’s generated. Used to decapsulate the SharedSecret from the Ciphertext received from the encapsulator.

Implementations

impl<'a> SecretKey<'a>

pub fn to_owned(&self) -> SecretKey<'static>

Available on crate feature alloc only.

Copies the key to the heap and makes it 'static.

pub fn as_array(&self) -> &[u8; 6492]

Returns the secret key as an array of bytes.

Please note that depending on your threat model, moving the data out of the SecretKey can be bad for security. The SecretKey type is designed to keep the backing data in a single location in memory and zeroing it out when it goes out of scope.

Trait Implementations

impl<'a> AsRef<[u8]> for SecretKey<'a>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for SecretKey<'a>

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

Formats the value using the given formatter.

impl<'sk> Decapsulator<Ciphertext> for SecretKey<'sk>

Available on crate feature kem only.

fn try_decap(
    &self,
    ciphertext: &Ciphertext
) -> Result<SharedSecret<Ciphertext>, Error>

Attempt to decapsulate the given encapsulated key. Returns the shared secret on success, or an error if something went wrong.

impl<'a> Drop for SecretKey<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a mut [u8; 6492]> for SecretKey<'a>

fn from(data: &'a mut [u8; 6492]) -> Self

Represents a mutable byte array of the correct size as a SecretKey. Please note that the array will be zeroed on drop.

impl From<Box<[u8; 6492], Global>> for SecretKey<'static>

Available on crate feature alloc only.

fn from(data: Box<[u8; 6492]>) -> Self

Converts to this type from the input type.

impl<'a> Zeroize for SecretKey<'a>

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.

impl<'a> ZeroizeOnDrop for SecretKey<'a>