OIDCDesktop Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TciOIDCDesktop

Remarks

The OIDCDesktop component 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 component 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 component simplifies requesting and parsing the discovery document. The RequestDiscoveryDoc method will make a request to the specified discovery document URL. It will retrieve the discovery document and parse the commonly used information from it, setting the properties in the DiscoveryDocDetails property. For example:

 
 Copy
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 property can be queried to get the raw JSON document. When the discovery document needs to be reloaded, the LoadDiscoveryDoc method can be used to reload the document. For example:

 
 Copy
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
• GetDiscoveryMetadata
• LoadDiscoveryDoc
• RequestDiscoveryDoc

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 method can be used to request the JWKS directly from the JWKS URI. This method will set the SignerJWKS property which is automatically parsed to fill the SignerCerts properties. If the SignerCerts properties is empty and the component needs to verify the ID Token, the component will automatically make this request.

To reduce the number of requests made by the Relying Party, the LoadSignerJWKS method can be used to parse the SignerJWKS again. This allows the Relying Party to cache the SignerJWKS property and reuse it later, reducing the amount of times the JWKS is requested from the OpenID Provider.

 
 Copy
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 component can be used to authenticate a user. When ready, call AuthenticateUser 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 component 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 component will start an embedded web server to listen for the redirect and automatically set the ReturnURL property so that the OpenID provider will know where to redirect the user. The WebServerPort and WebServerSSLEnabled 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. The ID token will parsed and validated once it is received. See 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, ClientSecret (optional), AuthorizationScope, and ReturnURL. The response from the token server will contain the ID Token, access token, and optional refresh token.

Usage: Authorization Code

 
 Copy
//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 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 property is set before calling AuthenticateUser, the request will be made without the authorization code and the RefreshToken will be used instead.

Usage: Refresh Tokens

 
 Copy
//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 component will automatically validate the ID Token after calling AuthenticateUser.

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

Usage: Validate and Parse an ID Token

In a case where an ID Token is provided directly to the component, the ValidateIdToken method can be used to validate it, and the ParseIdToken method can be used to parse it. The following example will set up the component with the information needed to validate and parse the ID Token.

 
 Copy
//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 component will set the properties in the UserDetails property with the corresponding information. If there is a claim that is not found in the UserDetails property, the GetIdTokenClaim and the GetUserInfoClaim methods can be used to search for specific claims.

Usage: Request UserInfo

To make a request to the UserInfo endpoint, the component will need to have the AccessToken property set. Additionally, the discovery document can be used to get the UserInfo endpoint. The following code example assumes that the AccessToken has been set to a cached token from the current user session.

 
 Copy
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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AccessToken Property (OIDCDesktop Component)

The access token received from an OpenID provider.

Syntax

property AccessToken: String read get_AccessToken write set_AccessToken;

Default Value

''

Remarks

After authenticating, this property will be populated with the access token from the OpenID provider. When set, the AccessTokenExp configuration setting will also be set with the expiration date of the access token. Once AccessToken is set, you can call RequestUserInfo to retrieve information about the authenticated user. Additionally, depending on the OpenID provider and the AuthorizationScope, 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.

AuthorizationScope Property (OIDCDesktop Component)

The authorization scope used during authorization.

Syntax

property AuthorizationScope: String read get_AuthorizationScope write set_AuthorizationScope;

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

AuthzResponseCode Property (OIDCDesktop Component)

The error code from a recent authorization attempt.

Syntax

property AuthzResponseCode: String read get_AuthzResponseCode;

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 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 property. The AuthErrorURI configuration setting may also be set if the request provided a URL to a page that describes the error.

This property is read-only.

AuthzResponseDesc Property (OIDCDesktop Component)

The error description from a recent authorization attempt.

Syntax

property AuthzResponseDesc: String read get_AuthzResponseDesc;

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

This property is read-only.

ClientId Property (OIDCDesktop Component)

The Id of the client assigned when registering the application.

Syntax

property ClientId: String read get_ClientId write set_ClientId;

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 method. Additionally, it is used to verify the Audiences property of an ID Token when calling the AuthenticateUser or ValidateIdToken methods.

ClientSecret Property (OIDCDesktop Component)

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

Syntax

property ClientSecret: String read get_ClientSecret write set_ClientSecret;

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.

DiscoveryDocDetails Property (OIDCDesktop Component)

Details about the OpenID provider's discovery document.

Syntax

