Struct KeyRing 

pub struct KeyRing { /* private fields */ }

Key ring for rotation-aware cookie signing/verification.

active is used to sign new cookies; previous keys are tried for verification only, letting old cookies remain valid through a rotation. Each key carries a string kid so callers can log which key admitted a given cookie when CookieSigned::get_with_kid is used.

Implementations

impl KeyRing

pub fn new(active_kid: impl Into<String>, active: Key) -> KeyRing

Build a key ring with a single active key.

pub fn with_previous(self, kid: impl Into<String>, key: Key) -> KeyRing

Add a previous key. Verification tries the active key first, then each previous key in insertion order.

pub fn revoke(&mut self, kid: &str) -> bool

Removes a previous key by kid. Cookies signed with that key will no longer be accepted — call this when a key has been disclosed or rotated past its retention window. Returns true if a key was removed.

pub fn previous_kids(&self) -> impl Iterator<Item = &str>

Returns the list of currently-trusted previous key ids in verification order. Use this to confirm a revocation took effect or to plan a key rotation.

pub fn active(&self) -> &Key

Borrow the active key.

pub fn active_kid(&self) -> &str

The active key id.

Trait Implementations

impl Clone for KeyRing

fn clone(&self) -> KeyRing

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.