OIDC Class

Properties   Methods   Events   Config Settings   Errors  

The OIDC class provides an easy way to add OpenID Connect-based SSO to your application.

Syntax

class cloudsso.OIDC

Remarks

The OIDC class provides a simple way to authenticate users using OpenID Connect. The library makes it easy to add SSO support to web applications. Identity management is performed by OpenID Providers such as Microsoft, Google, Apple, GitHub, GitLab, Okta, or others.

An application that uses an OpenID Provider for authentication purposes is referred to as a Relying Party. When a user visits a website (Relying Party), they are directed to authenticate with the chosen OpenID Provider. Once authenticated, the user will give the OpenID Provider consent to use their account information to login to the Relying Party's service. The Relying Party will then be issued an ID Token by the OpenID Provider that will then be verified to confirm the identity of the user. This removes the need to manage and secure sensitive user information like passwords. Additionally, an OpenID Provider can also provide profile information about the user, further reducing the amount of information that needs to be stored.

Setup

Typically, the Relying Party will need to register their application with the OpenID Provider. This will give the OpenID Provider knowledge about the Relying Party. The exact information needed depends on the OpenID Provider that is being used, but typically this will include the redirect_uri to which users will be returned after authentication has been completed. Once registered, the OpenID Provider will also provide the Relying Party with some information. Typically the following values will be provided by the OpenID Provider:

• Client Id (Required)
• Client Secret (Optional)
• Discovery Document URL (Recommended)

Once the application has been registered, the Relying Party can begin authenticating users.

Discovery

To start, a Relying Party will need to get information about the OpenID Provider they are connecting to. OIDC uses discovery documents to provide information about an OpenID Provider to a Relying Party. The OpenID Provider should host their discovery document at the domain of the issuer with /.well-known/openid-configuration concatenated at the end. For example, if the issuer is https://example.com, the discovery document URL would be:

https://example.com/.well-known/openid-configuration

This document stores important information that is required to correctly make requests and validate responses from an OpenID Provider.

Usage: Getting the Discovery Document

The OIDC class simplifies requesting and parsing the discovery document. The request_discovery_doc method will make a request to the specified discovery document URL. It will retrieve the discovery document and parse the commonly used information from it, setting the properties in the discovery_doc_details property. For example:

oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); string issuer = oidc.DiscoveryDocDetails.Issuer;

This discovery document does change from time to time, but typically it can be cached to reduce the number of requests being made by the Relying Party. To save the discovery document for later, the discovery_doc_details_content property can be queried to get the raw JSON document. When the discovery document needs to be reloaded, the load_discovery_doc method can be used to reload the document. For example:

oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); string raw_document = oidc.DiscoveryDocDetails.Content; //Save raw_document for later oidc.LoadDiscoveryDoc(raw_document);

The following properties and methods handle requesting, loading, or parsing discovery documents:

• discovery_doc_details
• get_discovery_metadata
• load_discovery_doc
• request_discovery_doc

Signing Certificates

The discovery document also provides a URI for the JSON Web Key Set (JWKS) that will be used to verify ID Tokens (see below). Each JSON Web Key Set contains one or more public certificates (keys) that correspond to a private key that can be used when an OpenID provider signs an ID Token. These keys are often rotated periodically but can generally be cached to reduce the amount of requests being made by the Relying Party.

Usage: Requesting and Reloading Signing Certificates

The request_signer_certs method can be used to request the JWKS directly from the JWKS URI. This method will set the signer_jwks property which is automatically parsed to fill the signer_certs properties. If the signer_certs properties is empty and the class needs to verify the ID Token, the class will automatically make this request.

To reduce the number of requests made by the Relying Party, the load_signer_jwks method can be used to parse the signer_jwks again. This allows the Relying Party to cache the signer_jwks property and reuse it later, reducing the amount of times the JWKS is requested from the OpenID Provider. oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); oidc.RequestSignerCerts(); string raw_jwks = oidc.SignerJWKS; //Save or Cache for later. //Continue on with operations that need to verify an ID Token. //Sometime later with a new instance. oidc.SignerJWKS = raw_jwks; oidc.LoadSignerJWKS(); //Continue on with new operations that need to verify an ID Token.

Authentication

The exact flow that a Relying Party goes through to authenticate a user depends on how the Relying Party configures their requests. These flows are broken up into different Grant Types with the most common being the Authorization Code grant type.

For a Relying Party using the Authorization Code grant type, the user must be redirected to the OpenID Provider's Authorization URL. The OpenID Provider will first ask the user to authenticate themselves. Once the user is authenticated, the OpenID Provider will then request authorization from the user to allow the Relying Party to access specific information about their account. This information will then be used to authenticate the user to the Relying Party. Once authorization has been provided, the user will be redirected back to the Relying Party with an authorization code.

With the authorization code, the Relying Party can now make a request to the token URL. The token server requires the authorization_code, client_id, and optional client_secret to confirm that the Relying Party has obtained authorization from the authorization server. The token server will then return an access_token,id_token, and optional refresh_token. To finish authenticating the user to the web application, the Relying Party will then validate the ID Token (see below).

Getting Authorization

Usage: Getting the Authorization URL

The following example will assume that the Relying Party is using the ogtAuthorizationCode grant_type. This grant type sets the ResponseType to code, instructing the OpenID Provider to send the authorization code once authorization has been completed. First, the OIDC class needs to be configured with the information about the OpenID Provider (see Discovery above) and the specific information that has been provided or configured about the Relying Party. Once the class is configured, the get_authorization_url method can be used to get the URL to which the user should be directed in order to complete the authorization process. //OpenID Provider oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); //Relying Party oidc.GrantType = ogtAuthorizationCode; oidc.ClientId = "Relying Party ID"; oidc.ReturnURL = "https://relying_party.com/"; oidc.AuthorizationScope = "openid profile email"; string authorization_url = oidc.GetAuthorizationURL(); //Direct the user to the URL...

Authorization Response

Parse vs. Process

The parse_oidc_response and process_oidc_response methods are used to handle HTTP requests that contain an OIDC response from an OpenID Provider. Generally, unless additional considerations or control are needed, the process_oidc_response method should be used. process_oidc_response will parse the incoming response from the OpenID Provider and make any additional requests necessary to obtain the access tokens and ID Tokens, as well as perform any necessary validation. For example, if an authorization code is found in the request, it will automatically make a request to the token server and handle/validate the response.

