Struct oauth2::PkceCodeVerifierS256

pub struct PkceCodeVerifierS256(_);

Code Verifier used for PKCE protection via the code_verifier parameter. The value must have a minimum length of 43 characters and a maximum length of 128 characters. Each character must be ASCII alphanumeric or one of the characters “-” / “.” / “_” / “~”.

Implementations

impl PkceCodeVerifierS256

pub fn new_random() -> Self

Generate a new random, base64-encoded code verifier.

pub fn new_random_len(num_bytes: u32) -> Self

Generate a new random, base64-encoded code 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.

pub fn code_challenge(&self) -> PkceCodeChallengeS256

Return the code challenge for the code verifier.

pub fn code_challenge_method() -> PkceCodeChallengeMethod

Return the code challenge method for this code verifier.

pub fn authorize_url_params(&self) -> Vec<(&'static str, String)>

Return the extension params used for authorize_url.

Trait Implementations

impl Clone for PkceCodeVerifierS256

fn clone(&self) -> PkceCodeVerifierS256

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PkceCodeVerifierS256

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PkceCodeVerifierS256

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<PkceCodeVerifierS256> for PkceCodeVerifierS256

fn eq(&self, other: &PkceCodeVerifierS256) -> 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 SecretNewType<String> for PkceCodeVerifierS256

fn new(s: String) -> Self

Create a new PkceCodeVerifierS256 to wrap the given String.

fn secret(&self) -> &String

Get the secret contained within this PkceCodeVerifierS256.

Security Warning

Leaking this value may compromise the security of the OAuth2 flow.

impl Serialize for PkceCodeVerifierS256

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 PkceCodeVerifierS256