OAuth Component

Properties   Methods   Events   Config Settings   Errors  

The OAuth component is used to authorize a client and provide an authorization string used in future requests.

Syntax

TcmOAuth

Remarks

The OAuth component supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method.

The OAuth component provides an easy way to obtain an authorization string for future requests to a service. The component implements an OAuth 2.0 client.

To begin using the component, first register your application with the service you want to use. During this process, obtain a ClientId and ClientSecret as well as the ServerAuthURL and ServerTokenURL for the authorization server. Then set ClientProfile to the client profile that best describes your situation and call GetAuthorization.

The following client profiles are currently supported by the component:

• Application (desktop application)
• Web (server-side application, such as a website)
• Device (an application without browser access, such as a game console)
• Mobile (phone or tablet application)
• JWT (server-to-server authentication using a JWT Bearer Token, such as Google service account authentication)

Application Profile

The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps:

First, set ClientProfile to ocpApplication. This defines the profile the component will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application.

Second, call GetAuthorization to begin the authorization process. When GetAuthorization is called, the component will build the URL to which the user will be directed and fire the LaunchBrowser event. The component will then launch the browser using the command and URL shown in the LaunchBrowser event and await the response. The duration for which the component will wait for a response is defined by BrowserResponseTimeout.

Third, the user will interact with the browser to authenticate and grant access to the connecting application. The user will then be redirected back to an embedded web server that was automatically started when GetAuthorization was called. At this time, the ReturnURL event will fire. This event provides an opportunity to provide a custom response to your user that they will see in their browser.

Fourth, the component will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in ServerTokenURL.

The authorization is now complete and the GetAuthorization method will return the authorization string. The authorization string can then be used with any of our components by simply setting the returned value to the authorization property before making a request.

The following is a simple example: component.ClientId = "CLIENT_ID"; component.ClientSecret = "CLIENT_ID"; component.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; component.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; HTTP.Authorization = component.GetAuthorization(); HTTP.Get("https://www.googleapis.com/oauth2/v1/userinfo");

Web Profile

The Web profile is applicable to applications that are run on the server side when the user uses the application from a web browser. To authorize your application (client) using this profile, use the following steps:

First, set ClientProfile to ocpWeb. This defines the profile the component will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application. Set ReturnURL to the page on your site that will be the endpoint the user is redirected back to after authentication.

Second, call GetAuthorizationURL. This will return a URL to which the user should be redirected. Redirect the user to this URL.

Third, after the user authenticates and is returned to the page on your site specified by ReturnURL, parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set AuthorizationCode property to the parsed value.

Fourth, after AuthorizationCode is set, call GetAuthorization to exchange the code specified in AuthorizationCode for a token from the server specified by ServerTokenURL. GetAuthorization will then return the authorization string. The authorization string can be used with any of our components by simply setting the returned value to the authorization property before making a request.

Device Profile

The Device profile is applicable to applications that are run on devices for which a web browser cannot be used. For example, a game console would use the Device profile. To authorize your application (client) using the device client profile use the following steps:

First, set ClientProfile to ocpDevice. This defines the profile the component will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application. Do not set ReturnURL.

Second, call GetAuthorizationURL. The component will automatically make a request to ServerAuthURL to obtain a user code for the device. The GetAuthorizationURL method will return the URL your user must visit from another device or computer that has web browser support. The GetAuthorizationURL method will also populate DeviceUserCode. This device user code must be provided to the user. The user will enter the code at the URL returned by GetAuthorizationURL.

Third, at this time, call GetAuthorization. The component will begin polling the server specified in ServerTokenURL. The polling interval is specified (in seconds) by the PollingInterval setting.

Fourth, after the user has authenticated, the GetAuthorization method will return the authorization string. To use the authorization string with any of our components, simply pass this value to the authorization property before making the request.

Mobile Profile

The Mobile profile is applicable to applications that are run on devices for which a web browser can be used. For instance, a mobile phone or tablet would use the Mobile profile. The behavior when using this profile is very similar to the Application profile. The only difference between the Mobile and Application profiles is the way the browser is launched. When set to the Mobile profile, the LaunchBrowser event will fire but the component will not attempt to launch the browser automatically. The browser must be launched manually from code. This behavior is the only difference between the Mobile and Application profiles. Please read the steps for the Application profile for a more detailed look at the process.

JWT Bearer Token (Server-to-Server) Profile

The JWT (JSON Web Token) Bearer Token profile is available for server-to-server authentication. For instance this may be used by web applications to access a Google service. In this case, the application will access data on behalf of the service account, not the end user. End-user interaction is not required.

First, specify AuthorizationScope ServerTokenURL and JWTServiceProvider.

