Struct Key

pub struct Key {
    pub algorithm: Algorithm,
    pub operations: HashSet<KeyOperation>,
    pub secret: Vec<u8>,
    pub kid: Option<String>,
    /* private fields */
}

Similar to JWK but not quite the same because it’s annoying to implement.

Fields

algorithm: Algorithm

The algorithm used by the key.

operations: HashSet<KeyOperation>

The operations that the key can perform.

secret: Vec<u8>

The secret key as base64url (unpadded).

kid: Option<String>

The key ID, useful for rotating keys.

Implementations

impl Key

pub fn from_str(s: &str) -> Result<Self>

pub fn from_file<P: AsRef<StdPath>>(path: P) -> Result<Self>

pub fn to_str(&self) -> Result<String>

pub fn to_file<P: AsRef<StdPath>>(&self, path: P) -> Result<()>

pub fn decode(&self, token: &str) -> Result<Claims>

pub fn encode(&self, payload: &Claims) -> Result<String>

pub fn generate(algorithm: Algorithm, id: Option<String>) -> Self

Generate a key pair for the given algorithm, returning the private and public keys.

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<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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.