Struct Key

Source

pub struct Key(/* private fields */);

Expand description

A secret key for authentication

This key is used to compute and verify authentication tags. It should be kept secret, as anyone with the key can create valid authentication tags.

Implementations§

Source §

impl Key

Source

pub fn generate() -> Result<Self>

Generates a new random key for authentication

This function generates a cryptographically secure random key that can be used for message authentication. The key is KEYBYTES (32) bytes long.

§Returns

Result<Self> - A new randomly generated key

§Example

use libsodium_rs as sodium;
use sodium::crypto_auth;
use sodium::ensure_init;

// Initialize libsodium
ensure_init().expect("Failed to initialize libsodium");

// Generate a random key
let key = crypto_auth::Key::generate().unwrap();

Source

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 - Byte slice of exactly KEYBYTES (32) bytes length

§Returns

Result<Self> - A new 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_auth;
use sodium::ensure_init;

// Initialize libsodium
ensure_init().expect("Failed to initialize libsodium");

// Create a key from existing bytes
let key_bytes = [0x42; crypto_auth::KEYBYTES]; // In a real application, use a proper key
let key = crypto_auth::Key::from_slice(&key_bytes).unwrap();

Source

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 securely.

§Returns

&[u8] - Reference to the key bytes

§Example

use libsodium_rs as sodium;
use sodium::crypto_auth;
use sodium::ensure_init;

// Initialize libsodium
ensure_init().expect("Failed to initialize libsodium");

// Generate a random key
let key = crypto_auth::Key::generate().unwrap();

// Get the raw bytes of the key
let key_bytes = key.as_bytes();
assert_eq!(key_bytes.len(), crypto_auth::KEYBYTES);