# OIDCDesktop Class

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

## Syntax

```text
OIDCDesktop
```

## Remarks

The OIDCDesktop class provides a simple way to authenticate users using OpenID Connect, making it easy to add SSO support to desktop applications. Identity management can be performed by OpenID Providers such as Microsoft, Google, Apple, GitHub, GitLab, Okta, or others.

OpenID Connect is an extension of the OAuth 2.0 specification that adds user authentication (ID Tokens) along with the authorization received by the OAuth provider (access tokens). In OpenID Connect, the OpenID Provider is the third-party service that will handle the actual authentication of the user, similar to the authorization server in OAuth 2.0. On the other side, the application that wants authentication is called the Relying Party. In OAuth 2.0, this would be similar to the OAuth client. Like in OAuth, when the application needs to authenticate a user, it redirects the user to the OpenID Provider's authorization server. The authorization server will authenticate the user, get authorization from the user to allow the application access to their profile, then get redirect back to the application's web server for further processing.

For ease-of-use, the OIDCDesktop class will handle launching a web server for your application, removing the need for your application to parse and validate the response from the authorization server. In accordance with recommendations for desktop applications from the OAuth 2.0 specification and the OpenID Connect standard, the web server is hosted on a localhost instance.

Once the redirect has been processed, the application typically makes an additional request to the OpenID Provider's token server for an ID Token, access token, and refresh token.

## 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. The OIDC standard 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 class simplifies requesting and parsing the discovery document. The [RequestDiscoveryDoc](#requestdiscoverydoc-method-oidcdesktop-class) 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 fields in the [DiscoveryDocDetails](#discoverydocdetails-property-oidcdesktop-class) property. For example:

```text
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 [Content](#DiscoveryDocDetails_f_Content) field can be queried to get the raw JSON document. When the discovery document needs to be reloaded, the [LoadDiscoveryDoc](#loaddiscoverydoc-method-oidcdesktop-class) method can be used to reload the document. For example:

```text
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:

