Struct josekit::jwt::JwtContext

pub struct JwtContext { /* fields omitted */ }

Implementations

impl JwtContext

pub fn new() -> Self

pub fn is_acceptable_critical(&self, name: &str) -> bool

Test a critical header claim name is acceptable.

Arguments

• name - a critical header claim name

pub fn add_acceptable_critical(&mut self, name: &str)

Add a acceptable critical header claim name

Arguments

• name - a acceptable critical header claim name

pub fn remove_acceptable_critical(&mut self, name: &str)

Remove a acceptable critical header claim name

Arguments

• name - a acceptable critical header claim name

pub fn encode_unsecured(
    &self,
    payload: &JwtPayload,
    header: &JwsHeader
) -> Result<String, JoseError>

Return the string repsentation of the JWT with a “none” algorithm.

Arguments

• payload - The payload data.
• header - The JWT heaser claims.

pub fn encode_with_signer(
    &self,
    payload: &JwtPayload,
    header: &JwsHeader,
    signer: &dyn JwsSigner
) -> Result<String, JoseError>

Return the string repsentation of the JWT with the siginig algorithm.

Arguments

• payload - The payload data.
• header - The JWS heaser claims.
• signer - a signer object.

pub fn encode_with_encrypter(
    &self,
    payload: &JwtPayload,
    header: &JweHeader,
    encrypter: &dyn JweEncrypter
) -> Result<String, JoseError>

Return the string repsentation of the JWT with the encrypting algorithm.

Arguments

• payload - The payload data.
• header - The JWE heaser claims.
• encrypter - a encrypter object.

pub fn decode_header(
    &self,
    input: impl AsRef<[u8]>
) -> Result<Box<dyn JoseHeader>, JoseError>

Return the Jose header decoded from JWT.

Arguments

• input - a JWT string representation.

pub fn decode_unsecured(
    &self,
    input: impl AsRef<[u8]>
) -> Result<(JwtPayload, JwsHeader), JoseError>

Return the JWT object decoded with the “none” algorithm.

Arguments

• input - a JWT string representation.

pub fn decode_with_verifier(
    &self,
    input: impl AsRef<[u8]>,
    verifier: &dyn JwsVerifier
) -> Result<(JwtPayload, JwsHeader), JoseError>

Return the JWT object decoded by the selected verifier.

Arguments

• verifier - a verifier of the signing algorithm.
• input - a JWT string representation.

pub fn decode_with_verifier_selector<'a, F>(
    &self,
    input: impl AsRef<[u8]>,
    selector: F
) -> Result<(JwtPayload, JwsHeader), JoseError> where
    F: Fn(&JwsHeader) -> Result<Option<&'a dyn JwsVerifier>, JoseError>, 

Return the JWT object decoded with a selected verifying algorithm.

Arguments

• input - a JWT string representation.
• selector - a function for selecting the verifying algorithm.

pub fn decode_with_verifier_in_jwk_set<F>(
    &self,
    input: impl AsRef<[u8]>,
    jwk_set: &JwkSet,
    selector: F
) -> Result<(JwtPayload, JwsHeader), JoseError> where
    F: Fn(&Jwk) -> Result<Option<&dyn JwsVerifier>, JoseError>, 

Return the JWT object decoded by using a JWK set.

Arguments

• input - a JWT string representation.
• jwk_set - a JWK set.
• selector - a function for selecting the verifying algorithm.

pub fn decode_with_decrypter(
    &self,
    input: impl AsRef<[u8]>,
    decrypter: &dyn JweDecrypter
) -> Result<(JwtPayload, JweHeader), JoseError>

Return the JWT object decoded by the selected decrypter.

Arguments

• input - a JWT string representation.
• decrypter - a decrypter of the decrypting algorithm.

pub fn decode_with_decrypter_selector<'a, F>(
    &self,
    input: impl AsRef<[u8]>,
    selector: F
) -> Result<(JwtPayload, JweHeader), JoseError> where
    F: Fn(&JweHeader) -> Result<Option<&'a dyn JweDecrypter>, JoseError>, 

Return the JWT object decoded with a selected decrypting algorithm.

Arguments

• input - a JWT string representation.
• decrypter_selector - a function for selecting the decrypting algorithm.

pub fn decode_with_decrypter_in_jwk_set<F>(
    &self,
    input: impl AsRef<[u8]>,
    jwk_set: &JwkSet,
    selector: F
) -> Result<(JwtPayload, JweHeader), JoseError> where
    F: Fn(&Jwk) -> Result<Option<&dyn JweDecrypter>, JoseError>, 

Return the JWT object decoded by using a JWK set.

Arguments

• input - a JWT string representation.
• jwk_set - a JWK set.
• selector - a function for selecting the decrypting algorithm.

Trait Implementations

impl Clone for JwtContext

fn clone(&self) -> JwtContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JwtContext

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

Formats the value using the given formatter.

impl PartialEq<JwtContext> for JwtContext

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

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

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

This method tests for !=.

impl Eq for JwtContext

impl StructuralEq for JwtContext

impl StructuralPartialEq for JwtContext