Struct jwt_compact::UntrustedToken

pub struct UntrustedToken<'a, 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<'a>

pub fn new<S: AsRef<str> + ?Sized>(s: &'a S) -> Result<Self, ParseError>

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<'static, H>

Converts this token to an owned form.

pub 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<'a, H: Clone> Clone for UntrustedToken<'a, H>

fn clone(&self) -> UntrustedToken<'a, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, H: Debug> Debug for UntrustedToken<'a, H>

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

Formats the value using the given formatter.

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

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.