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

nsoftware.CloudSSO.OIDC

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 fields 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 Content field 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 collection. If the SignerCerts collection 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

To get authorization from an OpenID Provider, the user will need to be directed to the authorization server using an Authorization URL. There, the user will be asked to login and give authorization for (or consent to) the OpenID provider giving access to the specified information within the scope set by the Relying Party.

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

Once the authorization process has been completed, the OpenID Provider will redirect the user back to the Relying Party. Depending on the response_type set by the Relying Party, the redirect may contain any combination of an ID Token, an access token, or an authorization code. Once the user has been redirected back to the Relying Party, the request must be parsed to obtain the information from the OpenID Provider.

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. By default, these methods will attempt to read the OIDC response from the HTTP headers and body found in the current HttpContext.

ASP.NET Core Notes

The component may be used within any .NET Standard-compatible platform, including .NET Core and ASP.NET Core. When using OIDC within an ASP.NET Core application, the component can be configured to automatically read from the request context and send using the response context. To do so, pass the HttpContext to the constructor of the OIDC class. For instance: OIDC oidc = new OIDC(HttpContext);

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

Once the Relying Party has an authorization code, the code can be used to obtain an ID Token and access token from the token server. Like when building the Authorization URL, the component will need to be configured again. Along with the other information, this step sometimes requires that a client secret be provided if it can be stored securely.

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:


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

Usage: Validate and Parse an ID Token

In a case where an ID Token is provided directly to the 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 fields 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.


AccessToken	The access token received from an OpenID provider.
AuthorizationScope	The authorization scope used during authorization.
AuthzResponseCode	The error code from a recently parsed HTTP request.
AuthzResponseDesc	The error description from a recently parsed HTTP request.
ClientId	The Id of the client assigned when registering the application.
ClientSecret	The secret value for the client assigned when registering the application.
DiscoveryDocDetails	Details about the OpenID provider's discovery document.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
GrantType	The grant type defining the authentication flow.
IdTokenInfo	Information about the current ID Token.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OIDCResponseBody	The HTTP body of an OIDC response.
OIDCResponseHeaders	The HTTP headers of an OIDC Response.
OtherHeaders	Other headers as determined by the user (optional).
Params	The parameters to be included in the request to the authorization server or received in the response.
Proxy	A set of properties related to proxy access.
RefreshToken	The refresh token received from or sent to the token server.
ReturnURL	The URL where the user (browser) returns after authorization.
SignerCerts	The signing certificates from an OpenID provider.
SignerJWKS	The JSON Web Key Set provided by an OpenID provider.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
State	An opaque value used to maintain state between the request and response.
Timeout	The timeout for the component.
TransferredData	The contents of the last response from the server.
TransferredHeaders	The full set of headers as received from the server.
UseNonce	Whether the Nonce parameter is added.
UsePKCE	Whether Proof Key for Code Exchange (PKCE) should be used.
UserDetails	The claims about the user.

Method List

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


AddParam	Adds a name-value pair to the query string parameters of the outgoing request.
Config	Sets or retrieves a configuration setting.
DoEvents	This method processes events from the internal message queue.
GetAuthorizationURL	Builds the URL for an OpenID provider's authorization server.
GetDiscoveryMetadata	Gets a specific metadata value from the discovery document.
GetIdTokenClaim	Gets a specific claim from the ID Token.
GetQueryParam	Gets a specific claim from the current HTTP request.
GetUserInfoClaim	Gets a specific claim from the UserInfo response.
Interrupt	This method interrupts the current method.
LoadDiscoveryDoc	Loads in a raw discovery document.
LoadSignerJWKS	Loads in the signer JWKS directly from a raw JWKS blob.
ParseIdToken	Parses an ID Token.
ParseOIDCResponse	Parses the current OIDC Response without additional processing.
ProcessOIDCResponse	Processes the current OIDC response.
RequestDiscoveryDoc	Requests the OpenID Discovery Document.
RequestSignerCerts	Requests the signing certificates from the OpenID provider.
RequestTokens	Requests new tokens from the token server.
RequestUserInfo	Requests the information of a user.
Reset	This method will reset the component.
ValidateIdToken	Validates an ID Token.

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.


Error	Fired when information is available about errors during data delivery.
Log	Fired once for each log message.
Redirect	Fired when a redirection is received from the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.

Config Settings

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


AccessTokenExp	The expiration date for the access token.
AuthErrorURI	The URI that provides more information about the authorization error.
AuthorizationCode	The authorization code to be exchanged with the token server.
Display	The requested display options to present to the end user.
ExpectedAudience	The expected audience when validating an ID Token.
ExpectedIssuer	The expected Issuer when validating an ID Token.
IDTokenHint	An ID Token value to be used as a hint about the user's session.
IdTokenVerificationFlags	The checks that are ignored when validating an ID Token.
LoginHint	The login hint sent to the authorization server.
Nonce	The nonce value that is used to verify an ID Token.
PKCEVerifier	The PKCE verifier used to generate the challenge.
ProcessedRequestType	The type of request that was processed or parsed.
Prompt	The requested conditions under which the authorization server prompts for login.
ResponseType	The value of the response_type request parameter.
ServerAuthURL	The URL of the authorization server.
ServerSignerCertURL	The URL of the signer certificate server.
ServerTokenURL	The URL of the token server.
ServerUserInfoURL	The URL of the UserInfo server.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallback	Whether to allow fallback from Negotiate to NTLM when authenticating.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformDeflate	Whether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (TCPClient only).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
UseNTLMv2	Whether to use NTLM V2.
CACertFilePaths	The paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

