Struct oauth2::PkceCodeChallenge

pub struct PkceCodeChallenge { /* fields omitted */ }

Code Challenge used for PKCE protection via the code_challenge parameter.

Implementations

impl PkceCodeChallenge

pub fn new_random_sha256() -> (Self, PkceCodeVerifier)

Generate a new random, base64-encoded SHA-256 PKCE code.

pub fn new_random_sha256_len(num_bytes: u32) -> (Self, PkceCodeVerifier)

Generate a new random, base64-encoded SHA-256 PKCE challenge code and verifier.

Arguments

• num_bytes - Number of random bytes to generate, prior to base64-encoding. The value must be in the range 32 to 96 inclusive in order to generate a verifier with a suitable length.

Panics

This method panics if the resulting PKCE code verifier is not of a suitable length to comply with RFC 7636.

pub fn from_code_verifier_sha256(code_verifier: &PkceCodeVerifier) -> Self

Generate a SHA-256 PKCE code challenge from the supplied PKCE code verifier.

Panics

This method panics if the supplied PKCE code verifier is not of a suitable length to comply with RFC 7636.

pub fn new_random_plain() -> (Self, PkceCodeVerifier)

Generate a new random, base64-encoded PKCE code. Use is discouraged unless the endpoint does not support SHA-256.

Panics

This method panics if the supplied PKCE code verifier is not of a suitable length to comply with RFC 7636.

pub fn from_code_verifier_plain(code_verifier: &PkceCodeVerifier) -> Self

Generate a plain PKCE code challenge from the supplied PKCE code verifier. Use is discouraged unless the endpoint does not support SHA-256.

Panics

This method panics if the supplied PKCE code verifier is not of a suitable length to comply with RFC 7636.

pub fn as_str(&self) -> &str

Returns the PKCE code challenge as a string.

pub fn method(&self) -> &PkceCodeChallengeMethod

Returns the PKCE code challenge method as a string.

Trait Implementations

impl Clone for PkceCodeChallenge

fn clone(&self) -> PkceCodeChallenge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PkceCodeChallenge

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PkceCodeChallenge

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<PkceCodeChallenge> for PkceCodeChallenge

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

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

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

This method tests for !=.

impl Serialize for PkceCodeChallenge

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PkceCodeChallenge