pub struct Key(/* private fields */);Expand description
A secret key for stream encryption
This key is used for symmetric encryption with various stream ciphers. All stream cipher variants in this module use the same key size (32 bytes).
Implementations§
Source§impl Key
impl Key
Sourcepub fn generate() -> Result<Self>
pub fn generate() -> Result<Self>
Generates a new random key for stream encryption
This function generates a cryptographically secure random key that can be used with any of the stream cipher variants in this module (ChaCha20, XChaCha20, Salsa20).
§Returns
Result<Self>- A randomly generated key
§Example
use libsodium_rs as sodium;
use sodium::crypto_stream;
use sodium::ensure_init;
// Initialize libsodium
ensure_init().expect("Failed to initialize libsodium");
// Generate a random key
let key = crypto_stream::Key::generate().unwrap();Sourcepub fn from_slice(slice: &[u8]) -> Result<Self>
pub fn from_slice(slice: &[u8]) -> Result<Self>
Creates a key from a byte slice
This function creates a key from an existing byte slice, which must be exactly
KEYBYTES (32) bytes long. This is useful when you have an existing key or
when you need to derive a key from another source.
§Arguments
slice- The bytes to create the key from
§Returns
Result<Self>- The key or an error if the input is invalid
§Errors
Returns an error if the input is not exactly KEYBYTES bytes long
§Example
use libsodium_rs as sodium;
use sodium::crypto_stream;
use sodium::ensure_init;
// Initialize libsodium
ensure_init().expect("Failed to initialize libsodium");
// Create a key from existing bytes
let key_bytes = [0x42; crypto_stream::KEYBYTES]; // In a real application, use a proper key
let key = crypto_stream::Key::from_slice(&key_bytes).unwrap();Sourcepub fn as_bytes(&self) -> &[u8] ⓘ
pub fn as_bytes(&self) -> &[u8] ⓘ
Returns a reference to the key as a byte slice
This method provides access to the raw bytes of the key, which can be useful when you need to pass the key to other functions or store it.
§Returns
&[u8]- A reference to the key bytes
§Security Considerations
Be careful when handling the raw key bytes. Avoid logging or displaying them, and ensure they are securely erased from memory when no longer needed.
§Example
use libsodium_rs as sodium;
use sodium::crypto_stream;
use sodium::ensure_init;
// Initialize libsodium
ensure_init().expect("Failed to initialize libsodium");
// Generate a random key
let key = crypto_stream::Key::generate().unwrap();
// Get the raw bytes of the key
let key_bytes = key.as_bytes();
assert_eq!(key_bytes.len(), crypto_stream::KEYBYTES);