property DiscoveryDocDetails: TciDiscoveryDocDetails read get_DiscoveryDocDetails;

Remarks

This property holds details parsed from the discovery document after RequestDiscoveryDoc or LoadDiscoveryDoc is called.

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

Firewall Property (OIDCDesktop Component)

A set of properties related to firewall access.

Syntax

property Firewall: TciFirewall read get_Firewall write set_Firewall;

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

FollowRedirects Property (OIDCDesktop Component)

Determines what happens when the server issues a redirect.

Syntax

property FollowRedirects: TciTFollowRedirects read get_FollowRedirects write set_FollowRedirects;

TciTFollowRedirects = (
  frNever,
  frAlways,
  frSameScheme
);

Default Value

frNever

Remarks

This property determines what happens when the server issues a redirect. Normally, the component 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 component raises an exception.

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 event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the component raises an exception instead.

GrantType Property (OIDCDesktop Component)

The grant type defining the authentication flow.

Syntax

property GrantType: TciTGrantTypes read get_GrantType write set_GrantType;

TciTGrantTypes = (
  ogtAuthorizationCode,
  ogtImplicit,
  ogtHybrid
);

Default Value

ogtAuthorizationCode

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 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 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 component 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 after setting this property.

IdTokenInfo Property (OIDCDesktop Component)

Information about the current ID Token.

Syntax

property IdTokenInfo: TciIdTokenInfo read get_IdTokenInfo;

Remarks

This property holds details about the ID Token.

When an ID Token is parsed either by calling ParseIdToken or retrieved after calling AuthenticateUser, 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.

OtherHeaders Property (OIDCDesktop Component)

Other headers as determined by the user (optional).

Syntax

property OtherHeaders: String read get_OtherHeaders write set_OtherHeaders;

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 ('#13#10') .

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 component beyond what is provided.

This property is not available at design time.

Params Property (OIDCDesktop Component)

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

Syntax

property Params: TciOAuthParamList read get_Params write set_Params;

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.

Proxy Property (OIDCDesktop Component)

A set of properties related to proxy access.

Syntax

property Proxy: TciProxy read get_Proxy write set_Proxy;

Remarks

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

RefreshToken Property (OIDCDesktop Component)

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

Syntax

property RefreshToken: String read get_RefreshToken write set_RefreshToken;

Default Value

''

Remarks

This property is set by the component when it receives a refresh token after the AuthenticateUser 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) for the user's AccessToken, 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 component 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, it will just set this property before calling the AuthenticateUser method.

Some OpenID providers will also return a newly issued ID Token when using a RefreshToken to get a new AccessToken. 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.

ReturnURL Property (OIDCDesktop Component)

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

Syntax

property ReturnURL: String read get_ReturnURL write set_ReturnURL;

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 creates the authorization URL.

Typically, this is automatically set to the internal web server that is created by the component upon calling AuthenticateUser or StartWebServer.

SignerCerts Property (OIDCDesktop Component)

The signing certificates from an OpenID provider.

Syntax

property SignerCerts: TciCertificateList read get_SignerCerts;

Remarks

This property contains a list of certificates from the OpenID provider that are used for signing ID Tokens. This properties can be manually populated using the RequestSignerCerts or LoadSignerJWKS methods.

The properties can be automatically populated when needed if it is empty and a SignerCertURL is available. This can happen when calling the AuthenticateUser or ValidateIdToken methods.

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

SignerJWKS Property (OIDCDesktop Component)

The JSON Web Key Set provided by an OpenID provider.

Syntax

property SignerJWKS: String read get_SignerJWKS;

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 when the component makes a request to populate the SignerCerts properties. The RequestSignerCerts method can be used to manually make a request to the SignerCertURL; otherwise, the component will automatically make the request if the properties is not set and it needs the certificates to validate an ID Token.

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

This property is read-only.

SSLAcceptServerCert Property (OIDCDesktop Component)

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

Syntax

property SSLAcceptServerCert: TciCertificate read get_SSLAcceptServerCert write set_SSLAcceptServerCert;

Remarks

If it finds any issues with the certificate presented by the server, the component 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.

SSLCert Property (OIDCDesktop Component)

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

Syntax

property SSLCert: TciCertificate read get_SSLCert write set_SSLCert;

Remarks

This property includes the digital certificate that the component 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 field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (OIDCDesktop Component)

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

Syntax

property SSLProvider: TciTSSLProviders read get_SSLProvider write set_SSLProvider;

