Struct SessionKey 

pub struct SessionKey(pub(crate) SymmetricCryptoKey);

A symmetric key that wraps the user key in the persisted state, allowing a rehydrated client to unlock without re-deriving the user key from a master password or other primary unlock factor.

Callers are responsible for storing this key in a secure location outside the SDK (e.g. the OS keychain) and providing it back to UnlockClient::unlock when reconstructing the client.

Tuple Fields

0: SymmetricCryptoKey

Implementations

impl SessionKey

pub fn make() -> Self

Mint a new random session key.

pub fn from_context<Ids: KeySlotIds>( key_to_seal: Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<(SymmetricKeyEnvelope, SessionKey), SymmetricKeyEnvelopeError>

Mint a new session key, seal key_to_seal (already present in ctx) with it, and return both the envelope and the new session key.

pub fn unwrap_to_context<Ids: KeySlotIds>( &self, envelope: &SymmetricKeyEnvelope, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<Ids::Symmetric, SymmetricKeyEnvelopeError>

Unseal envelope using this session key and place the resulting key in ctx, returning the local id under which it is registered.

Trait Implementations

impl PartialEq for SessionKey

fn eq(&self, other: &SessionKey) -> 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 StructuralPartialEq for SessionKey