Struct UntrustedToken

pub struct UntrustedToken<H = Empty> { /* private fields */ }

Parsed, but unvalidated token.

The type param (Empty by default) corresponds to the additional information enclosed in the token Header.

An UntrustedToken can be parsed from a string using the TryFrom implementation. This checks that a token is well-formed (has a header, claims and a signature), but does not validate the signature. As a shortcut, a token without additional header info can be created using Self::new().

Examples

let token_str = "eyJ0eXAiOiJKV1QiLA0KICJhbGciOiJIUzI1NiJ9.eyJp\
    c3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leG\
    FtcGxlLmNvbS9pc19yb290Ijp0cnVlfQ.dBjftJeZ4CVP-mB92K27uhbUJ\
    U1p1r_wW1gFWFOEjXk";
let token: UntrustedToken = token_str.try_into()?;
// The same operation using a shortcut:
let same_token = UntrustedToken::new(token_str)?;
// Token header can be accessed to select the verifying key etc.
let key_id: Option<&str> = token.header().key_id.as_deref();

Handling tokens with custom header fields

#[derive(Debug, Clone, Deserialize)]
struct HeaderExtensions {
    custom: String,
}

let token_str = "eyJhbGciOiJIUzI1NiIsImtpZCI6InRlc3Rfa2V5Iiwid\
    HlwIjoiSldUIiwiY3VzdG9tIjoiY3VzdG9tIn0.eyJzdWIiOiIxMjM0NTY\
    3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9._27Fb6nF\
    Tg-HSt3vO4ylaLGcU_ZV2VhMJR4HL7KaQik";
let token: UntrustedToken<HeaderExtensions> = token_str.try_into()?;
let extensions = &token.header().other_fields;
println!("{}", extensions.custom);

Implementations

impl<'a> UntrustedToken

pub fn new<S>(s: &'a S) -> Result<UntrustedToken, ParseError>

where S: AsRef<str> + ?Sized,

Creates an untrusted token from a string. This is a shortcut for calling the TryFrom conversion.

impl<H> UntrustedToken<H>

pub fn into_owned(self) -> UntrustedToken<H>

Converts this token to an owned form.

pub const fn header(&self) -> &Header<H>

Gets the token header.

pub fn algorithm(&self) -> &str

Gets the integrity algorithm used to secure the token.

pub fn signature_bytes(&self) -> &[u8]

Returns signature bytes from the token. These bytes are not guaranteed to form a valid signature.

pub fn deserialize_claims_unchecked<T>( &self, ) -> Result<Claims<T>, ValidationError>

where T: DeserializeOwned,

Deserializes claims from this token without checking token integrity. The resulting claims are thus not guaranteed to be valid.

Trait Implementations

impl<H> Clone for UntrustedToken<H>

where H: Clone,

fn clone(&self) -> UntrustedToken<H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H> Debug for UntrustedToken<H>

where H: Debug,

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

Formats the value using the given formatter.

impl<H> Decode for UntrustedToken<H>

where Header<H>: Decode,

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<UntrustedToken<H>, Error>

where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<'de, H> Deserialize<'de> for UntrustedToken<H>

where H: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<UntrustedToken<H>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<H> Encode for UntrustedToken<H>

where Header<H>: 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<H> MaxEncodedLen for UntrustedToken<H>

where Header<H>: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<H> PartialEq for UntrustedToken<H>

where H: PartialEq,

fn eq(&self, other: &UntrustedToken<H>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<H> Serialize for UntrustedToken<H>

where H: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, H> TryFrom<&'a str> for UntrustedToken<H>

where H: DeserializeOwned,

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( s: &'a str, ) -> Result<UntrustedToken<H>, <UntrustedToken<H> as TryFrom<&'a str>>::Error>

Performs the conversion.

impl<H> TypeInfo for UntrustedToken<H>

where Header<H>: TypeInfo + 'static, H: TypeInfo + 'static,

type Identity = UntrustedToken<H>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<H> EncodeLike for UntrustedToken<H>

where Header<H>: Encode,

impl<H> Eq for UntrustedToken<H>

where H: Eq,

impl<H> StructuralPartialEq for UntrustedToken<H>