OIDC Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TciOIDC

Remarks

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

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

Setup

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

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

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

Discovery

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

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

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

Usage: Getting the Discovery Document

The OIDC 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:

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

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. oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); oidc.RequestSignerCerts(); string raw_jwks = oidc.SignerJWKS; //Save or Cache for later. //Continue on with operations that need to verify an ID Token. //Sometime later with a new instance. oidc.SignerJWKS = raw_jwks; oidc.LoadSignerJWKS(); //Continue on with new operations that need to verify an ID Token.

Authentication

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

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

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

Getting Authorization

Usage: Getting the Authorization URL

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

Authorization Response

Parse vs. Process

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

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

Usage: Handling a redirect from an OpenID Provider

The OIDC component provides the ParseOIDCResponse and ProcessOIDCResponse methods to make it simple to get the required information from a redirect.

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

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

Getting Tokens

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

Refresh Tokens

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

Usage: Request Tokens

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

Verifying ID Tokens

When a Relying Party receives an ID Token, it can verify the token to confirm the identity of the user that it represents. When the component receives an ID Token after calling ParseOIDCResponse, ProcessOIDCResponse, or RequestTokens, it will automatically validate the ID Token.

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

Usage: Validate and Parse an ID Token

In a case where an ID Token is provided directly to the 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. //OpenID Provider oidc.RequestDiscoveryDoc("https://example.com/.well-known/openid-configuration"); oidc.RequestSignerCerts(); //Relying Party oidc.ClientId = "Relying Party ID"; oidc.IdTokenInfo.IdTokenContent = "ID_TOKEN"; try { oidc.ValidateIdToken(); } catch (OIDCException e) { //If there is any validation issues. } //Parse the validated ID Token. oidc.ParseIdToken(); string issuer = oidc.IdTokenInfo.Issuer;

User Information

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

When commonly used claims are parsed from an ID Token or the response from the UserInfo endpoint, the 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. 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 (OIDC Component)

The access token received from an OpenID provider.

Syntax

__property String AccessToken = { read=FAccessToken, write=FSetAccessToken };

Default Value

""

Remarks

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

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.

When an OpenID provider provides an access token depends on the ResponseType that was set when calling GetAuthorizationURL. Typically, the ResponseType configuration setting is set when selecting a GrantType which is set to ogtAuthorizationCode by default. When ResponseType contains code (ogtAuthorizationCode and ogtHybrid), the AccessToken is provided by the DiscoveryDocDetailsTokenURL. When ResponseType contains token (ogtAuthorizationCode and ogtHybrid), the AccessToken is provided by the DiscoveryDocDetailsAuthorizationURL.

Data Type

String

AuthorizationScope Property (OIDC Component)

The authorization scope used during authorization.

Syntax

__property String AuthorizationScope = { read=FAuthorizationScope, write=FSetAuthorizationScope };

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 ProcessOIDCResponse or ParseOIDCResponse, 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 (OIDC Component)

The error code from a recently parsed HTTP request.

Syntax

__property String AuthzResponseCode = { read=FAuthzResponseCode };

Default Value

""

Remarks

This property holds the most recent error response code from an HTTP request that contains the response to an authorization (Authz) attempt. This is set when ParseOIDCResponse or ProcessOIDCResponse is called and the error response parameter is present. 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.

Data Type

String

AuthzResponseDesc Property (OIDC Component)

The error description from a recently parsed HTTP request.

Syntax

__property String AuthzResponseDesc = { read=FAuthzResponseDesc };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ClientId Property (OIDC Component)

The Id of the client assigned when registering the application.

Syntax

__property String ClientId = { read=FClientId, write=FSetClientId };

Default Value

""

Remarks

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

Data Type

String

ClientSecret Property (OIDC Component)

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

Syntax

__property String ClientSecret = { read=FClientSecret, write=FSetClientSecret };

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 RequestTokens or ProcessOIDCResponse.

Data Type

String

DiscoveryDocDetailsAuthorizationURL Property (OIDC Component)

The server authorization endpoint URL.

Syntax

__property String DiscoveryDocDetailsAuthorizationURL = { read=FDiscoveryDocDetailsAuthorizationURL };