TciTSSLProviders = (
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
);

Default Value

sslpAutomatic

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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

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

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

SSLServerCert Property (OIDCDesktop Component)

The server certificate for the last established connection.

Syntax

property SSLServerCert: TciCertificate read get_SSLServerCert;

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.

State Property (OIDCDesktop Component)

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

Syntax

property State: String read get_State write set_State;

Default Value

''

Remarks

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

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

Timeout Property (OIDCDesktop Component)

The timeout for the component.

Syntax

property Timeout: Integer read get_Timeout write set_Timeout;

Default Value

60

Remarks

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

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

The component will use DoEvents 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 component raises an exception.

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.

UseNonce Property (OIDCDesktop Component)

Whether the Nonce parameter is added.

Syntax

property UseNonce: Boolean read get_UseNonce write set_UseNonce;

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

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

UsePKCE Property (OIDCDesktop Component)

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

Syntax

property UsePKCE: Boolean read get_UsePKCE write set_UsePKCE;

Default Value

false

Remarks

If this property is specified, the component will use Proof Key for Code Exchange (PKCE) as defined by RFC 7636 when AuthenticateUser is called. This applies when GrantType is set to the Authorization Code or Hybrid grant types. The PKCE verifier that is generated by the component will be set to the PKCEVerifier configuration setting.

UserDetails Property (OIDCDesktop Component)

The claims about the user.

Syntax

property UserDetails: TciUserDetails read get_UserDetails;

Remarks

This property holds details about the user.

When an ID Token is parsed either by calling ParseIdToken or when it is retrieved after calling AuthenticateUser, this property is populated with the claims from the ID Token.

When RequestUserInfo is called, this property is populated from the returned claims.

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

WebServerPort Property (OIDCDesktop Component)

The local port on which the embedded web server listens.

Syntax

property WebServerPort: Integer read get_WebServerPort write set_WebServerPort;

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.

WebServerSSLCert Property (OIDCDesktop Component)

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

Syntax

property WebServerSSLCert: TciCertificate read get_WebServerSSLCert write set_WebServerSSLCert;

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 is set to True.

WebServerSSLEnabled Property (OIDCDesktop Component)

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

Syntax

property WebServerSSLEnabled: Boolean read get_WebServerSSLEnabled write set_WebServerSSLEnabled;

Default Value

false

Remarks

This setting specifies whether the embedded web server uses a Secure Sockets Layer (SSL). If set to True, WebServerSSLCert is required and the server will accept only SSL connections. If set to False, only plaintext connects are supported.

AddParam Method (OIDCDesktop Component)

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

Syntax

procedure AddParam(ParamName: String; ParamValue: String);

Remarks

This method can be used to add query string parameters to the requests being made by the AuthenticateUser 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.

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

AuthenticateUser Method (OIDCDesktop Component)

Authenticates a user to the application.

Syntax

procedure AuthenticateUser();

Remarks

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

• AuthorizationScope
• ClientId
• ClientSecret
• DiscoveryDocDetails
• GrantType
• RefreshToken
• ReturnURL
• UseNonce
• UsePKCE

If a RefreshToken is not provided to the component, 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 component 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 component 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 component either through the response from the token server or from the id_token parameter, the component will automatically parse and validate the ID Token. See ParseIdToken and ValidateIdToken methods for more information.

If a RefreshToken is provided to the component, 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.