- [DiscoveryDocDetails](#discoverydocdetails-property-oidcdesktop-class)
- [GetDiscoveryMetadata](#getdiscoverymetadata-method-oidcdesktop-class)
- [LoadDiscoveryDoc](#loaddiscoverydoc-method-oidcdesktop-class)
- [RequestDiscoveryDoc](#requestdiscoverydoc-method-oidcdesktop-class)

### 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 [RequestSignerCerts](#requestsignercerts-method-oidcdesktop-class) method can be used to request the JWKS directly from the JWKS URI. This method will set the [SignerJWKS](#signerjwks-property-oidcdesktop-class) property which is automatically parsed to fill the [SignerCerts](#signercerts-property-oidcdesktop-class) collection. If the [SignerCerts](#signercerts-property-oidcdesktop-class) collection 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 [LoadSignerJWKS](#loadsignerjwks-method-oidcdesktop-class) method can be used to parse the [SignerJWKS](#signerjwks-property-oidcdesktop-class) again. This allows the Relying Party to cache the [SignerJWKS](#signerjwks-property-oidcdesktop-class) property and reuse it later, reducing the amount of times the JWKS is requested from the OpenID Provider.

```text
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.
```

## Authenticate a User

Once configured, the *OIDCDesktop* class can be used to authenticate a user. When ready, call [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) and the component will handle getting authorization, requesting token, and parsing/validating the ID token automatically.

The process starts by launching a browser window to the authorization URL generated by the class based on the discovery document. Typically, the OpenID provider's authorization server will ask the user to authenticate and then ask if they want to authorize the relying party (your application). If the user provides authorization (aka. consent) the authorization server will then redirect the user back to the relying party.

The class will start an embedded web server to listen for the redirect and automatically set the [ReturnURL](#returnurl-property-oidcdesktop-class) property so that the OpenID provider will know where to redirect the user. The [WebServerPort](#webserverport-property-oidcdesktop-class) and [WebServerSSLEnabled](#webserversslenabled-property-oidcdesktop-class) properties can be used to control where and how the web server is listening for the authorization response.

Once the user has been redirected, the web server will parse the information from the response, and then proceed depending on the [GrantType](#granttype-property-oidcdesktop-class). The ID token will parsed and validated once it is received. See [Verifying ID Tokens](#verifying-id-tokens) below for more information.

**Authorization Code**

The most commonly used grant type, the authorization code grant type returns an "authorization code" in the *code* parameter. By default, the internal web server will automatically parse the authorization code from the redirect, then use it in a secondary request to the token server along with the [ClientId](#clientid-property-oidcdesktop-class), [ClientSecret](#clientsecret-property-oidcdesktop-class) (optional), [AuthorizationScope](#authorizationscope-property-oidcdesktop-class), and [ReturnURL](#returnurl-property-oidcdesktop-class). The response from the token server will contain the ID Token, access token, and optional refresh token.

**Usage: Authorization Code**

```text
//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.AuthorizationScope = "openid profile email";

try {
  oidc.AuthenticateUser();
} catch (Exception e) {
  //Error handling if there is an issue authenticating the user.
}

string access_token = oidc.AccessToken;
string id_token = oidc.IdTokenInfo.IdTokenContent;
```

**Implicit**

The implicit grant type returns the ID Token and access token directly to the relying party from the authorization server rather than using the token server. It is largely considered deprecated due to security concerns, so the authorization code and hybrid grant types are highly recommended.

Since the response contains the tokens themselves, the values are too long for a typical query string. Instead, they are returned to the web server using URI fragments. Due to the limitation of URI fragments, the web server is unable to retrieve them directly. Instead, the page that the web server provides contains a JS script that will convert the parameters and send them to the back end for the web server.

Some OpenID providers support the *ResponseMode* parameter which allows for extensions of the OAuth protocol. One commonly supported response mode is the *form_post* mode. This will instead have the authorization make a form post to the web server, which removes the need for the secondary scripts, and is the recommended path when supported. See [ResponseMode](#ResponseMode) for more information.

**Hybrid**

This grant type uses concepts from both the implicit and authorization code grant types. Typically, this is used to provide the ID token in the authorization response along with an authorization code to retrieve an access token and refresh token. Similarly to the implicit grant type, URI fragments are used by default but some OpenID providers support the *form_post* extension.

**Refresh Tokens**

Refresh tokens allow Relying Parties to skip obtaining authorization again for users that have already provided it once. Refresh tokens are typically given during the authorization code and hybrid grant types after receiving the tokens from the token server. The exact specifics about how refresh tokens work depends on the OpenID Provider, but when the [RefreshToken](#refreshtoken-property-oidcdesktop-class) property is set before calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class), the request will be made without the authorization code and the [RefreshToken](#refreshtoken-property-oidcdesktop-class) will be used instead.

**Usage: Refresh Tokens**

```text
//Get OpenID Provider Settings
oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration");

oidc.RefreshToken = "REFRESH_TOKEN";

//Relying Party Settings
oidc.GrantType = ogtAuthorizationCode;
oidc.ClientId = "Relying Party ID";
oidc.ClientSecret = "Relying Party Secret Value";
oidc.AuthorizationScope = "openid profile email";

try {
  oidc.AuthenticateUser();
} catch (Exception e) {
  //Error handling if there is an issue authenticating the user.
}

string access_token = oidc.AccessToken;
string id_token = oidc.IdTokenInfo.IdTokenContent;
string refresh_token = oidc.RefreshToken; //Sometimes a new refresh token is provided
```

### 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. The class will automatically validate the ID Token after calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class).

 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](#signing-certificates)). The following claims are used to validate the ID Token:

|  |  |
| --- | --- |
| iss | The issuer claim, checked that it matches the issuer provided in the discovery document. |
| aud | The audience claim, checked that it matches the [ClientId](#clientid-property-oidcdesktop-class) for the Relying Party. |
| exp | The expiration claim, checked that the current time is before the specified value. |
| iat | The "issued at" claim, checked that it is present and not set to 1-1-1970 (Unix Epoch). |
| nbf | The "not before" claim, checked that the current time is after the specified value. |

**Usage: Validate and Parse an ID Token**

In a case where an ID Token is provided directly to the class, the [ValidateIdToken](#validateidtoken-method-oidcdesktop-class) method can be used to validate it, and the [ParseIdToken](#parseidtoken-method-oidcdesktop-class) 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.

```text
//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 (Exception 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 fields in the [UserDetails](#userdetails-property-oidcdesktop-class) property with the corresponding information. If there is a claim that is not found in the [UserDetails](#userdetails-property-oidcdesktop-class) property, the [GetIdTokenClaim](#getidtokenclaim-method-oidcdesktop-class) and the [GetUserInfoClaim](#getuserinfoclaim-method-oidcdesktop-class) 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 [AccessToken](#accesstoken-property-oidcdesktop-class) property set. Additionally, the discovery document can be used to get the UserInfo endpoint. The following code example assumes that the [AccessToken](#accesstoken-property-oidcdesktop-class) has been set to a cached token from the current user session.

```text
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.*

|  |  |
| --- | --- |
| [AccessToken](#accesstoken-property-oidcdesktop-class) | The access token received from an OpenID provider. |
| [AuthorizationScope](#authorizationscope-property-oidcdesktop-class) | The authorization scope used during authorization. |
| [AuthzResponseCode](#authzresponsecode-property-oidcdesktop-class) | The error code from a recent authorization attempt. |
| [AuthzResponseDesc](#authzresponsedesc-property-oidcdesktop-class) | The error description from a recent authorization attempt. |
| [ClientId](#clientid-property-oidcdesktop-class) | The Id of the client assigned when registering the application. |
| [ClientSecret](#clientsecret-property-oidcdesktop-class) | The secret value for the client assigned when registering the application. |
| [DiscoveryDocDetails](#discoverydocdetails-property-oidcdesktop-class) | Details about the OpenID provider's discovery document. |
| [Firewall](#firewall-property-oidcdesktop-class) | A set of properties related to firewall access. |
| [FollowRedirects](#followredirects-property-oidcdesktop-class) | Determines what happens when the server issues a redirect. |
| [GrantType](#granttype-property-oidcdesktop-class) | The grant type defining the authentication flow. |
| [IdTokenInfo](#idtokeninfo-property-oidcdesktop-class) | Information about the current ID Token. |
| [OtherHeaders](#otherheaders-property-oidcdesktop-class) | Other headers as determined by the user (optional). |
| [Params](#params-property-oidcdesktop-class) | The parameters to be included in the request to the authorization server or received in the response. |
| [Proxy](#proxy-property-oidcdesktop-class) | A set of properties related to proxy access. |
| [RefreshToken](#refreshtoken-property-oidcdesktop-class) | The refresh token received from or sent to the token server. |
| [ReturnURL](#returnurl-property-oidcdesktop-class) | The URL where the user (browser) returns after authorization. |
| [SignerCerts](#signercerts-property-oidcdesktop-class) | The signing certificates from an OpenID provider. |
| [SignerJWKS](#signerjwks-property-oidcdesktop-class) | The JSON Web Key Set provided by an OpenID provider. |
| [SSLAcceptServerCert](#sslacceptservercert-property-oidcdesktop-class) | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
| [SSLCert](#sslcert-property-oidcdesktop-class) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
| [SSLProvider](#sslprovider-property-oidcdesktop-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCert](#sslservercert-property-oidcdesktop-class) | The server certificate for the last established connection. |
| [State](#state-property-oidcdesktop-class) | An opaque value used to maintain state between the request and response. |
| [Timeout](#timeout-property-oidcdesktop-class) | The timeout for the class. |
| [UseNonce](#usenonce-property-oidcdesktop-class) | Whether the Nonce parameter is added. |
| [UsePKCE](#usepkce-property-oidcdesktop-class) | Whether Proof Key for Code Exchange (PKCE) should be used. |
| [UserDetails](#userdetails-property-oidcdesktop-class) | The claims about the user. |
| [WebServerPort](#webserverport-property-oidcdesktop-class) | The local port on which the embedded web server listens. |
| [WebServerSSLCert](#webserversslcert-property-oidcdesktop-class) | The certificate with the private key to use when a Secure Sockets Layer (SSL) is enabled. |
| [WebServerSSLEnabled](#webserversslenabled-property-oidcdesktop-class) | Whether the web server requires Secure Sockets Layer (SSL) connections. |

## Method List

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

|  |  |
| --- | --- |
| [AddParam](#addparam-method-oidcdesktop-class) | Adds a name-value pair to the query string parameters of the outgoing request. |
| [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) | Authenticates a user to the application. |
| [Config](#config-method-oidcdesktop-class) | Sets or retrieves a configuration setting. |
| [DoEvents](#doevents-method-oidcdesktop-class) | This method processes events from the internal message queue. |
| [GetDiscoveryMetadata](#getdiscoverymetadata-method-oidcdesktop-class) | Gets a specific metadata value from the discovery document. |
| [GetIdTokenClaim](#getidtokenclaim-method-oidcdesktop-class) | Gets a specific claim from the ID Token. |
| [GetQueryParam](#getqueryparam-method-oidcdesktop-class) | Gets a specific claim from the authorization response. |
| [GetUserInfoClaim](#getuserinfoclaim-method-oidcdesktop-class) | Gets a specific claim from the UserInfo response. |
| [Interrupt](#interrupt-method-oidcdesktop-class) | This method interrupts the current method. |
| [LoadDiscoveryDoc](#loaddiscoverydoc-method-oidcdesktop-class) | Loads in a raw discovery document. |
| [LoadSignerJWKS](#loadsignerjwks-method-oidcdesktop-class) | Loads in the signer JWKS directly from a raw JWKS blob. |
| [ParseIdToken](#parseidtoken-method-oidcdesktop-class) | Parses an ID Token. |
| [RequestDiscoveryDoc](#requestdiscoverydoc-method-oidcdesktop-class) | Requests the OpenID Discovery Document. |
| [RequestSignerCerts](#requestsignercerts-method-oidcdesktop-class) | Requests the signing certificates from the OpenID provider. |
| [RequestUserInfo](#requestuserinfo-method-oidcdesktop-class) | Requests the information of a user. |
| [Reset](#reset-method-oidcdesktop-class) | This method will reset the class. |
| [StartWebServer](#startwebserver-method-oidcdesktop-class) | Starts the embedded web server. |
| [StopWebServer](#stopwebserver-method-oidcdesktop-class) | Stops the embedded web server. |
| [ValidateIdToken](#validateidtoken-method-oidcdesktop-class) | Validates an ID Token. |

## 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.*

|  |  |
| --- | --- |
| [Error](#error-event-oidcdesktop-class) | Fired when information is available about errors during data delivery. |
| [LaunchBrowser](#launchbrowser-event-oidcdesktop-class) | Fires before launching a browser with the authorization URL. |
| [Log](#log-event-oidcdesktop-class) | Fired once for each log message. |
| [Redirect](#redirect-event-oidcdesktop-class) | Fired when a redirection is received from the server. |
| [SSLServerAuthentication](#sslserverauthentication-event-oidcdesktop-class) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-oidcdesktop-class) | Fired when secure connection progress messages are available. |

## Config Settings

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

|  |  |
| --- | --- |
| [AccessTokenExp](#AccessTokenExp) | The expiration date for the access token. |
| [AuthErrorURI](#AuthErrorURI) | The URI that provides more information about the authorization error. |
| [AuthorizationCode](#AuthorizationCode) | The authorization code to be exchanged with the token server. |
| [Display](#Display) | The requested display options to present to the end user. |
| [ExpectedAudience](#ExpectedAudience) | The expected audience when validating an ID Token. |
| [ExpectedIssuer](#ExpectedIssuer) | The expected Issuer when validating an ID Token. |
| [IDTokenHint](#IDTokenHint) | An ID Token value to be used as a hint about the user's session. |
| [IdTokenVerificationFlags](#IdTokenVerificationFlags) | The checks that are ignored when validating an ID Token. |
| [LoginHint](#LoginHint) | The login hint sent to the authorization server. |
| [Nonce](#Nonce) | The nonce value that is used to verify an ID Token. |
| [PKCEVerifier](#PKCEVerifier) | The PKCE verifier used to generate the challenge. |
| [Prompt](#Prompt) | The requested conditions under which the authorization server prompts for login. |
| [ResponseMode](#ResponseMode) | The value of the response_mode parameter. |
| [ResponseType](#ResponseType) | The value of the response_type request parameter. |
| [ServerAuthURL](#ServerAuthURL) | The URL of the authorization server. |
| [ServerSignerCertURL](#ServerSignerCertURL) | The URL of the signer certificate server. |
| [ServerTokenURL](#ServerTokenURL) | The URL of the token server. |
| [ServerUserInfoURL](#ServerUserInfoURL) | The URL of the UserInfo server. |
| [BrowserResponseTimeout](#BrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. |
| [WebServerFailedResponse](#WebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. |
| [WebServerHost](#WebServerHost) | The hostname used by the embedded web server. |
| [WebServerResponse](#WebServerResponse) | The custom response that is displayed to the user. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. |
| [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveRetryCount](#KeepAliveRetryCount) | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. |
| [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# AccessToken Property ([OIDCDesktop](#oidcdesktop-class) Class)

The access token received from an OpenID provider.

## Syntax

```text
ANSI (Cross Platform)
char* GetAccessToken();int SetAccessToken(const char* lpszAccessToken);

Unicode (Windows)
LPWSTR GetAccessToken();INT SetAccessToken(LPCWSTR lpszAccessToken);
```

## Default Value

""

## Remarks

After authenticating, this property will be populated with the access token from the OpenID provider. When set, the [AccessTokenExp](#AccessTokenExp) configuration setting will also be set with the expiration date of the access token. Once AccessToken is set, you can call [RequestUserInfo](#requestuserinfo-method-oidcdesktop-class) to retrieve information about the authenticated user. Additionally, depending on the OpenID provider and the [AuthorizationScope](#authorizationscope-property-oidcdesktop-class), it may be used to access other APIs that are supported by the OpenID provider.

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

## Data Type

String

# AuthorizationScope Property ([OIDCDesktop](#oidcdesktop-class) Class)

The authorization scope used during authorization.

## Syntax

```text
ANSI (Cross Platform)
char* GetAuthorizationScope();int SetAuthorizationScope(const char* lpszAuthorizationScope);

Unicode (Windows)
LPWSTR GetAuthorizationScope();INT SetAuthorizationScope(LPCWSTR lpszAuthorizationScope);
```

## 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 [AuthenticateUser](#authenticateuser-method-oidcdesktop-class), 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 AuthorizationScope when using Microsoft Entra as an OpenID provider.

See the OpenID provider's documentation for supported values.

## Data Type

String

# AuthzResponseCode Property ([OIDCDesktop](#oidcdesktop-class) Class)

The error code from a recent authorization attempt.

## Syntax

```text
ANSI (Cross Platform)
char* GetAuthzResponseCode();

Unicode (Windows)
LPWSTR GetAuthzResponseCode();
```

## Default Value

""

## Remarks

This property holds the most recent error response code from the most recent response to an authorization (Authz) attempt. This is set when [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) is called and the *error* response parameter is present in the authorization response. A description (if provided) of the error code can be found in the [AuthzResponseDesc](#authzresponsedesc-property-oidcdesktop-class) property. The [AuthErrorURI](#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.

## Data Type

String

# AuthzResponseDesc Property ([OIDCDesktop](#oidcdesktop-class) Class)

The error description from a recent authorization attempt.

## Syntax

```text
ANSI (Cross Platform)
char* GetAuthzResponseDesc();

Unicode (Windows)
LPWSTR GetAuthzResponseDesc();
```

## Default Value

""

## Remarks

This property holds the most recent error response description from the most recent response to an authorization (Authz) attempt. This is set when [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) is called and the *error_description* response parameter is present in the authorization response. The code for this error can be found in the [AuthzResponseCode](#authzresponsecode-property-oidcdesktop-class) property.

This property is read-only.

## Data Type

String

# ClientId Property ([OIDCDesktop](#oidcdesktop-class) Class)

The Id of the client assigned when registering the application.

## Syntax

```text
ANSI (Cross Platform)
char* GetClientId();int SetClientId(const char* lpszClientId);

Unicode (Windows)
LPWSTR GetClientId();INT SetClientId(LPCWSTR lpszClientId);
```

## Default Value

""

## Remarks

This property holds the Id of the relying party, also known as the client application, that was assigned when initially registering the application with the OpenID provider. This is also sometimes referred to as the *application id* or the *relying party id*. This property is used to build an make the requests made to the authorization and token servers when calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method. Additionally, it is used to verify the [Audiences](#IdTokenInfo_f_Audiences) field of an *ID Token* when calling the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) or [ValidateIdToken](#validateidtoken-method-oidcdesktop-class) methods.

## Data Type

String

# ClientSecret Property ([OIDCDesktop](#oidcdesktop-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetClientSecret();int SetClientSecret(const char* lpszClientSecret);

Unicode (Windows)
LPWSTR GetClientSecret();INT SetClientSecret(LPCWSTR lpszClientSecret);
```

## 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 [AuthenticateUser](#authenticateuser-method-oidcdesktop-class).

## Data Type

String

# DiscoveryDocDetails Property ([OIDCDesktop](#oidcdesktop-class) Class)

Details about the OpenID provider's discovery document.

## Syntax

```text
CloudSSODiscoveryDocDetails* GetDiscoveryDocDetails();
```

## Remarks

This property holds details parsed from the discovery document after [RequestDiscoveryDoc](#requestdiscoverydoc-method-oidcdesktop-class) or [LoadDiscoveryDoc](#loaddiscoverydoc-method-oidcdesktop-class) is called.

This property is read-only and not available at design time.

## Data Type

[CloudSSODiscoveryDocDetails](#discoverydocdetails-type)

# Firewall Property ([OIDCDesktop](#oidcdesktop-class) Class)

A set of properties related to firewall access.

## Syntax

```text
CloudSSOFirewall* GetFirewall();
int SetFirewall(CloudSSOFirewall* val);
```

## Remarks

This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect.

## Data Type

[CloudSSOFirewall](#firewall-type)

# FollowRedirects Property ([OIDCDesktop](#oidcdesktop-class) Class)

Determines what happens when the server issues a redirect.

## Syntax

```text
ANSI (Cross Platform)
int GetFollowRedirects();int SetFollowRedirects(int iFollowRedirects);

Unicode (Windows)
INT GetFollowRedirects();INT SetFollowRedirects(INT iFollowRedirects);
```

## Possible Values

```text
FR_NEVER(0), FR_ALWAYS(1), FR_SAME_SCHEME(2)
```

## 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 URLScheme 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 [Redirect](#redirect-event-oidcdesktop-class) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-oidcdesktop-class) 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.

## Data Type

Integer

# GrantType Property ([OIDCDesktop](#oidcdesktop-class) Class)

The grant type defining the authentication flow.

## Syntax

```text
ANSI (Cross Platform)
int GetGrantType();int SetGrantType(int iGrantType);

Unicode (Windows)
INT GetGrantType();INT SetGrantType(INT iGrantType);
```

## Possible Values

```text
OGT_AUTHORIZATION_CODE(0), OGT_IMPLICIT(1), OGT_HYBRID(2)
```

## 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 GrantType are:

- *ogtAuthorizationCode* (0)
- *ogtImplicit* (1)
- *ogtHybrid* (2)

When using the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method, each grant type causes the authorization server to respond differently.

When using *ogtAuthorizationCode* (Authorization Code Flow - Default), the authorization server returns a *code* parameter containing the authorization code which is set to the [AuthorizationCode](#AuthorizationCode) setting. The method will then automatically exchange the authorization code for the ID Token, access token, and refresh tokens with the token server.

When using *ogtImplicit* (Implicit Flow), the authorization server returns the *token* and *id_token* parameters. This provides the access token and ID token directly to the web 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 *ogtHybrid* (Hybrid Flow), the authorization server returns the *code* and *id_token* parameters. This flow is a combination of the authorization code and implicit grant types. Like the implicit grant type, the class will validate the ID Token immediately, then it will exchange the authorization code with the token server receiving an access token and possible ID Token.

**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](#ResponseType) after setting this property.

## Data Type

Integer

# IdTokenInfo Property ([OIDCDesktop](#oidcdesktop-class) Class)

Information about the current ID Token.

## Syntax

```text
CloudSSOIdTokenInfo* GetIdTokenInfo();
```

## Remarks

This property holds details about the ID Token.

When an ID Token is parsed either by calling [ParseIdToken](#parseidtoken-method-oidcdesktop-class) or retrieved after calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class), this property is populated with the claims that are specific to the ID Token.

This property is read-only and not available at design time.

## Data Type

[CloudSSOIdTokenInfo](#idtokeninfo-type)

# OtherHeaders Property ([OIDCDesktop](#oidcdesktop-class) Class)

Other headers as determined by the user (optional).

## Syntax

```text
ANSI (Cross Platform)
char* GetOtherHeaders();int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
```

## 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 ContentType 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.

This property is not available at design time.

## Data Type

String

# Params Property ([OIDCDesktop](#oidcdesktop-class) Class)

The parameters to be included in the request to the authorization server or received in the response.

## Syntax

```text
CloudSSOList<CloudSSOOAuthParam>* GetParams();
int SetParams(CloudSSOList<CloudSSOOAuthParam>* val);
```

## Remarks

This property is a collection of query string parameters to be added in the request when creating the authorization URL. This will also hold the parameters returned in the response.

This property is not available at design time.

## Data Type

[CloudSSOOAuthParam](#oauthparam-type)

# Proxy Property ([OIDCDesktop](#oidcdesktop-class) Class)

A set of properties related to proxy access.

## Syntax

```text
CloudSSOProxy* GetProxy();
int SetProxy(CloudSSOProxy* val);
```

## Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

## Data Type

[CloudSSOProxy](#proxy-type)

# RefreshToken Property ([OIDCDesktop](#oidcdesktop-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetRefreshToken();int SetRefreshToken(const char* lpszRefreshToken);

Unicode (Windows)
LPWSTR GetRefreshToken();INT SetRefreshToken(LPCWSTR lpszRefreshToken);
```

## Default Value

""

## Remarks

This property is set by the class when it receives a refresh token after the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method makes 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](#AccessTokenExp)) for the user's [AccessToken](#accesstoken-property-oidcdesktop-class), the RefreshToken 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 RefreshToken, 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 RefreshToken saved. Once the application needs a new [AccessToken](#accesstoken-property-oidcdesktop-class), it will just set this property before calling the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method.

Some OpenID providers will also return a newly issued ID Token when using a RefreshToken to get a new [AccessToken](#accesstoken-property-oidcdesktop-class). Additionally, some OpenID providers will either provide a new RefreshToken or reset the expiration date on the RefreshToken that was used. See the OpenID provider's documentation for more specifics.

## Data Type

String

# ReturnURL Property ([OIDCDesktop](#oidcdesktop-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetReturnURL();int SetReturnURL(const char* lpszReturnURL);

Unicode (Windows)
LPWSTR GetReturnURL();INT SetReturnURL(LPCWSTR lpszReturnURL);
```

## 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 [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) creates the authorization URL.

Typically, this is automatically set to the internal web server that is created by the component upon calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) or [StartWebServer](#startwebserver-method-oidcdesktop-class).

## Data Type

String

# SignerCerts Property ([OIDCDesktop](#oidcdesktop-class) Class)

The signing certificates from an OpenID provider.

## Syntax

```text
CloudSSOList<CloudSSOCertificate>* GetSignerCerts();
```

## Remarks

This property contains a list of certificates from the OpenID provider that are used for signing *ID Tokens*. This collection can be manually populated using the [RequestSignerCerts](#requestsignercerts-method-oidcdesktop-class) or [LoadSignerJWKS](#loadsignerjwks-method-oidcdesktop-class) methods.

The collection can be automatically populated when needed if it is empty and a *SignerCertURL* is available. This can happen when calling the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) or [ValidateIdToken](#validateidtoken-method-oidcdesktop-class) methods.

This property is read-only and not available at design time.

## Data Type

[CloudSSOCertificate](#certificate-type)

# SignerJWKS Property ([OIDCDesktop](#oidcdesktop-class) Class)

The JSON Web Key Set provided by an OpenID provider.

## Syntax

```text
ANSI (Cross Platform)
char* GetSignerJWKS();

Unicode (Windows)
LPWSTR GetSignerJWKS();
```

## 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 [SignerCertURL](#DiscoveryDocDetails_f_SignerCertURL) when the class makes a request to populate the [SignerCerts](#signercerts-property-oidcdesktop-class) collection. The [RequestSignerCerts](#requestsignercerts-method-oidcdesktop-class) method can be used to manually make a request to the [SignerCertURL](#DiscoveryDocDetails_f_SignerCertURL); otherwise, the class will automatically make the request if the collection 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 [LoadSignerJWKS](#loadsignerjwks-method-oidcdesktop-class) method. This can be used to reduce how often the class makes requests to the [SignerCertURL](#DiscoveryDocDetails_f_SignerCertURL) server.

This property is read-only.

## Data Type

String

# SSLAcceptServerCert Property ([OIDCDesktop](#oidcdesktop-class) Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

## Syntax

```text
CloudSSOCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudSSOCertificate* val);
```

## Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

NOTE: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

## Data Type

[CloudSSOCertificate](#certificate-type)

# SSLCert Property ([OIDCDesktop](#oidcdesktop-class) Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

## Syntax

```text
CloudSSOCertificate* GetSSLCert();
int SetSSLCert(CloudSSOCertificate* val);
```

## Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the store and subject fields.

## Data Type

[CloudSSOCertificate](#certificate-type)

# SSLProvider Property ([OIDCDesktop](#oidcdesktop-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetSSLProvider();int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();INT SetSSLProvider(INT iSSLProvider);
```

## Possible Values

```text
SSLP_AUTOMATIC(0), SSLP_PLATFORM(1), SSLP_INTERNAL(2)
```

## 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:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

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](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

## Data Type

Integer

# SSLServerCert Property ([OIDCDesktop](#oidcdesktop-class) Class)

The server certificate for the last established connection.

## Syntax

```text
CloudSSOCertificate* GetSSLServerCert();
```

## Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

## Data Type

[CloudSSOCertificate](#certificate-type)

# State Property ([OIDCDesktop](#oidcdesktop-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
char* GetState();int SetState(const char* lpszState);

Unicode (Windows)
LPWSTR GetState();INT SetState(LPCWSTR lpszState);
```

## 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.

## Data Type

String

# Timeout Property ([OIDCDesktop](#oidcdesktop-class) Class)

The timeout for the class.

## Syntax

```text
ANSI (Cross Platform)
int GetTimeout();int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();INT SetTimeout(INT iTimeout);
```

## 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 [DoEvents](#doevents-method-oidcdesktop-class) 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.

## Data Type

Integer

# UseNonce Property ([OIDCDesktop](#oidcdesktop-class) Class)

Whether the Nonce parameter is added.

## Syntax

```text
ANSI (Cross Platform)
int GetUseNonce();int SetUseNonce(int bUseNonce);

Unicode (Windows)
BOOL GetUseNonce();INT SetUseNonce(BOOL bUseNonce);
```

## Default Value

FALSE

## Remarks

If this property is set to true, the *nonce* parameter will be added to the OIDC authorization request when GetAuthorizationURL 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](#state-property-oidcdesktop-class)).

If the [Nonce](#Nonce) configuration setting is not set before calling GetAuthorizationURL the class will generate a new one and set the [Nonce](#Nonce) setting. The same nonce value will need to be supplied to the class before calling the ProcessOIDCResponse or [ValidateIdToken](#validateidtoken-method-oidcdesktop-class) methods. When the class validates an ID Token, it will check the [Nonce](#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](#Nonce) configuration setting.

## Data Type

Boolean

# UsePKCE Property ([OIDCDesktop](#oidcdesktop-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int GetUsePKCE();int SetUsePKCE(int bUsePKCE);

Unicode (Windows)
BOOL GetUsePKCE();INT SetUsePKCE(BOOL bUsePKCE);
```

## 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 [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) is called. This applies when [GrantType](#granttype-property-oidcdesktop-class) is set to the *Authorization Code* or *Hybrid* grant types. The PKCE verifier that is generated by the class will be set to the [PKCEVerifier](#PKCEVerifier) configuration setting.

## Data Type

Boolean

# UserDetails Property ([OIDCDesktop](#oidcdesktop-class) Class)

The claims about the user.

## Syntax

```text
CloudSSOUserDetails* GetUserDetails();
```

## Remarks

This property holds details about the user.

When an ID Token is parsed either by calling [ParseIdToken](#parseidtoken-method-oidcdesktop-class) or when it is retrieved after calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class), this property is populated with the claims from the ID Token.

When [RequestUserInfo](#requestuserinfo-method-oidcdesktop-class) is called, this property is populated from the returned claims.

This property is read-only and not available at design time.

## Data Type

[CloudSSOUserDetails](#userdetails-type)

# WebServerPort Property ([OIDCDesktop](#oidcdesktop-class) Class)

The local port on which the embedded web server listens.

## Syntax

```text
ANSI (Cross Platform)
int GetWebServerPort();int SetWebServerPort(int iWebServerPort);

Unicode (Windows)
INT GetWebServerPort();INT SetWebServerPort(INT iWebServerPort);
```

## Default Value

0

## Remarks

This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening. This is applicable only when using the embedded web server.

## Data Type

Integer

# WebServerSSLCert Property ([OIDCDesktop](#oidcdesktop-class) Class)

The certificate with the private key to use when a Secure Sockets Layer (SSL) is enabled.

## Syntax

```text
CloudSSOCertificate* GetWebServerSSLCert();
int SetWebServerSSLCert(CloudSSOCertificate* val);
```

## Remarks

This property specifies the certificate with the private key to use when the embedded web server is used. This setting is applicable only when [WebServerSSLEnabled](#webserversslenabled-property-oidcdesktop-class) is set to *True*.

## Data Type

[CloudSSOCertificate](#certificate-type)

# WebServerSSLEnabled Property ([OIDCDesktop](#oidcdesktop-class) Class)

Whether the web server requires Secure Sockets Layer (SSL) connections.

## Syntax

```text
ANSI (Cross Platform)
int GetWebServerSSLEnabled();int SetWebServerSSLEnabled(int bWebServerSSLEnabled);

Unicode (Windows)
BOOL GetWebServerSSLEnabled();INT SetWebServerSSLEnabled(BOOL bWebServerSSLEnabled);
```

## Default Value

FALSE

## Remarks

This setting specifies whether the embedded web server uses a Secure Sockets Layer (SSL). If set to *True*, [WebServerSSLCert](#webserversslcert-property-oidcdesktop-class) is required and the server will accept only SSL connections. If set to *False*, only plaintext connects are supported.

## Data Type

Boolean

# AddParam Method ([OIDCDesktop](#oidcdesktop-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int AddParam(const char* lpszParamName, const char* lpszParamValue);

Unicode (Windows)
INT AddParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue);
```

## Remarks

This method can be used to add query string parameters to the requests being made by the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) 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.

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# AuthenticateUser Method ([OIDCDesktop](#oidcdesktop-class) Class)

Authenticates a user to the application.

## Syntax

```text
ANSI (Cross Platform)
int AuthenticateUser();

Unicode (Windows)
INT AuthenticateUser();
```

## Remarks

This method will attempt to authenticate the current user using the settings from the following properties and fields:

- [AuthorizationScope](#authorizationscope-property-oidcdesktop-class)
- [ClientId](#clientid-property-oidcdesktop-class)
- [ClientSecret](#clientsecret-property-oidcdesktop-class)
- [DiscoveryDocDetails](#discoverydocdetails-property-oidcdesktop-class)
- [GrantType](#granttype-property-oidcdesktop-class)
- [RefreshToken](#refreshtoken-property-oidcdesktop-class)
- [ReturnURL](#returnurl-property-oidcdesktop-class)
- [UseNonce](#usenonce-property-oidcdesktop-class)
- [UsePKCE](#usepkce-property-oidcdesktop-class)

If a [RefreshToken](#refreshtoken-property-oidcdesktop-class) is not provided to the class, The method will first try to launch a web browser window that directs a user to the configured OpenID Provider's authorization page. See below for more information about refresh tokens. The user will then go through the authorization process with the OpenID Provider, and provide consent to allow the relying party (your application) access to their user information. Then, the OpenID provider will redirect the user back to the application.

At the same time that the user is directed to the authorization server, the class will also start an internal web server that will be listening for the user to get redirected back to it once the authorization process is complete. Once the user has been redirected, the web server will parse the information from the redirect. The exact information retrieved from this redirect depends on the grant type that is being used.

- *ogtAuthorizationCode* - *code*
- *ogtHybrid* - *code*, *id_token*
- *ogtImplicit* - *token*, *id_token*

The *code* parameter holds the authorization code that proves that the authorization process with the user completed successfully. If found by the web server, the class will use that to make a request to the token server, exchanging it for an ID Token, access token, and an optional refresh token.

The *id_token* and *token* parameters provide the ID Token and access token respectively. Unlike the *code* parameter, the tokens are provided directly to the web server without needing to make additional requests to the token server. However, the use of these parameters are often not recommended due to security concerns.

Whenever an ID Token is found by the class either through the response from the token server or from the *id_token* parameter, the class will automatically parse and validate the ID Token. See [ParseIdToken](#parseidtoken-method-oidcdesktop-class) and [ValidateIdToken](#validateidtoken-method-oidcdesktop-class) methods for more information.

If a [RefreshToken](#refreshtoken-property-oidcdesktop-class) is provided to the class, the method can get a new set of tokens without needing to have a user re-authorize the application. The refresh token is used instead of the authorization code to make the request to the token server. This is useful to improve the user experience by reducing the amount of times the user needs to interact with the OpenID Provider.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Config Method ([OIDCDesktop](#oidcdesktop-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-oidcdesktop-class) 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](#config-settings-oidcdesktop-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# DoEvents Method ([OIDCDesktop](#oidcdesktop-class) Class)

This method processes events from the internal message queue.

## Syntax

```text
ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# GetDiscoveryMetadata Method ([OIDCDesktop](#oidcdesktop-class) Class)

Gets a specific metadata value from the discovery document.

## Syntax

```text
ANSI (Cross Platform)
char* GetDiscoveryMetadata(const char* lpszmetadataName);

Unicode (Windows)
LPWSTR GetDiscoveryMetadata(LPCWSTR lpszmetadataName);
```

## 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 [LoadDiscoveryDoc](#loaddiscoverydoc-method-oidcdesktop-class) and [RequestDiscoveryDoc](#requestdiscoverydoc-method-oidcdesktop-class) methods. For example, to get the authorization endpoint metadata field from the document, both of the following are valid:

**Metadata Name**

```text
oidc.GetDiscoveryMetadata("authorization_endpoint");
```

**JSON Path**

```text
oidc.GetDiscoveryMetadata("/json/authorization_endpoint");
```

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# GetIdTokenClaim Method ([OIDCDesktop](#oidcdesktop-class) Class)

Gets a specific claim from the ID Token.

## Syntax

```text
ANSI (Cross Platform)
char* GetIdTokenClaim(const char* lpszclaimName);

Unicode (Windows)
LPWSTR GetIdTokenClaim(LPCWSTR lpszclaimName);
```

## 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**

```text
oidc.GetIdTokenClaim("aud");
```

**JSON Path**

```text
oidc.GetIdTokenClaim("/json/aud");
```

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# GetQueryParam Method ([OIDCDesktop](#oidcdesktop-class) Class)

Gets a specific claim from the authorization response.

## Syntax

```text
ANSI (Cross Platform)
char* GetQueryParam(const char* lpszparamName);

Unicode (Windows)
LPWSTR GetQueryParam(LPCWSTR lpszparamName);
```

## Remarks

This method searches the last response from the latest [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method call for a specific query parameter. 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.

```text
oidc.AuthenticateUser();

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

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# GetUserInfoClaim Method ([OIDCDesktop](#oidcdesktop-class) Class)

Gets a specific claim from the UserInfo response.

## Syntax

```text
ANSI (Cross Platform)
char* GetUserInfoClaim(const char* lpszclaimName);

Unicode (Windows)
LPWSTR GetUserInfoClaim(LPCWSTR lpszclaimName);
```

## Remarks

This method will search the most recent response from the [RequestUserInfo](#requestuserinfo-method-oidcdesktop-class) method 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**

```text
oidc.GetUserInfoClaim("aud");
```

**JSON Path**

```text
oidc.GetUserInfoClaim("/json/aud");
```

## Error Handling (C++)

This method returns a String value; after it returns, call the *GetLastErrorCode()* method to obtain its result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

# Interrupt Method ([OIDCDesktop](#oidcdesktop-class) Class)

This method interrupts the current method.

## Syntax

```text
ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# LoadDiscoveryDoc Method ([OIDCDesktop](#oidcdesktop-class) Class)

Loads in a raw discovery document.

## Syntax

```text
ANSI (Cross Platform)
int LoadDiscoveryDoc(const char* lpszdocumentData);

Unicode (Windows)
INT LoadDiscoveryDoc(LPCWSTR lpszdocumentData);
```

## 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 [RequestDiscoveryDoc](#requestdiscoverydoc-method-oidcdesktop-class) method.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# LoadSignerJWKS Method ([OIDCDesktop](#oidcdesktop-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
int LoadSignerJWKS(const char* lpszjwksData);

Unicode (Windows)
INT LoadSignerJWKS(LPCWSTR lpszjwksData);
```

## Remarks

This method loads the JSON Web Keys Set (JWKS) provided through the *jwksData* parameter. Calling this method will set the [SignerJWKS](#signerjwks-property-oidcdesktop-class) property and populate the [SignerCerts](#signercerts-property-oidcdesktop-class) collection without making a request to the [SignerCertURL](#DiscoveryDocDetails_f_SignerCertURL) endpoint. Typically, this will be used to reload a JWKS that we previously requested by the [RequestSignerCerts](#requestsignercerts-method-oidcdesktop-class) method.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ParseIdToken Method ([OIDCDesktop](#oidcdesktop-class) Class)

Parses an ID Token.

## Syntax

```text
ANSI (Cross Platform)
int ParseIdToken();

Unicode (Windows)
INT ParseIdToken();
```

## Remarks

This method parses the current ID Token. If the method is able to successfully parse the ID Token, it will populate the [IdTokenInfo](#idtokeninfo-property-oidcdesktop-class) and [UserDetails](#userdetails-property-oidcdesktop-class) properties. Any uncommon or custom claims can be retrieved by calling the [GetIdTokenClaim](#getidtokenclaim-method-oidcdesktop-class) method. The ID Token can be populated directly by setting the [IdTokenContent](#IdTokenInfo_f_IdTokenContent) field or by calling the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method. As a note, the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method will automatically parse and validate any ID Token's if they are found during the authorization or authentication process.

See [ValidateIdToken](#validateidtoken-method-oidcdesktop-class) for information on validating an ID Token.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RequestDiscoveryDoc Method ([OIDCDesktop](#oidcdesktop-class) Class)

Requests the OpenID Discovery Document.

## Syntax

```text
ANSI (Cross Platform)
int RequestDiscoveryDoc(const char* lpszURL);

Unicode (Windows)
INT RequestDiscoveryDoc(LPCWSTR lpszURL);
```

## 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 RequestDiscoveryDoc before calling GetAuthorizationURL 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 [DiscoveryDocDetails](#discoverydocdetails-property-oidcdesktop-class) property is populated. The [Content](#DiscoveryDocDetails_f_Content) field may be stored and reloaded using the [LoadDiscoveryDoc](#loaddiscoverydoc-method-oidcdesktop-class) method to avoid calling RequestDiscoveryDoc on subsequent authorization requests.

To access values not automatically parsed by the class, the [GetDiscoveryMetadata](#getdiscoverymetadata-method-oidcdesktop-class) method can be used to query for a specific metadata entry.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RequestSignerCerts Method ([OIDCDesktop](#oidcdesktop-class) Class)

Requests the signing certificates from the OpenID provider.

## Syntax

```text
ANSI (Cross Platform)
int RequestSignerCerts();

Unicode (Windows)
INT RequestSignerCerts();
```

## Remarks

This method makes a request to the [SignerCertURL](#DiscoveryDocDetails_f_SignerCertURL) 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 [SignerCerts](#signercerts-property-oidcdesktop-class) collection with the signer certificates parsed from the JWKS. Additionally, this method will set the [SignerJWKS](#signerjwks-property-oidcdesktop-class) property with the returned JWKS. The [SignerJWKS](#signerjwks-property-oidcdesktop-class) property can be saved for later and used with the [LoadSignerJWKS](#loadsignerjwks-method-oidcdesktop-class) method to avoid needing to use this method for subsequent requests.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# RequestUserInfo Method ([OIDCDesktop](#oidcdesktop-class) Class)

Requests the information of a user.

## Syntax

```text
ANSI (Cross Platform)
int RequestUserInfo();

Unicode (Windows)
INT RequestUserInfo();
```

## Remarks

This method makes a request to get a specific user's info based on the current [AccessToken](#accesstoken-property-oidcdesktop-class). The request is made to the UserInfo endpoint which is defined by the [UserInfoURL](#DiscoveryDocDetails_f_UserInfoURL) field when parsed from a discovery document. The URL can also be provided directly to the class by setting the [ServerUserInfoURL](#ServerUserInfoURL) configuration setting.

When a valid response is returned from the UserInfo endpoint, the class will populate the fields in the [UserDetails](#userdetails-property-oidcdesktop-class) property. For uncommon or custom claims, the [GetUserInfoClaim](#getuserinfoclaim-method-oidcdesktop-class) method can be used to get claims not covered by the [UserDetails](#userdetails-property-oidcdesktop-class) property.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Reset Method ([OIDCDesktop](#oidcdesktop-class) Class)

This method will reset the class.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
```

## Remarks

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

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# StartWebServer Method ([OIDCDesktop](#oidcdesktop-class) Class)

Starts the embedded web server.

## Syntax

```text
ANSI (Cross Platform)
int StartWebServer();

Unicode (Windows)
INT StartWebServer();
```

## Remarks

This method starts the embedded web server. This method can be used to manually start the embedded web server. Under normal circumstances, this is not needed as the component will automatically start and stop the web server when [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) is called. You may decide, however, to start the web server manually before calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class). When called, this method will also populate [ReturnURL](#returnurl-property-oidcdesktop-class) with the address of the embedded server.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# StopWebServer Method ([OIDCDesktop](#oidcdesktop-class) Class)

Stops the embedded web server.

## Syntax

```text
ANSI (Cross Platform)
int StopWebServer();

Unicode (Windows)
INT StopWebServer();
```

## Remarks

This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authorization process when [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) is called.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# ValidateIdToken Method ([OIDCDesktop](#oidcdesktop-class) Class)

Validates an ID Token.

## Syntax

```text
ANSI (Cross Platform)
int ValidateIdToken();

Unicode (Windows)
INT ValidateIdToken();
```

## Remarks

This method validates the current ID Token. Typically, the class will automatically validate and parse an ID Token if it is found during the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method, but the ID Token can also be populated directly by setting the [IdTokenContent](#IdTokenInfo_f_IdTokenContent) field. This can also be used to re-validate an ID Token if needed.

The method will first check the signature of the ID Token using the [SignerCerts](#signercerts-property-oidcdesktop-class) collection which contains the corresponding public certificates of the certificates used to sign the original ID Token. If the [SignerCerts](#signercerts-property-oidcdesktop-class) collection is not populated, then a request will be made to the [SignerCertURL](#DiscoveryDocDetails_f_SignerCertURL) field or the [ServerSignerCertURL](#ServerSignerCertURL) configuration setting if set. This is equivalent to calling the [RequestSignerCerts](#requestsignercerts-method-oidcdesktop-class) method.

Then, the class will verify that the [Issuer](#IdTokenInfo_f_Issuer) field matches what is expected in the [Issuer](#DiscoveryDocDetails_f_Issuer) field. Next, the [Audiences](#IdTokenInfo_f_Audiences) will be checked to ensure that it matches the [ClientId](#clientid-property-oidcdesktop-class) property. The [ExpectedIssuer](#ExpectedIssuer) and [ExpectedAudience](#ExpectedAudience) configuration settings can be used to override the typical expected values. The last check is to ensure that the [IssuedTime](#IdTokenInfo_f_IssuedTime) and [ExpTime](#IdTokenInfo_f_ExpTime) 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](#IdTokenVerificationFlags) configuration setting can be used.

## Error Handling (C++)

This method returns a result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the *GetLastErrorCode()* method after it returns.)

# Error Event ([OIDCDesktop](#oidcdesktop-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(OIDCDesktopErrorEventParams *e);
typedef struct {  int ErrorCode;  const char *Description;
  int reserved;
} OIDCDesktopErrorEventParams;

Unicode (Windows)
virtual INT FireError(OIDCDesktopErrorEventParams *e);
typedef struct {  INT ErrorCode;  LPCWSTR Description;
  INT reserved;
} OIDCDesktopErrorEventParams;
```

## Remarks

The 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](#trappable-errors-oidcdesktop-class) section.

# LaunchBrowser Event ([OIDCDesktop](#oidcdesktop-class) Class)

Fires before launching a browser with the authorization URL.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireLaunchBrowser(OIDCDesktopLaunchBrowserEventParams *e);
typedef struct {  char *URL;  char *Command;
  int reserved;
} OIDCDesktopLaunchBrowserEventParams;

Unicode (Windows)
virtual INT FireLaunchBrowser(OIDCDesktopLaunchBrowserEventParams *e);
typedef struct {  LPWSTR URL;  LPWSTR Command;
  INT reserved;
} OIDCDesktopLaunchBrowserEventParams;
```

## Remarks

When the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method is called, the class will fire this event with the *Command*, which will be executed by the class. The *URL* parameter will be the authorization URL that the user will be directed to authenticate.

Within this event, you may override the current value of either *Command* or *URL* and provide your own value. If *Command* is set to an empty string, the class will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter.

In Windows, ShellExecute is used to execute *Command*, which limits the verbs available for use in *Command* to:

- edit
- explore
- find
- open
- print

# Log Event ([OIDCDesktop](#oidcdesktop-class) Class)

Fired once for each log message.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireLog(OIDCDesktopLogEventParams *e);
typedef struct {  int LogLevel;  const char *Message;  const char *LogType;
  int reserved;
} OIDCDesktopLogEventParams;

Unicode (Windows)
virtual INT FireLog(OIDCDesktopLogEventParams *e);
typedef struct {  INT LogLevel;  LPCWSTR Message;  LPCWSTR LogType;
  INT reserved;
} OIDCDesktopLogEventParams;
```

## Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

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

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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"

# Redirect Event ([OIDCDesktop](#oidcdesktop-class) Class)

Fired when a redirection is received from the server.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRedirect(OIDCDesktopRedirectEventParams *e);
typedef struct {  const char *Location;  int Accept;
  int reserved;
} OIDCDesktopRedirectEventParams;

Unicode (Windows)
virtual INT FireRedirect(OIDCDesktopRedirectEventParams *e);
typedef struct {  LPCWSTR Location;  BOOL Accept;
  INT reserved;
} OIDCDesktopRedirectEventParams;
```

## 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 [FollowRedirects](#followredirects-property-oidcdesktop-class) property.

# SSLServerAuthentication Event ([OIDCDesktop](#oidcdesktop-class) Class)

Fired after the server presents its certificate to the client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(OIDCDesktopSSLServerAuthenticationEventParams *e);
typedef struct {  const char *CertEncoded;
  int lenCertEncoded;  const char *CertSubject;  const char *CertIssuer;  const char *Status;  int Accept;
  int reserved;
} OIDCDesktopSSLServerAuthenticationEventParams;

Unicode (Windows)
virtual INT FireSSLServerAuthentication(OIDCDesktopSSLServerAuthenticationEventParams *e);
typedef struct {  LPCSTR CertEncoded;
  INT lenCertEncoded;  LPCWSTR CertSubject;  LPCWSTR CertIssuer;  LPCWSTR Status;  BOOL Accept;
  INT reserved;
} OIDCDesktopSSLServerAuthenticationEventParams;
```

## 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.

# SSLStatus Event ([OIDCDesktop](#oidcdesktop-class) Class)

Fired when secure connection progress messages are available.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireSSLStatus(OIDCDesktopSSLStatusEventParams *e);
typedef struct {  const char *Message;
  int reserved;
} OIDCDesktopSSLStatusEventParams;

Unicode (Windows)
virtual INT FireSSLStatus(OIDCDesktopSSLStatusEventParams *e);
typedef struct {  LPCWSTR Message;
  INT reserved;
} OIDCDesktopSSLStatusEventParams;
```

## Remarks

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

# Certificate Type

This is the digital certificate being used.

## Syntax

 *CloudSSOCertificate* (declared in *cloudsso.h*)

## Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *char* (read-only)*
*Default Value: ""*

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.

 **ExpirationDate** *char* (read-only)*
*Default Value: ""*

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.

 **ExtendedKeyUsage** *char* (read-only)*
*Default Value: ""*

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

 **Fingerprint** *char* (read-only)*
*Default Value: ""*

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*

 **FingerprintSHA1** *char* (read-only)*
*Default Value: ""*

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*

 **FingerprintSHA256** *char* (read-only)*
*Default Value: ""*

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*

 **Issuer** *char* (read-only)*
*Default Value: ""*

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

 **PrivateKey** *char* (read-only)*
*Default Value: ""*

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

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *int (read-only)*
*Default Value: FALSE*

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *char* (read-only)*
*Default Value: ""*

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *char* (read-only)*
*Default Value: ""*

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

 **PublicKeyAlgorithm** *char* (read-only)*
*Default Value: ""*

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.

 **PublicKeyLength** *int (read-only)*
*Default Value: 0*

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

 **SerialNumber** *char* (read-only)*
*Default Value: ""*

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.

 **SignatureAlgorithm** *char* (read-only)*
*Default Value: ""*

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.

 **Store** *char**
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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).

 **StorePassword** *char**
*Default Value: ""*

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

 **StoreType** *int*
*Default Value: 0*

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 field can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the CertMgr class by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **SubjectAltNames** *char* (read-only)*
*Default Value: ""*

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

 **ThumbprintMD5** *char* (read-only)*
*Default Value: ""*

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.

 **ThumbprintSHA1** *char* (read-only)*
*Default Value: ""*

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.

 **ThumbprintSHA256** *char* (read-only)*
*Default Value: ""*

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.

 **Usage** *char* (read-only)*
*Default Value: ""*

The text description of [UsageFlags](#Certificate_f_UsageFlags).

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.

 **UsageFlags** *int (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

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

 **Version** *char* (read-only)*
*Default Value: ""*

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

 **Subject** *char**
*Default Value: ""*

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 field 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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

 **Encoded** *char**
*Default Value: ""*

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

## Constructors

```text
Certificate()
```

 Creates a instance whose properties can be set.

```text
Certificate(const char* lpEncoded, int lenEncoded)
```

 Parses * Encoded * as an X.509 public key.

```text
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

# DiscoveryDocDetails Type

Details about the OpenID provider's discovery document.

## Syntax

 *CloudSSODiscoveryDocDetails* (declared in *cloudsso.h*)

## Remarks

The fields of this type correspond to metadata details from an OpenID provider's discovery document.

The following fields are available:

- [AuthorizationURL](#DiscoveryDocDetails_f_AuthorizationURL)

- [ClaimsParamSupported](#DiscoveryDocDetails_f_ClaimsParamSupported)

- [Content](#DiscoveryDocDetails_f_Content)

- [Issuer](#DiscoveryDocDetails_f_Issuer)

- [LogoutURL](#DiscoveryDocDetails_f_LogoutURL)

- [RegistrationURL](#DiscoveryDocDetails_f_RegistrationURL)

- [ServiceDocsURL](#DiscoveryDocDetails_f_ServiceDocsURL)

- [SignerCertURL](#DiscoveryDocDetails_f_SignerCertURL)

- [SupportedClaims](#DiscoveryDocDetails_f_SupportedClaims)

- [SupportedDisplays](#DiscoveryDocDetails_f_SupportedDisplays)

- [SupportedGrantTypes](#DiscoveryDocDetails_f_SupportedGrantTypes)

- [SupportedResponseTypes](#DiscoveryDocDetails_f_SupportedResponseTypes)

- [SupportedScopes](#DiscoveryDocDetails_f_SupportedScopes)

- [TokenURL](#DiscoveryDocDetails_f_TokenURL)

- [UserInfoURL](#DiscoveryDocDetails_f_UserInfoURL)

## Fields

 **AuthorizationURL** *char* (read-only)*
*Default Value: ""*

The server authorization endpoint URL.

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

 **ClaimsParamSupported** *int (read-only)*
*Default Value: FALSE*

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.

 **Content** *char* (read-only)*
*Default Value: ""*

The raw discovery document JSON.

 **Issuer** *char* (read-only)*
*Default Value: ""*

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.

 **LogoutURL** *char* (read-only)*
*Default Value: ""*

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.

 **RegistrationURL** *char* (read-only)*
*Default Value: ""*

The dynamic client registration URL.

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

 **ServiceDocsURL** *char* (read-only)*
*Default Value: ""*

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.

 **SignerCertURL** *char* (read-only)*
*Default Value: ""*

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.

 **SupportedClaims** *char* (read-only)*
*Default Value: ""*

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.

 **SupportedDisplays** *char* (read-only)*
*Default Value: ""*

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.

 **SupportedGrantTypes** *char* (read-only)*
*Default Value: ""*

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.

 **SupportedResponseTypes** *char* (read-only)*
*Default Value: ""*

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.

 **SupportedScopes** *char* (read-only)*
*Default Value: ""*

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.

 **TokenURL** *char* (read-only)*
*Default Value: ""*

The token endpoint URL.

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

 **UserInfoURL** *char* (read-only)*
*Default Value: ""*

The user info endpoint URL.

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

## Constructors

```text
DiscoveryDocDetails()
```

# Firewall Type

The firewall the component will connect through.

## Syntax

 *CloudSSOFirewall* (declared in *cloudsso.h*)

## Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall [Host](#Firewall_f_Host) and the [FirewallType](#Firewall_f_FirewallType).

The following fields are available:

- [AutoDetect](#Firewall_f_AutoDetect)

- [FirewallType](#Firewall_f_FirewallType)

- [Host](#Firewall_f_Host)

- [Password](#Firewall_f_Password)

- [Port](#Firewall_f_Port)

- [User](#Firewall_f_User)

## Fields

 **AutoDetect** *int*
*Default Value: FALSE*

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

 **FirewallType** *int*
*Default Value: 0*

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

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [Port](#Firewall_f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [Port](#Firewall_f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [Port](#Firewall_f_Port) is set to 1080. |

 **Host** *char**
*Default Value: ""*

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

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

 **Password** *char**
*Default Value: ""*

A password if authentication is to be used when connecting through the firewall. If [Host](#Firewall_f_Host) is specified, the [User](#Firewall_f_User) and [Password](#Firewall_f_Password) fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

 **Port** *int*
*Default Value: 0*

The Transmission Control Protocol (TCP) port for the firewall [Host](#Firewall_f_Host). See the description of the [Host](#Firewall_f_Host) field for details.

NOTE: This field is set automatically when [FirewallType](#Firewall_f_FirewallType) is set to a valid value. See the description of the [FirewallType](#Firewall_f_FirewallType) field for details.

 **User** *char**
*Default Value: ""*

A username if authentication is to be used when connecting through a firewall. If [Host](#Firewall_f_Host) is specified, this field and the [Password](#Firewall_f_Password) field are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class fails with an error.

## Constructors

```text
Firewall()
```

# IdTokenInfo Type

This type holds details about an ID Token.

## Syntax

 *CloudSSOIdTokenInfo* (declared in *cloudsso.h*)

## Remarks

The fields of this type correspond to claims from the ID Token.

The following fields are available:

- [Audiences](#IdTokenInfo_f_Audiences)

- [AuthTime](#IdTokenInfo_f_AuthTime)

- [ExpTime](#IdTokenInfo_f_ExpTime)

- [IdTokenContent](#IdTokenInfo_f_IdTokenContent)

- [IssuedTime](#IdTokenInfo_f_IssuedTime)

- [Issuer](#IdTokenInfo_f_Issuer)

## Fields

 **Audiences** *char* (read-only)*
*Default Value: ""*

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

 **AuthTime** *int64 (read-only)*
*Default Value: 0*

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.

 **ExpTime** *int64*
*Default Value: 0*

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.

 **IdTokenContent** *char**
*Default Value: ""*

The raw value of the ID Token.

 **IssuedTime** *int64*
*Default Value: 0*

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.

 **Issuer** *char**
*Default Value: ""*

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

## Constructors

```text
IdTokenInfo()
```

# OAuthParam Type

This is the parameter to be used in the request or received in the response.

## Syntax

 *CloudSSOOAuthParam* (declared in *cloudsso.h*)

## Remarks

This type describes a parameter that is used in a request or received in the response.

The following fields are available:

- [Name](#OAuthParam_f_Name)

- [Value](#OAuthParam_f_Value)

## Fields

 **Name** *char**
*Default Value: ""*

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

 **Value** *char**
*Default Value: ""*

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.

## Constructors

```text
OAuthParam()
```

```text
OAuthParam(const char* lpszName, const char* lpszValue)
```

# Proxy Type

The proxy the component will connect to.

## Syntax

 *CloudSSOProxy* (declared in *cloudsso.h*)

## Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the [Server](#Proxy_f_Server) and the [AuthScheme](#Proxy_f_AuthScheme).

The following fields are available:

- [AuthScheme](#Proxy_f_AuthScheme)

- [AutoDetect](#Proxy_f_AutoDetect)

- [Password](#Proxy_f_Password)

- [Port](#Proxy_f_Port)

- [Server](#Proxy_f_Server)

- [SSL](#Proxy_f_SSL)

- [User](#Proxy_f_User)

## Fields

 **AuthScheme** *int*
*Default Value: 0*

The type of authorization to perform when connecting to the proxy. This is used only when the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set.

[AuthScheme](#Proxy_f_AuthScheme) should be set to authNone (3) when no authentication is expected.

By default, [AuthScheme](#Proxy_f_AuthScheme) is authBasic (0), and if the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are set, the class will attempt basic authentication.

If [AuthScheme](#Proxy_f_AuthScheme) is set to authDigest (1), digest authentication will be attempted instead.

If [AuthScheme](#Proxy_f_AuthScheme) 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 [AuthScheme](#Proxy_f_AuthScheme) is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of [User](#Proxy_f_User) and [Password](#Proxy_f_Password).

 **AutoDetect** *int*
*Default Value: FALSE*

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

 **Password** *char**
*Default Value: ""*

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

If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server.

If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation.

 **Port** *int*
*Default Value: 80*

The Transmission Control Protocol (TCP) port for the proxy [Server](#Proxy_f_Server) (default 80). See the description of the [Server](#Proxy_f_Server) field for details.

 **Server** *char**
*Default Value: ""*

If a proxy [Server](#Proxy_f_Server) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the [Server](#Proxy_f_Server) field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [Server](#Proxy_f_Server) field is set to the corresponding address. If the search is not successful, an error is returned.

 **SSL** *int*
*Default Value: 0*

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

|  |  |
| --- | --- |
| psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
| psAlways (1) | The connection is always SSL-enabled. |
| psNever (2) | The connection is not SSL-enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |

 **User** *char**
*Default Value: ""*

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

If [AuthScheme](#Proxy_f_AuthScheme) is set to Basic Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*.

If [AuthScheme](#Proxy_f_AuthScheme) is set to Digest Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to respond to the Digest Authentication challenge from the server.

If [AuthScheme](#Proxy_f_AuthScheme) is set to NTLM Authentication, the [User](#Proxy_f_User) and [Password](#Proxy_f_Password) fields are used to authenticate through NTLM negotiation.

## Constructors

```text
Proxy()
```

```text
Proxy(const char* lpszServer, int iPort)
```

```text
Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)
```

# UserDetails Type

This type holds details about the user.

## Syntax

 *CloudSSOUserDetails* (declared in *cloudsso.h*)

## Remarks

The fields of this type correspond to claims about the user.

The following fields are available:

- [AddrCountry](#UserDetails_f_AddrCountry)

- [AddrFormatted](#UserDetails_f_AddrFormatted)

- [AddrLocality](#UserDetails_f_AddrLocality)

- [AddrPostalCode](#UserDetails_f_AddrPostalCode)

- [AddrRegion](#UserDetails_f_AddrRegion)

- [AddrStreetAddr](#UserDetails_f_AddrStreetAddr)

- [Birthday](#UserDetails_f_Birthday)

- [Email](#UserDetails_f_Email)

- [EmailVerified](#UserDetails_f_EmailVerified)

- [FirstName](#UserDetails_f_FirstName)

- [Gender](#UserDetails_f_Gender)

- [LastName](#UserDetails_f_LastName)

- [Locale](#UserDetails_f_Locale)

- [MiddleName](#UserDetails_f_MiddleName)

- [Name](#UserDetails_f_Name)

- [Nickname](#UserDetails_f_Nickname)

- [PhoneNumber](#UserDetails_f_PhoneNumber)

- [PhoneNumberVerified](#UserDetails_f_PhoneNumberVerified)

- [PictureURL](#UserDetails_f_PictureURL)

- [PreferredUsername](#UserDetails_f_PreferredUsername)

- [ProfileURL](#UserDetails_f_ProfileURL)

- [Subject](#UserDetails_f_Subject)

- [UpdatedAt](#UserDetails_f_UpdatedAt)

- [Website](#UserDetails_f_Website)

- [ZoneInfo](#UserDetails_f_ZoneInfo)

## Fields

 **AddrCountry** *char* (read-only)*
*Default Value: ""*

The country name portion of the user's address.

 **AddrFormatted** *char* (read-only)*
*Default Value: ""*

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

 **AddrLocality** *char* (read-only)*
*Default Value: ""*

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

 **AddrPostalCode** *char* (read-only)*
*Default Value: ""*

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

 **AddrRegion** *char* (read-only)*
*Default Value: ""*

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

 **AddrStreetAddr** *char* (read-only)*
*Default Value: ""*

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.

 **Birthday** *char* (read-only)*
*Default Value: ""*

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.

 **Email** *char* (read-only)*
*Default Value: ""*

The user's preferred email address.

 **EmailVerified** *int (read-only)*
*Default Value: FALSE*

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.

 **FirstName** *char* (read-only)*
*Default Value: ""*

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

 **Gender** *char* (read-only)*
*Default Value: ""*

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

 **LastName** *char* (read-only)*
*Default Value: ""*

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

 **Locale** *char* (read-only)*
*Default Value: ""*

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

 **MiddleName** *char* (read-only)*
*Default Value: ""*

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

 **Name** *char* (read-only)*
*Default Value: ""*

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

 **Nickname** *char* (read-only)*
*Default Value: ""*

The casual name of the user. This may or may not be the same as [FirstName](#UserDetails_f_FirstName).

 **PhoneNumber** *char* (read-only)*
*Default Value: ""*

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*.

 **PhoneNumberVerified** *int (read-only)*
*Default Value: FALSE*

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.

 **PictureURL** *char* (read-only)*
*Default Value: ""*

The URL of the user's profile picture.

 **PreferredUsername** *char* (read-only)*
*Default Value: ""*

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

 **ProfileURL** *char* (read-only)*
*Default Value: ""*

The URL of the user's profile page.

 **Subject** *char* (read-only)*
*Default Value: ""*

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

 **UpdatedAt** *int64 (read-only)*
*Default Value: 0*

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.

 **Website** *char* (read-only)*
*Default Value: ""*

The URL of the user's website.

 **ZoneInfo** *char* (read-only)*
*Default Value: ""*

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

## Constructors

```text
UserDetails()
```

# CloudSSOList Type

## Syntax

 *CloudSSOList<T>* (declared in *cloudsso.h*)

## Remarks

 *CloudSSOList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the OIDCDesktop class.

```text
int GetCount() {}
```

```text
int SetCount(int count) {}
```

```text
T* Get(int index) {}
```

```text
T* Set(int index, T* value) {}
```

|  |  |
| --- | --- |
| Methods |  |
| GetCount | This method returns the current size of the collection. |
| SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. |
| Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. |
| Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. |

# Config Settings ([OIDCDesktop](#oidcdesktop-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration 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](#config-method-oidcdesktop-class) method.

### OIDCDesktop Config Settings

**AccessTokenExp**: The expiration date for the access token.The expiration date for the most recently retrieved access token.

**AuthErrorURI**: The URI that provides more information about the authorization error.When the authorization server returns with an authorization or authentication error, the OpenID provider can optionally provide a URI to a web-page that provides more information on the error.

**AuthorizationCode**: The authorization code to be exchanged with the token server.The authorization code that will be used in a request to the token server. This configuration setting is set when calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class).

**Display**: The requested display options to present to the end user.This optional setting specifies the display options that the authorization server should display to the user. Possible values are:

|  |  |
| --- | --- |
| page | The authorization server SHOULD display the authentication and consent UI consistent with a full user agent page view. If the display parameter is not specified, this is the default display mode. |
| popup | The authorization server SHOULD display the authentication and consent UI consistent with a popup user agent window. The popup user agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. |
| touch | The authorization server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. |
| wap | The authorization server SHOULD display the authentication and consent UI consistent with a "feature phone" type display. |

 The authorization server may choose to use another method to determine how to interact with the user.

This setting corresponds to the *display* request parameter.

**ExpectedAudience**: The expected audience when validating an ID Token.When set, the class will check the audience (aud) claim against this value rather than the [ClientId](#clientid-property-oidcdesktop-class) property.

**ExpectedIssuer**: The expected Issuer when validating an ID Token.When set, the class will check the issuer (iss) claim against this value rather than the value found in the [Issuer](#IdTokenInfo_f_Issuer) field.

**IDTokenHint**: An ID Token value to be used as a hint about the user's session.This setting may be specified before calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) to provide an ID Token as a hint about the user's current or past authenticated session. If the user identified by the ID Token present here is logged in, then the authorization server should return a positive response. If [Prompt](#Prompt) is set to *none*, it is recommended to set this value. The value for this setting is the raw [Issuer](#IdTokenInfo_f_Issuer) received from a previous session.

This setting corresponds to the *id_token_hint* request parameter.

**IdTokenVerificationFlags**: The checks that are ignored when validating an ID Token.Informs the class to skip certain checks when validating an ID Token. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore the issuer (iss) claim. |
| 0x00000002 | Ignore the audience (aud) claim. |
| 0x00000004 | Ignore the expiration (exp) claim. |
| 0x00000008 | Ignore the JWT signature. |
| 0x00000010 | Ignore the "issued at" (iat) claim. |
| 0x00000020 | Ignore the "not before" (nbf) claim. |
| 0x00000040 | Ignore the nonce (nonce) claim. |

**LoginHint**: The login hint sent to the authorization server.This setting optionally specifies an identifier of the end-user which may be used as a hint to the authorization server about the user's identity. For instance, this may be the email address or phone number of a user. The authorization may or may not use the value provided.

This setting corresponds to the *login_hint* request parameter.

**Nonce**: The nonce value that is used to verify an ID Token.This setting provides the value of the Nonce parameter that is provided to the OpenID Provider when making a request and the value that should be used for validation when validating an ID Token. If left blank when [UseNonce](#usenonce-property-oidcdesktop-class) is set to true, the class will generate a new one.

When validating an ID Token with the *nonce* claim, the class will check the claim against this setting. If the instance of the class that generated the authorization request is different than the instance of the class that is doing the validating, then this configuration setting will need to be set again. If the class generates the nonce value, then the application will need to save the original nonce value in a safe location specific to the user authenticating.

**PKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting, when queried, provides the PKCE verifier that is used to generate the PKCE challenge for the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method when [UsePKCE](#usepkce-property-oidcdesktop-class) is set to *true*. It can be used to process the response from the authorization server from a different instance than the one used to create the authorization request.

**Prompt**: The requested conditions under which the authorization server prompts for login.This optional setting specifies the conditions under which the authorization server should prompt for login. The value specified here is a space-delimited, case-sensitive list of one or more of the following values. For instance: *login consent*. Possible values are:

|  |  |
| --- | --- |
| none | The authorization server MUST NOT display any authentication or consent user interface pages. An error is returned if an end-user is not already authenticated, the client does not have pre-configured consent for the requested claims, or the client does not fulfill other conditions for processing the request. The error code will typically be login_required, interaction_required, or another code defined in Section 3.1.2.6 of the OpenID specification. This can be used as a method to check for existing authentication and/or consent. |
| login | The authorization server SHOULD prompt the end-user for re-authentication. If it cannot re-authenticate the end-user, it MUST return an error, typically login_required. |
| consent | The authorization server SHOULD prompt the end-user for consent before returning information to the client. If it cannot obtain consent, it MUST return an error, typically consent_required. |
| select_account | The authorization server SHOULD prompt the end-user to select a user account. This enables an end-user who has multiple accounts at the authorization server to select amongst the multiple accounts for which they might have current sessions. If it cannot obtain an account selection choice made by the end-user, it MUST return an error, typically account_selection_required. |

The prompt parameter can be used to make sure that the end-user is still present for the current session or to bring attention to the request. If this parameter contains *none* with any other value, an error is returned.

This setting corresponds to the *prompt* request parameter.

**ResponseMode**: The value of the response_mode parameter.This configuration setting is used to set the response_mode parameter when building the authorization URL after calling [AuthenticateUser](#authenticateuser-method-oidcdesktop-class). If left empty (default) the parameter will not be set in the request. This informs the authorization server to use the defaults described by the OAuth 2.0 specification. For authorization code, this will be the *query* mode. For implicit, this will typically be the *fragment* mode. Support modes are as follows:

| Mode | Description |
| --- | --- |
| query | The response parameters are encoded in a query string when the user is redirected back to the class. |
| fragment | The response parameters are encoded in a fragment when the user is redirected back to the class. |
| form_post | The response parameters are encoded as HTML form values and posted (rather than redirected) back to the class. This mode is an extension of the OAuth 2.0 protocol and may not be supported by the authorization server. |

**ResponseType**: The value of the response_type request parameter.This setting optionally specifies the value of the *response_type* request parameter. When [GrantType](#granttype-property-oidcdesktop-class) is set, a value for the *response_type* is automatically chosen. If a different value is desired, it may be specified here. The table below illustrates the default and possible values.

|  |  |  |
| --- | --- | --- |
| [GrantType](#granttype-property-oidcdesktop-class) | Default value | Possible values |
| 0 (Authorization Code) | code | code |
| 1 (Implicit) | id_token token | id_tokenid_token token |
| 2 (Hybrid) | code id_token | code id_tokencode tokencode id_token token |

**ServerAuthURL**: The URL of the authorization server.This configuration setting is used to provide the class an authorization server URL directly to be used by the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method.

**ServerSignerCertURL**: The URL of the signer certificate server.This configuration setting is used to provide the class a signer certificate server URL directly to be used when requesting signer certificates.

**ServerTokenURL**: The URL of the token server.This configuration setting is used to provide the class a token server URL directly to be used by the [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) method.

**ServerUserInfoURL**: The URL of the UserInfo server.This configuration setting is used to provide the class a UserInfo server URL directly to be used by the [RequestUserInfo](#requestuserinfo-method-oidcdesktop-class) method.

### WebServer Config Settings

**BrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This configuration setting specifies the amount of time (in seconds) the component will wait for a response from the browser in the [LaunchBrowser](#launchbrowser-event-oidcdesktop-class) event. The default value is 0, meaning that the component will wait indefinitely.

**WebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) is called, the user will be redirected to the embedded web server upon completing authentication with the OpenID Provider. If authentication fails, the HTML specified here will be sent to the user's browser.

**WebServerHost**: The hostname used by the embedded web server.This configuration setting specifies the hostname used by the embedded web server. This specifies the interface on which the embedded web server listens and also the value displayed in the [ReturnURL](#returnurl-property-oidcdesktop-class). This should be set to the hostname only, and not to the full URL.

The default value is *localhost*.

**WebServerResponse**: The custom response that is displayed to the user.When [AuthenticateUser](#authenticateuser-method-oidcdesktop-class) is called, the user will be redirected to the embedded web server upon completing authentication with the OpenID Provider. This setting allows you to specify the HTML that will be sent to the user's browser.

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option 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 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), 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 option is set to 1 (Always), 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, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A [Redirect](#redirect-event-oidcdesktop-class) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-oidcdesktop-class) event is a good place to set properties related to the new connection (e.g., new authentication parameters).

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

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

**HTTP/2 Notes**

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.

**HTTP/3 Notes**

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *false*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-oidcdesktop-class) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

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).

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [FollowRedirects](#followredirects-property-oidcdesktop-class) is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

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

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [User](#Proxy_f_User) and [Password](#Proxy_f_Password) are specified, this value is calculated using the algorithm specified by [AuthScheme](#Proxy_f_AuthScheme).

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*.

**UsePlatformHTTPClient**: Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (*URLConnection* in Java, *WebRequest* in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

NOTE: This setting is applicable only to Mac/iOS editions.

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [AutoDetect](#Proxy_f_AutoDetect) is set to *True*.

When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-oidcdesktop-class) for establishing a connection and transmitting/receiving data.

**EnableFallback**:

**FallbackTimeout**:

**FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveRetryCount**: The number of keep-alive packets to be sent before the remotehost is considered disconnected.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

NOTE: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The LocalHost setting 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 value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the LocalHost setting 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).

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-oidcdesktop-class) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.

**SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

*/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem*

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-oidcdesktop-class) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----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-----
```

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-oidcdesktop-class) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----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-----
```

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-oidcdesktop-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-oidcdesktop-class) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-oidcdesktop-class) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-oidcdesktop-class) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-oidcdesktop-class) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

```text
-----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-----
```

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#sslprovider-property-oidcdesktop-class) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-oidcdesktop-class) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [DoEvents](#doevents-method-oidcdesktop-class) is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([OIDCDesktop](#oidcdesktop-class) Class)

## Error Handling (C++)

Call the *GetLastErrorCode()* method to obtain the last called method's result code; *0* indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the *GetLastError()* method can be called to retrieve the associated error message.

### OIDCDesktop Errors

|  |  |
| --- | --- |
| 900 | Invalid discovery document. The data is not a properly formatted discovery document. |
| 901 | Invalid ID Token. The ID Token could not be parsed. |
| 902 | Invalid ResponseType specified. The supplied ResponseType was unrecognized. |
| 903 | ID Token verification failed. |
| 910 | ID Token verification failed. ID Token has expired. |
| 911 | ID Token verification failed. ID Token issuer does not match expected issuer. |
| 912 | ID Token verification failed. ID Token audience does not match the expected audience. |
| 913 | ID Token verification failed. ID Token is missing a required claim. |
| 914 | ID Token verification failed. ID Token is meant for future use. |
| 915 | ID Token verification failed. ID Token has an invalid issued time. |
| 920 | ID Token verification failed. Could not validate signature. |
| 921 | ID Token verification failed. Could not find a valid Signer Certificate. |
| 922 | ID Token verification failed. Could not find a Signer Certificate that matches ID Token Headers. |
| 923 | ID Token verification failed. Could not find signature. |
| 940 | Authorization response processing error. The authorization response contained an error message from the authorization server. Check description for more information. |
| 940 | Authorization response timeout. The |

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