Default Value

""

Remarks

The server authorization endpoint URL.

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

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

Data Type

String

DiscoveryDocDetailsClaimsParamSupported Property (OIDC Component)

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

Syntax

__property bool DiscoveryDocDetailsClaimsParamSupported = { read=FDiscoveryDocDetailsClaimsParamSupported };

Default Value

false

Remarks

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

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

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

Data Type

Boolean

DiscoveryDocDetailsContent Property (OIDC Component)

The raw discovery document JSON.

Syntax

__property String DiscoveryDocDetailsContent = { read=FDiscoveryDocDetailsContent };

Default Value

""

Remarks

The raw discovery document JSON.

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

Data Type

String

DiscoveryDocDetailsIssuer Property (OIDC Component)

The issuer identifier of the OpenID provider.

Syntax

__property String DiscoveryDocDetailsIssuer = { read=FDiscoveryDocDetailsIssuer };

Default Value

""

Remarks

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

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

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

Data Type

String

DiscoveryDocDetailsLogoutURL Property (OIDC Component)

The logout endpoint URL.

Syntax

__property String DiscoveryDocDetailsLogoutURL = { read=FDiscoveryDocDetailsLogoutURL };

Default Value

""

Remarks

The logout endpoint URL.

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

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

Data Type

String

DiscoveryDocDetailsRegistrationURL Property (OIDC Component)

The dynamic client registration URL.

Syntax

__property String DiscoveryDocDetailsRegistrationURL = { read=FDiscoveryDocDetailsRegistrationURL };

Default Value

""

Remarks

The dynamic client registration URL.

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

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

Data Type

String

DiscoveryDocDetailsServiceDocsURL Property (OIDC Component)

The URL of the human-readable service documentation.

Syntax

__property String DiscoveryDocDetailsServiceDocsURL = { read=FDiscoveryDocDetailsServiceDocsURL };

Default Value

""

Remarks

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

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

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

Data Type

String

DiscoveryDocDetailsSignerCertURL Property (OIDC Component)

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

Syntax

__property String DiscoveryDocDetailsSignerCertURL = { read=FDiscoveryDocDetailsSignerCertURL };

Default Value

""

Remarks

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

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

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

Data Type

String

DiscoveryDocDetailsSupportedClaims Property (OIDC Component)

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

Syntax

__property String DiscoveryDocDetailsSupportedClaims = { read=FDiscoveryDocDetailsSupportedClaims };

Default Value

""

Remarks

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

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

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

Data Type

String

DiscoveryDocDetailsSupportedDisplays Property (OIDC Component)

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

Syntax

__property String DiscoveryDocDetailsSupportedDisplays = { read=FDiscoveryDocDetailsSupportedDisplays };

Default Value

""

Remarks

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

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

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

Data Type

String

DiscoveryDocDetailsSupportedGrantTypes Property (OIDC Component)

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

Syntax

__property String DiscoveryDocDetailsSupportedGrantTypes = { read=FDiscoveryDocDetailsSupportedGrantTypes };

Default Value

""

Remarks

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

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

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

Data Type

String

DiscoveryDocDetailsSupportedResponseTypes Property (OIDC Component)

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

Syntax

__property String DiscoveryDocDetailsSupportedResponseTypes = { read=FDiscoveryDocDetailsSupportedResponseTypes };

Default Value

""

Remarks

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

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

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

Data Type

String

DiscoveryDocDetailsSupportedScopes Property (OIDC Component)

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

Syntax

__property String DiscoveryDocDetailsSupportedScopes = { read=FDiscoveryDocDetailsSupportedScopes };

Default Value

""

Remarks

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

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

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

Data Type

String

DiscoveryDocDetailsTokenURL Property (OIDC Component)

The token endpoint URL.

Syntax

__property String DiscoveryDocDetailsTokenURL = { read=FDiscoveryDocDetailsTokenURL };

Default Value

""

Remarks

The token endpoint URL.

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

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

Data Type

String

DiscoveryDocDetailsUserInfoURL Property (OIDC Component)

The user info endpoint URL.

Syntax

__property String DiscoveryDocDetailsUserInfoURL = { read=FDiscoveryDocDetailsUserInfoURL };

