Struct openid_client::client::Client

pub struct Client { /* private fields */ }

Client instance

Implementations

impl Client

Implementation for Client Read Methods

pub async fn from_uri_async( registration_client_uri: &str, registration_access_token: Option<String>, jwks: Option<Jwks>, client_options: Option<ClientOptions>, issuer: Option<&Issuer>, interceptor: Option<RequestInterceptor>, is_fapi: bool ) -> Result<Self, OidcClientError>

Creates a client from the Client Read Endpoint

Creates a Client from the Client read endpoint.

• registration_client_uri - The client read endpoint
• registration_access_token - The access token to be sent with the request
• jwks - Private Jwks of the client
• client_options - The ClientOptions
• issuer - Issuer
• interceptor - RequestInterceptor
• is_fapi - Marks the client as FAPI client

Example:

    let _client = Client::from_uri_async(
        "https://auth.example.com/client/id",
        None,
        None,
        None,
        None,
        None,
        false
    )
    .await
    .unwrap();

Example: with all params

    let jwk = Jwk::generate_rsa_key(2048).unwrap();

    let jwks = Jwks::from(vec![jwk]);

    let client_options = ClientOptions {
        additional_authorized_parties: Some(vec!["authParty".to_string()]),
    };

   #[derive(Debug, Clone)]
   pub(crate) struct CustomInterceptor {
       pub some_header: String,
       pub some_header_value: String,
   }

   impl Interceptor for CustomInterceptor {
       fn intercept(&mut self, _req: &Request) -> RequestOptions {
           let mut headers: HeaderMap = HeaderMap::new();

           let header = HeaderName::from_bytes(self.some_header.as_bytes()).unwrap();
           let header_value = HeaderValue::from_bytes(self.some_header_value.as_bytes()).unwrap();

           headers.append(header, header_value);

           RequestOptions {
               headers,
               timeout: Duration::from_millis(5000),
               ..Default::default()
           }
       }

       fn clone_box(&self) -> Box<dyn Interceptor> {
           Box::new(CustomInterceptor {
               some_header: self.some_header.clone(),
               some_header_value: self.some_header_value.clone(),
           })
       }
   }

   let interceptor = CustomInterceptor {
       some_header: "foo".to_string(),
       some_header_value: "bar".to_string(),
   };

    let issuer = Issuer::discover_async("https://auth.example.com", Some(Box::new(interceptor)))
        .await
        .unwrap();

    let _client = Client::from_uri_async(
        "https://auth.example.com/client/id",
        Some("token".to_string()),
        Some(jwks),
        Some(client_options),
        Some(&issuer),
        Some(Box::new(interceptor)),
        false
    )
    .await
    .unwrap();

impl Client

Implementations for Dynamic Client Registration

pub async fn register_async( issuer: &Issuer, client_metadata: ClientMetadata, register_options: Option<ClientRegistrationOptions>, interceptor: Option<RequestInterceptor>, is_fapi: bool ) -> Result<Self, OidcClientError>

Dynamic Client Registration

Attempts a Dynamic Client Registration using the Issuer’s registration_endpoint

• issuer - The Issuer client should be registered to.
• client_metadata - The ClientMetadata to be sent using the registration request.
• register_options - ClientRegistrationOptions
• interceptor - RequestInterceptor
• is_fapi - Marks the client as FAPI client

Example:

    let issuer = Issuer::discover_async("https://auth.example.com", None)
        .await
        .unwrap();

    let metadata = ClientMetadata {
        client_id: Some("identifier".to_string()),
        ..ClientMetadata::default()
    };

    let _client = Client::register_async(&issuer, metadata, None, None, false)
        .await
        .unwrap();

