Struct A256KWKey 

pub struct A256KWKey { /* private fields */ }

AES-256 Key Wrap key for JWE.

This is a symmetric key that can both encrypt and decrypt JWE tokens.

Implementations

impl A256KWKey

pub fn from_bytes(key: &[u8]) -> Result<Self, Error>

Create a key from raw bytes.

The key must be exactly 32 bytes (256 bits).

pub fn generate() -> Self

Generate a random key.

pub fn to_bytes(&self) -> Vec<u8>

Export the key as raw bytes.

pub fn with_key_id(self, key_id: impl Into<String>) -> Self

Set the key ID.

pub fn key_id(&self) -> Option<&str>

Get the key ID.

pub fn encrypt<CustomClaims: Serialize>( &self, claims: JWTClaims<CustomClaims>, ) -> Result<String, Error>

Encrypt claims into a JWE token.

pub fn encrypt_with_options<CustomClaims: Serialize>( &self, claims: JWTClaims<CustomClaims>, options: &EncryptionOptions, ) -> Result<String, Error>

Encrypt claims into a JWE token with options.

pub fn decrypt_token<CustomClaims: DeserializeOwned>( &self, token: &str, options: Option<DecryptionOptions>, ) -> Result<JWTClaims<CustomClaims>, Error>

Decrypt a JWE token and return the claims.

pub fn decode_metadata(token: &str) -> Result<JWETokenMetadata, Error>

Decode token metadata without decrypting.

Trait Implementations

impl Clone for A256KWKey

fn clone(&self) -> A256KWKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for A256KWKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for A256KWKey

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.