Config Method (OIDCDesktop Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

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

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

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

DoEvents Method (OIDCDesktop Component)

This method processes events from the internal message queue.

Syntax

procedure DoEvents();

Remarks

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

GetDiscoveryMetadata Method (OIDCDesktop Component)

Gets a specific metadata value from the discovery document.

Syntax

function GetDiscoveryMetadata(metadataName: String): String;

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 and RequestDiscoveryDoc methods. For example, to get the authorization endpoint metadata field from the document, both of the following are valid:

Metadata Name

 
 Copy
oidc.GetDiscoveryMetadata("authorization_endpoint");

JSON Path

 
 Copy
oidc.GetDiscoveryMetadata("/json/authorization_endpoint");

GetIdTokenClaim Method (OIDCDesktop Component)

Gets a specific claim from the ID Token.

Syntax

function GetIdTokenClaim(claimName: String): String;

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

 
 Copy
oidc.GetIdTokenClaim("aud");

JSON Path

 
 Copy
oidc.GetIdTokenClaim("/json/aud");

GetQueryParam Method (OIDCDesktop Component)

Gets a specific claim from the authorization response.

Syntax

function GetQueryParam(paramName: String): String;

Remarks

This method searches the last response from the latest AuthenticateUser method call for a specific query parameter. For example, if the request that was recently processed by the component contains the state parameter, then the following code would return the value of the state returned from the authorization server.

 
 Copy
oidc.AuthenticateUser();

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

GetUserInfoClaim Method (OIDCDesktop Component)

Gets a specific claim from the UserInfo response.

Syntax

function GetUserInfoClaim(claimName: String): String;

Remarks

This method will search the most recent response from the RequestUserInfo 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

 
 Copy
oidc.GetUserInfoClaim("aud");

JSON Path

 
 Copy
oidc.GetUserInfoClaim("/json/aud");

Interrupt Method (OIDCDesktop Component)

This method interrupts the current method.

Syntax

procedure Interrupt();

Remarks

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

LoadDiscoveryDoc Method (OIDCDesktop Component)

Loads in a raw discovery document.

Syntax

procedure LoadDiscoveryDoc(documentData: String);

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

LoadSignerJWKS Method (OIDCDesktop Component)

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

Syntax

procedure LoadSignerJWKS(jwksData: String);

Remarks

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

ParseIdToken Method (OIDCDesktop Component)

Parses an ID Token.

Syntax

procedure 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 and UserDetails properties. Any uncommon or custom claims can be retrieved by calling the GetIdTokenClaim method. The ID Token can be populated directly by setting the IdTokenContent property or by calling the AuthenticateUser method. As a note, the AuthenticateUser method will automatically parse and validate any ID Token's if they are found during the authorization or authentication process.

See ValidateIdToken for information on validating an ID Token.

RequestDiscoveryDoc Method (OIDCDesktop Component)

Requests the OpenID Discovery Document.

Syntax

procedure RequestDiscoveryDoc(URL: String);

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 component 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 property is populated. The Content property may be stored and reloaded using the LoadDiscoveryDoc method to avoid calling RequestDiscoveryDoc on subsequent authorization requests.

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

RequestSignerCerts Method (OIDCDesktop Component)

Requests the signing certificates from the OpenID provider.

Syntax

procedure RequestSignerCerts();

Remarks

This method makes a request to the 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 component will automatically populate the SignerCerts properties with the signer certificates parsed from the JWKS. Additionally, this method will set the SignerJWKS property with the returned JWKS. The SignerJWKS property can be saved for later and used with the LoadSignerJWKS method to avoid needing to use this method for subsequent requests.

RequestUserInfo Method (OIDCDesktop Component)

Requests the information of a user.

Syntax

procedure RequestUserInfo();

Remarks

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

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

Reset Method (OIDCDesktop Component)

This method will reset the component.

Syntax

procedure Reset();

Remarks

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

StartWebServer Method (OIDCDesktop Component)

Starts the embedded web server.

Syntax

procedure 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 is called. You may decide, however, to start the web server manually before calling AuthenticateUser. When called, this method will also populate ReturnURL with the address of the embedded server.

StopWebServer Method (OIDCDesktop Component)

Stops the embedded web server.

Syntax

procedure 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 is called.

ValidateIdToken Method (OIDCDesktop Component)

Validates an ID Token.

Syntax

procedure ValidateIdToken();

Remarks

This method validates the current ID Token. Typically, the component will automatically validate and parse an ID Token if it is found during the AuthenticateUser method, but the ID Token can also be populated directly by setting the IdTokenContent property. 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 properties which contains the corresponding public certificates of the certificates used to sign the original ID Token. If the SignerCerts properties is not populated, then a request will be made to the SignerCertURL property or the ServerSignerCertURL configuration setting if set. This is equivalent to calling the RequestSignerCerts method.

Then, the component will verify that the Issuer property matches what is expected in the Issuer property. Next, the Audiences will be checked to ensure that it matches the ClientId property. The ExpectedIssuer and ExpectedAudience configuration settings can be used to override the typical expected values. The last check is to ensure that the IssuedTime and 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 component will throw an exception with the matching error code. If certain steps in the verification process should be skipped, the IdTokenVerificationFlags configuration setting can be used.

Error Event (OIDCDesktop Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

LaunchBrowser Event (OIDCDesktop Component)

Fires before launching a browser with the authorization URL.

Syntax

type TLaunchBrowserEvent = procedure (
  Sender: TObject;
  var URL: String;
  var Command: String
) of Object;

property OnLaunchBrowser: TLaunchBrowserEvent read FOnLaunchBrowser write FOnLaunchBrowser;

Remarks

When the AuthenticateUser method is called, the component will fire this event with the Command, which will be executed by the component. 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 component 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 Component)

Fired once for each log message.

Syntax

type TLogEvent = procedure (
  Sender: TObject;
  LogLevel: Integer;
  const Message: String;
  const LogType: String
) of Object;

property OnLog: TLogEvent read FOnLog write FOnLog;

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Redirect Event (OIDCDesktop Component)

Fired when a redirection is received from the server.

Syntax

type TRedirectEvent = procedure (
  Sender: TObject;
  const Location: String;
  var Accept: Boolean
) of Object;

property OnRedirect: TRedirectEvent read FOnRedirect write FOnRedirect;

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 component raises an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SSLServerAuthentication Event (OIDCDesktop Component)

Fired after the server presents its certificate to the client.

Syntax

type TSSLServerAuthenticationEvent = procedure (
  Sender: TObject;
  const CertEncoded: String;
  const CertEncodedB: TBytes;
  const CertSubject: String;
  const CertIssuer: String;
  const Status: String;
  var Accept: Boolean
) of Object;

property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;

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

Fired when secure connection progress messages are available.

Syntax

type TSSLStatusEvent = procedure (
  Sender: TObject;
  const Message: String
) of Object;

property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;

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.

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.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

C#
 Copy
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);