The parse_oidc_response method will only parse the information from the request. If an ID Token is found in the request, it will be validated. No further actions are performed.

Usage: Handling a redirect from an OpenID Provider

The OIDC class provides the parse_oidc_response and process_oidc_response methods to make it simple to get the required information from a redirect.

If the current HTTP context is unavailable, for instance when the class is not used directly within a web application, the HTTP headers and body that contain the OIDC response can be supplied by setting the oidc_response_headers and oidc_response_body properties.

The rest of the examples in this section will assume that the parse_oidc_response method is being used. See the process_oidc_response method for more information.

Getting Tokens

When request_tokens is called, a request is made to the token server. The token server authenticates the requester (the Relying Party) using the information provided in the request. Then, the token server will return an access token, an ID Token, and an optional refresh token. The Relying Party then needs to verify the ID Token (see below).

Refresh Tokens

Refresh tokens allow Relying Parties to skip obtaining authorization again for users that have already provided it once. How refresh tokens work depends on the OpenID Provider, but when the refresh_token property is set before calling request_tokens, the request will be made without the authorization code and the refresh_token will be used instead.

Usage: Request Tokens

The request_tokens method is used in the following example to make a request to the token server after parse_oidc_response has been called. //Parse OIDC Response oidc.ParseOIDCResponse(); //Get OpenID Provider Settings oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); //Relying Party Settings oidc.GrantType = ogtAuthorizationCode; oidc.ClientId = "Relying Party ID"; oidc.ClientSecret = "Relying Party Secret Value"; oidc.ReturnURL = "https://relying_party.com/"; oidc.AuthorizationScope = "openid profile email"; try { oidc.RequestTokens(); } catch (OIDCException e) { //Error handling if there is an issue with the response. } string access_token = oidc.AccessToken; string id_token = oidc.IdTokenInfo.IdTokenContent; string refresh_token = oidc.RefreshToken;

Verifying ID Tokens

When a Relying Party receives an ID Token, it can verify the token to confirm the identity of the user that it represents. When the class receives an ID Token after calling parse_oidc_response, process_oidc_response, or request_tokens, it will automatically validate the ID Token.

The validation process checks the different JWT claims in the ID Token along with the signature using one of the keys from the JWKS provided by the OpenID Provider (see Signing Certificates). The following claims are used to validate the ID Token:

Usage: Validate and Parse an ID Token

In a case where an ID Token is provided directly to the class, the validate_id_token method can be used to validate it, and the parse_id_token method can be used to parse it. The following example will set up the class with the information needed to validate and parse the ID Token. //OpenID Provider oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); oidc.RequestSignerCerts(); //Relying Party oidc.ClientId = "Relying Party ID"; oidc.IdTokenInfo.IdTokenContent = "ID_TOKEN"; try { oidc.ValidateIdToken(); } catch (OIDCException e) { //If there is any validation issues. } //Parse the validated ID Token. oidc.ParseIdToken(); string issuer = oidc.IdTokenInfo.Issuer;

User Information

OpenID Providers give information about users through claims. These claims can be found in an ID Token or by calling the UserInfo endpoint to request the information directly.

When commonly used claims are parsed from an ID Token or the response from the UserInfo endpoint, the class will set the properties in the user_details property with the corresponding information. If there is a claim that is not found in the user_details property, the get_id_token_claim and the get_user_info_claim methods can be used to search for specific claims.

Usage: Request UserInfo

To make a request to the UserInfo endpoint, the class will need to have the access_token property set. Additionally, the discovery document can be used to get the UserInfo endpoint. The following code example assumes that the access_token has been set to a cached token from the current user session. oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); oidc.AccessToken = "ACCESS_TOKEN"; oidc.RequestUserInfo(); string email = oidc.UserDetails.Email; string custom_claim = oidc.GetUserInfoClaim("/json/custom_claim");

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

access_token Property

The access token received from an OpenID provider.

Syntax

def get_access_token() -> str: ...
def set_access_token(value: str) -> None: ...

access_token = property(get_access_token, set_access_token)

Default Value

""

Remarks

This property will be populated with an access token that was received from an OpenID provider. When set, the AccessTokenExp configuration setting will also be set with the expiration date of the access token. The access token allows for requests to be made to the discovery_doc_details_user_info_url to retrieve information about the authenticated user. Additionally, depending on the OpenID provider, it may be used to access other APIs that are supported by the OpenID provider depending on how authorization_scope was set when calling get_authorization_url.

Each access_token is specific to the user that authorized the OpenID provider to provide it to your application. An access_token cannot be shared between multiple users.

When an OpenID provider provides an access token depends on the ResponseType that was set when calling get_authorization_url. Typically, the ResponseType configuration setting is set when selecting a grant_type which is set to ogtAuthorizationCode by default. When ResponseType contains code (ogtAuthorizationCode and ogtHybrid), the access_token is provided by the discovery_doc_details_token_url. When ResponseType contains token (ogtAuthorizationCode and ogtHybrid), the access_token is provided by the discovery_doc_details_authorization_url.

authorization_scope Property

The authorization scope used during authorization.

Syntax

def get_authorization_scope() -> str: ...
def set_authorization_scope(value: str) -> None: ...

authorization_scope = property(get_authorization_scope, set_authorization_scope)

Default Value

"openid"

Remarks

This property specifies the authorization scopes sent in the authorization request. The value specified here must be a space-separated list of scopes. For instance, openid profile email. The openid scope must always be present. The default value is openid.

After calling process_oidc_response or parse_oidc_response, if the authorization server returned the scope parameter, this property will be updated to match.

Along with OpenID Connect scopes, some OpenID providers also support other OAuth 2.0 scopes for various APIs that are also hosted by the OpenID provider. These can often also be added alongside the OpenID scopes. For example, openid profile email offline_access Mail.ReadWrite would be an example of a valid authorization_scope when using Microsoft Entra as an OpenID provider.

See the OpenID provider's documentation for supported values.

authz_response_code Property

The error code from a recently parsed HTTP request.

Syntax

def get_authz_response_code() -> str: ...

authz_response_code = property(get_authz_response_code, None)

Default Value

""

Remarks

This property holds the most recent error response code from an HTTP request that contains the response to an authorization (Authz) attempt. This is set when parse_oidc_response or process_oidc_response is called and the error response parameter is present. A description (if provided) of the error code can be found in the authz_response_desc property. The AuthErrorURI configuration setting may also be set if the request provided a URL to a page that describes the error.

