Struct crypt_guard::KeyControl::Key

pub struct Key { /* private fields */ }

Represents a cryptographic key, including its type and raw content.

Implementations

impl Key

Represents a cryptographic key with its type and content. It provides functionalities to manipulate and store keys in various formats.

pub fn new(key_type: KeyTypes, content: Vec<u8>) -> Self

Constructs a new Key with specified type and content, optimizing storage based on the key type.

Parameters

• key_type: The type of the key (public, secret, ciphertext, shared secret).
• content: The raw content of the key.

Returns

A new instance of Key.

pub fn new_public_key(key: Vec<u8>) -> Self

Factory methods for creating specific types of keys by building new Self elements.

pub fn new_secret_key(key: Vec<u8>) -> Self

pub fn new_ciphertext(key: Vec<u8>) -> Self

pub fn new_shared_secret(key: Vec<u8>) -> Self

pub fn get(&self) -> Result<&Key, CryptError>

Accessors for the key’s properties.

pub fn key_type(&self) -> Result<&KeyTypes, CryptError>

pub fn content(&self) -> Result<&[u8], CryptError>

pub fn save(&self, base_path: PathBuf) -> Result<(), CryptError>

Safely stores the key to a specified path.

Parameters

• base_path: The base directory path where the key will be saved.

Returns

An Ok(()) on success or a CryptError on failure.

pub fn encap(&self) -> Result<(Key, Key), CryptError>

Encapsulates the key, generating a ciphertext and shared secret.

Returns

A tuple containing the ciphertext and shared secret as Key instances, or a CryptError.

pub fn decap(&self, ciphertext: Key) -> Result<Key, CryptError>

Decapsulates the ciphertext using the secret key, retrieving the shared secret.

Parameters

• ciphertext: The ciphertext Key to be decapsulated.

Returns

The shared secret as a Key, or a CryptError.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl PartialEq for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Key