Second, specify JWT-specific values. The use of the JWT profile also requires additional configuration settings to be specified, including a certificate with private key used to sign the JWT. Either specify the JWTJSONKey configuration setting, which will parse the necessary information automatically, or manually specify the following configuration settings:

• JWTIssuer (required)
• JWTAudience (required)
• JWTCertStoreType (required)
• JWTCertStore (required)
• JWTCertStorePassword (required)
• JWTCertSubject (required)
• JWTSubject
• JWTValidityTime
• JWTSignatureAlgorithm

Example 1. Google: oauth.AuthorizationScope = "https://www.googleapis.com/auth/analytics"; oauth.ServerTokenURL = "https://www.googleapis.com/oauth2/v3/token"; oauth.ClientProfile = OauthClientProfiles.ocpJWT; oauth.Config("JWTServiceProvider=0"); oauth.Config("JWTIssuer=CLIENT_ID"); oauth.Config("JWTAudience=https://www.googleapis.com/oauth2/v3/token"); oauth.Config("JWTCertStoreType=2"); oauth.Config("JWTCertStore=C:\\MyCertificate.p12"); oauth.Config("JWTCertStorePassword=password"); oauth.Config("JWTCertSubject=*"); oauth.Config("JWTValidityTime=5400"); //in seconds string authStr = oauth.GetAuthorization();

Example 2. Microsoft: oauth.ClientId = "Client_Id"; oauth.ClientProfile = OauthClientProfiles.ocpJWT; oauth.AuthorizationScope = "https://graph.microsoft.com/.default"; oauth.ServerTokenURL = "https://login.microsoftonline.com/" + tenant_id + "/oauth2/V2.0/token"; oauth.Config("JWTServiceProvider=1"); oauth.Config("JWTIssuer=" + CLIENT_ID); oauth.Config("JWTSubject=" + CLIENT_ID); oauth.Config("JWTCertStoreType=2"); oauth.Config("JWTCertStore=C:\\MyCertificate.p12"); oauth.Config("JWTCertStorePassword=password"); oauth.Config("JWTCertSubject=*"); oauth.Config("JWTValidityTime=3600"); oauth.Config("JWTAudience=https://login.microsoftonline.com/"+ tenant_id + "/oauth2/V2.0/token"); string authStr = oauth.GetAuthorization();

Custom Responses

When using a profile that makes use of the embedded web server, the response that is displayed to the user on success of failure may be customized to include a variety of product- and company-specific information. The following section is applicable only when the embedded web server is used, for instance, when ClientProfile is set to ocpApplication.

By default, the component will display a formatted result message indicating whether the authorization succeeded or failed. The following optional settings control the text of the message as well as product images, company logos, and links for help or licensing terms that can be displayed to the user.

Alternatively, for complete control, set the WebServerResponse and WebServerFailedResponse settings to the full HTML to be displayed to the user.

Property List

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

Method List

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

Event List

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

Config Settings

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

AccessToken Property (OAuth Component)

This property includes the access token returned by the authorization server.

Syntax

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

Default Value

""

Remarks

This property will be populated with the access token returned by the authorization server after a call to GetAuthorization. This will be the raw access token, whereas the return value from the GetAuthorization method will also include the required data so that it can be passed directly to the Authorization property of other components or added as the value of the authorization header in another client implementation.

Data Type

String

AccessTokenExp Property (OAuth Component)

This property includes the lifetime of the access token.

Syntax

__property int AccessTokenExp = { read=FAccessTokenExp };

Default Value

0

Remarks

This setting holds the lifetime of the access token in seconds. For instance the value 3600 indicates that the token will expire in one hour from the time it was generated.

This property is read-only.

Data Type

Integer

AuthorizationCode Property (OAuth Component)

This property includes the authorization code that is exchanged for an access token.

Syntax

__property String AuthorizationCode = { read=FAuthorizationCode, write=FSetAuthorizationCode };

Default Value

""

Remarks

This property is used with the AuthorizationCode GrantType. When ClientProfile is set to ocpApplication (Application flow), this property will be informational only, as the GetAuthorization method will automatically exchange this code for a token with the authorization server specified in ServerTokenURL.

When ClientProfile is set to ocpWeb (Web flow), this property needs to be set to the authorization code returned from the authorization server. Typically, this value is parsed when the service redirects the user back to your website. See ClientProfile for more information.

If this property is set before calling GetAuthorization, the component will not make a request to the authorization sever and instead will attempt to exchange the code with the authorization server for an access token.

This property is not available at design time.

Data Type

String

AuthorizationScope Property (OAuth Component)

This property includes the scope request or response parameter used during authorization.

Syntax

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

Default Value

""

Remarks