This property is read-only.

authz_response_desc Property

The error description from a recently parsed HTTP request.

Syntax

def get_authz_response_desc() -> str: ...

authz_response_desc = property(get_authz_response_desc, None)

Default Value

""

Remarks

This property holds the most recent error response description from an HTTP request that contains the response to an authorization (Authz) attempt. This is set when parse_oidc_response or process_oidc_response is called and the error_description response parameter is present. The code for this error can be found in the authz_response_code property.

This property is read-only.

client_id Property

The Id of the client assigned when registering the application.

Syntax

def get_client_id() -> str: ...
def set_client_id(value: str) -> None: ...

client_id = property(get_client_id, set_client_id)

Default Value

""

Remarks

This property holds the Id of the client that was assigned when initially registering the application with the OpenID provider. This is sometimes referred to as the application id or the relying party id. This property is used to build the authorization URL when calling get_authorization_url. It is also used when making a request to the token server when calling process_oidc_response and request_tokens. Additionally, it is used to verify the id_token_audiences property of an ID Token when calling the validate_id_token, process_oidc_response, and possibly request_tokens methods.

client_secret Property

The secret value for the client assigned when registering the application.

Syntax

def get_client_secret() -> str: ...
def set_client_secret(value: str) -> None: ...

client_secret = property(get_client_secret, set_client_secret)

Default Value

""

Remarks

This property holds the secret of the client that might have been assigned when initially registering the application with the OpenID provider. This property is optional depending on the OpenID provider. If provided, it will be used when making a request to the token server when calling request_tokens or process_oidc_response.

discovery_doc_details_authorization_url Property

The server authorization endpoint URL.

Syntax

def get_discovery_doc_details_authorization_url() -> str: ...

discovery_doc_details_authorization_url = property(get_discovery_doc_details_authorization_url, None)

Default Value

""

Remarks

The server authorization endpoint URL.

This setting corresponds to the authorization_endpoint parameter in the discovery document.

This property is read-only.

discovery_doc_details_claims_param_supported Property

Whether the claims request parameter is supported by the Open ID provider.

Syntax

def get_discovery_doc_details_claims_param_supported() -> bool: ...

discovery_doc_details_claims_param_supported = property(get_discovery_doc_details_claims_param_supported, None)

Default Value

FALSE

Remarks

Whether the claims request parameter is supported by the Open ID provider.

This setting corresponds to the claims_parameter_supported parameter in the discovery document.

This property is read-only.

discovery_doc_details_content Property

The raw discovery document JSON.

Syntax

def get_discovery_doc_details_content() -> str: ...

discovery_doc_details_content = property(get_discovery_doc_details_content, None)

Default Value

""

Remarks

The raw discovery document JSON.

This property is read-only.

discovery_doc_details_issuer Property

The issuer identifier of the OpenID provider.

Syntax

def get_discovery_doc_details_issuer() -> str: ...

discovery_doc_details_issuer = property(get_discovery_doc_details_issuer, None)

Default Value

""

Remarks

The issuer identifier of the OpenID provider. This value is the same as the iss claim returned in ID Tokens issued from this provider. The value is a URL with the https scheme with no query string or fragment component.

This setting corresponds to the issuer parameter in the discovery document.

This property is read-only.

discovery_doc_details_logout_url Property

The logout endpoint URL.

Syntax

def get_discovery_doc_details_logout_url() -> str: ...

discovery_doc_details_logout_url = property(get_discovery_doc_details_logout_url, None)

Default Value

""

Remarks

The logout endpoint URL.

This setting corresponds to the optional end_session_endpoint parameter that may be found in the discovery document. If a user is directed to this URL, they will be asked to log out of their account.

This property is read-only.

discovery_doc_details_registration_url Property

The dynamic client registration URL.

Syntax

def get_discovery_doc_details_registration_url() -> str: ...

discovery_doc_details_registration_url = property(get_discovery_doc_details_registration_url, None)

Default Value

""

Remarks

The dynamic client registration URL.

This setting corresponds to the registration_endpoint parameter in the discovery document.

This property is read-only.

discovery_doc_details_service_docs_url Property

The URL of the human-readable service documentation.

Syntax

def get_discovery_doc_details_service_docs_url() -> str: ...

discovery_doc_details_service_docs_url = property(get_discovery_doc_details_service_docs_url, None)

Default Value

""

Remarks

The URL of the human-readable service documentation. The information at this URL is intended for developers integrating with the OpenID provider and may contain useful information.

This setting corresponds to the service_documentation parameter in the discovery document.

This property is read-only.

discovery_doc_details_signer_cert_url Property

The URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider.

Syntax

def get_discovery_doc_details_signer_cert_url() -> str: ...

discovery_doc_details_signer_cert_url = property(get_discovery_doc_details_signer_cert_url, None)

Default Value

""

Remarks

The URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. The signer keys are automatically retrieved by the class when the ID Token signature verification is performed.

This setting corresponds to the jwks_uri parameter in the discovery document.

This property is read-only.

discovery_doc_details_supported_claims Property

A comma-separated list of claims that are supported by the OpenID provider.

Syntax

def get_discovery_doc_details_supported_claims() -> str: ...

discovery_doc_details_supported_claims = property(get_discovery_doc_details_supported_claims, None)

Default Value

""

Remarks

A comma-separated list of claims that are supported by the OpenID provider. For instance: aud,email,email_verified,exp,family_name,given_name,iat,iss,locale,name,picture,sub

This setting corresponds to the claims_supported parameter in the discovery document.

This property is read-only.

discovery_doc_details_supported_displays Property

A comma-separated list of display values that are supported by the OpenID provider.

Syntax

def get_discovery_doc_details_supported_displays() -> str: ...

discovery_doc_details_supported_displays = property(get_discovery_doc_details_supported_displays, None)

Default Value

""

Remarks

A comma-separated list of display values that are supported by the OpenID provider.

This setting corresponds to the display_values_supported parameter in the discovery document.

This property is read-only.

discovery_doc_details_supported_grant_types Property

A comma-separated list of grant types supported by the OpenID provider.

Syntax

def get_discovery_doc_details_supported_grant_types() -> str: ...

discovery_doc_details_supported_grant_types = property(get_discovery_doc_details_supported_grant_types, None)

Default Value

""

Remarks

A comma-separated list of grant types supported by the OpenID provider. If this value is not specified by the OpenID provider, it is specified that authorization_code and implicit are supported by the OpenID provider.