Example: with all params

   #[derive(Debug, Clone)]
   pub(crate) struct CustomInterceptor {
       pub some_header: String,
       pub some_header_value: String,
   }

   impl Interceptor for CustomInterceptor {
       fn intercept(&mut self, _req: &Request) -> RequestOptions {
           let mut headers: HeaderMap = HeaderMap::new();

           let header = HeaderName::from_bytes(self.some_header.as_bytes()).unwrap();
           let header_value = HeaderValue::from_bytes(self.some_header_value.as_bytes()).unwrap();

           headers.append(header, header_value);

           RequestOptions {
               headers,
               timeout: Duration::from_millis(5000),
               ..Default::default()
           }
       }

       fn clone_box(&self) -> Box<dyn Interceptor> {
           Box::new(CustomInterceptor {
               some_header: self.some_header.clone(),
               some_header_value: self.some_header_value.clone(),
           })
       }
   }

   let interceptor1 = CustomInterceptor {
       some_header: "foo".to_string(),
       some_header_value: "bar".to_string(),
   };

    let interceptor2 = CustomInterceptor {
        some_header: "foo".to_string(),
        some_header_value: "bar".to_string(),
    };

    let issuer = Issuer::discover_async("https://auth.example.com", Some(Box::new(interceptor1)))
        .await
        .unwrap();

    let metadata = ClientMetadata {
        client_id: Some("identifier".to_string()),
        ..ClientMetadata::default()
    };

    let jwk = Jwk::generate_rsa_key(2048).unwrap();

    let registration_options = ClientRegistrationOptions {
        initial_access_token: Some("initial_access_token".to_string()),
        jwks: Some(Jwks::from(vec![jwk])),
        client_options: Default::default(),
    };

    let _client = Client::register_async(
        &issuer,
        metadata,
        Some(registration_options),
        Some(Box::new(interceptor2)),
        false
    )
    .await
    .unwrap();

pub fn metadata(&self) -> ClientMetadata

Get Client Metadata

Gets the ClientMetadata of the client/self

impl Client

Getter & Setter method implementations for Client

pub fn get_client_id(&self) -> String

Get client id

pub fn get_client_secret(&self) -> Option<String>

Get client secret

pub fn get_grant_types(&self) -> Vec<String>

Get grant types

pub fn get_registration_access_token(&self) -> Option<String>

Get registration access token

pub fn get_registration_client_uri(&self) -> Option<String>

Get registration client uri

pub fn get_client_id_issued_at(&self) -> Option<i64>

Get client id issued at. Epoch(seconds)

pub fn get_client_secret_expires_at(&self) -> Option<i64>

Get client secret exprires at. Epoch(seconds)

pub fn get_id_token_signed_response_alg(&self) -> String

Get id token signed response algorithm

pub fn get_response_types(&self) -> Vec<String>

Get response types. See crate::types::ClientMetadata.

pub fn get_token_endpoint_auth_method(&self) -> String

Get token endpoint authentication method. See crate::types::ClientMetadata.

pub fn get_token_endpoint_auth_signing_alg(&self) -> Option<String>

Get token endpoint authentication signing alg. See crate::types::ClientMetadata.

pub fn get_introspection_endpoint_auth_method(&self) -> Option<String>

Get introspection endpoint authentication method. See crate::types::ClientMetadata.

pub fn get_introspection_endpoint_auth_signing_alg(&self) -> Option<String>

Get introspection endpoint authentication signing alg. See crate::types::ClientMetadata.

pub fn get_revocation_endpoint_auth_method(&self) -> Option<String>

Get revocation endpoint authentication method. See crate::types::ClientMetadata.

pub fn get_revocation_endpoint_auth_signing_alg(&self) -> Option<String>

Get revocation endpoint authentication signing alg. See crate::types::ClientMetadata.

pub fn get_authorization_encrypted_response_alg(&self) -> Option<String>

Get authorization encrypted response alg

pub fn get_authorization_encrypted_response_enc(&self) -> Option<String>

Get authorization encrypted respnse enc

pub fn get_authorization_signed_response_alg(&self) -> Option<String>

Get authorization signed response alg

pub fn get_field(&self, key: &str) -> Option<&Value>

Gets a field from other_fields

pub fn get_redirect_uri(&self) -> Option<String>

Get redirect uri. See crate::types::ClientMetadata.