If the scope is not set, the authorization server will use the default access scope for your application as determined by the server. To request a specific access scope, set this property to a space-separated list of strings as defined by the authorization server.

After calling GetAuthorization, this property will be updated with the scope sent in the response from the server and will indicate the scope that was actually granted.

Data Type

String

ClientId Property (OAuth Component)

This property includes the Id of the client assigned when registering the application.

Syntax

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

Default Value

""

Remarks

This property holds the Id of the client that was assigned when initially registering the application with the authorization server. This value must be specified before calling GetAuthorization or GetAuthorizationURL.

Data Type

String

ClientProfile Property (OAuth Component)

This property includes the type of client that is requesting authorization.

Syntax

__property TcmOAuthClientProfiles ClientProfile = { read=FClientProfile, write=FSetClientProfile };

enum TcmOAuthClientProfiles {
  ocpApplication=0,
  ocpWeb=1,
  ocpDevice=2,
  ocpMobile=3,
  ocpJWT=4
};

Default Value

ocpApplication

Remarks

This defines the type of client that will be requesting authorization. Set this before calling GetAuthorization to inform the component to act accordingly. Possible values are as follows:

Application Profile

The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps:

First, set ClientProfile to ocpApplication. This defines the profile the component will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application.

Second, call GetAuthorization to begin the authorization process. When GetAuthorization is called, the component will build the URL to which the user will be directed and fire the LaunchBrowser event. The component will then launch the browser using the command and URL shown in the LaunchBrowser event and await the response. The duration for which the component will wait for a response is defined by BrowserResponseTimeout.

Third, the user will interact with the browser to authenticate and grant access to the connecting application. The user will then be redirected back to an embedded web server that was automatically started when GetAuthorization was called. At this time, the ReturnURL event will fire. This event provides an opportunity to provide a custom response to your user that they will see in their browser.

Fourth, the component will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in ServerTokenURL.

The authorization is now complete and the GetAuthorization method will return the authorization string. The authorization string can then be used with any of our components by simply setting the returned value to the authorization property before making a request.

The following is a simple example: component.ClientId = "CLIENT_ID"; component.ClientSecret = "CLIENT_ID"; component.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; component.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; HTTP.Authorization = component.GetAuthorization(); HTTP.Get("https://www.googleapis.com/oauth2/v1/userinfo");

Web Profile

The Web profile is applicable to applications that are run on the server side when the user uses the application from a web browser. To authorize your application (client) using this profile, use the following steps:

First, set ClientProfile to ocpWeb. This defines the profile the component will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application. Set ReturnURL to the page on your site that will be the endpoint the user is redirected back to after authentication.

Second, call GetAuthorizationURL. This will return a URL to which the user should be redirected. Redirect the user to this URL.

Third, after the user authenticates and is returned to the page on your site specified by ReturnURL, parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set AuthorizationCode property to the parsed value.

Fourth, after AuthorizationCode is set, call GetAuthorization to exchange the code specified in AuthorizationCode for a token from the server specified by ServerTokenURL. GetAuthorization will then return the authorization string. The authorization string can be used with any of our components by simply setting the returned value to the authorization property before making a request.

Device Profile

The Device profile is applicable to applications that are run on devices for which a web browser cannot be used. For example, a game console would use the Device profile. To authorize your application (client) using the device client profile use the following steps:

First, set ClientProfile to ocpDevice. This defines the profile the component will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application. Do not set ReturnURL.

Second, call GetAuthorizationURL. The component will automatically make a request to ServerAuthURL to obtain a user code for the device. The GetAuthorizationURL method will return the URL your user must visit from another device or computer that has web browser support. The GetAuthorizationURL method will also populate DeviceUserCode. This device user code must be provided to the user. The user will enter the code at the URL returned by GetAuthorizationURL.

Third, at this time, call GetAuthorization. The component will begin polling the server specified in ServerTokenURL. The polling interval is specified (in seconds) by the PollingInterval setting.

Fourth, after the user has authenticated, the GetAuthorization method will return the authorization string. To use the authorization string with any of our components, simply pass this value to the authorization property before making the request.

Mobile Profile

The Mobile profile is applicable to applications that are run on devices for which a web browser can be used. For instance, a mobile phone or tablet would use the Mobile profile. The behavior when using this profile is very similar to the Application profile. The only difference between the Mobile and Application profiles is the way the browser is launched. When set to the Mobile profile, the LaunchBrowser event will fire but the component will not attempt to launch the browser automatically. The browser must be launched manually from code. This behavior is the only difference between the Mobile and Application profiles. Please read the steps for the Application profile for a more detailed look at the process.

JWT Bearer Token (Server-to-Server) Profile

