Struct Key 

pub struct Key {
    pub algorithm: Algorithm,
    pub operations: HashSet<KeyOperation>,
    pub key: KeyType,
    pub kid: Option<KeyId>,
    pub guest: Vec<String>,
    pub guest_sub: Vec<String>,
    pub guest_pub: Vec<String>,
    /* private fields */
}

JWK, almost to spec (https://datatracker.ietf.org/doc/html/rfc7517) 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.

key: KeyType

Defaults to KeyType::OCT

kid: Option<KeyId>

The key ID, useful for rotating keys.

guest: Vec<String>

Path prefixes for both unauthenticated subscribe and publish access. Shorthand for setting both guest_sub and guest_pub.

guest_sub: Vec<String>

Path prefixes for unauthenticated subscribe access. "" means everything.

guest_pub: Vec<String>

Path prefixes for unauthenticated publish access. "" means everything.

Implementations

impl Key

pub fn serialize<__S>( __self: &Key, __serializer: __S, ) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

impl<'de> Key

pub fn deserialize<__D>(__deserializer: __D) -> Result<Key, __D::Error>

where __D: Deserializer<'de>,

impl Key

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

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

Load a key from a file, auto-detecting JSON or base64url encoding.

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

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

Write the key to a file as JSON.

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

Write the key to a file as base64url-encoded JSON.

pub fn to_public(&self) -> Result<Self>

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

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

pub fn generate(algorithm: Algorithm, id: Option<KeyId>) -> Result<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.