pub fn get_redirect_uris(&self) -> Option<Vec<String>>

Get redirect uris. See crate::types::ClientMetadata.

pub fn get_response_type(&self) -> Option<String>

Get response type

pub fn get_application_type(&self) -> Option<String>

Get application type

pub fn get_contacts(&self) -> Option<Vec<String>>

Get contacts

pub fn get_client_name(&self) -> Option<String>

Get client name

pub fn get_logo_uri(&self) -> Option<String>

Get logo uri

pub fn get_client_uri(&self) -> Option<String>

Get client uri

pub fn get_policy_uri(&self) -> Option<String>

Get policy uri

pub fn get_tos_uri(&self) -> Option<String>

Get tos uri

pub fn get_jwks_uri(&self) -> Option<String>

Get jwks uri

pub fn get_sector_identifier_uri(&self) -> Option<String>

Get sector identifier uri

pub fn get_subject_type(&self) -> Option<String>

Get subject type

pub fn get_id_token_encrypted_response_alg(&self) -> Option<String>

Get id token encrypted response algorithm

pub fn get_id_token_encrypted_response_enc(&self) -> Option<String>

Get id token encrypted response algorithm

pub fn get_userinfo_signed_response_alg(&self) -> Option<String>

Get userinfo signed response algorithm

pub fn get_userinfo_encrypted_response_alg(&self) -> Option<String>

Get userinfo encrypted response algorithm

pub fn get_userinfo_encrypted_response_enc(&self) -> Option<String>

Get userinfo encrypted response algorithm

pub fn get_request_object_signing_alg(&self) -> Option<String>

Get request object signing algorithm

pub fn get_request_object_encryption_alg(&self) -> Option<String>

Get request object encryption algorithm

pub fn get_request_object_encryption_enc(&self) -> Option<String>

Get request object encryption algorithm

pub fn get_default_max_age(&self) -> Option<u64>

Get default max age

pub fn get_require_auth_time(&self) -> Option<bool>

Get require auth time

pub fn get_default_acr_values(&self) -> Option<Vec<String>>

Get default acr values

pub fn get_initiate_login_uri(&self) -> Option<String>

Get initiate login uri

pub fn get_request_uris(&self) -> Option<String>

Get request uris

pub fn get_jwks(&self) -> Option<Jwks>

Get jwks

pub fn get_issuer(&self) -> Option<&Issuer>

Gets the issuer that the client was created with.

pub fn get_private_jwks(&self) -> Option<Jwks>

Gets the private jwks

pub fn get_client_options(&self) -> Option<ClientOptions>

Gets the client options the client was created with

pub fn set_request_interceptor(&mut self, interceptor: RequestInterceptor)

Sets a new RequestInterceptor on the client

impl Client

Implementation for Client

pub fn authorization_url( &self, params: AuthorizationParameters ) -> Result<Url, OidcClientError>

Authorization Url

Builds an authorization url with respect to the params

• params - AuthorizationParameters : Customize the authorization request

Example:

  let issuer_metadata = IssuerMetadata {
      issuer: "https://auth.example.com".to_string(),
      authorization_endpoint: Some("https://auth.example.com/auth".to_string()),
      ..Default::default()
  };

  let issuer = Issuer::new(issuer_metadata, None);

  let client_metadata = ClientMetadata {
      client_id: Some("identifier".to_string()),
      ..Default::default()
  };

  let client = issuer.client(client_metadata, None, None, None).unwrap();

  let url = client.authorization_url(AuthorizationParameters::default()).unwrap();

pub fn end_session_url( &self, params: EndSessionParameters ) -> Result<Url, OidcClientError>

End Session Url

Builds an endsession url with respect to the params

• params - EndSessionParameters : Customize the endsession url

Example:

  let issuer_metadata = IssuerMetadata {
      end_session_endpoint: Some("https://auth.example.com/end".to_string()),
      ..Default::default()
  };

  let issuer = Issuer::new(issuer_metadata, None);

  let client_metadata = ClientMetadata {
      client_id: Some("identifier".to_string()),
      ..Default::default()
  };

  let client = issuer.client(client_metadata, None, None, None).unwrap();

  let url = client.end_session_url(EndSessionParameters::default()).unwrap();

pub fn authorization_post( &self, params: AuthorizationParameters ) -> Result<String, OidcClientError>

Authorization Post

Builds an authorization post page with respect to the params

• params - AuthorizationParameters : Customize the authorization request

Example:

  let issuer_metadata = IssuerMetadata {
      authorization_endpoint: Some("https://auth.example.com/auth".to_string()),
      ..Default::default()
  };

  let issuer = Issuer::new(issuer_metadata, None);

  let client_metadata = ClientMetadata {
      client_id: Some("identifier".to_string()),
      ..Default::default()
  };

  let client = issuer.client(client_metadata, None, None, None).unwrap();

  let html = client.authorization_post(AuthorizationParameters::default()).unwrap();

pub async fn grant_async( &mut self, body: HashMap<String, Value>, params: AuthenticationPostParams ) -> Result<TokenSet, OidcClientError>

Token Grant

Performs a grant at the token_endpoint

• body - HashMap<String, Value> : Request body
• params - AuthenticationPostParams : Parameters for customizing auth request

Example:

  let issuer_metadata = IssuerMetadata {
      token_endpoint: Some("https://auth.example.com/token".to_string()),
      ..Default::default()
  };

  let issuer = Issuer::new(issuer_metadata, None);

  let client_metadata = ClientMetadata {
      client_id: Some("identifier".to_string()),
      ..Default::default()
  };

  let client = issuer.client(client_metadata, None, None, None).unwrap();

  let body: HashMap<String, Value> = HashMap::new();

  let token_set = client.grant(body, AuthenticationPostParams::default()).await.unwrap();

pub async fn oauth_callback_async( &mut self, redirect_uri: Option<String>, params: CallbackParams, checks: Option<OAuthCallbackChecks>, extras: Option<CallbackExtras> ) -> Result<TokenSet, OidcClientError>

OAuth Callback

Performs the callback for Authorization Server’s authorization response.

• redirect_uri - The redirect uri of the Client
• params - CallbackParams : Parameters recieved from the callback response
• checks - OAuthCallbackChecks : Checks to be performed against params
• extras - CallbackExtras : Extra details to be used for token grant

Example:

  let issuer_metadata = IssuerMetadata {
      issuer: Some("https://auth.example.com".to_string()),
      token_endpoint: Some("https://auth.example.com/token".to_string()),
      ..Default::default()
  };

  let issuer = Issuer::new(issuer_metadata, None);

  let client_metadata = ClientMetadata {
      client_id: Some("identifier".to_string()),
      client_secret: Some("secure".to_string()),
      ..Default::default()
  };

  let callback_params = CallbackParams {
      code: Some("code".to_string()),
      ..Default::default()
  };

  let checks = OAuthCallbackChecks {
      response_type: Some("code".to_string()),
      ..Default::default()
  };

  let token_set = client
      .oauth_callback_async(
          Some("https://rp.example.com/cb".to_string()),
          callback_params,
          Some(checks),
          None,
      )
      .await.unwrap();

pub fn set_skip_max_age_check(&mut self, max_age_check: bool)

When skip_max_age_check is set to true, Id token’s Max age wont be validated

pub fn set_skip_nonce_check(&mut self, nonce_check: bool)

When skip_nonce_check is set to true, Id token’s Nonce wont be validated

pub fn set_clock_skew_duration(&mut self, duration: Duration)

It is possible the RP or OP environment has a system clock skew, which can result in the error “JWT not active yet”.

pub async fn callback_async( &mut self, redirect_uri: Option<String>, params: CallbackParams, checks: Option<OpenIDCallbackChecks>, extras: Option<CallbackExtras> ) -> Result<TokenSet, OidcClientError>

Callback

Performs the callback for Authorization Server’s authorization response.

