Struct Key 

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

A 32-byte XChaCha20-Poly1305 key. Zeroized on drop and never printed.

The bytes live on the heap, so moving a key, or growing a list of keys, moves a pointer and leaves no copy of the bytes behind. Keys compare in constant time.

Implementations

impl Key

pub const LEN: usize = 32

pub fn from_bytes(bytes: [u8; 32]) -> Key

A key holding bytes. Copies the caller still holds are the caller’s to zeroize.

pub fn from_slice(bytes: &[u8]) -> Option<Key>

Returns None unless bytes is exactly 32 bytes long.

pub fn from_base64(text: &str) -> Result<Key, KeyError>

A key written as standard base64, with or without = padding, as kinship keygen prints it. Surrounding whitespace is ignored.

pub fn to_base64(&self) -> Zeroizing<String>

The key as padded standard base64, the form from_base64 reads and kinship keygen prints. The text is the secret itself: never log it. It is zeroized when dropped, and written into its final allocation, so no copy is left behind.

pub fn id(&self) -> u32

First 4 bytes of BLAKE3(key), big-endian. Sent in the clear to pick the right key.

pub fn key_id(&self) -> KeyId

id as a KeyId, which prints as 8 hex characters.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Drop for Key

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for Key

impl PartialEq for Key

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

Looks at every byte whatever it finds, so the time taken does not tell where two keys differ.

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

Inequality operator !=.