Constructors

>

constructor Create();

constructor Create(valEncoded: TBytes);

constructor Create(valStoreType: TciCertStoreTypes; valStore: String; valStorePassword: String; valSubject: String);

constructor Create(valStoreType: TciCertStoreTypes; valStore: TBytes; valStorePassword: String; valSubject: String);

DiscoveryDocDetails Type

Details about the OpenID provider's discovery document.

Remarks

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

• AuthorizationURL
• ClaimsParamSupported
• Content
• Issuer
• LogoutURL
• RegistrationURL
• ServiceDocsURL
• SignerCertURL
• SupportedClaims
• SupportedDisplays
• SupportedGrantTypes
• SupportedResponseTypes
• SupportedScopes
• TokenURL
• UserInfoURL

Fields

Constructors

constructor Create();

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

• AutoDetect
• FirewallType
• Host
• Password
• Port
• User

Fields

Constructors

constructor Create();

IdTokenInfo Type

This type holds details about an ID Token.

Remarks

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

• Audiences
• AuthTime
• ExpTime
• IdTokenContent
• IssuedTime
• Issuer

Fields

Constructors

constructor Create();

OAuthParam Type

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

Remarks

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

• Name
• Value

Fields

Constructors

constructor Create();

constructor Create(valName: String; valValue: String);

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

• AuthScheme
• AutoDetect
• Password
• Port
• Server
• SSL
• User

Fields

Constructors

constructor Create();

constructor Create(valServer: String; valPort: Integer);

constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);

UserDetails Type

This type holds details about the user.

Remarks

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

• AddrCountry
• AddrFormatted
• AddrLocality
• AddrPostalCode
• AddrRegion
• AddrStreetAddr
• Birthday
• Email
• EmailVerified
• FirstName
• Gender
• LastName
• Locale
• MiddleName
• Name
• Nickname
• PhoneNumber
• PhoneNumberVerified
• PictureURL
• PreferredUsername
• ProfileURL
• Subject
• UpdatedAt
• Website
• ZoneInfo

Fields

Constructors

constructor Create();

Config Settings (OIDCDesktop Component)

OIDCDesktop Config Settings

WebServer Config Settings

HTTP Config Settings

 
 Copy
Sat, 29 Oct 2017 19:43:31 GMT.

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

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

TCPClient Config Settings

SSL Config Settings

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

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

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

 
 Copy
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");

C#
 Copy
server.Config("SSLNegotiatedCipher[connId]");

C#
 Copy
server.Config("SSLNegotiatedCipherStrength[connId]");

C#
 Copy
server.Config("SSLNegotiatedCipherSuite[connId]");

C#
 Copy
server.Config("SSLNegotiatedKeyExchange[connId]");

C#
 Copy
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

C#
 Copy
server.Config("SSLNegotiatedVersion[connId]");

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (OIDCDesktop Component)

OIDCDesktop Errors

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