Default Value

""

Remarks

The user info endpoint URL.

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

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

Data Type

String

FirewallAutoDetect Property (OIDC Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (OIDC Component)

The type of firewall to connect through.

Syntax

__property TciOIDCFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TciOIDCFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (OIDC Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (OIDC Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (OIDC Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (OIDC Component)

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

FollowRedirects Property (OIDC Component)

Determines what happens when the server issues a redirect.

Syntax

__property TciOIDCFollowRedirects FollowRedirects = { read=FFollowRedirects, write=FSetFollowRedirects };

enum TciOIDCFollowRedirects {
  frNever=0,
  frAlways=1,
  frSameScheme=2
};

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.

Data Type

Integer

GrantType Property (OIDC Component)

The grant type defining the authentication flow.

Syntax

__property TciOIDCGrantTypes GrantType = { read=FGrantType, write=FSetGrantType };

enum TciOIDCGrantTypes {
  ogtAuthorizationCode=0,
  ogtImplicit=1,
  ogtHybrid=2
};

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:

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

When handled by the component using the ParseOIDCResponse and ProcessOIDCResponse methods, each grant type acts in the following manner by default.

When using 0 (Authorization Code Flow - Default), the AuthorizationCode configuration setting is set by the authorization server. When using ProcessOIDCResponse or calling the RequestTokens method after parsing, the component will make a request to the token server and return the AccessToken and IdTokenInfo properties. If provided, this grant type also supports the RefreshToken property.

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

When using 2 (Hybrid Flow), by default the AuthorizationCode configuration setting is set by the authorization server along with the IdTokenInfo property (see Additional Notes). When using ProcessOIDCResponse or calling the RequestTokens method after parsing, the component will make a request to the token server and set the AccessToken property and the IdTokenInfo property if provided again. If provided, this grant type also supports the RefreshToken property.

Additional Notes

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

Data Type

Integer

IdTokenAudiences Property (OIDC Component)

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

Syntax

__property String IdTokenAudiences = { read=FIdTokenAudiences };

Default Value

""

Remarks

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

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

Data Type

String

IdTokenAuthTime Property (OIDC Component)

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

Syntax

__property __int64 IdTokenAuthTime = { read=FIdTokenAuthTime };

Default Value

0

Remarks

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

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

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

Data Type

Long64

IdTokenExpTime Property (OIDC Component)

The time when the ID Token expires.

Syntax

__property __int64 IdTokenExpTime = { read=FIdTokenExpTime };

Default Value

0

Remarks

The time when the ID Token expires.

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

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

Data Type

Long64

IdTokenIdTokenContent Property (OIDC Component)

The raw value of the ID Token.

Syntax

__property String IdTokenIdTokenContent = { read=FIdTokenIdTokenContent, write=FSetIdTokenIdTokenContent };

Default Value

""

Remarks

The raw value of the ID Token.

This property is not available at design time.

Data Type

String

IdTokenIssuedTime Property (OIDC Component)

The time when the authentication for this ID Token occurred.

Syntax

__property __int64 IdTokenIssuedTime = { read=FIdTokenIssuedTime };

Default Value

0

Remarks

The time when the authentication for this ID Token occurred.

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

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

Data Type

Long64

IdTokenIssuer Property (OIDC Component)

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

Syntax

__property String IdTokenIssuer = { read=FIdTokenIssuer };

Default Value

""

Remarks

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

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

Data Type

String

LocalHost Property (OIDC Component)

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

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

Default Value

""

Remarks

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

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

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

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

Data Type

String

OIDCResponseBody Property (OIDC Component)

The HTTP body of an OIDC response.

Syntax

__property String OIDCResponseBody = { read=FOIDCResponseBody, write=FSetOIDCResponseBody };

Default Value

""

Remarks

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

Data Type

String

OIDCResponseHeaders Property (OIDC Component)

The HTTP headers of an OIDC Response.

Syntax

__property String OIDCResponseHeaders = { read=FOIDCResponseHeaders, write=FSetOIDCResponseHeaders };

Default Value

""

Remarks

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

Data Type

String

OtherHeaders Property (OIDC Component)

Other headers as determined by the user (optional).

Syntax

__property String OtherHeaders = { read=FOtherHeaders, write=FSetOtherHeaders };

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

This property is not available at design time.

Data Type

String

ParamCount Property (OIDC Component)

The number of records in the Param arrays.

Syntax

__property int ParamCount = { read=FParamCount, write=FSetParamCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParamName
• ParamValue

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

This property is not available at design time.

Data Type

Integer

ParamName Property (OIDC Component)

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

Syntax

__property String ParamName[int ParamIndex] = { read=FParamName, write=FSetParamName };

Default Value

""

Remarks

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

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParamCount property.

This property is not available at design time.

Data Type

String

ParamValue Property (OIDC Component)

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

Syntax

__property String ParamValue[int ParamIndex] = { read=FParamValue, write=FSetParamValue };

Default Value

""

Remarks

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

The ParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParamCount property.

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (OIDC Component)

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

Syntax

__property TciOIDCProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TciOIDCProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

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

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (OIDC Component)

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

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (OIDC Component)

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

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (OIDC Component)

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

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (OIDC Component)

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

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (OIDC Component)

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

Syntax

__property TciOIDCProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TciOIDCProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

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

Data Type

Integer

ProxyUser Property (OIDC Component)

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

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RefreshToken Property (OIDC Component)

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

Syntax

__property String RefreshToken = { read=FRefreshToken, write=FSetRefreshToken };

Default Value

""

Remarks

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

Usage:

In cases where a user's session may last longer than the actual expiration period (see AccessTokenExp) for the user's 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 RequestTokens 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.

Data Type

String

ReturnURL Property (OIDC Component)

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

Syntax

__property String ReturnURL = { read=FReturnURL, write=FSetReturnURL };

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

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

Data Type

String

SignerCertCount Property (OIDC Component)

The number of records in the SignerCert arrays.

Syntax

__property int SignerCertCount = { read=FSignerCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SignerCertEncoded

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

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

Data Type

Integer

SignerCertEncoded Property (OIDC Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SignerCertEncoded[int SignerCertIndex] = { read=FSignerCertEncoded };
__property DynamicArray<Byte> SignerCertEncodedB[int SignerCertIndex] = { read=FSignerCertEncodedB };

Default Value

""

Remarks

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

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

The SignerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertCount property.

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

Data Type

Byte Array

SignerJWKS Property (OIDC Component)

The JSON Web Key Set provided by an OpenID provider.

Syntax

__property String SignerJWKS = { read=FSignerJWKS };

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 DiscoveryDocDetailsSignerCertURL when the component makes a request to populate the SignerCerts properties. The RequestSignerCerts method can be used to manually make a request to the DiscoveryDocDetailsSignerCertURL; 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 DiscoveryDocDetailsSignerCertURL server.

This property is read-only.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (OIDC Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (OIDC Component)

The date on which the certificate expires.

Syntax

__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (OIDC Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (OIDC Component)

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

Syntax

__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (OIDC Component)

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

Syntax

__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (OIDC Component)

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

Syntax

__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (OIDC Component)

The issuer of the certificate.

Syntax

__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (OIDC Component)

The private key of the certificate (if available).

Syntax

__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (OIDC Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (OIDC Component)

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

Syntax

__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (OIDC Component)

The public key of the certificate.

Syntax

__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (OIDC Component)

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

Syntax

__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (OIDC Component)

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

Syntax

__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (OIDC Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (OIDC Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (OIDC Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore };
__property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

SSLAcceptServerCertStorePassword Property (OIDC Component)

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

Syntax

__property String SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (OIDC Component)

The type of certificate store for this certificate.

Syntax

__property TciOIDCSSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };

enum TciOIDCSSLAcceptServerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (OIDC Component)

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

Syntax

__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (OIDC Component)

The MD5 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (OIDC Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (OIDC Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (OIDC Component)

The text description of UsageFlags .

Syntax

__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (OIDC Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };

Default Value

0

Remarks

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

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (OIDC Component)

The certificate's version number.

Syntax

__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (OIDC Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (OIDC Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertEffectiveDate Property (OIDC Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (OIDC Component)

The date on which the certificate expires.

Syntax

__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (OIDC Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertFingerprint Property (OIDC Component)

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

Syntax

__property String SSLCertFingerprint = { read=FSSLCertFingerprint };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (OIDC Component)

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

Syntax

__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (OIDC Component)

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

Syntax

__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertIssuer Property (OIDC Component)

The issuer of the certificate.

Syntax

__property String SSLCertIssuer = { read=FSSLCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (OIDC Component)

The private key of the certificate (if available).

Syntax

__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (OIDC Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (OIDC Component)

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

Syntax

__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKey Property (OIDC Component)

The public key of the certificate.

Syntax

__property String SSLCertPublicKey = { read=FSSLCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (OIDC Component)

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

Syntax

__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (OIDC Component)

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

Syntax

__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (OIDC Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (OIDC Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertStore Property (OIDC Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

SSLCertStorePassword Property (OIDC Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (OIDC Component)

The type of certificate store for this certificate.

Syntax

__property TciOIDCSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TciOIDCSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (OIDC Component)

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

Syntax

__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (OIDC Component)

The MD5 hash of the certificate.

Syntax

__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (OIDC Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (OIDC Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertUsage Property (OIDC Component)

The text description of UsageFlags .

Syntax

__property String SSLCertUsage = { read=FSSLCertUsage };

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (OIDC Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };

Default Value

0

Remarks

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

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (OIDC Component)

The certificate's version number.

Syntax

__property String SSLCertVersion = { read=FSSLCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertSubject Property (OIDC Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (OIDC Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLProvider Property (OIDC Component)

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

Syntax

__property TciOIDCSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TciOIDCSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

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, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (OIDC Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (OIDC Component)

The date on which the certificate expires.

Syntax

__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (OIDC Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (OIDC Component)

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

Syntax

__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (OIDC Component)

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

Syntax

__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (OIDC Component)

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

Syntax

__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (OIDC Component)

The issuer of the certificate.

Syntax

__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (OIDC Component)

The private key of the certificate (if available).

Syntax

__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (OIDC Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (OIDC Component)

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

Syntax

__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (OIDC Component)

The public key of the certificate.

Syntax

__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (OIDC Component)

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

Syntax

__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (OIDC Component)

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

Syntax

__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (OIDC Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (OIDC Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStore Property (OIDC Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLServerCertStore = { read=FSSLServerCertStore };
__property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Byte Array

SSLServerCertStorePassword Property (OIDC Component)

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

Syntax

__property String SSLServerCertStorePassword = { read=FSSLServerCertStorePassword };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (OIDC Component)

The type of certificate store for this certificate.

Syntax

__property TciOIDCSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };

enum TciOIDCSSLServerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (OIDC Component)

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

Syntax

__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (OIDC Component)

The MD5 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (OIDC Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (OIDC Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertUsage Property (OIDC Component)

The text description of UsageFlags .

Syntax

__property String SSLServerCertUsage = { read=FSSLServerCertUsage };

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

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

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

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

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (OIDC Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };

Default Value

0

Remarks

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

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (OIDC Component)

The certificate's version number.

Syntax

__property String SSLServerCertVersion = { read=FSSLServerCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertSubject Property (OIDC Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLServerCertSubject = { read=FSSLServerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (OIDC Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

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

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

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

Data Type

Byte Array

State Property (OIDC Component)

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

Syntax

__property String State = { read=FState, write=FSetState };

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

The timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

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.

Data Type

Integer

TransferredData Property (OIDC Component)

The contents of the last response from the server.

Syntax

__property String TransferredData = { read=FTransferredData };
__property DynamicArray<Byte> TransferredDataB = { read=FTransferredDataB };

Default Value

""

Remarks

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

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

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

Data Type

Byte Array

TransferredHeaders Property (OIDC Component)

The full set of headers as received from the server.

Syntax

__property String TransferredHeaders = { read=FTransferredHeaders };

Default Value

""

Remarks

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

The Header event shows the individual headers as parsed by the component.

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

Data Type

String

UseNonce Property (OIDC Component)

Whether the Nonce parameter is added.

Syntax

__property bool UseNonce = { read=FUseNonce, write=FSetUseNonce };

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.

Data Type

Boolean

UsePKCE Property (OIDC Component)

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

Syntax

__property bool UsePKCE = { read=FUsePKCE, write=FSetUsePKCE };

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 GetAuthorizationURL is called. This applies when GrantType is set to the Authorization Code or Hybrid grant types. Typically, a new instance of the component will be used to process the request from the authorization server than the one used to create the request to the authorization server. To verify the request from the authorization server, the PKCEVerifier will need to be saved in a safe location. Then before handling the request from the authorization server, the PKCEVerifier should be set to the saved value.

Data Type

Boolean

UserDetailsAddrCountry Property (OIDC Component)

The country name portion of the user's address.

Syntax

__property String UserDetailsAddrCountry = { read=FUserDetailsAddrCountry };

Default Value

""

Remarks

The country name portion of the user's address.

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

Data Type

String

UserDetailsAddrFormatted Property (OIDC Component)

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

Syntax

__property String UserDetailsAddrFormatted = { read=FUserDetailsAddrFormatted };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsAddrLocality Property (OIDC Component)

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

Syntax

__property String UserDetailsAddrLocality = { read=FUserDetailsAddrLocality };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsAddrPostalCode Property (OIDC Component)

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

Syntax

__property String UserDetailsAddrPostalCode = { read=FUserDetailsAddrPostalCode };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsAddrRegion Property (OIDC Component)

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

Syntax

__property String UserDetailsAddrRegion = { read=FUserDetailsAddrRegion };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsAddrStreetAddr Property (OIDC Component)

The street address portion of the user's address.

Syntax

__property String UserDetailsAddrStreetAddr = { read=FUserDetailsAddrStreetAddr };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsBirthday Property (OIDC Component)

The user's birthday.

Syntax

__property String UserDetailsBirthday = { read=FUserDetailsBirthday };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsEmail Property (OIDC Component)

The user's preferred email address.

Syntax

__property String UserDetailsEmail = { read=FUserDetailsEmail };

Default Value

""

Remarks

The user's preferred email address.

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

Data Type

String

UserDetailsEmailVerified Property (OIDC Component)

Whether the user's email address has been verified.

Syntax

__property bool UserDetailsEmailVerified = { read=FUserDetailsEmailVerified };

Default Value

false

Remarks

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

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

Data Type

Boolean

UserDetailsFirstName Property (OIDC Component)

The first name of the user.

Syntax

__property String UserDetailsFirstName = { read=FUserDetailsFirstName };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsGender Property (OIDC Component)

The user's gender.

Syntax

__property String UserDetailsGender = { read=FUserDetailsGender };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsLastName Property (OIDC Component)

The last name of the user.

Syntax

__property String UserDetailsLastName = { read=FUserDetailsLastName };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsLocale Property (OIDC Component)

The end user's locale.

Syntax

__property String UserDetailsLocale = { read=FUserDetailsLocale };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsMiddleName Property (OIDC Component)

The middle name of the user.

Syntax

__property String UserDetailsMiddleName = { read=FUserDetailsMiddleName };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsName Property (OIDC Component)

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

Syntax

__property String UserDetailsName = { read=FUserDetailsName };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsNickname Property (OIDC Component)

The casual name of the user.

Syntax

__property String UserDetailsNickname = { read=FUserDetailsNickname };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsPhoneNumber Property (OIDC Component)

The user's phone number.

Syntax

__property String UserDetailsPhoneNumber = { read=FUserDetailsPhoneNumber };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsPhoneNumberVerified Property (OIDC Component)

Whether the user's phone number has been verified.

Syntax

__property bool UserDetailsPhoneNumberVerified = { read=FUserDetailsPhoneNumberVerified };

Default Value

false

Remarks

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

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

Data Type

Boolean

UserDetailsPictureURL Property (OIDC Component)

The URL of the user's profile picture.

Syntax

__property String UserDetailsPictureURL = { read=FUserDetailsPictureURL };

Default Value

""

Remarks

The URL of the user's profile picture.

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

Data Type

String

UserDetailsPreferredUsername Property (OIDC Component)

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

Syntax

__property String UserDetailsPreferredUsername = { read=FUserDetailsPreferredUsername };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsProfileURL Property (OIDC Component)

The URL of the user's profile page.

Syntax

__property String UserDetailsProfileURL = { read=FUserDetailsProfileURL };

Default Value

""

Remarks

The URL of the user's profile page.

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

Data Type

String

UserDetailsSubject Property (OIDC Component)

The subject of the user that is being represented.

Syntax

__property String UserDetailsSubject = { read=FUserDetailsSubject };

Default Value

""

Remarks

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

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

Data Type

String

UserDetailsUpdatedAt Property (OIDC Component)

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

Syntax

__property __int64 UserDetailsUpdatedAt = { read=FUserDetailsUpdatedAt };

Default Value

0

Remarks

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

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

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

Data Type

Long64

UserDetailsWebsite Property (OIDC Component)

The URL of the user's website.

Syntax

__property String UserDetailsWebsite = { read=FUserDetailsWebsite };

Default Value

""

Remarks

The URL of the user's website.

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

Data Type

String

UserDetailsZoneInfo Property (OIDC Component)

The user's time zone.

Syntax

__property String UserDetailsZoneInfo = { read=FUserDetailsZoneInfo };

Default Value

""

Remarks

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

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

Data Type

String

AddParam Method (OIDC Component)

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

Syntax

void __fastcall AddParam(String ParamName, String ParamValue);

Remarks

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

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

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

Config Method (OIDC Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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

This method processes events from the internal message queue.

Syntax

void __fastcall 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.

GetAuthorizationURL Method (OIDC Component)

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

Syntax

String __fastcall GetAuthorizationURL();

Remarks

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

• AuthorizationScope (Required)
• ClientId (Required)
• GrantType (Required)
• ReturnURL (Required)
• UsePKCE (Optional)
• Display (Optional)
• IDTokenHint (Optional)
• LoginHint (Optional)
• Prompt (Optional)
• ResponseType (Optional)

GetDiscoveryMetadata Method (OIDC Component)

Gets a specific metadata value from the discovery document.

Syntax

String __fastcall GetDiscoveryMetadata(String metadataName);

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 oidc.GetDiscoveryMetadata("authorization_endpoint");

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

GetIdTokenClaim Method (OIDC Component)

Gets a specific claim from the ID Token.

Syntax

String __fastcall GetIdTokenClaim(String claimName);

Remarks

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

Claim Name oidc.GetIdTokenClaim("aud");

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

GetQueryParam Method (OIDC Component)

Gets a specific claim from the current HTTP request.

Syntax

String __fastcall GetQueryParam(String paramName);

Remarks

This method searches the current context (after ProcessOIDCResponse or ParseOIDCResponse is called) or the OIDCResponseHeaders property for a specific query parameter and returns the value. 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.

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

GetUserInfoClaim Method (OIDC Component)

Gets a specific claim from the UserInfo response.

Syntax

String __fastcall GetUserInfoClaim(String claimName);

Remarks

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

Claim Name oidc.GetUserInfoClaim("aud");

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

Interrupt Method (OIDC Component)

This method interrupts the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

LoadDiscoveryDoc Method (OIDC Component)

Loads in a raw discovery document.

Syntax

void __fastcall LoadDiscoveryDoc(String documentData);

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

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

Syntax

void __fastcall LoadSignerJWKS(String jwksData);

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 DiscoveryDocDetailsSignerCertURL endpoint. Typically, this will be used to reload a JWKS that we previously requested by the RequestSignerCerts method.

ParseIdToken Method (OIDC Component)

Parses an ID Token.

Syntax

void __fastcall 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 IdTokenIdTokenContent property or by calling the ParseOIDCResponse, ProcessOIDCResponse, or RequestTokens methods. Typically, the component will automatically validate and parse an ID Token if it is found. The exception is if the ParseOIDCResponse method is called which will only set the IdTokenIdTokenContent property. See ValidateIdToken for information on validating an ID Token.

ParseOIDCResponse Method (OIDC Component)

Parses the current OIDC Response without additional processing.

Syntax

void __fastcall ParseOIDCResponse();

Remarks

This method parses the OIDC Response from the current HTTP request and, if applicable, parses the ID Token, authorization code, or error information from it, populating the IdTokenIdTokenContent, AuthorizationCode, and AuthzResponseCode properties respectively. Unlike the ProcessOIDCResponse method, this method will not do any additional processing. Typically, this method is used with others like RequestSignerCerts, ValidateIdToken, ParseIdToken, and RequestTokens.

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

ProcessOIDCResponse Method (OIDC Component)

Processes the current OIDC response.

Syntax

void __fastcall ProcessOIDCResponse();

Remarks

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

• ParseOIDCResponse
• RequestTokens
• RequestSignerCerts (if SignerCerts is not set)
• ValidateIdToken
• ParseIdToken

RequestDiscoveryDoc Method (OIDC Component)

Requests the OpenID Discovery Document.

Syntax

void __fastcall RequestDiscoveryDoc(String URL);

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 DiscoveryDocDetailsContent 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 (OIDC Component)

Requests the signing certificates from the OpenID provider.

Syntax

void __fastcall RequestSignerCerts();

Remarks

This method makes a request to the DiscoveryDocDetailsSignerCertURL 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.

RequestTokens Method (OIDC Component)

Requests new tokens from the token server.

Syntax

void __fastcall RequestTokens();

Remarks

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

If an ID Token is returned, the component will automatically attempt to verify it using the values specified by the DiscoveryDocDetails, ClientId, and SignerCerts properties. If verification is successful, it will then attempt to parse the ID Token. See ValidateIdToken and ParseIdToken for more information.

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

RequestUserInfo Method (OIDC Component)

Requests the information of a user.

Syntax

void __fastcall 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 DiscoveryDocDetailsUserInfoURL 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 (OIDC Component)

This method will reset the component.

Syntax

void __fastcall Reset();

Remarks

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

ValidateIdToken Method (OIDC Component)

Validates an ID Token.

Syntax

void __fastcall ValidateIdToken();

Remarks

This method validates the current ID Token. The ID Token can be populated directly by setting the IdTokenIdTokenContent property or by calling the ParseOIDCResponse, ProcessOIDCResponse, or RequestTokens methods. Typically, the component will automatically validate and parse an ID Token if it is found. The exception is if the ParseOIDCResponse method is called which will only set the IdTokenIdTokenContent property.

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 DiscoveryDocDetailsSignerCertURL property or the ServerSignerCertURL configuration setting if set. This is equivalent to calling the RequestSignerCerts method.

Then, the component will verify that the IdTokenIssuer property matches what is expected in the DiscoveryDocDetailsIssuer property. Next, the IdTokenAudiences 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 IdTokenIssuedTime and IdTokenExpTime 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 (OIDC Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TciOIDCErrorEventParams;
typedef void __fastcall (__closure *TciOIDCErrorEvent)(System::TObject* Sender, TciOIDCErrorEventParams *e);
__property TciOIDCErrorEvent OnError = { 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.

Log Event (OIDC Component)

Fired once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TciOIDCLogEventParams;
typedef void __fastcall (__closure *TciOIDCLogEvent)(System::TObject* Sender, TciOIDCLogEventParams *e);
__property TciOIDCLogEvent OnLog = { 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 (OIDC Component)

Fired when a redirection is received from the server.

Syntax

typedef struct {
  String Location;
  bool Accept;
} TciOIDCRedirectEventParams;
typedef void __fastcall (__closure *TciOIDCRedirectEvent)(System::TObject* Sender, TciOIDCRedirectEventParams *e);
__property TciOIDCRedirectEvent OnRedirect = { 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 (OIDC Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TciOIDCSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TciOIDCSSLServerAuthenticationEvent)(System::TObject* Sender, TciOIDCSSLServerAuthenticationEventParams *e);
__property TciOIDCSSLServerAuthenticationEvent OnSSLServerAuthentication = { 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 (OIDC Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TciOIDCSSLStatusEventParams;
typedef void __fastcall (__closure *TciOIDCSSLStatusEvent)(System::TObject* Sender, TciOIDCSSLStatusEventParams *e);
__property TciOIDCSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Config Settings (OIDC Component)

OIDC Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (OIDC Component)

OIDC Errors

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