AccessToken Property (OIDC Component)

The access token received from an OpenID provider.

public string AccessToken { get; set; }

Public Property AccessToken As String

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 UserInfoURL 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 TokenURL. When ResponseType contains token (ogtAuthorizationCode and ogtHybrid), the AccessToken is provided by the AuthorizationURL.

AuthorizationScope Property (OIDC Component)

The authorization scope used during authorization.

Syntax

C#
VB.NET

public string AuthorizationScope { get; set; }

Public Property AuthorizationScope As String

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.

AuthzResponseCode Property (OIDC Component)

The error code from a recently parsed HTTP request.

Syntax

C#
VB.NET

public string AuthzResponseCode { get; }

Public ReadOnly Property AuthzResponseCode As String

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.

AuthzResponseDesc Property (OIDC Component)

The error description from a recently parsed HTTP request.

Syntax

C#
VB.NET

public string AuthzResponseDesc { get; }

Public ReadOnly Property AuthzResponseDesc As String

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.

ClientId Property (OIDC Component)

The Id of the client assigned when registering the application.

Syntax

C#
VB.NET

public string ClientId { get; set; }

Public Property ClientId As String

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 Audiences field of an ID Token when calling the ValidateIdToken, ProcessOIDCResponse, and possibly RequestTokens methods.

ClientSecret Property (OIDC Component)

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

Syntax

C#
VB.NET

public string ClientSecret { get; set; }

Public Property ClientSecret As String

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.

DiscoveryDocDetails Property (OIDC Component)

Details about the OpenID provider's discovery document.

Syntax

C#
VB.NET

public DiscoveryDocDetails DiscoveryDocDetails { get; }

Public ReadOnly Property DiscoveryDocDetails As DiscoveryDocDetails

Remarks

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

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

Please refer to the DiscoveryDocDetails type for a complete list of fields.

Firewall Property (OIDC Component)

A set of properties related to firewall access.

Syntax

C#
VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

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

Please refer to the Firewall type for a complete list of fields.

FollowRedirects Property (OIDC Component)

Determines what happens when the server issues a redirect.

Syntax

C#
VB.NET

public OIDCFollowRedirects FollowRedirects { get; set; }

enum OIDCFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}

Public Property FollowRedirects As OidcFollowRedirects

Enum OIDCFollowRedirects
  frNever
  frAlways
  frSameScheme
End Enum

Default Value

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 throws 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 throws an exception instead.

GrantType Property (OIDC Component)

The grant type defining the authentication flow.

Syntax

C#
VB.NET

public OIDCGrantTypes GrantType { get; set; }

enum OIDCGrantTypes {
  ogtAuthorizationCode,
  ogtImplicit,
  ogtHybrid
}

Public Property GrantType As OidcGrantTypes

Enum OIDCGrantTypes
  ogtAuthorizationCode
  ogtImplicit
  ogtHybrid
End Enum

Default Value

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.

IdTokenInfo Property (OIDC Component)

Information about the current ID Token.

Syntax

C#
VB.NET

public IdTokenInfo IdTokenInfo { get; }

Public ReadOnly Property IdTokenInfo As IdTokenInfo

Remarks

This property holds details about the ID Token.

When an ID Token is parsed either by calling ParseIdToken or retrieved after calling ProcessOIDCResponse or RequestTokens, this property is populated with the claims that are specific to the ID Token.

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

Please refer to the IdTokenInfo type for a complete list of fields.

LocalHost Property (OIDC Component)

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

Syntax

C#
VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

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.

OIDCResponseBody Property (OIDC Component)

The HTTP body of an OIDC response.

Syntax

C#
VB.NET

public string OIDCResponseBody { get; set; }

Public Property OIDCResponseBody As String

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.

OIDCResponseHeaders Property (OIDC Component)

The HTTP headers of an OIDC Response.

Syntax

C#
VB.NET

public string OIDCResponseHeaders { get; set; }

Public Property OIDCResponseHeaders As String

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.

OtherHeaders Property (OIDC Component)

Other headers as determined by the user (optional).

Syntax

C#
VB.NET

public string OtherHeaders { get; set; }

Public Property OtherHeaders As String

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.

Params Property (OIDC Component)

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

Syntax

C#
VB.NET

public OAuthParamList Params { get; }

Public Property Params As OAuthParamList

Remarks

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

This property is not available at design time.

Please refer to the OAuthParam type for a complete list of fields.

Proxy Property (OIDC Component)

A set of properties related to proxy access.

Syntax

C#
VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

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

Please refer to the Proxy type for a complete list of fields.

RefreshToken Property (OIDC Component)

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

Syntax

C#
VB.NET

public string RefreshToken { get; set; }

Public Property RefreshToken As String

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.

ReturnURL Property (OIDC Component)

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

Syntax

C#
VB.NET

public string ReturnURL { get; set; }

Public Property ReturnURL As String

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.

SignerCerts Property (OIDC Component)

The signing certificates from an OpenID provider.

Syntax

C#
VB.NET

public CertificateList SignerCerts { get; }

Public ReadOnly Property SignerCerts As CertificateList

Remarks

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

The collection can be automatically populated when needed if it is empty and a SignerCertURL is available. This can happen when calling ParseOIDCResponse or ProcessOIDCResponse if the response type includes id_token, when calling RequestTokens or ProcessOIDCResponse if the token server returns an ID Token, or when calling ValidateIdToken.

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

Please refer to the Certificate type for a complete list of fields.

SignerJWKS Property (OIDC Component)

The JSON Web Key Set provided by an OpenID provider.

Syntax

C#
VB.NET

public string SignerJWKS { get; }

Public ReadOnly Property SignerJWKS As String

Default Value

Remarks

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

Typically, this is returned from the SignerCertURL when the component makes a request to populate the SignerCerts collection. The RequestSignerCerts method can be used to manually make a request to the SignerCertURL; otherwise, the component will automatically make the request if the collection is not set and it needs the certificates to validate an ID Token.

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

This property is read-only.

SSLAcceptServerCert Property (OIDC Component)

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

Syntax

C#
VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

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

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

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

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (OIDC Component)

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

Syntax

C#
VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (OIDC Component)

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

Syntax

C#
VB.NET

public OIDCSSLProviders SSLProvider { get; set; }

enum OIDCSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As OidcSSLProviders

Enum OIDCSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

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:


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

Additional Notes

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

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

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (OIDC Component)

The server certificate for the last established connection.

Syntax

C#
VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

State Property (OIDC Component)

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

Syntax

C#
VB.NET

public string State { get; set; }

Public Property State As String

Default Value

Remarks

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

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

Timeout Property (OIDC Component)

The timeout for the component.

Syntax

C#
VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

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

TransferredData Property (OIDC Component)

The contents of the last response from the server.

Syntax

C#
VB.NET

public string TransferredData { get; }
public byte[] TransferredDataB { get; }

Public ReadOnly Property TransferredData As String
Public ReadOnly Property TransferredDataB As Byte()

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.

TransferredHeaders Property (OIDC Component)

The full set of headers as received from the server.

Syntax

C#
VB.NET

public string TransferredHeaders { get; }

Public ReadOnly Property TransferredHeaders As String

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.

UseNonce Property (OIDC Component)

Whether the Nonce parameter is added.

Syntax

C#
VB.NET

public bool UseNonce { get; set; }

Public Property UseNonce As Boolean

Default Value

False

Remarks

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

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

UsePKCE Property (OIDC Component)

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

Syntax

C#
VB.NET

public bool UsePKCE { get; set; }

Public Property UsePKCE As Boolean

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.

UserDetails Property (OIDC Component)

The claims about the user.

Syntax

C#
VB.NET

public UserDetails UserDetails { get; }

Public ReadOnly Property UserDetails As UserDetails

Remarks

This property holds details about the user.

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

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

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

Please refer to the UserDetails type for a complete list of fields.

AddParam Method (OIDC Component)

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

Syntax

C#
VB.NET

public void AddParam(string paramName, string paramValue);

Async Version
public async Task AddParam(string paramName, string paramValue);
public async Task AddParam(string paramName, string paramValue, CancellationToken cancellationToken);

Public Sub AddParam(ByVal ParamName As String, ByVal ParamValue As String)

Async Version
Public Sub AddParam(ByVal ParamName As String, ByVal ParamValue As String) As Task
Public Sub AddParam(ByVal ParamName As String, ByVal ParamValue As String, cancellationToken As CancellationToken) As Task

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

C#
VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

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

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

DoEvents Method (OIDC Component)

This method processes events from the internal message queue.

Syntax

C#
VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

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

C#
VB.NET

public string GetAuthorizationURL();

Async Version
public async Task<string> GetAuthorizationURL();
public async Task<string> GetAuthorizationURL(CancellationToken cancellationToken);

Public Function GetAuthorizationURL() As String

Async Version
Public Function GetAuthorizationURL() As Task(Of String)
Public Function GetAuthorizationURL(cancellationToken As CancellationToken) As Task(Of String)

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

C#
VB.NET

public string GetDiscoveryMetadata(string metadataName);

Async Version
public async Task<string> GetDiscoveryMetadata(string metadataName);
public async Task<string> GetDiscoveryMetadata(string metadataName, CancellationToken cancellationToken);

Public Function GetDiscoveryMetadata(ByVal metadataName As String) As String

Async Version
Public Function GetDiscoveryMetadata(ByVal metadataName As String) As Task(Of String)
Public Function GetDiscoveryMetadata(ByVal metadataName As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

Metadata Name oidc.GetDiscoveryMetadata("authorization_endpoint");

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

GetIdTokenClaim Method (OIDC Component)

Gets a specific claim from the ID Token.

Syntax

C#
VB.NET

public string GetIdTokenClaim(string claimName);

Async Version
public async Task<string> GetIdTokenClaim(string claimName);
public async Task<string> GetIdTokenClaim(string claimName, CancellationToken cancellationToken);

Public Function GetIdTokenClaim(ByVal claimName As String) As String

Async Version
Public Function GetIdTokenClaim(ByVal claimName As String) As Task(Of String)
Public Function GetIdTokenClaim(ByVal claimName As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

Claim Name oidc.GetIdTokenClaim("aud");

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

GetQueryParam Method (OIDC Component)

Gets a specific claim from the current HTTP request.

Syntax

C#
VB.NET

public string GetQueryParam(string paramName);

Async Version
public async Task<string> GetQueryParam(string paramName);
public async Task<string> GetQueryParam(string paramName, CancellationToken cancellationToken);

Public Function GetQueryParam(ByVal paramName As String) As String

Async Version
Public Function GetQueryParam(ByVal paramName As String) As Task(Of String)
Public Function GetQueryParam(ByVal paramName As String, cancellationToken As CancellationToken) As Task(Of String)

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

C#
VB.NET

public string GetUserInfoClaim(string claimName);

Async Version
public async Task<string> GetUserInfoClaim(string claimName);
public async Task<string> GetUserInfoClaim(string claimName, CancellationToken cancellationToken);

Public Function GetUserInfoClaim(ByVal claimName As String) As String

Async Version
Public Function GetUserInfoClaim(ByVal claimName As String) As Task(Of String)
Public Function GetUserInfoClaim(ByVal claimName As String, cancellationToken As CancellationToken) As Task(Of String)

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

C#
VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

LoadDiscoveryDoc Method (OIDC Component)

Loads in a raw discovery document.

Syntax

C#
VB.NET

public void LoadDiscoveryDoc(string documentData);

Async Version
public async Task LoadDiscoveryDoc(string documentData);
public async Task LoadDiscoveryDoc(string documentData, CancellationToken cancellationToken);

Public Sub LoadDiscoveryDoc(ByVal documentData As String)

Async Version
Public Sub LoadDiscoveryDoc(ByVal documentData As String) As Task
Public Sub LoadDiscoveryDoc(ByVal documentData As String, cancellationToken As CancellationToken) As Task

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

C#
VB.NET

public void LoadSignerJWKS(string jwksData);

Async Version
public async Task LoadSignerJWKS(string jwksData);
public async Task LoadSignerJWKS(string jwksData, CancellationToken cancellationToken);

Public Sub LoadSignerJWKS(ByVal jwksData As String)

Async Version
Public Sub LoadSignerJWKS(ByVal jwksData As String) As Task
Public Sub LoadSignerJWKS(ByVal jwksData As String, cancellationToken As CancellationToken) As Task

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

ParseIdToken Method (OIDC Component)

Parses an ID Token.

Syntax

C#
VB.NET

public void ParseIdToken();

Async Version
public async Task ParseIdToken();
public async Task ParseIdToken(CancellationToken cancellationToken);

Public Sub ParseIdToken()

Async Version
Public Sub ParseIdToken() As Task
Public Sub ParseIdToken(cancellationToken As CancellationToken) As Task

Remarks

This method parses the current ID Token. If the method is able to successfully parse the ID Token, it will populate the IdTokenInfo and UserDetails properties. Any uncommon or custom claims can be retrieved by calling the GetIdTokenClaim method. The ID Token can be populated directly by setting the IdTokenContent field 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 IdTokenContent field. See ValidateIdToken for information on validating an ID Token.

ParseOIDCResponse Method (OIDC Component)

Parses the current OIDC Response without additional processing.

Syntax

C#
VB.NET

public void ParseOIDCResponse();

Async Version
public async Task ParseOIDCResponse();
public async Task ParseOIDCResponse(CancellationToken cancellationToken);

Public Sub ParseOIDCResponse()

Async Version
Public Sub ParseOIDCResponse() As Task
Public Sub ParseOIDCResponse(cancellationToken As CancellationToken) As Task

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

C#
VB.NET

public void ProcessOIDCResponse();

Async Version
public async Task ProcessOIDCResponse();
public async Task ProcessOIDCResponse(CancellationToken cancellationToken);

Public Sub ProcessOIDCResponse()

Async Version
Public Sub ProcessOIDCResponse() As Task
Public Sub ProcessOIDCResponse(cancellationToken As CancellationToken) As Task

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

If an ID Token is returned from both the initial OIDC response from the authorization server and from the token server, both ID Tokens will be validated, but the ID Token from the token server will be used. The HTTP request is taken directly from the OIDCResponseHeaders and OIDCResponseBody properties if set; otherwise, it will try to read the HTTP context.

RequestDiscoveryDoc Method (OIDC Component)

Requests the OpenID Discovery Document.

Syntax

C#
VB.NET

public void RequestDiscoveryDoc(string URL);

Async Version
public async Task RequestDiscoveryDoc(string URL);
public async Task RequestDiscoveryDoc(string URL, CancellationToken cancellationToken);

Public Sub RequestDiscoveryDoc(ByVal URL As String)

Async Version
Public Sub RequestDiscoveryDoc(ByVal URL As String) As Task
Public Sub RequestDiscoveryDoc(ByVal URL As String, cancellationToken As CancellationToken) As Task

Remarks

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

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

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

Call RequestDiscoveryDoc before calling GetAuthorizationURL to populate the component properties with information required to request authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method, the DiscoveryDocDetails property is populated. The Content field 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

C#
VB.NET

public void RequestSignerCerts();

Async Version
public async Task RequestSignerCerts();
public async Task RequestSignerCerts(CancellationToken cancellationToken);

Public Sub RequestSignerCerts()

Async Version
Public Sub RequestSignerCerts() As Task
Public Sub RequestSignerCerts(cancellationToken As CancellationToken) As Task

Remarks

This method makes a request to the SignerCertURL to get the current signer certificates for the OpenID provider. The OpenID provider will return a JSON Web Key Set (JWKS) that represents the set of signing certificates that might be used when signing ID Tokens. The component will automatically populate the SignerCerts collection 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

C#
VB.NET

public void RequestTokens();

Async Version
public async Task RequestTokens();
public async Task RequestTokens(CancellationToken cancellationToken);

Public Sub RequestTokens()

Async Version
Public Sub RequestTokens() As Task
Public Sub RequestTokens(cancellationToken As CancellationToken) As Task

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 TokenURL field or the ServerTokenURL configuration setting if either has been set.

RequestUserInfo Method (OIDC Component)

Requests the information of a user.

Syntax

C#
VB.NET

public void RequestUserInfo();

Async Version
public async Task RequestUserInfo();
public async Task RequestUserInfo(CancellationToken cancellationToken);

Public Sub RequestUserInfo()

Async Version
Public Sub RequestUserInfo() As Task
Public Sub RequestUserInfo(cancellationToken As CancellationToken) As Task

Remarks

This method makes a request to get a specific user's info based on the current AccessToken. The request is made to the UserInfo endpoint which is defined by the UserInfoURL field 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 fields 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

C#
VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

ValidateIdToken Method (OIDC Component)

Validates an ID Token.

Syntax

C#
VB.NET

public void ValidateIdToken();

Async Version
public async Task ValidateIdToken();
public async Task ValidateIdToken(CancellationToken cancellationToken);

Public Sub ValidateIdToken()

Async Version
Public Sub ValidateIdToken() As Task
Public Sub ValidateIdToken(cancellationToken As CancellationToken) As Task

Remarks

This method validates the current ID Token. The ID Token can be populated directly by setting the IdTokenContent field 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 IdTokenContent field.

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

Then, the component will verify that the Issuer field matches what is expected in the Issuer field. Next, the Audiences will be checked to ensure that it matches the ClientId property. The ExpectedIssuer and ExpectedAudience configuration settings can be used to override the typical expected values. The last check is to ensure that the IssuedTime and ExpTime are valid based on the current time. Additionally, if the nbf (Not Before) claim is present, that will also be verified.

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

Error Event (OIDC Component)

Fired when information is available about errors during data delivery.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, OIDCErrorEventArgs e);

public class OIDCErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As OIDCErrorEventArgs)

Public Class OIDCErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws 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

C#
VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, OIDCLogEventArgs e);

public class OIDCLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As OIDCLogEventArgs)

Public Class OIDCLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

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:


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

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

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

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

Message is the log entry.

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

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

Redirect Event (OIDC Component)

Fired when a redirection is received from the server.

Syntax

C#
VB.NET

public event OnRedirectHandler OnRedirect;

public delegate void OnRedirectHandler(object sender, OIDCRedirectEventArgs e);

public class OIDCRedirectEventArgs : EventArgs {
  public string Location { get; }
  public bool Accept { get; set; }
}

Public Event OnRedirect As OnRedirectHandler

Public Delegate Sub OnRedirectHandler(sender As Object, e As OIDCRedirectEventArgs)

Public Class OIDCRedirectEventArgs Inherits EventArgs
  Public ReadOnly Property Location As String
  Public Property Accept As Boolean
End Class

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

C#
VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, OIDCSSLServerAuthenticationEventArgs e);

public class OIDCSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As OIDCSSLServerAuthenticationEventArgs)

Public Class OIDCSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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

C#
VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, OIDCSSLStatusEventArgs e);

public class OIDCSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As OIDCSSLStatusEventArgs)

Public Class OIDCSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

Certificate Type

This is the digital certificate being used.

Remarks

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

The following fields are available:

Fields

EffectiveDate
string (read-only)
Default: ""

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

23-Jan-2000 15:00:00.

ExpirationDate
string (read-only)
Default: ""

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

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string (read-only)
Default: ""

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

Fingerprint
string (read-only)
Default: ""

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

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

FingerprintSHA1
string (read-only)
Default: ""

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

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

FingerprintSHA256
string (read-only)
Default: ""

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

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

Issuer
string (read-only)
Default: ""

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

PrivateKey
string (read-only)
Default: ""

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

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

PrivateKeyAvailable
bool (read-only)
Default: False

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

PrivateKeyContainer
string (read-only)
Default: ""

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

PublicKey
string (read-only)
Default: ""

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

PublicKeyAlgorithm
string (read-only)
Default: ""

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

PublicKeyLength
int (read-only)
Default: 0

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

SerialNumber
string (read-only)
Default: ""

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

SignatureAlgorithm
string (read-only)
Default: ""

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

Store
string
Default: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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


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

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

StoreB
byte []
Default: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Designations of certificate stores are platform dependent.

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


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

StorePassword
string
Default: ""

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

StoreType
CertStoreTypes
Default: 0

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CERTMGR component. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
string (read-only)
Default: ""

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

ThumbprintMD5
string (read-only)
Default: ""

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

ThumbprintSHA1
string (read-only)
Default: ""

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

ThumbprintSHA256
string (read-only)
Default: ""

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

Usage
string (read-only)
Default: ""

The text description of UsageFlags.

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

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

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

UsageFlags
int (read-only)
Default: 0

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


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

Please see the Usage field for a text representation of UsageFlags.

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

Version
string (read-only)
Default: ""

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

Subject
string
Default: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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:


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

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

Encoded
string
Default: ""

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

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

EncodedB
byte []
Default: ""

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

Constructors

C#
VB.NET

public Certificate();

Public Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

C#
VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

C#
VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

Parses Encoded as an X.509 public key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

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

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

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

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

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

DiscoveryDocDetails Type

Details about the OpenID provider's discovery document.

Remarks

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

The following fields are available:

SupportedResponseTypes

SupportedScopes

TokenURL

UserInfoURL

Fields

AuthorizationURL
string (read-only)
Default: ""

The server authorization endpoint URL.

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

ClaimsParamSupported
bool (read-only)
Default: False

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

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

Content
string (read-only)
Default: ""

The raw discovery document JSON.

Issuer
string (read-only)
Default: ""

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

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

LogoutURL
string (read-only)
Default: ""

The logout endpoint URL.

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

RegistrationURL
string (read-only)
Default: ""

The dynamic client registration URL.

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

ServiceDocsURL
string (read-only)
Default: ""

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

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

SignerCertURL
string (read-only)
Default: ""

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.

SupportedClaims
string (read-only)
Default: ""

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

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

SupportedDisplays
string (read-only)
Default: ""

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

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

SupportedGrantTypes
string (read-only)
Default: ""

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

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

SupportedResponseTypes
string (read-only)
Default: ""

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

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

SupportedScopes
string (read-only)
Default: ""

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

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

TokenURL
string (read-only)
Default: ""

The token endpoint URL.

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

UserInfoURL
string (read-only)
Default: ""

The user info endpoint URL.

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

Constructors

C#
VB.NET

public DiscoveryDocDetails();

Public DiscoveryDocDetails()

Firewall Type

The firewall the component will connect through.

Remarks

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

The following fields are available:

Fields

AutoDetect
bool
Default: False

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

FirewallType
FirewallTypes
Default: 0

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


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

Host
string
Default: ""

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

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

Password
string
Default: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Port
int
Default: 0

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

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

User
string
Default: ""

A username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the component throws an exception.

Constructors

C#
VB.NET

public Firewall();

Public Firewall()

IdTokenInfo Type

This type holds details about an ID Token.

Remarks

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

The following fields are available:

Fields

Audiences
string (read-only)
Default: ""

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

AuthTime
long (read-only)
Default: 0

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

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

ExpTime
long
Default: 0

The time when the ID Token expires.

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

IdTokenContent
string
Default: ""

The raw value of the ID Token.

IssuedTime
long
Default: 0

The time when the authentication for this ID Token occurred.

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

Issuer
string
Default: ""

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

Constructors

C#
VB.NET

public IdTokenInfo();

Public IdTokenInfo()

OAuthParam Type

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

Remarks

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

The following fields are available:

Name

Value

Fields

Name
string
Default: ""

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

Value
string
Default: ""

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.

Constructors

C#
VB.NET

public OAuthParam();

Public OAuthParam()

C#
VB.NET

public OAuthParam(string name, string value);

Public OAuthParam(ByVal Name As String, ByVal Value As String)

Proxy Type

The proxy the component will connect to.

Remarks

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

The following fields are available:

Fields

AuthScheme
ProxyAuthSchemes
Default: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.

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

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

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
bool
Default: False

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

Password
string
Default: ""

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

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

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default: 80

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

Server
string
Default: ""

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

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

SSL
ProxySSLTypes
Default: 0

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


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

User
string
Default: ""

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

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

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

C#
VB.NET

public Proxy();

Public Proxy()

C#
VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

C#
VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

UserDetails Type

This type holds details about the user.

Remarks

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

The following fields are available:

Fields

AddrCountry
string (read-only)
Default: ""

The country name portion of the user's address.

AddrFormatted
string (read-only)
Default: ""

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

AddrLocality
string (read-only)
Default: ""

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

AddrPostalCode
string (read-only)
Default: ""

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

AddrRegion
string (read-only)
Default: ""

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

AddrStreetAddr
string (read-only)
Default: ""

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

Birthday
string (read-only)
Default: ""

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

Email
string (read-only)
Default: ""

The user's preferred email address.

EmailVerified
bool (read-only)
Default: False

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

FirstName
string (read-only)
Default: ""

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

Gender
string (read-only)
Default: ""

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

LastName
string (read-only)
Default: ""

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

Locale
string (read-only)
Default: ""

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

MiddleName
string (read-only)
Default: ""

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

Name
string (read-only)
Default: ""

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

Nickname
string (read-only)
Default: ""

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

PhoneNumber
string (read-only)
Default: ""

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

PhoneNumberVerified
bool (read-only)
Default: False

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

PictureURL
string (read-only)
Default: ""

The URL of the user's profile picture.

PreferredUsername
string (read-only)
Default: ""

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

ProfileURL
string (read-only)
Default: ""

The URL of the user's profile page.

Subject
string (read-only)
Default: ""

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

UpdatedAt
long (read-only)
Default: 0

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

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

Website
string (read-only)
Default: ""

The URL of the user's website.

ZoneInfo
string (read-only)
Default: ""

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

Constructors

C#
VB.NET

public UserDetails();

Public UserDetails()

Config Settings (OIDC Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

OIDC Config Settings

AccessTokenExp: The expiration date for the access token.

The expiration date for the most recently retrieved access token.

AuthErrorURI: The URI that provides more information about the authorization error.

When the authorization server returns with an authorization or authentication error, the OpenID provider can optionally provide a URI to a webpage that provides more information on the error.

AuthorizationCode: The authorization code to be exchanged with the token server.

The authorization code that will be used in a request to the token server. This configuration setting is set when calling ProcessOIDCResponse or ParseOIDCResponse. This configuration setting is used when calling RequestTokens or when found during the ProcessOIDCResponse method's execution.

Display: The requested display options to present to the end user.

This optional setting specifies the display options that the authorization server should display to the user. Possible values are:


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

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

This setting corresponds to the display request parameter.

ExpectedAudience: The expected audience when validating an ID Token.

When set, the component will check the audience (aud) claim against this value rather than the ClientId property.

ExpectedIssuer: The expected Issuer when validating an ID Token.

When set, the component will check the issuer (iss) claim against this value rather than the value found in the Issuer field.

IDTokenHint: An ID Token value to be used as a hint about the user's session.

This setting may be specified before calling GetAuthorizationURL to provide an ID Token as a hint about the user's current or past authenticated session. If the user identified by the ID Token present here is logged in, then the authorization server should return a positive response. If Prompt is set to none, it is recommended to set this value. The value for this setting is the raw Issuer received from a previous session.

This setting corresponds to the id_token_hint request parameter.

IdTokenVerificationFlags: The checks that are ignored when validating an ID Token.

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


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

LoginHint: The login hint sent to the authorization server.

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

This setting corresponds to the login_hint request parameter.

Nonce: The nonce value that is used to verify an ID Token.

This setting provides the value of the Nonce parameter that is provided to the OpenID Provider when making a request and the value that should be used for validation when validating an ID Token. If left blank when UseNonce is set to true, the component will generate a new one.

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

PKCEVerifier: The PKCE verifier used to generate the challenge.

This configuration setting, when queried, provides the PKCE verifier that is used to generate the PKCE challenge for the GetAuthorizationURL, ProcessOIDCResponse, and RequestTokens methods when UsePKCE is set to true. It can be used to process the response from the authorization server from a different instance than the one used to create the authorization request.

ProcessedRequestType: The type of request that was processed or parsed.

This configuration setting is the type of request that was processed or parsed after calling ProcessOIDCResponse or ParseOIDCResponse.

0 - Authorization Success
1 - Authorization Failure
99 - Unknown Type

Prompt: The requested conditions under which the authorization server prompts for login.

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


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

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

This setting corresponds to the prompt request parameter.

ResponseType: The value of the response_type request parameter.

This setting optionally specifies the value of the response_type request parameter. When GrantType is set, a value for the response_type is automatically chosen. If a different value is desired, it may be specified here. The table below illustrates the default and possible values.


GrantType	Default value	Possible values
0 (Authorization Code)	`code`	`code`
1 (Implicit)	`id_token token`	`id_token` `id_token token`
2 (Hybrid)	`code id_token`	`code id_token` `code token` `code id_token token`

ServerAuthURL: The URL of the authorization server.

This configuration setting is used to provide the component an authorization server URL directly to be used by the GetAuthorizationURL method.

ServerSignerCertURL: The URL of the signer certificate server.

This configuration setting is used to provide the component a signer certificate server URL directly to be used when requesting signer certificates.

ServerTokenURL: The URL of the token server.

This configuration setting is used to provide the component a token server URL directly to be used by the ProcessOIDCResponse or RequestTokens methods.

ServerUserInfoURL: The URL of the UserInfo server.

This configuration setting is used to provide the component a UserInfo server URL directly to be used by the RequestUserInfo method.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the component adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The component only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

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

When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

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

If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.

The default value is True.

AllowNTLMFallback: Whether to allow fallback from Negotiate to NTLM when authenticating.

This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

Append: Whether to append data to LocalFile.

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

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

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

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

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

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

The default value is False.

EncodeURL: If set to True the URL will be encoded by the component.

If set to True, the URL passed to the component will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

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

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component throws an exception.

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

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

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

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the component will perform a GET on the new location.

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

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

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

HTTPVersion: The version of HTTP used by the component.

This property specifies the HTTP version used by the component. Possible values are as follows:

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

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

HTTP/2 Notes

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

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

HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.

HTTP/3 Notes

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

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

IfModifiedSince: A date determining the maximum age of the desired document.

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

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

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

The default value for KeepAlive is false.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

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

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


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

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

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

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

MaxHeaders: Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.

This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxHTTPCookies: Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

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

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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

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

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

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

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

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode: The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine: The first line of the last response from the server.

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

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the component.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.

TransferredHeaders: The full set of headers as received from the server.

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

TransferredRequest: The full request as sent by the client.

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

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.

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

UseIDNs: Whether to encode hostnames to internationalized domain names.

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

The default value is False and the hostname will always be used exactly as specified.

UsePlatformDeflate: Whether to use the platform implementation to decompress compressed responses.

This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

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

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

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

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

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

TCPClient Config Settings

CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.

This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the component will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the component whether or not to automatically detect and use firewall system settings, if available.

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

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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

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

FirewallListener: If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

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

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

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

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


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

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

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

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

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

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

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

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

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

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

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

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

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

LingerTime: Time in seconds to have the connection linger.

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

LocalHost: The name of the local host through which connections are initiated or accepted.

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

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

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

LocalPort: The port in the local host where the component binds.

This configuration setting must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

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

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

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

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

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

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

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

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

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

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

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

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


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

UseNTLMv2: Whether to use NTLM V2.

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

SSL Config Settings

CACertFilePaths: The paths to CA certificate files when using Mono on Unix/Linux.

This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

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

The default value is as follows:

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

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

ReuseSSLSession: Determines if the SSL session is reused.

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

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

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

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

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

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component throws an exception.

When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

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

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

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

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

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

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

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

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

Example values when SSLProvider is set to Internalinclude the following:

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

Possible values when SSLProvider is set to Internal include the following:

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

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

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

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


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

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

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

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

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

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

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

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

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

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

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

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

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:


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

This functionality is currently not available in Java or when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificates to use during SSL server certificate validation.

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

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

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

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component throws an exception.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

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

TLS12SupportedGroups: The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

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

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

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

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

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

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

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

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

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

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

FirewallData: Used to send extra data to the firewall.

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

InBufferSize: The size in bytes of the incoming queue of the socket.

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

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

OutBufferSize: The size in bytes of the outgoing queue of the socket.

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

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

Base Config Settings

BuildInfo: Information about the product's build.

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

GUIAvailable: Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

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

MaskSensitiveData: Whether sensitive data is masked in log messages.

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

This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

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

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (OIDC Component)

OIDC Errors

900	Invalid discovery document. The data is not a properly formatted discovery document.
901	Invalid ID Token. The ID Token could not be parsed.
902	Invalid ResponseType specified. The supplied ResponseType was unrecognized.
903	ID Token verification failed.
910	ID Token verification failed. ID Token has expired.
911	ID Token verification failed. ID Token issuer does not match expected issuer.
912	ID Token verification failed. ID Token audience does not match the expected audience.
913	ID Token verification failed. ID Token is missing a required claim.
914	ID Token verification failed. ID Token is meant for future use.
915	ID Token verification failed. ID Token has an invalid issued time.
920	ID Token verification failed. Could not validate signature.
921	ID Token verification failed. Could not find a valid Signer Certificate.
922	ID Token verification failed. Could not find a Signer Certificate that matches ID Token Headers.
923	ID Token verification failed. Could not find signature.
930	OIDC Response processing error. The OIDC Response could not be found. Check the HTTPContext or the OIDCResponseHeaders property.
931	OIDC Response processing error. The OIDC Response's HTTP headers or body were malformed. Check that processed request contains OIDC content meant for a relying party.
932	OIDC Response processing error. The OIDC Response contained an error message from the authorization server. Check description for more information.

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