Struct CliOAuth

pub struct CliOAuth { /* private fields */ }

The CLI OAuth helper.

Implementations

impl CliOAuth

pub fn builder() -> CliOAuthBuilder

Constructs a new builder struct for configuration.

pub fn redirect_url(&self) -> RedirectUrl

Generates the redirect URL that will sent in the authorization URL to the identity provider.

Pass the result of this method to oauth2::Client::set_redirect_uri while building the client.

pub async fn authorize<TE, TR, TT, TIR, RT, TRE>( &mut self, oauth_client: &Client<TE, TR, TT, TIR, RT, TRE>, ) -> Result<(), ServerError>

where TE: ErrorResponse + 'static, TR: TokenResponse<TT>, TT: TokenType, TIR: TokenIntrospectionResponse<TT>, RT: RevocableToken, TRE: ErrorResponse + 'static,

Initiates the Authorization Code flow.

The PKCE challenge and verifier are generated. The challenge is used in the authorization URL, and the verifier is saved for the validation step.

The user’s browser is then opened to the authorization URL, and the authorization code (code) and CSRF token (state) are extracted from the redirect request and recorded . These values will also be used in the validation step, and then returned to the caller for the token exchange.

pub fn validate(&mut self) -> Result<AuthContext, AuthError>

Validates the authorization code and CSRF token (state).

If validation is successful, then the code and PKCE verifier are returned to the caller in order to build the exchange code request.

This method must be called after CliOAuth::authorize completes successfully.

Trait Implementations

impl Debug for CliOAuth

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

Formats the value using the given formatter.