Struct Renamed

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

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

Examples

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

let alg = Renamed::new(Hs256, "HS2");
let key = Hs256Key::new(b"super_secret_key_donut_steel");
let token_string = alg.token(&Header::empty(), &Claims::empty(), &key)?;

let token = UntrustedToken::new(&token_string)?;
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.validator::<Empty>(&key).validate(&token).is_err());

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

Implementations

impl<A> Renamed<A>

where A: Algorithm,

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

Creates a renamed algorithm.

Trait Implementations

impl<A> Algorithm for Renamed<A>

where A: Algorithm,

type Signature = <A as Algorithm>::Signature

Signature produced by the algorithm.

type SigningKey = <A as Algorithm>::SigningKey

Key used when issuing new tokens.

type VerifyingKey = <A as Algorithm>::VerifyingKey

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

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: &<Renamed<A> as Algorithm>::SigningKey, message: &[u8], ) -> <Renamed<A> as Algorithm>::Signature

Signs a message with the signing_key.

fn verify_signature( &self, signature: &<Renamed<A> as Algorithm>::Signature, verifying_key: &<Renamed<A> as Algorithm>::VerifyingKey, message: &[u8], ) -> bool

Verifies the message against the signature and verifying_key.

impl<A> Clone for Renamed<A>

where A: Clone,

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 for Renamed<A>

where A: Debug,

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

Formats the value using the given formatter.

impl<A> Encode for Renamed<A>

where A: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<A> TypeInfo for Renamed<A>

where A: TypeInfo + 'static,

type Identity = Renamed<A>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<A> Copy for Renamed<A>

where A: Copy,

impl<A> EncodeLike for Renamed<A>

where A: Encode,