Struct Client

Source

pub struct Client<TE, TR, TIR, RT, TRE, HasAuthUrl = EndpointNotSet, HasDeviceAuthUrl = EndpointNotSet, HasIntrospectionUrl = EndpointNotSet, HasRevocationUrl = EndpointNotSet, HasTokenUrl = EndpointNotSet>where
    TE: ErrorResponse,
    TR: TokenResponse,
    TIR: TokenIntrospectionResponse,
    RT: RevocableToken,
    TRE: ErrorResponse,
    HasAuthUrl: EndpointState,
    HasDeviceAuthUrl: EndpointState,
    HasIntrospectionUrl: EndpointState,
    HasRevocationUrl: EndpointState,
    HasTokenUrl: EndpointState,
{ /* private fields */ }

Expand description

Stores the configuration for an OAuth2 client.

This type implements the Builder Pattern together with typestates to encode whether certain fields have been set that are prerequisites to certain authentication flows. For example, the authorization endpoint must be set via set_auth_uri() before authorize_url() can be called. Each endpoint has a corresponding generic type parameter (e.g., HasAuthUrl) used to statically enforce these dependencies. These generics are set automatically by the corresponding setter functions, and in most cases user code should not need to deal with them directly.

In addition to unconditional setters (e.g., set_auth_uri()), each endpoint has a corresponding conditional setter (e.g., set_auth_uri_option()) that sets a conditional typestate (EndpointMaybeSet). When the conditional typestate is set, endpoints can be used via fallible methods that return ConfigurationError::MissingUrl if an endpoint has not been set. This is useful in dynamic scenarios such as OpenID Connect Discovery, in which it cannot be determined until runtime whether an endpoint is configured.

§Error Types

To enable compile time verification that only the correct and complete set of errors for the Client function being invoked are exposed to the caller, the Client type is specialized on multiple implementations of the ErrorResponse trait. The exact ErrorResponse implementation returned varies by the RFC that the invoked Client function implements:

Generic type TE (aka Token Error) for errors defined by RFC 6749 OAuth 2.0 Authorization Framework.
Generic type TRE (aka Token Revocation Error) for errors defined by RFC 7009 OAuth 2.0 Token Revocation.

For example when revoking a token, error code unsupported_token_type (from RFC 7009) may be returned:

let res = client
    .revoke_token(AccessToken::new("some token".to_string()).into())
    .unwrap()
    .request(&http_client);

assert!(matches!(res, Err(
    RequestTokenError::ServerResponse(err)) if matches!(err.error(),
        RevocationErrorResponseType::UnsupportedTokenType)));

§Examples

See the crate root documentation for usage examples.

Struct ClientCopy item path

§Error Types

§Examples

Implementations§

impl<TE, TR, TIR, RT, TRE> Client<TE, TR, TIR, RT, TRE, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointNotSet>where TE: ErrorResponse + 'static, TR: TokenResponse, TIR: TokenIntrospectionResponse, RT: RevocableToken, TRE: ErrorResponse + 'static,

pub fn new(client_id: ClientId) -> Self

pub fn set_auth_type(self, auth_type: AuthType) -> Self

pub fn set_auth_uri( self, auth_url: AuthUrl, ) -> Client<TE, TR, TIR, RT, TRE, EndpointSet, HasDeviceAuthUrl, HasIntrospectionUrl, HasRevocationUrl, HasTokenUrl>

pub fn set_auth_uri_option( self, auth_url: Option<AuthUrl>, ) -> Client<TE, TR, TIR, RT, TRE, EndpointMaybeSet, HasDeviceAuthUrl, HasIntrospectionUrl, HasRevocationUrl, HasTokenUrl>

pub fn set_client_secret(self, client_secret: ClientSecret) -> Self

