Struct Key

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

A cryptographic master key to sign or encrypt cookies.

Implementations

impl Key

pub fn from(key: Vec<u8>) -> Key

Creates a new Key from a string that’s at least 256-bits (32 bytes) long. For security, the master key must be cryptographically random.

Panics

Panics if key is less than 32 bytes in length.

For a non-panicking version, use crate::Key::try_from() or generate a key with Key::generate() or Key::try_generate().

Example

use biscotti::Key;

let key = { /* a cryptographically random key >= 32 bytes */ };

let key = Key::from(key);

pub fn generate() -> Key

Generates signing/encryption keys from a secure, random source. Keys are generated nondeterministically.

Panics

Panics if randomness cannot be retrieved from the operating system. See Key::try_generate() for a non-panicking version.

Example

use biscotti::Key;

let key = Key::generate();

pub fn try_generate() -> Option<Key>

Attempts to generate signing/encryption keys from a secure, random source. Keys are generated nondeterministically. If randomness cannot be retrieved from the underlying operating system, returns None.

Example

use biscotti::Key;

let key = Key::try_generate();

pub fn master(&self) -> &[u8]

Returns the raw bytes of the master key. Guaranteed to be at least 32 bytes.

Example

use biscotti::Key;

let key = Key::generate();
let master_key = key.master();

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<D>(deserializer: D) -> Result<Key, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Key

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Key

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Key

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Key

fn try_from(key: &[u8]) -> Result<Self, Self::Error>

A fallible version of Key::from().

Succeeds when Key::from() succeeds and returns an error where Key::from() panics, namely, if key is too short.

Example

use biscotti::Key;

let key = { /* a cryptographically random key >= 32 bytes */ };
assert!(Key::try_from(key).is_ok());

// A key that's far too short to use.
let key = &[1, 2, 3, 4][..];
assert!(Key::try_from(key).is_err());

type Error = KeyError

The type returned in the event of a conversion error.

impl TryFrom<Vec<u8>> for Key

fn try_from(key: Vec<u8>) -> Result<Self, Self::Error>

A fallible version of Key::from().

Succeeds when Key::from() succeeds and returns an error where Key::from() panics, namely, if key is too short.

Example

use biscotti::Key;

let key = { /* a cryptographically random key >= 32 bytes */ };
assert!(Key::try_from(key).is_ok());

// A key that's far too short to use.
let key = vec![1, 2, 3, 4];
assert!(Key::try_from(key).is_err());

type Error = KeyError

The type returned in the event of a conversion error.

impl Eq for Key