The JWT (JSON Web Token) Bearer Token profile is available for server-to-server authentication. For instance this may be used by web applications to access a Google service. In this case, the application will access data on behalf of the service account, not the end user. End-user interaction is not required.

First, specify AuthorizationScope ServerTokenURL and JWTServiceProvider.

Second, specify JWT-specific values. The use of the JWT profile also requires additional configuration settings to be specified, including a certificate with private key used to sign the JWT. Either specify the JWTJSONKey configuration setting, which will parse the necessary information automatically, or manually specify the following configuration settings:

• JWTIssuer (required)
• JWTAudience (required)
• JWTCertStoreType (required)
• JWTCertStore (required)
• JWTCertStorePassword (required)
• JWTCertSubject (required)
• JWTSubject
• JWTValidityTime
• JWTSignatureAlgorithm

Example 1. Google: oauth.AuthorizationScope = "https://www.googleapis.com/auth/analytics"; oauth.ServerTokenURL = "https://www.googleapis.com/oauth2/v3/token"; oauth.ClientProfile = OauthClientProfiles.ocpJWT; oauth.Config("JWTServiceProvider=0"); oauth.Config("JWTIssuer=CLIENT_ID"); oauth.Config("JWTAudience=https://www.googleapis.com/oauth2/v3/token"); oauth.Config("JWTCertStoreType=2"); oauth.Config("JWTCertStore=C:\\MyCertificate.p12"); oauth.Config("JWTCertStorePassword=password"); oauth.Config("JWTCertSubject=*"); oauth.Config("JWTValidityTime=5400"); //in seconds string authStr = oauth.GetAuthorization();

Example 2. Microsoft: oauth.ClientId = "Client_Id"; oauth.ClientProfile = OauthClientProfiles.ocpJWT; oauth.AuthorizationScope = "https://graph.microsoft.com/.default"; oauth.ServerTokenURL = "https://login.microsoftonline.com/" + tenant_id + "/oauth2/V2.0/token"; oauth.Config("JWTServiceProvider=1"); oauth.Config("JWTIssuer=" + CLIENT_ID); oauth.Config("JWTSubject=" + CLIENT_ID); oauth.Config("JWTCertStoreType=2"); oauth.Config("JWTCertStore=C:\\MyCertificate.p12"); oauth.Config("JWTCertStorePassword=password"); oauth.Config("JWTCertSubject=*"); oauth.Config("JWTValidityTime=3600"); oauth.Config("JWTAudience=https://login.microsoftonline.com/"+ tenant_id + "/oauth2/V2.0/token"); string authStr = oauth.GetAuthorization();

Data Type

Integer

ClientSecret Property (OAuth Component)

This property includes the secret value for the client assigned when registering the application.

Syntax

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

Default Value

""

Remarks

This property holds the secret of the client that was assigned when initially registering the application with the authorization server. This value must be specified before calling GetAuthorization or GetAuthorizationURL.

Data Type

String

Connected Property (OAuth Component)

This shows whether the component is connected.

Syntax

__property bool Connected = { read=FConnected, write=FSetConnected };

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

CookieCount Property (OAuth Component)

The number of records in the Cookie arrays.

Syntax

