Struct jwt_compact::Renamed

pub struct Renamed<A> { /* fields omitted */ }

Algorithm that uses a custom name when creating and validating tokens.

Examples

use jwt_compact::{alg::{Hs256, Hs256Key}, prelude::*, Empty, Renamed};

let alg = Renamed::new(Hs256, "HS2");
let key = Hs256Key::from(b"super_secret_key_donut_steel" as &[_]);
let token_string = alg.token(Header::default(), &Claims::empty(), &key).unwrap();

let token = UntrustedToken::try_from(token_string.as_str()).unwrap();
assert_eq!(token.algorithm(), "HS2");
// Note that the created token cannot be verified against the original algorithm
// since the algorithm name recorded in the token header doesn't match.
assert!(Hs256.validate_integrity::<Empty>(&token, &key).is_err());

// ...but the modified alg is working as expected.
assert!(alg.validate_integrity::<Empty>(&token, &key).is_ok());

Methods

impl<A: Algorithm> Renamed<A>

pub fn new(algorithm: A, new_name: &'static str) -> Self

Creates a renamed algorithm.

Trait Implementations

impl<A: Algorithm> Algorithm for Renamed<A>

type SigningKey = A::SigningKey

Key used when issuing new tokens.

type VerifyingKey = A::VerifyingKey

Key used when verifying tokens. May coincide with SigningKey for symmetric algorithms (e.g., HS*).

type Signature = A::Signature

Signature produced by the algorithm.

fn name(&self) -> Cow<'static, str>

Returns the name of this algorithm, as mentioned in the alg field of the JWT header.

fn sign(
    &self,
    signing_key: &Self::SigningKey,
    message: &[u8]
) -> Self::Signature

Signs a message with the signing_key.

fn verify_signature(
    &self,
    signature: &Self::Signature,
    verifying_key: &Self::VerifyingKey,
    message: &[u8]
) -> bool

Verifies the message against the signature and verifying_key.

impl<A: Copy> Copy for Renamed<A>

impl<A: Clone> Clone for Renamed<A>

fn clone(&self) -> Renamed<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for Renamed<A>

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

Formats the value using the given formatter.