Struct aliri::jwt::JwtRef

pub struct JwtRef(/* private fields */);

A borrowed reference to a JSON Web Token (Jwt)

This type provides custom implementations of Display and Debug to prevent unintentional disclosures of sensitive values. See the documentation on those trait implementations for more information.

Implementations

impl JwtRef

pub fn decompose<H>(&self) -> Result<Decomposed<'_, H>, JwtVerifyError>

where H: for<'de> Deserialize<'de>,

Decomposes the JWT into its parts, preparing it for later processing.

Errors

Returns an error if the JWT is malformed.

pub fn verify<C, H, V>( &self, key: &V, validator: &CoreValidator ) -> Result<Validated<C, H>, JwtVerifyError>

where C: for<'de> Deserialize<'de> + CoreClaims, H: for<'de> Deserialize<'de> + CoreHeaders, V: Verifier<Algorithm = Algorithm>, JwtVerifyError: From<V::Error>,

Verifies a token against a particular JWK and validation plan

If you need to inspect the token first to determine how to verify the token, use decompose() to peek into the JWT.

Errors

Returns an error if the token is invalid according to the validator.

pub fn verify_with_custom<C, H, V, X>( &self, key: &V, validator: &CoreValidator, custom: X ) -> Result<Validated<C, H>, JwtVerifyError>

where C: for<'de> Deserialize<'de> + CoreClaims, H: for<'de> Deserialize<'de> + CoreHeaders, V: Verifier<Algorithm = Algorithm>, JwtVerifyError: From<V::Error>, X: ClaimsValidator<C, H>,

Verifies a token against a particular JWK and validation plan

If you need to inspect the token first to determine how to verify the token, use decompose() to peek into the JWT.

Errors

Returns an error if the token is invalid according to either the core or custom validators.

impl JwtRef

pub const fn from_str(raw: &str) -> &Self

Transparently reinterprets the string slice as a strongly-typed JwtRef

pub const fn from_static(raw: &'static str) -> &'static Self

Transparently reinterprets the static string slice as a strongly-typed JwtRef

pub fn into_owned(self: Box<JwtRef>) -> Jwt

Converts a Box<JwtRef> into a Jwt without copying or allocating

pub const fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

Trait Implementations

impl AsRef<JwtRef> for Jwt

fn as_ref(&self) -> &JwtRef

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for JwtRef

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<JwtRef> for Jwt

fn borrow(&self) -> &JwtRef

Immutably borrows from an owned value.

impl Borrow<str> for JwtRef

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Debug for JwtRef

By default, this type holds potentially sensitive information. To prevent unintentional disclosure of this value, this type will not print out its contents without explicitly specifying the alternate debug format, i.e. {:#?}. When specified in this form, it will print out the entire header and payload, but will omit the token’s signature. To change the number of characters in the signature that should be printed, specify the amount as a width in the format string, i.e. {:#25?}.

If not specified, a placeholder value will be printed out instead to indicate that it is hiding sensitive information.

If, for any reason, the token does not contain a . character, then the limitations specified above will apply to the token as a whole.

Example

let token = JwtRef::from_str(concat!(
    "eyJhbGciOiJIUzI1NiJ9.",
    "eyJzdWIiOiJBbGlyaSIsImF1ZCI6Im15X2FwaSIsImlzcyI6ImF1dGhvcml0eSJ9.",
    "2N5yyY2UjqlUKSSCpFVWzfixfBRTWahiN2PrUuiuxbE"
));

assert_eq!(format!("{:?}", token), "***JWT***");
assert_eq!(format!("{:#?}", token), concat!(
    "\"eyJhbGciOiJIUzI1NiJ9.",
    "eyJzdWIiOiJBbGlyaSIsImF1ZCI6Im15X2FwaSIsImlzcyI6ImF1dGhvcml0eSJ9.",
    "…\""
));
assert_eq!(format!("{:#5?}", token), concat!(
    "\"eyJhbGciOiJIUzI1NiJ9.",
    "eyJzdWIiOiJBbGlyaSIsImF1ZCI6Im15X2FwaSIsImlzcyI6ImF1dGhvcml0eSJ9.",
    "2N5y…\""
));
assert_eq!(format!("{:#9999?}", token), concat!(
    "\"eyJhbGciOiJIUzI1NiJ9.",
    "eyJzdWIiOiJBbGlyaSIsImF1ZCI6Im15X2FwaSIsImlzcyI6ImF1dGhvcml0eSJ9.",
    "2N5yyY2UjqlUKSSCpFVWzfixfBRTWahiN2PrUuiuxbE\""
));

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a JwtRef

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for Box<JwtRef>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for JwtRef

By default, this type holds potentially sensitive information. To prevent unintentional disclosure of this value, this type will not print out its contents without explicitly specifying the alternate format, i.e. {:#}. When specified in this form, it will print out the entire token by default. However, if it is preferable to elide some of the characters in the signature, then that can be modified by specify the quantity as a width in the format string, i.e. {:#10}.

If not specified, a placeholder value will be printed out instead to indicate that it is hiding sensitive information.

If, for any reason, the token does not contain a . character, then the limitations specified above will apply to the token as a whole.

Example

let token = JwtRef::from_str(concat!(
    "eyJhbGciOiJIUzI1NiJ9.",
    "eyJzdWIiOiJBbGlyaSIsImF1ZCI6Im15X2FwaSIsImlzcyI6ImF1dGhvcml0eSJ9.",
    "2N5yyY2UjqlUKSSCpFVWzfixfBRTWahiN2PrUuiuxbE"
));

assert_eq!(format!("{}", token), "***JWT***");
assert_eq!(format!("{:#}", token), concat!(
    "eyJhbGciOiJIUzI1NiJ9.",
    "eyJzdWIiOiJBbGlyaSIsImF1ZCI6Im15X2FwaSIsImlzcyI6ImF1dGhvcml0eSJ9.",
    "2N5yyY2UjqlUKSSCpFVWzfixfBRTWahiN2PrUuiuxbE"
));
assert_eq!(format!("{:#5}", token), concat!(
    "eyJhbGciOiJIUzI1NiJ9.",
    "eyJzdWIiOiJBbGlyaSIsImF1ZCI6Im15X2FwaSIsImlzcyI6ImF1dGhvcml0eSJ9.",
    "2N5y…"
));
assert_eq!(format!("{:#9999}", token), concat!(
    "eyJhbGciOiJIUzI1NiJ9.",
    "eyJzdWIiOiJBbGlyaSIsImF1ZCI6Im15X2FwaSIsImlzcyI6ImF1dGhvcml0eSJ9.",
    "2N5yyY2UjqlUKSSCpFVWzfixfBRTWahiN2PrUuiuxbE"
));

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

Formats the value using the given formatter.

impl<'a, 'b: 'a> From<&'a Cow<'b, JwtRef>> for &'a JwtRef

fn from(r: &'a Cow<'b, JwtRef>) -> &'a JwtRef

Converts to this type from the input type.

impl From<&JwtRef> for Arc<JwtRef>

fn from(r: &JwtRef) -> Self

Converts to this type from the input type.

impl<'a> From<&'a JwtRef> for Cow<'a, JwtRef>

fn from(r: &'a JwtRef) -> Self

Converts to this type from the input type.

impl From<&JwtRef> for Jwt

fn from(s: &JwtRef) -> Self

Converts to this type from the input type.

impl From<&JwtRef> for Rc<JwtRef>

fn from(r: &JwtRef) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for &'a JwtRef

fn from(s: &'a str) -> &'a JwtRef

Converts to this type from the input type.

impl From<Jwt> for Box<JwtRef>

fn from(r: Jwt) -> Self

Converts to this type from the input type.

impl Hash for JwtRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl PartialEq<&JwtRef> for Jwt

fn eq(&self, other: &&JwtRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<Jwt> for &JwtRef

fn eq(&self, other: &Jwt) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<Jwt> for JwtRef

fn eq(&self, other: &Jwt) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<JwtRef> for Jwt

fn eq(&self, other: &JwtRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for JwtRef

fn eq(&self, other: &JwtRef) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for JwtRef

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl ToOwned for JwtRef

type Owned = Jwt

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for JwtRef

impl StructuralPartialEq for JwtRef