__property int CookieCount = { read=FCookieCount, write=FSetCookieCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (OAuth Component)

This is the domain of a received cookie.

Syntax

__property String CookieDomain[int CookieIndex] = { read=FCookieDomain };

Default Value

""

Remarks

This is the domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieExpiration Property (OAuth Component)

This property contains an expiration time for the cookie (if provided by the server).

Syntax

__property String CookieExpiration[int CookieIndex] = { read=FCookieExpiration };

Default Value

""

Remarks

This property contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieName Property (OAuth Component)

This property, contains the name of the cookie.

Syntax

__property String CookieName[int CookieIndex] = { read=FCookieName, write=FSetCookieName };

Default Value

""

Remarks

This property, contains the name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (OAuth Component)

This property contains a path name to limit the cookie to (if provided by the server).

Syntax

__property String CookiePath[int CookieIndex] = { read=FCookiePath };

Default Value

""

Remarks

This property contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

String

CookieSecure Property (OAuth Component)

This property contains the security flag of the received cookie.

Syntax

__property bool CookieSecure[int CookieIndex] = { read=FCookieSecure };

Default Value

false

Remarks

This property contains the security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

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

Data Type

Boolean

CookieValue Property (OAuth Component)

This property contains the value of the cookie.

Syntax

__property String CookieValue[int CookieIndex] = { read=FCookieValue, write=FSetCookieValue };

Default Value

""

Remarks

This property contains the value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The CookieIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (OAuth Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

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

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (OAuth Component)

This property determines the type of firewall to connect through.

Syntax

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

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

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (OAuth Component)

This property contains the name or IP address of firewall (optional).

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (OAuth Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (OAuth Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

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

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

Integer

FirewallUser Property (OAuth Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

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

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

FollowRedirects Property (OAuth Component)

This property determines what happens when the server issues a redirect.

Syntax

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

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

Default Value

frNever

Remarks

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

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

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

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

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

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

Data Type

Integer

GrantType Property (OAuth Component)

This property includes the OAuth grant type used to acquire an OAuth access token.

Syntax

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

enum TcmOAuthGrantTypes {
  ogtAuthorizationCode=0,
  ogtImplicit=1,
  ogtPassword=2,
  ogtClientCredentials=3,
  ogtAdminConsent=4
};

Default Value

ogtAuthorizationCode

Remarks

This setting specifies the type of grant to obtain. In most cases the Authorization Code grant type (default) is used, so it is typically not necessary to change this. The supported values are:

For all grant types listed set ClientProfile to Application.

The Authorization Code grant is the most commonly used grant type. It follows the flow described for the Application Client Profile section in the OAuth introduction page.

Implicit grants are similar to Authorization Code, except that a Bearer token is returned directly from the authorization server without requiring a second step to exchange a code for a bearer token. To use this grant type set:

• ClientId
• ClientSecret
• ServerAuthURL

The Resource Owner Password Credentials grant type may be used to authenticate on behalf of a resource owner with the owner's credentials. Authentication is performed directly and the user is not prompted to authenticate the application. To use this grant type set:

• PasswordGrantUsername to the username of the resource owner
• ClientSecret to the password of the resource owner
• ClientId optional, set to the client id for the resource
• ServerTokenURL

The Client Credentials grant type is typically used for server-to-server authentication. The client authenticates directly to the authentication server and receives a token without any user interaction. To use this grant type set:

• ClientId
• ClientSecret
• ServerTokenURL

The AdminConsent grant type is used when setting up application permissions for apps that authenticate to Microsoft. To use this grant type set:

• ClientId

If the Admin consents to the scopes, the tenant ID can be accessed through the Microsoft365AdminConsentTenant configuration and is often needed for authenticating a client later (eg. Client Credentials Grant Flow). Once the Admin consents once, they typically will not need to go through the process again unless the scopes of the application change.

If the Admin does not consent to the scopes, the error message can be found in the Microsoft365AdminConsentError configuration setting and the error description can be found in the Microsoft365AdminConsentErrorDesc configuration setting.

Data Type

Integer

Idle Property (OAuth Component)

The current status of the component.

Syntax

__property bool Idle = { read=FIdle };

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalHost Property (OAuth Component)

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

Syntax

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

Default Value

""

Remarks

The LocalHost 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 multi-homed 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 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 multi-homed hosts (machines with more than one IP interface).

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

Data Type

String

OtherHeaders Property (OAuth Component)

This property includes other headers as determined by the user (optional).

Syntax

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

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

ParamCount Property (OAuth Component)

The number of records in the Param arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParamName
• ParamValue

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

This property is not available at design time.

Data Type

Integer

ParamName Property (OAuth Component)

This property contains the name of the parameter to be used in the request or returned in the response.

Syntax

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

Default Value

""

Remarks

This property contains the name of the parameter to be used in the request or returned in the response.

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

This property is not available at design time.

Data Type

String

ParamValue Property (OAuth Component)

This property contains the value of the parameter to be used in the request or returned in the response.

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (OAuth Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

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

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

Default Value

authBasic

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (OAuth Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

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

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (OAuth Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

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

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

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

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

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

Data Type

String

ProxyPort Property (OAuth Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

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

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (OAuth Component)

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

Syntax

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

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (OAuth Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

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

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

Default Value

psAutomatic

Remarks

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

Data Type

Integer

ProxyUser Property (OAuth Component)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

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

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

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

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

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

Data Type

String

RefreshToken Property (OAuth Component)

This property specifies the refresh token received from or sent to the authorization server.

Syntax

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

Default Value

""

Remarks

When GetAuthorization is called, if the authorization server returns a refresh token along with the access token, this property will hold the refresh token. Save this value for later use.

When your access token expires, set this property to the corresponding refresh token. Then call GetAuthorization, and the component will use this token to retrieve a new access token. The new authorization string will be returned by the GetAuthorization method. No user interaction is required when refreshing an access token.

Data Type

String

ReturnURL Property (OAuth Component)

This property includes the URL where the user (browser) returns after authenticating.

Syntax

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

Default Value

""

Remarks

When ClientProfile is set to ocpApplication, this will be automatically set to the address of the local embedded web server. In that case, this property can be inspected to determine the URL where the user will be redirected, but it does not need to be set.

When calling GetAuthorizationURL, which is common when ClientProfile is set to ocpWeb, set this property to the URL on your server where the user will be redirected after authenticating with the authorization server.

This property corresponds to the redirect_uri query string parameter.

Data Type

String

ServerAuthURL Property (OAuth Component)

This property includes the URL of the authorization server.

Syntax

__property String ServerAuthURL = { read=FServerAuthURL, write=FSetServerAuthURL };

Default Value

""

Remarks

This property specifies the URL of the authorization server used when GetAuthorization is called. This value is used when constructing the URL to which the user will be redirected to authenticate and grant access.

This should be specified before calling GetAuthorization.

Data Type

String

ServerTokenURL Property (OAuth Component)

This property includes the URL used to obtain the access token.

Syntax

__property String ServerTokenURL = { read=FServerTokenURL, write=FSetServerTokenURL };

Default Value

""

Remarks

The property specifies the URL where the grant will be exchanged for the access token. This is typically a separate HTTP endpoint on the authorization server.

This must be set before calling GetAuthorization.

Data Type

String

SSLAcceptServerCertEncoded Property (OAuth Component)

This is the certificate (PEM/base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (OAuth Component)

This is the certificate (PEM/base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (OAuth Component)

This is the name of the certificate store for the client certificate.

Syntax

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

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

SSLCertStorePassword Property (OAuth Component)

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (OAuth Component)

This is the type of certificate store for this certificate.

Syntax

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

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

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (OAuth Component)

This is the subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (OAuth Component)

This specifies the SSL/TLS implementation to use.

Syntax

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

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

Default Value

sslpAutomatic

Remarks

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

Possible values are:

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

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

Data Type

Integer

SSLServerCertEncoded Property (OAuth Component)

This is the certificate (PEM/base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

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

Data Type

Byte Array

Timeout Property (OAuth Component)

A timeout for the component.

Syntax

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

Default Value

60

Remarks

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

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

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (OAuth Component)

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

Syntax

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

Default Value

""

Remarks

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

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

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

Data Type

Byte Array

TransferredHeaders Property (OAuth Component)

This property includes the full set of headers as received from the server.

Syntax

__property String TransferredHeaders = { read=FTransferredHeaders };

Default Value

""

Remarks

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

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

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

Data Type

String

UsePKCE Property (OAuth Component)

This property specifies if Proof Key for Code Exchange (PKCE) should be used.

Syntax

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

Default Value

false

Remarks

If specified, Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when GetAuthorization is called. This applies when using the Authorization Code GrantType. The PKCEChallengeEncoding configuration setting can be used to control the code challenge method that will be used. When using the ocpWeb ClientProfile, the PKCEVerifier configuration setting can be used to get/set the verifier that was used to generate the challenge. See the PKCEVerifier documentation for more information.

Data Type

Boolean

WebServerPort Property (OAuth Component)

This property includes the local port on which the embedded web server listens.

Syntax

__property int WebServerPort = { read=FWebServerPort, write=FSetWebServerPort };

Default Value

0

Remarks

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

Data Type

Integer

WebServerSSLCertStore Property (OAuth Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String WebServerSSLCertStore = { read=FWebServerSSLCertStore, write=FSetWebServerSSLCertStore };
__property DynamicArray<Byte> WebServerSSLCertStoreB = { read=FWebServerSSLCertStoreB, write=FSetWebServerSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The WebServerSSLCertStoreType property denotes the type of the certificate store specified by WebServerSSLCertStore. If the store is password protected, specify the password in WebServerSSLCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

WebServerSSLCertStorePassword Property (OAuth Component)

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

Syntax

__property String WebServerSSLCertStorePassword = { read=FWebServerSSLCertStorePassword, write=FSetWebServerSSLCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

WebServerSSLCertStoreType Property (OAuth Component)

This is the type of certificate store for this certificate.

Syntax

__property TcmOAuthWebServerSSLCertStoreTypes WebServerSSLCertStoreType = { read=FWebServerSSLCertStoreType, write=FSetWebServerSSLCertStoreType };

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

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

WebServerSSLCertSubject Property (OAuth Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String WebServerSSLCertSubject = { read=FWebServerSSLCertSubject, write=FSetWebServerSSLCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

WebServerSSLEnabled Property (OAuth Component)

This property specifies whether the web server requires Secure Sockets Layer (SSL) connections.

Syntax

__property bool WebServerSSLEnabled = { read=FWebServerSSLEnabled, write=FSetWebServerSSLEnabled };

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.

Data Type

Boolean

AddCookie Method (OAuth Component)

This method adds a cookie and the corresponding value to the outgoing request headers.

Syntax

void __fastcall AddCookie(String CookieName, String CookieValue);

Remarks

This property adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

AddParam Method (OAuth Component)

This method adds a name-value pair to the query string parameters of outgoing request.

Syntax

void __fastcall AddParam(String ParamName, String ParamValue);

Remarks

This method can be used to add query string parameters to the outgoing request. One common use for this method would be to add the state parameter to the request, which can be used when the ClientProfile is ocpWeb to add user-defined data. The authorization server will include the state parameter in the response and will be available in the post back to your server, which will allow you to maintain state in your application.

Config Method (OAuth Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

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

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

DoEvents Method (OAuth Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

GetAuthorization Method (OAuth Component)

This method gets the authorization string required to access the protected resource.

Syntax

String __fastcall GetAuthorization();

Remarks

This method performs several operations automatically depending on the value of ClientProfile. Please see the introduction section for the OAuth component for a detailed overview of the typical scenarios.

After authorization is completed, this method will return the authorization string, which can be passed directly to the authorization property of any other component. This can also be passed as the value of the HTTP authorization header to other implementations that access the protected resource as well.

The AccessToken property should be cleared before calling this method.

GetAuthorizationURL Method (OAuth Component)

This method builds and returns the URL to which the user should be redirected for authorization.

Syntax

String __fastcall GetAuthorizationURL();

Remarks

When this method is called, the component will return the URL used for authorization. The component will not make any connections, but instead it will return the URL to you so that you may redirect the user to this location. This is useful when ClientProfile is set to ocpWeb. Before calling this method, set the following:

• ClientId
• ClientSecret
• ReturnURL
• AuthorizationScope (optional)

GetParam Method (OAuth Component)

This method gets a specific parameter from a query string.

Syntax

String __fastcall GetParam(String ParamName);

Remarks

This method can be used to get a specific parameter from a query string.

For example, when using the ocpApplication profile, this method can be used in the ReturnURL event to query the parameters that are returned from the authorization server. Then, it can be called after GetAuthorization completes to query the parameters that the token server responded with.

string authorizationString = oauth.GetAuthorization(); string stateValue = oauth.GetParam("state");

Interrupt Method (OAuth Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

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

Reset Method (OAuth Component)

Reset the component.

Syntax

void __fastcall Reset();

Remarks

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

StartWebServer Method (OAuth Component)

This method starts the embedded web server.

Syntax

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

StopWebServer Method (OAuth Component)

This method stops the embedded web server.

Syntax

void __fastcall StopWebServer();

Remarks

This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authorization process when GetAuthorization 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.

Connected Event (OAuth Component)

This event is fired immediately after a connection completes (or fails).

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TcmOAuthConnectedEventParams;
typedef void __fastcall (__closure *TcmOAuthConnectedEvent)(System::TObject* Sender, TcmOAuthConnectedEventParams *e);
__property TcmOAuthConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (OAuth Component)

This event is fired to indicate changes in the connection state.

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TcmOAuthConnectionStatusEventParams;
typedef void __fastcall (__closure *TcmOAuthConnectionStatusEvent)(System::TObject* Sender, TcmOAuthConnectionStatusEventParams *e);
__property TcmOAuthConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (OAuth Component)

This event is fired when a connection is closed.

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TcmOAuthDisconnectedEventParams;
typedef void __fastcall (__closure *TcmOAuthDisconnectedEvent)(System::TObject* Sender, TcmOAuthDisconnectedEventParams *e);
__property TcmOAuthDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (OAuth Component)

This event is fired when a document finishes transferring.

Syntax

typedef struct {
  int Direction;
} TcmOAuthEndTransferEventParams;
typedef void __fastcall (__closure *TcmOAuthEndTransferEvent)(System::TObject* Sender, TcmOAuthEndTransferEventParams *e);
__property TcmOAuthEndTransferEvent OnEndTransfer = { read=FOnEndTransfer, write=FOnEndTransfer };

Remarks

The EndTransfer event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (OAuth Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TcmOAuthErrorEventParams;
typedef void __fastcall (__closure *TcmOAuthErrorEvent)(System::TObject* Sender, TcmOAuthErrorEventParams *e);
__property TcmOAuthErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

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

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

Header Event (OAuth Component)

This event is fired every time a header line comes in.

Syntax

typedef struct {
  String Field;
  String Value;
} TcmOAuthHeaderEventParams;
typedef void __fastcall (__closure *TcmOAuthHeaderEvent)(System::TObject* Sender, TcmOAuthHeaderEventParams *e);
__property TcmOAuthHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

LaunchBrowser Event (OAuth Component)

This event fires before launching a browser with the authorization URL.

Syntax

typedef struct {
  String URL;
  String Command;
} TcmOAuthLaunchBrowserEventParams;
typedef void __fastcall (__closure *TcmOAuthLaunchBrowserEvent)(System::TObject* Sender, TcmOAuthLaunchBrowserEventParams *e);
__property TcmOAuthLaunchBrowserEvent OnLaunchBrowser = { read=FOnLaunchBrowser, write=FOnLaunchBrowser };

Remarks

When the ClientProfile property is set to ocpApplication and GetAuthorization is called, the component will fire this event with the Command, which will be executed by the component. The URL parameter will be the authorization URL that the user will be directed to authenticate.

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

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

• edit
• explore
• find
• open
• print

Log Event (OAuth Component)

This event fires once for each log message.

Syntax

typedef struct {
  int LogLevel;
  String Message;
  String LogType;
} TcmOAuthLogEventParams;
typedef void __fastcall (__closure *TcmOAuthLogEvent)(System::TObject* Sender, TcmOAuthLogEventParams *e);
__property TcmOAuthLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Redirect Event (OAuth Component)

This event is fired when a redirection is received from the server.

Syntax

typedef struct {
  String Location;
  bool Accept;
} TcmOAuthRedirectEventParams;
typedef void __fastcall (__closure *TcmOAuthRedirectEvent)(System::TObject* Sender, TcmOAuthRedirectEventParams *e);
__property TcmOAuthRedirectEvent OnRedirect = { read=FOnRedirect, write=FOnRedirect };

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the component raises an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

ReturnURL Event (OAuth Component)

This event fires when the user is redirected to the embedded web server.

Syntax

typedef struct {
  String URLPath;
  String QueryString;
  String ResponseHeaders;
  String ResponseBody;
} TcmOAuthReturnURLEventParams;
typedef void __fastcall (__closure *TcmOAuthReturnURLEvent)(System::TObject* Sender, TcmOAuthReturnURLEventParams *e);
__property TcmOAuthReturnURLEvent OnReturnURL = { read=FOnReturnURL, write=FOnReturnURL };

Remarks

When ClientProfile is set to ocpApplication and the embedded web server is used (default), this event will fire when the user is redirected from the authorization server back to the local embedded web server. The event provides an opportunity to set the ResponseHeaders and ResponseBody and to provide a custom response that the user will see in their browser.

URLPath and QueryString are informational parameters that show the values sent by the authorization server.

Additionally, the Params* properties will be populated. This allows the GetParam method to be used to get a specific parameter returned from the authorization server when used within this event.

SetCookie Event (OAuth Component)

This event is fired for every cookie set by the server.

Syntax

typedef struct {
  String Name;
  String Value;
  String Expires;
  String Domain;
  String Path;
  bool Secure;
} TcmOAuthSetCookieEventParams;
typedef void __fastcall (__closure *TcmOAuthSetCookieEvent)(System::TObject* Sender, TcmOAuthSetCookieEventParams *e);
__property TcmOAuthSetCookieEvent OnSetCookie = { read=FOnSetCookie, write=FOnSetCookie };

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (OAuth Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TcmOAuthSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TcmOAuthSSLServerAuthenticationEvent)(System::TObject* Sender, TcmOAuthSSLServerAuthenticationEventParams *e);
__property TcmOAuthSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

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

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

SSLStatus Event (OAuth Component)

Shows the progress of the secure connection.

Syntax

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

Remarks

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

StartTransfer Event (OAuth Component)

This event is fired when a document starts transferring (after the headers).

Syntax

typedef struct {
  int Direction;
} TcmOAuthStartTransferEventParams;
typedef void __fastcall (__closure *TcmOAuthStartTransferEvent)(System::TObject* Sender, TcmOAuthStartTransferEventParams *e);
__property TcmOAuthStartTransferEvent OnStartTransfer = { read=FOnStartTransfer, write=FOnStartTransfer };

Remarks

The StartTransfer event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (OAuth Component)

This event is fired when the HTTP status line is received from the server.

Syntax

typedef struct {
  String HTTPVersion;
  int StatusCode;
  String Description;
} TcmOAuthStatusEventParams;
typedef void __fastcall (__closure *TcmOAuthStatusEvent)(System::TObject* Sender, TcmOAuthStatusEventParams *e);
__property TcmOAuthStatusEvent OnStatus = { read=FOnStatus, write=FOnStatus };

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (OAuth Component)

This event is fired while a document transfers (delivers document).

Syntax

typedef struct {
  int Direction;
  __int64 BytesTransferred;
  int PercentDone;
  String Text;
  DynamicArray<Byte> TextB;
} TcmOAuthTransferEventParams;
typedef void __fastcall (__closure *TcmOAuthTransferEvent)(System::TObject* Sender, TcmOAuthTransferEventParams *e);
__property TcmOAuthTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (OAuth Component)

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (OAuth Component)

OAuth Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors