[−][src]Struct actix_web::cookie::Key
A cryptographic master key for use with Signed
and/or Private
jars.
This structure encapsulates secure, cryptographic keys for use with both
PrivateJar and SignedJar.
It can be derived from a single master key via
from_master or generated from a secure random source
via generate. A single instance of Key
can be used for
both a PrivateJar
and a SignedJar
.
This type is only available when the secure
feature is enabled.
Methods
impl Key
[src]
pub fn from_master(key: &[u8]) -> Key
[src]
Derives new signing/encryption keys from a master key.
The master key must be at least 256-bits (32 bytes). For security, the master key must be cryptographically random. The keys are derived deterministically from the master key.
Panics
Panics if key
is less than 32 bytes in length.
Example
use actix_http::cookie::Key; let master_key = { /* a cryptographically random key >= 32 bytes */ }; let key = Key::from_master(master_key);
pub fn generate() -> Key
[src]
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 try_generate for a non-panicking version.
Example
use actix_http::cookie::Key; let key = Key::generate();
pub fn try_generate() -> Option<Key>
[src]
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 actix_http::cookie::Key; let key = Key::try_generate();
pub fn signing(&self) -> &[u8]
[src]
Returns the raw bytes of a key suitable for signing cookies.
Example
use actix_http::cookie::Key; let key = Key::generate(); let signing_key = key.signing();
pub fn encryption(&self) -> &[u8]
[src]
Returns the raw bytes of a key suitable for encrypting cookies.
Example
use actix_http::cookie::Key; let key = Key::generate(); let encryption_key = key.encryption();
Trait Implementations
Auto Trait Implementations
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
impl<T> From for T
[src]
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.