pub fn set_device_authorization_url( self, device_authorization_url: DeviceAuthorizationUrl, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, EndpointSet, HasIntrospectionUrl, HasRevocationUrl, HasTokenUrl>

pub fn set_device_authorization_url_option( self, device_authorization_url: Option<DeviceAuthorizationUrl>, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, EndpointMaybeSet, HasIntrospectionUrl, HasRevocationUrl, HasTokenUrl>

pub fn set_introspection_url( self, introspection_url: IntrospectionUrl, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, EndpointSet, HasRevocationUrl, HasTokenUrl>

pub fn set_introspection_url_option( self, introspection_url: Option<IntrospectionUrl>, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, EndpointMaybeSet, HasRevocationUrl, HasTokenUrl>

pub fn set_redirect_uri(self, redirect_url: RedirectUrl) -> Self

pub fn set_revocation_url( self, revocation_url: RevocationUrl, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, HasIntrospectionUrl, EndpointSet, HasTokenUrl>

pub fn set_revocation_url_option( self, revocation_url: Option<RevocationUrl>, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, HasIntrospectionUrl, EndpointMaybeSet, HasTokenUrl>

pub fn set_token_uri( self, token_url: TokenUrl, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, HasIntrospectionUrl, HasRevocationUrl, EndpointSet>

pub fn set_token_uri_option( self, token_url: Option<TokenUrl>, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, HasIntrospectionUrl, HasRevocationUrl, EndpointMaybeSet>

pub fn client_id(&self) -> &ClientId

pub fn auth_type(&self) -> &AuthType

pub fn redirect_uri(&self) -> Option<&RedirectUrl>

pub fn auth_uri(&self) -> &AuthUrl

pub fn authorize_url<S>(&self, state_fn: S) -> AuthorizationRequest<'_>where S: FnOnce() -> CsrfToken,

§Arguments

§Security Warning

pub fn auth_uri(&self) -> Option<&AuthUrl>

pub fn authorize_url<S>( &self, state_fn: S, ) -> Result<AuthorizationRequest<'_>, ConfigurationError>where S: FnOnce() -> CsrfToken,

§Arguments

§Security Warning

pub fn exchange_client_credentials( &self, ) -> ClientCredentialsTokenRequest<'_, TE, TR>

pub fn exchange_code( &self, code: AuthorizationCode, ) -> CodeTokenRequest<'_, TE, TR>

pub fn exchange_device_access_token<'a, EF>( &'a self, auth_response: &'a DeviceAuthorizationResponse<EF>, ) -> DeviceAccessTokenRequest<'a, 'static, TR, EF>where EF: ExtraDeviceAuthorizationFields,

pub fn exchange_password<'a>( &'a self, username: &'a ResourceOwnerUsername, password: &'a ResourceOwnerPassword, ) -> PasswordTokenRequest<'a, TE, TR>

pub fn exchange_refresh_token<'a>( &'a self, refresh_token: &'a RefreshToken, ) -> RefreshTokenRequest<'a, TE, TR>

pub fn token_uri(&self) -> &TokenUrl

pub fn exchange_client_credentials( &self, ) -> Result<ClientCredentialsTokenRequest<'_, TE, TR>, ConfigurationError>

pub fn exchange_code( &self, code: AuthorizationCode, ) -> Result<CodeTokenRequest<'_, TE, TR>, ConfigurationError>

pub fn exchange_device_access_token<'a, EF>( &'a self, auth_response: &'a DeviceAuthorizationResponse<EF>, ) -> Result<DeviceAccessTokenRequest<'a, 'static, TR, EF>, ConfigurationError>where EF: ExtraDeviceAuthorizationFields,

pub fn exchange_password<'a>( &'a self, username: &'a ResourceOwnerUsername, password: &'a ResourceOwnerPassword, ) -> Result<PasswordTokenRequest<'a, TE, TR>, ConfigurationError>

pub fn exchange_refresh_token<'a>( &'a self, refresh_token: &'a RefreshToken, ) -> Result<RefreshTokenRequest<'a, TE, TR>, ConfigurationError>

pub fn token_uri(&self) -> Option<&TokenUrl>

pub fn exchange_device_code(&self) -> DeviceAuthorizationRequest<'_, TE>

pub fn device_authorization_url(&self) -> &DeviceAuthorizationUrl

pub fn exchange_device_code( &self, ) -> Result<DeviceAuthorizationRequest<'_, TE>, ConfigurationError>

pub fn device_authorization_url(&self) -> Option<&DeviceAuthorizationUrl>

pub fn introspect<'a>( &'a self, token: &'a AccessToken, ) -> IntrospectionRequest<'a, TE, TIR>

pub fn introspection_url(&self) -> &IntrospectionUrl

pub fn introspect<'a>( &'a self, token: &'a AccessToken, ) -> Result<IntrospectionRequest<'a, TE, TIR>, ConfigurationError>

pub fn introspection_url(&self) -> Option<&IntrospectionUrl>

pub fn revoke_token( &self, token: RT, ) -> Result<RevocationRequest<'_, RT, TRE>, ConfigurationError>

pub fn revocation_url(&self) -> &RevocationUrl

pub fn revoke_token( &self, token: RT, ) -> Result<RevocationRequest<'_, RT, TRE>, ConfigurationError>

pub fn revocation_url(&self) -> Option<&RevocationUrl>

Trait Implementations§

fn clone( &self, ) -> Client<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, HasIntrospectionUrl, HasRevocationUrl, HasTokenUrl>

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

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

Auto Trait Implementations§

impl<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, HasIntrospectionUrl, HasRevocationUrl, HasTokenUrl> Freeze for Client<TE, TR, TIR, RT, TRE, HasAuthUrl, HasDeviceAuthUrl, HasIntrospectionUrl, HasRevocationUrl, HasTokenUrl>

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Same for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

Struct Client

impl<TE, TR, TIR, RT, TRE> Client<TE, TR, TIR, RT, TRE, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointNotSet, EndpointNotSet>
where TE: ErrorResponse + 'static, TR: TokenResponse, TIR: TokenIntrospectionResponse, RT: RevocableToken, TRE: ErrorResponse + 'static,

pub fn authorize_url<S>(&self, state_fn: S) -> AuthorizationRequest<'_>
where S: FnOnce() -> CsrfToken,

pub fn authorize_url<S>( &self, state_fn: S, ) -> Result<AuthorizationRequest<'_>, ConfigurationError>
where S: FnOnce() -> CsrfToken,

pub fn exchange_device_access_token<'a, EF>( &'a self, auth_response: &'a DeviceAuthorizationResponse<EF>, ) -> DeviceAccessTokenRequest<'a, 'static, TR, EF>
where EF: ExtraDeviceAuthorizationFields,

pub fn exchange_device_access_token<'a, EF>( &'a self, auth_response: &'a DeviceAuthorizationResponse<EF>, ) -> Result<DeviceAccessTokenRequest<'a, 'static, TR, EF>, ConfigurationError>
where EF: ExtraDeviceAuthorizationFields,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

impl<T> ErasedDestructor for T
where T: 'static,