Struct ProofKeyCodeExchange

pub struct ProofKeyCodeExchange {
    pub code_verifier: String,
    pub code_challenge: String,
    pub code_challenge_method: String,
}

Fields

code_verifier: String

Used to verify the the The code verifier is not included in the authorization URL. You can set the code verifier here and then use the From trait for [AuthorizationCodeCredential] which does use the code verifier.

code_challenge: String

Used to secure authorization code grants by using Proof Key for Code Exchange (PKCE). Required if code_challenge_method is included. For more information, see the PKCE RFC. This parameter is now recommended for all application types, both public and confidential clients, and required by the Microsoft identity platform for single page apps using the authorization code flow.

code_challenge_method: String

The method used to encode the code_verifier for the code_challenge parameter. This SHOULD be S256, but the spec allows the use of plain if the client can’t support SHA256.

If excluded, code_challenge is assumed to be plaintext if code_challenge is included. The Microsoft identity platform supports both plain and S256. For more information, see the PKCE RFC. This parameter is required for single page apps using the authorization code flow.

Implementations

impl ProofKeyCodeExchange

pub fn new<T>( code_verifier: T, code_challenge: T, code_challenge_method: T, ) -> Result<ProofKeyCodeExchange, AuthorizationFailure>

where T: AsRef<str>,

Trait Implementations

impl Clone for ProofKeyCodeExchange

fn clone(&self) -> ProofKeyCodeExchange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl GenPkce for ProofKeyCodeExchange

fn code_challenge_method() -> String

fn code_verifier() -> String

Known as code_verifier in proof key for code exchange Uses the Rust ring crypto library to generate a secure random 32-octet sequence that is base64 URL encoded (no padding)

fn code_challenge(code_verifier: &String) -> String

fn oneshot() -> Result<ProofKeyCodeExchange, AuthorizationFailure>

Generate a code challenge and code verifier for the authorization code grant flow using proof key for code exchange (PKCE) and SHA256.

impl Hash for ProofKeyCodeExchange

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

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ProofKeyCodeExchange

fn cmp(&self, other: &ProofKeyCodeExchange) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ProofKeyCodeExchange

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ProofKeyCodeExchange

fn partial_cmp(&self, other: &ProofKeyCodeExchange) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ProofKeyCodeExchange

impl StructuralPartialEq for ProofKeyCodeExchange