• redirect_uri - The redirect uri of the Client
• params - CallbackParams : Parameters recieved from the callback response
• checks - OpenIDCallbackChecks : Checks to be performed against params
• extras - CallbackExtras : Extra details to be used for token grant

Example:

  let issuer_metadata = IssuerMetadata {
      issuer: Some("https://auth.example.com".to_string()),
      token_endpoint: Some("https://auth.example.com/token".to_string()),
      ..Default::default()
  };

  let issuer = Issuer::new(issuer_metadata, None);

  let client_metadata = ClientMetadata {
      client_id: Some("identifier".to_string()),
      client_secret: Some("secure".to_string()),
      ..Default::default()
  };

  let callback_params = CallbackParams {
      code: Some("code".to_string()),
      ..Default::default()
  };

  let token_set = client
      .callback_async(
          Some("https://rp.example.com/cb".to_string()),
          callback_params,
          None,
          None,
      )
      .await.unwrap();

pub async fn introspect_async( &mut self, token: &str, token_type_hint: Option<String>, params: Option<IntrospectionParams> ) -> Result<Response, OidcClientError>

Introspect

Performs an introspection request at Issuer::introspection_endpoint

• token : The token to introspect
• token_type_hint : Type of the token passed in token. Usually access_token or refresh_token
• params: See IntrospectionParams

pub fn request_resource_async<'life0, 'life1, 'life_self, 'async_recursion>( &'life_self mut self, resource_url: &'life0 str, token: &'life1 str, token_type: Option<String>, retry: bool, params: RequestResourceParams ) -> Pin<Box<dyn Future<Output = Result<Response, OidcClientError>> + 'async_recursion>>where 'life0: 'async_recursion, 'life1: 'async_recursion, 'life_self: 'async_recursion,

Request Resource

Performs a request to fetch using the access token at resource_url.

• resource_url : Url of the resource server
• token : Token to authenticate the resource fetch request
• token_type : Type of the token. Eg: access_token
• retry : Whether to retry if the request failed or not
• params : See RequestResourceParams

pub fn callback_params( &self, incoming_url: Option<&Url>, incoming_body: Option<String> ) -> Result<CallbackParams, OidcClientError>

Callback Params

Tries to convert the Url or a body string to CallbackParams

• incoming_url : The full url of the request (Url). Use this param if the request is of the type GET
• incoming_body : Incoming body. Use this param if the request is of the type POST

Only one of the above parameter is parsed.

pub async fn refresh_async( &mut self, token_set: TokenSet, params: Option<RefreshTokenRequestParams> ) -> Result<TokenSet, OidcClientError>

Refresh Request

Performs a Token Refresh request at Issuer’s token_endpoint

• token_set : TokenSet with refresh token that will be used to perform the request
• params : See RefreshTokenRequestParams

pub async fn revoke_async( &mut self, token: String, hint: Option<String>, params: Option<RevokeRequestParams> ) -> Result<Response, OidcClientError>

Revoke Token

Performs a token revocation at Issuer’s revocation_endpoint

• token : The token to be revoked
• hint : Hint to which type of token is being revoked
• params : See RevokeRequestParams

pub async fn userinfo_async( &mut self, token_set: &TokenSet, options: UserinfoRequestParams ) -> Result<JwtPayload, OidcClientError>

Userinfo

Performs userinfo request at Issuer’s userinfo endpoint.

• token_set : TokenSet with access_token that will be used to perform the request
• options : See UserinfoRequestParams

pub async fn request_object_async( &mut self, request_object: Value ) -> Result<String, OidcClientError>

Request Object

Creates a request object for JAR

• request_object : A Value which should be an object

pub async fn pushed_authorization_request_async( &mut self, params: Option<AuthorizationParameters>, par_params: Option<PushedAuthorizationRequestParams> ) -> Result<Value, OidcClientError>

Pushed Authorization Request

Performs a PAR on the pushed_authorization_request_endpoint

• params : See AuthorizationParameters
• par_params : See PushedAuthorizationRequestParams

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.