This setting corresponds to the grant_types_supported parameter in the discovery document.

This property is read-only.

discovery_doc_details_supported_response_types Property

A comma-separated list of response types supported by the OpenID provider.

Syntax

def get_discovery_doc_details_supported_response_types() -> str: ...

discovery_doc_details_supported_response_types = property(get_discovery_doc_details_supported_response_types, None)

Default Value

""

Remarks

A comma-separated list of response types supported by the OpenID provider. If this value is not specified by the OpenID provider, it is defined that the OpenID provider supports (at a minimum) the code, id_token, and token id_token values.

This setting corresponds to the response_types_supported parameter in the discovery document.

This property is read-only.

discovery_doc_details_supported_scopes Property

A comma-separated list of scopes that are supported by the OpenID provider.

Syntax

def get_discovery_doc_details_supported_scopes() -> str: ...

discovery_doc_details_supported_scopes = property(get_discovery_doc_details_supported_scopes, None)

Default Value

""

Remarks

A comma-separated list of scopes that are supported by the OpenID provider. For instance: openid,email,profile

This setting corresponds to the scopes_supported parameter in the discovery document.

This property is read-only.

discovery_doc_details_token_url Property

The token endpoint URL.

Syntax

def get_discovery_doc_details_token_url() -> str: ...

discovery_doc_details_token_url = property(get_discovery_doc_details_token_url, None)

Default Value

""

Remarks

The token endpoint URL.

This setting corresponds to the token_endpoint parameter in the discovery document.

This property is read-only.

discovery_doc_details_user_info_url Property

The user info endpoint URL.

Syntax

def get_discovery_doc_details_user_info_url() -> str: ...

discovery_doc_details_user_info_url = property(get_discovery_doc_details_user_info_url, None)

Default Value

""

Remarks

The user info endpoint URL.

This setting corresponds to the userinfo_endpoint parameter in the discovery document.

This property is read-only.

firewall_auto_detect Property

Whether to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

A password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

A username if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

follow_redirects Property

Determines what happens when the server issues a redirect.

Syntax

def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...

follow_redirects = property(get_follow_redirects, set_follow_redirects)

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new url for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new url is retrieved automatically only if the url_scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

grant_type Property

The grant type defining the authentication flow.

Syntax

def get_grant_type() -> int: ...
def set_grant_type(value: int) -> None: ...

grant_type = property(get_grant_type, set_grant_type)

Default Value

0

Remarks

This property defines the grant type used when performing authentication. The value specified here controls the authentication flow.

Possible values for grant_type are:

• 0 (Authorization Code - Default)
• 1 (Implicit)
• 2 (Hybrid)

When handled by the class using the parse_oidc_response and process_oidc_response methods, each grant type acts in the following manner by default.

When using 0 (Authorization Code Flow - Default), the AuthorizationCode configuration setting is set by the authorization server. When using process_oidc_response or calling the request_tokens method after parsing, the class will make a request to the token server and return the access_token and id_token_info properties. If provided, this grant type also supports the refresh_token property.

When using 1 (Implicit Flow), the access_token and id_token_info properties are set by the authorization server. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself.

When using 2 (Hybrid Flow), by default the AuthorizationCode configuration setting is set by the authorization server along with the id_token_info property (see Additional Notes). When using process_oidc_response or calling the request_tokens method after parsing, the class will make a request to the token server and set the access_token property and the id_token_info property if provided again. If provided, this grant type also supports the refresh_token property.

Additional Notes

The response_type request parameter is automatically set based on the value specified here. In some cases, multiple values are acceptable and a default value is chosen automatically. To explicitly specify a response_type value for the chosen grant type, set ResponseType after setting this property.

id_token_audiences Property

A comma-separated list of audiences for which the ID Token is intended.

Syntax

def get_id_token_audiences() -> str: ...

id_token_audiences = property(get_id_token_audiences, None)

Default Value

""

Remarks

A comma-separated list of audiences for which the ID Token is intended.

This property is read-only.

id_token_auth_time Property

The time when the end user authenticates with the authorization server.

Syntax

def get_id_token_auth_time() -> int: ...

id_token_auth_time = property(get_id_token_auth_time, None)

Default Value

0

Remarks

The time when the end user authenticates with the authorization server.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

This property is read-only.

id_token_exp_time Property

The time when the ID Token expires.

Syntax

def get_id_token_exp_time() -> int: ...

id_token_exp_time = property(get_id_token_exp_time, None)

Default Value

0

Remarks

The time when the ID Token expires.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

This property is read-only.

id_token_id_token_content Property

The raw value of the ID Token.

Syntax

def get_id_token_id_token_content() -> str: ...
def set_id_token_id_token_content(value: str) -> None: ...

id_token_id_token_content = property(get_id_token_id_token_content, set_id_token_id_token_content)

Default Value

""

Remarks

The raw value of the ID Token.

id_token_issued_time Property

The time when the authentication for this ID Token occurred.

Syntax

def get_id_token_issued_time() -> int: ...

id_token_issued_time = property(get_id_token_issued_time, None)

Default Value

0

Remarks

The time when the authentication for this ID Token occurred.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

This property is read-only.

id_token_issuer Property

The issuer, or authorization server, that constructed the ID Token.

Syntax

def get_id_token_issuer() -> str: ...

id_token_issuer = property(get_id_token_issuer, None)

Default Value

""

Remarks

The issuer, or authorization server, that constructed the ID Token.

This property is read-only.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

oidc_response_body Property

The HTTP body of an OIDC response.

Syntax

def get_oidc_response_body() -> str: ...
def set_oidc_response_body(value: str) -> None: ...

oidc_response_body = property(get_oidc_response_body, set_oidc_response_body)

Default Value

""

Remarks

This property specifies the HTTP body for an OIDC response. This can be set to directly provide the HTTP body of the OIDC response to be processed by the parse_oidc_response or process_oidc_response methods. This property is also populated with the HTTP body that is parsed from the HTTP context if used by the parse_oidc_response or process_oidc_response methods.

oidc_response_headers Property

The HTTP headers of an OIDC Response.

Syntax

def get_oidc_response_headers() -> str: ...
def set_oidc_response_headers(value: str) -> None: ...

oidc_response_headers = property(get_oidc_response_headers, set_oidc_response_headers)

Default Value

""

Remarks

