Struct CodeVerifier 

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

A code_verifier: the value a client keeps and never sends until it redeems the authorization code.

Redaction

Renders as CodeVerifier(…) under Debug. It is a secret with the same lifetime and reach as the token it becomes, so it must not escape through a panic message or an assertion failure. Display is the deliberate exception, because a client has to put this in a code_verifier form field to redeem the code at all.

Implementations

impl CodeVerifier

pub fn new(value: impl Into<String>) -> Result<Self, PkceError>

Parse a verifier against RFC 7636 §4.1’s grammar.

Errors

PkceError::VerifierLength if it is shorter than 43 or longer than 128 characters; PkceError::VerifierCharset if it contains anything outside unreserved.

pub fn as_str(&self) -> &str

The verifier, as it goes in a code_verifier form field.

pub fn challenge(&self, method: ChallengeMethod) -> CodeChallenge

The challenge this verifier produces under method.

RFC 7636 §4.3. Plain returns the verifier unchanged; S256 returns BASE64URL-ENCODE(SHA256(ASCII(code_verifier))), unpadded, which is 43 characters and always inside the code_challenge grammar.

Trait Implementations

impl Clone for CodeVerifier

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodeVerifier

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

Formats the value using the given formatter.

impl Display for CodeVerifier

Implements fmt::Display for a CodeVerifier.

This is the one path that prints the secret in full, and it exists so a client can build a code_verifier field. Prefer as_str at any call site that is not literally serialising one into a token request.

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

Formats the value using the given formatter.

impl Eq for CodeVerifier

impl PartialEq for CodeVerifier

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodeVerifier