OIDCDesktop Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

cloudsso.OIDCDesktop

Remarks

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

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

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

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

--- TBD ---

Setup

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

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

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

Discovery

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

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

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

Usage: Getting the Discovery Document

The OIDC class simplifies requesting and parsing the discovery document. The 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 class needs to verify the ID Token, the class will automatically make this request.

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

Authentication

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

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

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

Getting Authorization

Usage: Getting the Authorization URL

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

Authorization Response

Parse vs. Process

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

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

Usage: Handling a redirect from an OpenID Provider

The OIDC class 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 specified HttpServletRequest object.

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

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

Getting Tokens

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

Refresh Tokens

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

Usage: Request Tokens

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

Verifying ID Tokens

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

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

Usage: Validate and Parse an ID Token

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

User Information

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

When commonly used claims are parsed from an ID Token or the response from the UserInfo endpoint, the class will set the 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 class 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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AccessToken Property (OIDCDesktop Class)

The access token received from an OpenID provider.

Syntax

public String getAccessToken();
public void setAccessToken(String accessToken);

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

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 AuthenticateUser. 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 by making a request to the token server. When ResponseType contains token (ogtImplicit and ogtHybrid), the AccessToken is provided by the AuthorizationURL in the authorization response.

AuthorizationScope Property (OIDCDesktop Class)

The authorization scope used during authorization.

Syntax

public String getAuthorizationScope();
public void setAuthorizationScope(String authorizationScope);

Default Value

"openid"

Remarks

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

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

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

See the OpenID provider's documentation for supported values.

AuthzResponseCode Property (OIDCDesktop Class)

The error code from a recent authorization attempt.

Syntax

public String getAuthzResponseCode();

Default Value

""

Remarks

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

This property is read-only.

AuthzResponseDesc Property (OIDCDesktop Class)

The error description from a recent authorization attempt.

Syntax

public String getAuthzResponseDesc();

Default Value

""

Remarks

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

This property is read-only.

ClientId Property (OIDCDesktop Class)

The Id of the client assigned when registering the application.

Syntax

public String getClientId();
public void setClientId(String clientId);

Default Value

""

Remarks

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

ClientSecret Property (OIDCDesktop Class)

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

Syntax

public String getClientSecret();
public void setClientSecret(String clientSecret);

Default Value

""

Remarks

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

DiscoveryDocDetails Property (OIDCDesktop Class)

Details about the OpenID provider's discovery document.

Syntax

public DiscoveryDocDetails getDiscoveryDocDetails();

Remarks

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

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

Firewall Property (OIDCDesktop Class)

A set of properties related to firewall access.

Syntax

public Firewall getFirewall();
public void setFirewall(Firewall firewall);

Remarks

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

FollowRedirects Property (OIDCDesktop Class)

Determines what happens when the server issues a redirect.

Syntax

public int getFollowRedirects();
public void setFollowRedirects(int followRedirects);

Enumerated values:
  public final static int frNever = 0;
  public final static int frAlways = 1;
  public final static int frSameScheme = 2;

Default Value

0

Remarks

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

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class 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 class throws an exception instead.

GrantType Property (OIDCDesktop Class)

The grant type defining the authentication flow.

Syntax

public int getGrantType();
public void setGrantType(int grantType);

Enumerated values:
  public final static int ogtAuthorizationCode = 0;
  public final static int ogtImplicit = 1;
  public final static int ogtHybrid = 2;

Default Value

0

Remarks

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

Possible values for GrantType are:

• ogtAuthorizationCode (0)
• ogtImplicit (1)
• ogtHybrid (2)

When using the AuthenticateUser method, each grant type causes the authorization server to respond differently.

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

When using ogtImplicit (Implicit Flow), the authorization server returns the token and id_token parameters. This provides the access token and ID token directly to the web server. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself.

When using ogtHybrid (Hybrid Flow), the authorization server returns the code and id_token parameters. This flow is a combination of the authorization code and implicit grant types. Like the implicit grant type, the class will validate the ID Token immediately, then it will exchange the authorization code with the token server receiving an access token and possible ID Token.

Additional Notes

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

IdTokenInfo Property (OIDCDesktop Class)

Information about the current ID Token.

Syntax

public IdTokenInfo getIdTokenInfo();

Remarks

This property holds details about the ID Token.

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

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

OtherHeaders Property (OIDCDesktop Class)

Other headers as determined by the user (optional).

Syntax

public String getOtherHeaders();
public void setOtherHeaders(String otherHeaders);

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Params Property (OIDCDesktop Class)

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

Syntax

public OAuthParamList getParams();
public void setParams(OAuthParamList params);

Remarks

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

This property is not available at design time.

Proxy Property (OIDCDesktop Class)

A set of properties related to proxy access.

Syntax

public Proxy getProxy();
public void setProxy(Proxy proxy);

Remarks

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

RefreshToken Property (OIDCDesktop Class)

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

Syntax

public String getRefreshToken();
public void setRefreshToken(String refreshToken);

Default Value

""

Remarks

This property is set by the class when it receives a refresh token after the AuthenticateUser method makes a request to an OpenID provider's token server.

Usage:

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

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

ReturnURL Property (OIDCDesktop Class)

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

Syntax

public String getReturnURL();
public void setReturnURL(String returnURL);

Default Value

""

Remarks

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

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

SignerCerts Property (OIDCDesktop Class)

The signing certificates from an OpenID provider.

Syntax

public CertificateList getSignerCerts();

Remarks

This property contains a list of certificates from the OpenID provider that are used for signing ID Tokens. This collection can be manually populated using the RequestSignerCerts 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 the AuthenticateUser or ValidateIdToken methods.

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

SignerJWKS Property (OIDCDesktop Class)

The JSON Web Key Set provided by an OpenID provider.

Syntax

public String getSignerJWKS();

Default Value

""

Remarks

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

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

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

This property is read-only.

SSLAcceptServerCert Property (OIDCDesktop Class)

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

Syntax

public Certificate getSSLAcceptServerCert();
public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

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

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

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

SSLCert Property (OIDCDesktop Class)

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

Syntax

public Certificate getSSLCert();
public void setSSLCert(Certificate SSLCert);

Remarks

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

SSLProvider Property (OIDCDesktop Class)

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

Syntax

public int getSSLProvider();
public void setSSLProvider(int SSLProvider);

Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

Default Value

0

Remarks

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

Possible values are as follows:

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

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

SSLServerCert Property (OIDCDesktop Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

State Property (OIDCDesktop Class)

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

Syntax

public String getState();
public void setState(String state);

Default Value

""

Remarks

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

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

Timeout Property (OIDCDesktop Class)

The timeout for the class.

Syntax

public int getTimeout();
public void setTimeout(int timeout);

Default Value

60

Remarks

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

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

The class will use 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 class 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.

UseNonce Property (OIDCDesktop Class)

Whether the Nonce parameter is added.

Syntax

public boolean isUseNonce();
public void setUseNonce(boolean useNonce);

Default Value

False

Remarks

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

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

UsePKCE Property (OIDCDesktop Class)

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

Syntax

public boolean isUsePKCE();
public void setUsePKCE(boolean usePKCE);

Default Value

False

Remarks

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

UserDetails Property (OIDCDesktop Class)

The claims about the user.

Syntax

public UserDetails getUserDetails();

Remarks

This property holds details about the user.

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

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

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

WebServerPort Property (OIDCDesktop Class)

The local port on which the embedded web server listens.

Syntax

public int getWebServerPort();
public void setWebServerPort(int webServerPort);

Default Value

0

Remarks

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

WebServerSSLCert Property (OIDCDesktop Class)

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

Syntax

public Certificate getWebServerSSLCert();
public void setWebServerSSLCert(Certificate webServerSSLCert);

Remarks

This property specifies the certificate with the private key to use when the embedded web server is used. This setting is applicable only when WebServerSSLEnabled is set to True.

WebServerSSLEnabled Property (OIDCDesktop Class)

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

Syntax

public boolean isWebServerSSLEnabled();
public void setWebServerSSLEnabled(boolean webServerSSLEnabled);

Default Value

False

Remarks

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

AddParam Method (OIDCDesktop Class)

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

Syntax

public void addParam(String paramName, String paramValue);

Remarks

This method can be used to add query string parameters to the requests being made by the AuthenticateUser method.

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

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

AuthenticateUser Method (OIDCDesktop Class)

Authenticates a user to the application.

Syntax

public void authenticateUser();

Remarks

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

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

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

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

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

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

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

Whenever an ID Token is found by the class either through the response from the token server or from the id_token parameter, the class will automatically parse and validate the ID Token. See ParseIdToken and ValidateIdToken methods for more information.

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

Config Method (OIDCDesktop Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

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

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

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

DoEvents Method (OIDCDesktop Class)

This method processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

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

GetDiscoveryMetadata Method (OIDCDesktop Class)

Gets a specific metadata value from the discovery document.

Syntax

public String getDiscoveryMetadata(String metadataName);

Remarks

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

Metadata Name oidc.GetDiscoveryMetadata("authorization_endpoint");

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

GetIdTokenClaim Method (OIDCDesktop Class)

Gets a specific claim from the ID Token.

Syntax

public String getIdTokenClaim(String claimName);

Remarks

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

Claim Name oidc.GetIdTokenClaim("aud");

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

GetQueryParam Method (OIDCDesktop Class)

Gets a specific claim from the authorization response.

Syntax

public String getQueryParam(String paramName);

Remarks

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

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

GetUserInfoClaim Method (OIDCDesktop Class)

Gets a specific claim from the UserInfo response.

Syntax

public String getUserInfoClaim(String claimName);

Remarks

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

Claim Name oidc.GetUserInfoClaim("aud");

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

Interrupt Method (OIDCDesktop Class)

This method interrupts the current method.

Syntax

public void interrupt();

Remarks

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

LoadDiscoveryDoc Method (OIDCDesktop Class)

Loads in a raw discovery document.

Syntax

public void loadDiscoveryDoc(String documentData);

Remarks

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

LoadSignerJWKS Method (OIDCDesktop Class)

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

Syntax

public void loadSignerJWKS(String jwksData);

Remarks

This method loads the JSON Web Keys Set (JWKS) provided through the jwksData parameter. Calling this method will set the SignerJWKS property and populate the SignerCerts 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 (OIDCDesktop Class)

Parses an ID Token.

Syntax

public void parseIdToken();

Remarks

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

See ValidateIdToken for information on validating an ID Token.

RequestDiscoveryDoc Method (OIDCDesktop Class)

Requests the OpenID Discovery Document.

Syntax

public void requestDiscoveryDoc(String URL);

Remarks

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

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

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

Call RequestDiscoveryDoc before calling GetAuthorizationURL to populate the class properties with information required to request authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method, the DiscoveryDocDetails 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 class, the GetDiscoveryMetadata method can be used to query for a specific metadata entry.

RequestSignerCerts Method (OIDCDesktop Class)

Requests the signing certificates from the OpenID provider.

Syntax

public void requestSignerCerts();

Remarks

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

RequestUserInfo Method (OIDCDesktop Class)

Requests the information of a user.

Syntax

public void requestUserInfo();

Remarks

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

When a valid response is returned from the UserInfo endpoint, the class will populate the 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 (OIDCDesktop Class)

This method will reset the class.

Syntax

public void reset();

Remarks

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

StartWebServer Method (OIDCDesktop Class)

Starts the embedded web server.

Syntax

public void startWebServer();

Remarks

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

StopWebServer Method (OIDCDesktop Class)

Stops the embedded web server.

Syntax

public void stopWebServer();

Remarks

This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authorization process when AuthenticateUser is called. If ReUseWebServer is set to True, the server will not be automatically stopped, and this method must be called to stop the embedded web server.

ValidateIdToken Method (OIDCDesktop Class)

Validates an ID Token.

Syntax

public void validateIdToken();

Remarks

This method validates the current ID Token. The ID Token can be populated directly by setting the IdTokenContent field or by calling the AuthenticateUser method. Typically, the class will automatically validate and parse an ID Token if it is found. This can be used to re-validate an ID Token if needed.

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 class 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 class will throw an exception with the matching error code. If certain steps in the verification process should be skipped, the IdTokenVerificationFlags configuration setting can be used.

Error Event (OIDCDesktop Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultOIDCDesktopEventListener implements OIDCDesktopEventListener {
  ...
  public void error(OIDCDesktopErrorEvent e) {}
  ...
}

public class OIDCDesktopErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

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

LaunchBrowser Event (OIDCDesktop Class)

Fires before launching a browser with the authorization URL.

Syntax

public class DefaultOIDCDesktopEventListener implements OIDCDesktopEventListener {
  ...
  public void launchBrowser(OIDCDesktopLaunchBrowserEvent e) {}
  ...
}

public class OIDCDesktopLaunchBrowserEvent {
  public String URL; //read-write
  public String command; //read-write
}

Remarks

When the AuthenticateUser method is called, the class will fire this event with the Command, which will be executed by the class. The URL parameter will be the authorization URL that the user will be directed to authenticate.

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

Log Event (OIDCDesktop Class)

Fired once for each log message.

Syntax

public class DefaultOIDCDesktopEventListener implements OIDCDesktopEventListener {
  ...
  public void log(OIDCDesktopLogEvent e) {}
  ...
}

public class OIDCDesktopLogEvent {
  public int logLevel;
  public String message;
  public String logType;
}

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Redirect Event (OIDCDesktop Class)

Fired when a redirection is received from the server.

Syntax

public class DefaultOIDCDesktopEventListener implements OIDCDesktopEventListener {
  ...
  public void redirect(OIDCDesktopRedirectEvent e) {}
  ...
}

public class OIDCDesktopRedirectEvent {
  public String location;
  public boolean accept; //read-write
}

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class 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 (OIDCDesktop Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultOIDCDesktopEventListener implements OIDCDesktopEventListener {
  ...
  public void SSLServerAuthentication(OIDCDesktopSSLServerAuthenticationEvent e) {}
  ...
}

public class OIDCDesktopSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

Remarks

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

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

SSLStatus Event (OIDCDesktop Class)

Fired when secure connection progress messages are available.

Syntax

public class DefaultOIDCDesktopEventListener implements OIDCDesktopEventListener {
  ...
  public void SSLStatus(OIDCDesktopSSLStatusEvent e) {}
  ...
}

public class OIDCDesktopSSLStatusEvent {
  public String message;
}

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.

Fields

Constructors

public Certificate();

public Certificate( certificateFile);

public Certificate( encoded);

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

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

public Certificate( storeType,  store,  storePassword,  encoded);

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

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

public Certificate( storeType,  store,  storePassword,  encoded);

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.

Fields

Constructors

public DiscoveryDocDetails();

Firewall Type

The firewall the class 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.

Fields

Constructors

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.

Fields

Constructors

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.

Fields

Constructors

public OAuthParam();

public OAuthParam( name,  value);

Proxy Type

The proxy the class 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.

Fields

Constructors

public Proxy();

public Proxy( server,  port);

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

UserDetails Type

This type holds details about the user.

Remarks

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

Fields

Constructors

public UserDetails();

Config Settings (OIDCDesktop Class)

OIDCDesktop Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (OIDCDesktop Class)

OIDCDesktop Errors