This property specifies the HTTP headers for an OIDC Response. This can be set to directly provide the HTTP headers of the OIDC response to be processed by the parse_oidc_response or process_oidc_response methods. This property is also populated with the HTTP headers that are parsed from the HTTP context if used by the parse_oidc_response or process_oidc_response methods.

other_headers Property

Other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

param_count Property

The number of records in the Param arrays.

Syntax

def get_param_count() -> int: ...
def set_param_count(value: int) -> None: ...

param_count = property(get_param_count, set_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• param_name
• param_value

The array indices start at 0 and end at param_count - 1.

param_name Property

The name of the parameter to be used in the request or returned in the response.

Syntax

def get_param_name(param_index: int) -> str: ...
def set_param_name(param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the parameter to be used in the request or returned in the response.

The param_index parameter specifies the index of the item in the array. The size of the array is controlled by the param_count property.

param_value Property

The value of the parameter to be used in the request or returned in the response.

Syntax

def get_param_value(param_index: int) -> str: ...
def set_param_value(param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the parameter to be used in the request or returned in the response. When issuing a request, the class will URL encode the value specified here. Returned values will be automatically URL decoded.

The param_index parameter specifies the index of the item in the array. The size of the array is controlled by the param_count property.

proxy_auth_scheme Property

The type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

Whether to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

A password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

A username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

refresh_token Property

The refresh token received from or sent to the token server.

Syntax

def get_refresh_token() -> str: ...
def set_refresh_token(value: str) -> None: ...

refresh_token = property(get_refresh_token, set_refresh_token)

Default Value

""

Remarks

This property is set by the class when it receives a refresh token after the process_oidc_response or request_tokens methods make a request to an OpenID provider's token server.

Usage:

In cases where a user's session may last longer than the actual expiration period (see AccessTokenExp) for the user's access_token, the refresh_token can be used to "refresh" the session. "Refreshing" the session allows the application to get a new access token without needing to have the user re-authorize the application again. To have the class use a refresh_token, first the application will need to save the refresh token in a secure location. Refresh tokens are specific to the user, meaning each user will need to have their own refresh_token saved. Once the application needs a new access_token, it will just set this property before calling the request_tokens method.

Some OpenID providers will also return a newly issued ID Token when using a refresh_token to get a new access_token. Additionally, some OpenID providers will either provide a new refresh_token or reset the expiration date on the refresh_token that was used. See the OpenID provider's documentation for more specifics.

return_url Property

The URL where the user (browser) returns after authorization.

Syntax

def get_return_url() -> str: ...
def set_return_url(value: str) -> None: ...

return_url = property(get_return_url, set_return_url)

Default Value

""

Remarks

This property specifies the URL that is used by the authorization server to redirect the user after the user has finished the authorization process with the authorization server. This property corresponds to the redirect_uri query string parameter when get_authorization_url creates the authorization URL.

Typically, this is set to the part of the web server that is responsible for processing incoming HTTP requests using the process_oidc_response or parse_oidc_response methods.

signer_cert_count Property

The number of records in the SignerCert arrays.

Syntax

def get_signer_cert_count() -> int: ...

signer_cert_count = property(get_signer_cert_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• signer_cert_encoded

The array indices start at 0 and end at signer_cert_count - 1.

This property is read-only.

signer_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_signer_cert_encoded(signer_cert_index: int) -> bytes: ...

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The signer_cert_store and signer_cert_subject properties also may be used to specify a certificate.

When signer_cert_encoded is set, a search is initiated in the current signer_cert_store for the private key of the certificate. If the key is found, signer_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, signer_cert_subject is set to an empty string.

The signer_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the signer_cert_count property.

This property is read-only.

signer_jwks Property

The JSON Web Key Set provided by an OpenID provider.

Syntax

def get_signer_jwks() -> str: ...

signer_jwks = property(get_signer_jwks, None)

Default Value

""

Remarks

This property holds the JSON Web Key Set provided by the OpenID Provider that will be used for signing ID Tokens.

Typically, this is returned from the discovery_doc_details_signer_cert_url when the class makes a request to populate the signer_certs properties. The request_signer_certs method can be used to manually make a request to the discovery_doc_details_signer_cert_url; otherwise, the class will automatically make the request if the properties is not set and it needs the certificates to validate an ID Token.

This property can be saved/cached for later and used to reload the certificates by calling the load_signer_jwks method. This can be used to reduce how often the class makes requests to the discovery_doc_details_signer_cert_url server.

This property is read-only.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_provider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

state Property

An opaque value used to maintain state between the request and response.

Syntax

def get_state() -> str: ...
def set_state(value: str) -> None: ...

state = property(get_state, set_state)

Default Value

""

Remarks

This property optionally holds a string value which will be returned by the authorization server with the response.

Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes (for instance to prevent Cross-Site Request Forgery). The contents of this property are treated as an opaque value.

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

transferred_data Property

The contents of the last response from the server.

Syntax

def get_transferred_data() -> bytes: ...

transferred_data = property(get_transferred_data, None)

Default Value

""

Remarks

This property contains the contents of the last response from the server.

TransferredDataLimit controls the maximum amount of data accumulated in transferred_data (by default, there is no limit).

This property is read-only.

transferred_headers Property

The full set of headers as received from the server.

Syntax

def get_transferred_headers() -> str: ...

transferred_headers = property(get_transferred_headers, None)

Default Value

""

Remarks

This property returns the complete set of raw headers as received from the server.

The on_header event shows the individual headers as parsed by the class.

This property is read-only.

use_nonce Property

Whether the Nonce parameter is added.

Syntax

def get_use_nonce() -> bool: ...
def set_use_nonce(value: bool) -> None: ...

use_nonce = property(get_use_nonce, set_use_nonce)

Default Value

FALSE

Remarks

If this property is set to true, the nonce parameter will be added to the OIDC authorization request when get_authorization_url is called. In OpenID Connect, the nonce parameter is provided during the authorization request. Then, when the OpenID Provider issues an ID Token, they will include the nonce claim with the same value (similar to state).

If the Nonce configuration setting is not set before calling get_authorization_url the class will generate a new one and set the Nonce setting. The same nonce value will need to be supplied to the class before calling the process_oidc_response or validate_id_token methods. When the class validates an ID Token, it will check the Nonce configuration setting if a nonce claim is found. By default, the nonce claim is not required but setting this property to true will require the nonce claim to be present and match the Nonce configuration setting.

use_pkce Property

Whether Proof Key for Code Exchange (PKCE) should be used.

Syntax

def get_use_pkce() -> bool: ...
def set_use_pkce(value: bool) -> None: ...

use_pkce = property(get_use_pkce, set_use_pkce)

Default Value

FALSE

Remarks

If this property is specified, the class will use Proof Key for Code Exchange (PKCE) as defined by RFC 7636 when get_authorization_url is called. This applies when grant_type is set to the Authorization Code or Hybrid grant types. Typically, a new instance of the class will be used to process the request from the authorization server than the one used to create the request to the authorization server. To verify the request from the authorization server, the PKCEVerifier will need to be saved in a safe location. Then before handling the request from the authorization server, the PKCEVerifier should be set to the saved value.

user_details_addr_country Property

The country name portion of the user's address.

Syntax

def get_user_details_addr_country() -> str: ...

user_details_addr_country = property(get_user_details_addr_country, None)

Default Value

""

Remarks

The country name portion of the user's address.

This property is read-only.

user_details_addr_formatted Property

The full mailing address of the user, formatted for display or use on a mailing label.

Syntax

def get_user_details_addr_formatted() -> str: ...

user_details_addr_formatted = property(get_user_details_addr_formatted, None)

Default Value

""

Remarks

The full mailing address of the user, formatted for display or use on a mailing label. This value may contain multiple lines.

This property is read-only.

user_details_addr_locality Property

The city or locality portion of the user's address.

Syntax

def get_user_details_addr_locality() -> str: ...

user_details_addr_locality = property(get_user_details_addr_locality, None)

Default Value

""

Remarks

The city or locality portion of the user's address.

This property is read-only.

user_details_addr_postal_code Property

The zip code or postal code portion of the user's address.

Syntax

def get_user_details_addr_postal_code() -> str: ...

user_details_addr_postal_code = property(get_user_details_addr_postal_code, None)

Default Value

""

Remarks

The zip code or postal code portion of the user's address.

This property is read-only.

user_details_addr_region Property

The state, province, prefecture, or region portion of the user's address.

Syntax

def get_user_details_addr_region() -> str: ...

user_details_addr_region = property(get_user_details_addr_region, None)

Default Value

""

Remarks

The state, province, prefecture, or region portion of the user's address.

This property is read-only.

user_details_addr_street_addr Property

The street address portion of the user's address.

Syntax

def get_user_details_addr_street_addr() -> str: ...

user_details_addr_street_addr = property(get_user_details_addr_street_addr, None)

Default Value

""

Remarks

The street address portion of the user's address. This is the full street address which may include house number, street name, post office box, and multi-line extended street information. This value may contain multiple lines.

This property is read-only.

user_details_birthday Property

The user's birthday.

Syntax

def get_user_details_birthday() -> str: ...

user_details_birthday = property(get_user_details_birthday, None)

Default Value

""

Remarks

The user's birthday. The format of the value is YYYY-MM-DD or YYYY. The year may be 0000 to indicate that it was omitted.

This property is read-only.

user_details_email Property

The user's preferred email address.

Syntax

def get_user_details_email() -> str: ...

user_details_email = property(get_user_details_email, None)

Default Value

""

Remarks

The user's preferred email address.

This property is read-only.

user_details_email_verified Property

Whether the user's email address has been verified.

Syntax

def get_user_details_email_verified() -> bool: ...

user_details_email_verified = property(get_user_details_email_verified, None)

Default Value

FALSE

Remarks

Whether the user's email address has been verified. To be considered verified, the end-user must prove the email address was under the user's control at the time of verification.

This property is read-only.

user_details_first_name Property

The first name of the user.

Syntax

def get_user_details_first_name() -> str: ...

user_details_first_name = property(get_user_details_first_name, None)

Default Value

""

Remarks

The first name of the user. If multiple names are present, they are space-separated.

This property is read-only.

user_details_gender Property

The user's gender.

Syntax

def get_user_details_gender() -> str: ...

user_details_gender = property(get_user_details_gender, None)

Default Value

""

Remarks

The user's gender. Defined values are male and female, but other values may also be used.

This property is read-only.

user_details_last_name Property

The last name of the user.

Syntax

def get_user_details_last_name() -> str: ...

user_details_last_name = property(get_user_details_last_name, None)

Default Value

""

Remarks

The last name of the user. If multiple names are present, they are space-separated.

This property is read-only.

user_details_locale Property

The end user's locale.

Syntax

def get_user_details_locale() -> str: ...

user_details_locale = property(get_user_details_locale, None)

Default Value

""

Remarks

The end user's locale. This is represented as a BCP47 (RFC 5646) language tag. For instance, en-US or en_US.

This property is read-only.

user_details_middle_name Property

The middle name of the user.

Syntax

def get_user_details_middle_name() -> str: ...

user_details_middle_name = property(get_user_details_middle_name, None)

Default Value

""

Remarks

The middle name of the user. If multiple names are present, they are space-separated.

This property is read-only.

user_details_name Property

The user's full name in displayable form including all name parts.

Syntax

def get_user_details_name() -> str: ...

user_details_name = property(get_user_details_name, None)

Default Value

""

Remarks

The user's full name in displayable form including all name parts. This may include titles and suffixes.

This property is read-only.

user_details_nickname Property

The casual name of the user.

Syntax

def get_user_details_nickname() -> str: ...

user_details_nickname = property(get_user_details_nickname, None)

Default Value

""

Remarks

The casual name of the user. This may or may not be the same as user_details_first_name.

This property is read-only.

user_details_phone_number Property

The user's phone number.

Syntax

def get_user_details_phone_number() -> str: ...

user_details_phone_number = property(get_user_details_phone_number, None)

Default Value

""

Remarks

The user's phone number. This may be in E.164 format, for instance +1 (425) 555-1212. If an extension is present, it may be represented according to RFC 3966. For instance: +1 (604) 555-1234;ext=5678.

This property is read-only.

user_details_phone_number_verified Property

Whether the user's phone number has been verified.

Syntax

def get_user_details_phone_number_verified() -> bool: ...

user_details_phone_number_verified = property(get_user_details_phone_number_verified, None)

Default Value

FALSE

Remarks

Whether the user's phone number has been verified. To be considered verified, the end-user must prove the phone number was under the user's control at the time of verification.

This property is read-only.

user_details_picture_url Property

The URL of the user's profile picture.

Syntax

def get_user_details_picture_url() -> str: ...

user_details_picture_url = property(get_user_details_picture_url, None)

Default Value

""

Remarks

The URL of the user's profile picture.

This property is read-only.

user_details_preferred_username Property

The shorthand name by which the end-user wishes to be referred.

Syntax

def get_user_details_preferred_username() -> str: ...

user_details_preferred_username = property(get_user_details_preferred_username, None)

Default Value

""

Remarks

The shorthand name by which the end-user wishes to be referred.

This property is read-only.

user_details_profile_url Property

The URL of the user's profile page.

Syntax

def get_user_details_profile_url() -> str: ...

user_details_profile_url = property(get_user_details_profile_url, None)

Default Value

""

Remarks

The URL of the user's profile page.

This property is read-only.

user_details_subject Property

The subject of the user that is being represented.

Syntax

def get_user_details_subject() -> str: ...

user_details_subject = property(get_user_details_subject, None)

Default Value

""

Remarks

The subject of the user that is being represented. This property is set when parsed from an ID Token or after retrieving the user info. Typically this represents the user of the application.

This property is read-only.

user_details_updated_at Property

The time when the user's information was last updated.

Syntax

def get_user_details_updated_at() -> int: ...

user_details_updated_at = property(get_user_details_updated_at, None)

Default Value

0

Remarks

The time when the user's information was last updated.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

This property is read-only.

user_details_website Property

The URL of the user's website.

Syntax

def get_user_details_website() -> str: ...

user_details_website = property(get_user_details_website, None)

Default Value

""

Remarks

The URL of the user's website.

This property is read-only.

user_details_zone_info Property

The user's time zone.

Syntax

def get_user_details_zone_info() -> str: ...

user_details_zone_info = property(get_user_details_zone_info, None)

Default Value

""

Remarks

The user's time zone. For instance: America/Los_Angeles.

This property is read-only.

add_param Method

Adds a name-value pair to the query string parameters of the outgoing request.

Syntax

def add_param(param_name: str, param_value: str) -> None: ...

Remarks

This method can be used to add query string parameters to the requests being built by the get_authorization_url method.

For example, this can be used to set the ui_locales request parameter. This parameter allows you to provide language preferences to the authorization server for a more cohesive user experience. For example, the following informs the authorization server that the user would prefer French (Canada), French (General), and English (General), in that order.

oidc.AddParam("ui_locales", "fr-CA fr en");

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

get_authorization_url Method

Builds the URL for an OpenID provider's authorization server.

Syntax

def get_authorization_url() -> str: ...

Remarks

This method will build the authorization URL that should be used to direct the user to the OpenID provider's authorization server. Before calling this method, the class will need to be configured so that it has the needed information. The discovery document for the OpenID provider is used to provide the necessary information about the authorization server like the discovery_doc_details_authorization_url. If needed, the ServerAuthURL configuration setting can be used to override or manually provide the URL of the authorization server. The rest of the information needed can be provided through the following properties or configuration settings.

• authorization_scope (Required)
• client_id (Required)
• grant_type (Required)
• return_url (Required)
• use_pkce (Optional)
• Display (Optional)
• IDTokenHint (Optional)
• LoginHint (Optional)
• Prompt (Optional)
• ResponseType (Optional)

get_discovery_metadata Method

Gets a specific metadata value from the discovery document.

Syntax

def get_discovery_metadata(metadata_name: str) -> str: ...

Remarks

This method will search the current discovery document for a specific metadata value. This can take the metadata name or the JSON path. This works on documents that have been provided by both the load_discovery_doc and request_discovery_doc methods. For example, to get the authorization endpoint metadata field from the document, both of the following are valid:

Metadata Name oidc.GetDiscoveryMetadata("authorization_endpoint");

JSON Path oidc.GetDiscoveryMetadata("/json/authorization_endpoint");

get_id_token_claim Method

Gets a specific claim from the ID Token.

Syntax

def get_id_token_claim(claim_name: str) -> str: ...

Remarks

This method will search the current ID Token for a specific claim. This can take the claim name (defined by the specification) or a JSON path. For example, to get the audience claim from the ID Token, both of the following are valid:

Claim Name oidc.GetIdTokenClaim("aud");

JSON Path oidc.GetIdTokenClaim("/json/aud");

get_query_param Method

Gets a specific claim from the current HTTP request.

Syntax

def get_query_param(param_name: str) -> str: ...

Remarks

This method searches the current context (after process_oidc_response or parse_oidc_response is called) or the oidc_response_headers property for a specific query parameter and returns the value. For example, if the request that was recently processed by the class contains the state parameter, then the following code would return the value of the state returned from the authorization server.

oidc.ProcessHTTPRequest(); string state = oidc.GetQueryParam("state");

get_user_info_claim Method

Gets a specific claim from the UserInfo response.

Syntax

def get_user_info_claim(claim_name: str) -> str: ...

Remarks

This method will search the most recent response from the request_user_info method response for a specific claim. This can take the claim name (defined by the specification) or a JSON path. For example, to get the audience claim from the response, both of the following are valid:

Claim Name oidc.GetUserInfoClaim("aud");

JSON Path oidc.GetUserInfoClaim("/json/aud");

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

load_discovery_doc Method

Loads in a raw discovery document.

Syntax

def load_discovery_doc(document_data: str) -> None: ...

Remarks

This method loads a discovery document directly from the documentData parameter. Typically, this can be used to reload a discovery document that has been previously retrieved by the request_discovery_doc method.

load_signer_jwks Method

Loads in the signer JWKS directly from a raw JWKS blob.

Syntax

def load_signer_jwks(jwks_data: str) -> None: ...

Remarks

This method loads the JSON Web Keys Set (JWKS) provided through the jwksData parameter. Calling this method will set the signer_jwks property and populate the signer_certs properties without making a request to the discovery_doc_details_signer_cert_url endpoint. Typically, this will be used to reload a JWKS that we previously requested by the request_signer_certs method.

parse_id_token Method

Parses an ID Token.

Syntax

def parse_id_token() -> None: ...

Remarks

This method parses the current ID Token. If the method is able to successfully parse the ID Token, it will populate the id_token_info and user_details properties. Any uncommon or custom claims can be retrieved by calling the get_id_token_claim method. The ID Token can be populated directly by setting the id_token_id_token_content property or by calling the parse_oidc_response, process_oidc_response, or request_tokens methods. Typically, the class will automatically validate and parse an ID Token if it is found. The exception is if the parse_oidc_response method is called which will only set the id_token_id_token_content property. See validate_id_token for information on validating an ID Token.

parse_oidc_response Method

Parses the current OIDC Response without additional processing.

Syntax

def parse_oidc_response() -> None: ...

Remarks

This method parses the OIDC Response from the current HTTP request and, if applicable, parses the ID Token, authorization code, or error information from it, populating the id_token_id_token_content, AuthorizationCode, and authz_response_code properties respectively. Unlike the process_oidc_response method, this method will not do any additional processing. Typically, this method is used with others like request_signer_certs, validate_id_token, parse_id_token, and request_tokens.

The HTTP request is taken directly from the oidc_response_headers and oidc_response_body properties if set; otherwise, it will try to read the HTTP context. If this method is able to parse the HTTP request and headers from the HTTP Context, it will also set the oidc_response_headers and oidc_response_body properties.

process_oidc_response Method

Processes the current OIDC response.

Syntax

def process_oidc_response() -> None: ...

Remarks

This method parses the OIDC response out of the current HTTP request and processes the results. Depending on the grant_type and ResponseType settings when the request was created, the processing flow will change. Generally, this method is equivalent to calling the following methods:

• parse_oidc_response
• request_tokens
• request_signer_certs (if signer_certs is not set)
• validate_id_token
• parse_id_token

request_discovery_doc Method

Requests the OpenID Discovery Document.

Syntax

def request_discovery_doc(url: str) -> None: ...

Remarks

This method gets the OpenID Connect Discovery Document specified by the URL parameter and parses the response. The discovery document contains details about the OpenID Provider configuration including endpoint URLs, supported claims and response types, and more.

The discovery document URL is typically published by an OpenID Provider (OP) and must be known before calling this method. The format of the URL is standardized and typically takes the form:

https://www.youropenidserver.com/.well-known/openid-configuration

Call request_discovery_doc before calling get_authorization_url to populate the class properties with information required to request authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method, the discovery_doc_details property is populated. The discovery_doc_details_content property may be stored and reloaded using the load_discovery_doc method to avoid calling request_discovery_doc on subsequent authorization requests.

To access values not automatically parsed by the class, the get_discovery_metadata method can be used to query for a specific metadata entry.

request_signer_certs Method

Requests the signing certificates from the OpenID provider.

Syntax

def request_signer_certs() -> None: ...

Remarks

This method makes a request to the discovery_doc_details_signer_cert_url to get the current signer certificates for the OpenID provider. The OpenID provider will return a JSON Web Key Set (JWKS) that represents the set of signing certificates that might be used when signing ID Tokens. The class will automatically populate the signer_certs properties with the signer certificates parsed from the JWKS. Additionally, this method will set the signer_jwks property with the returned JWKS. The signer_jwks property can be saved for later and used with the load_signer_jwks method to avoid needing to use this method for subsequent requests.

request_tokens Method

Requests new tokens from the token server.

Syntax

def request_tokens() -> None: ...

Remarks

This method makes a request to the token server to exchange an AuthorizationCode or refresh_token for a set of tokens. The specific tokens returned depends on the grant type and OpenID provider, but they can be any combination of an access_token, ID Token (id_token_info), and refresh_token.

If an ID Token is returned, the class will automatically attempt to verify it using the values specified by the discovery_doc_details, client_id, and signer_certs properties. If verification is successful, it will then attempt to parse the ID Token. See validate_id_token and parse_id_token for more information.

The class will make the request to the discovery_doc_details_token_url property or the ServerTokenURL configuration setting if either has been set.

request_user_info Method

Requests the information of a user.

Syntax

def request_user_info() -> None: ...

Remarks

This method makes a request to get a specific user's info based on the current access_token. The request is made to the UserInfo endpoint which is defined by the discovery_doc_details_user_info_url property when parsed from a discovery document. The URL can also be provided directly to the class by setting the ServerUserInfoURL configuration setting.

When a valid response is returned from the UserInfo endpoint, the class will populate the properties in the user_details property. For uncommon or custom claims, the get_user_info_claim method can be used to get claims not covered by the user_details property.

reset Method

This method will reset the class.

Syntax

def reset() -> None: ...

Remarks

This method will reset the class's properties to their default values.

validate_id_token Method

Validates an ID Token.

Syntax

def validate_id_token() -> None: ...

Remarks

This method validates the current ID Token. The ID Token can be populated directly by setting the id_token_id_token_content property or by calling the parse_oidc_response, process_oidc_response, or request_tokens methods. Typically, the class will automatically validate and parse an ID Token if it is found. The exception is if the parse_oidc_response method is called which will only set the id_token_id_token_content property.

The method will first check the signature of the ID Token using the signer_certs properties which contains the corresponding public certificates of the certificates used to sign the original ID Token. If the signer_certs properties is not populated, then a request will be made to the discovery_doc_details_signer_cert_url property or the ServerSignerCertURL configuration setting if set. This is equivalent to calling the request_signer_certs method.

Then, the class will verify that the id_token_issuer property matches what is expected in the discovery_doc_details_issuer property. Next, the id_token_audiences will be checked to ensure that it matches the client_id property. The ExpectedIssuer and ExpectedAudience configuration settings can be used to override the typical expected values. The last check is to ensure that the id_token_issued_time and id_token_exp_time are valid based on the current time. Additionally, if the nbf (Not Before) claim is present, that will also be verified.

If verification fails, the class will throw an exception with the matching error code. If certain steps in the verification process should be skipped, the IdTokenVerificationFlags configuration setting can be used.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class OIDCErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class OIDC:
@property
def on_error() -> Callable[[OIDCErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[OIDCErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_log Event

Fired once for each log message.

Syntax

class OIDCLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class OIDC:
@property
def on_log() -> Callable[[OIDCLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[OIDCLogEventParams], None]) -> None: ...

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_redirect Event

Fired when a redirection is received from the server.

Syntax

class OIDCRedirectEventParams(object):
  @property
  def location() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class OIDC:
@property
def on_redirect() -> Callable[[OIDCRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[OIDCRedirectEventParams], None]) -> None: ...

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class OIDCSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class OIDC:
@property
def on_ssl_server_authentication() -> Callable[[OIDCSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[OIDCSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class OIDCSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class OIDC:
@property
def on_ssl_status() -> Callable[[OIDCSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[OIDCSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

OIDC Config Settings

OIDC Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

OIDC Errors

OIDC Errors

The class may also return one of the following error codes, which are inherited from other classes.