# OAuth Module The OAuth module is used to authorize a client and provide an authorization string used in future requests. ## Syntax ```text IPWorks.OAuth ``` ## Remarks The OAuth class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the [SSLServerAuthentication](#sslserverauthentication-event-oauth-module) event allows you to check the server identity and other security attributes. The [SSLStatus](#sslstatus-event-oauth-module) event provides information about the SSL handshake. Additional SSL-related settings are also supported through the [Config](#config-method-oauth-module) method. The OAuth class provides an easy way to obtain an authorization string for future requests to a service. The class implements an OAuth 2.0 client. To begin using the class, first register your application with the service you want to use. During this process, obtain a [ClientId](#clientid-property-oauth-module) and [ClientSecret](#clientsecret-property-oauth-module) as well as the [ServerAuthURL](#serverauthurl-property-oauth-module) and [ServerTokenURL](#servertokenurl-property-oauth-module) for the authorization server. Then set [ClientProfile](#clientprofile-property-oauth-module) to the client profile that best describes your situation and call [GetAuthorization](#getauthorization-method-oauth-module). The following client profiles are currently supported by the class: - 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) Please see the detailed descriptions for each client profile as well as how the class is used to authorize an application using that client profile. ## 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](#clientprofile-property-oauth-module) to ocpApplication. This defines the profile the class will use. Set the [ClientId](#clientid-property-oauth-module), [ClientSecret](#clientsecret-property-oauth-module), [ServerAuthURL](#serverauthurl-property-oauth-module), and [ServerTokenURL](#servertokenurl-property-oauth-module) to the values you obtained when registering your application. Second, call [GetAuthorization](#getauthorization-method-oauth-module) to begin the authorization process. When [GetAuthorization](#getauthorization-method-oauth-module) is called, the class will build the URL to which the user will be directed and fire the [LaunchBrowser](#launchbrowser-event-oauth-module) event. The class will then launch the browser using the command and URL shown in the [LaunchBrowser](#launchbrowser-event-oauth-module) event and await the response. The duration for which the class will wait for a response is defined by [BrowserResponseTimeout](#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](#getauthorization-method-oauth-module) was called. At this time, the [ReturnURL](#returnurl-event-oauth-module) 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 class will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in [ServerTokenURL](#servertokenurl-property-oauth-module). The authorization is now complete and the [GetAuthorization](#getauthorization-method-oauth-module) 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: ```text 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](#clientprofile-property-oauth-module) to ocpWeb. This defines the profile the component will use. Set the [ClientId](#clientid-property-oauth-module), [ClientSecret](#clientsecret-property-oauth-module), [ServerAuthURL](#serverauthurl-property-oauth-module), and [ServerTokenURL](#servertokenurl-property-oauth-module) to the values you obtained when registering your application. Set [ReturnURL](#returnurl-property-oauth-module) to the page on your site that will be the endpoint the user is redirected back to after authentication. Second, call [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). 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](#returnurl-property-oauth-module), parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set [AuthorizationCode](#authorizationcode-property-oauth-module) property to the parsed value. Fourth, after [AuthorizationCode](#authorizationcode-property-oauth-module) is set, call [GetAuthorization](#getauthorization-method-oauth-module) to exchange the code specified in [AuthorizationCode](#authorizationcode-property-oauth-module) for a token from the server specified by [ServerTokenURL](#servertokenurl-property-oauth-module). [GetAuthorization](#getauthorization-method-oauth-module) 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](#clientprofile-property-oauth-module) to ocpDevice. This defines the profile the class will use. Set the [ClientId](#clientid-property-oauth-module), [ClientSecret](#clientsecret-property-oauth-module), [ServerAuthURL](#serverauthurl-property-oauth-module), and [ServerTokenURL](#servertokenurl-property-oauth-module) to the values you obtained when registering your application. Do not set [ReturnURL](#returnurl-property-oauth-module). Second, call [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). The class will automatically make a request to [ServerAuthURL](#serverauthurl-property-oauth-module) to obtain a user code for the device. The [GetAuthorizationURL](#getauthorizationurl-method-oauth-module) method will return the URL your user must visit from another device or computer that has web browser support. The [GetAuthorizationURL](#getauthorizationurl-method-oauth-module) method will also populate [DeviceUserCode](#DeviceUserCode). This device user code must be provided to the user. The user will enter the code at the URL returned by [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). Third, at this time, call [GetAuthorization](#getauthorization-method-oauth-module). The class will begin polling the server specified in [ServerTokenURL](#servertokenurl-property-oauth-module). The polling interval is specified (in seconds) by the [PollingInterval](#PollingInterval) setting. Fourth, after the user has authenticated, the [GetAuthorization](#getauthorization-method-oauth-module) 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](#launchbrowser-event-oauth-module) event will fire but the class 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](#authorizationscope-property-oauth-module) [ServerTokenURL](#servertokenurl-property-oauth-module) and [JWTServiceProvider](#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](#JWTJSONKey) configuration setting, which will parse the necessary information automatically, or manually specify the following configuration settings: - [JWTIssuer](#JWTIssuer) (required) - [JWTAudience](#JWTAudience) (required) - [JWTCertStoreType](#JWTCertStoreType) (required) - [JWTCertStore](#JWTCertStore) (required) - [JWTCertStorePassword](#JWTCertStorePassword) (required) - [JWTCertSubject](#JWTCertSubject) (required) - [JWTSubject](#JWTSubject) - [JWTValidityTime](#JWTValidityTime) - [JWTSignatureAlgorithm](#JWTSignatureAlgorithm) Additional fields may be added to the JWT using the [AddParam](#addparam-method-oauth-module) method. **Example 1. Google:** ```text 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:** ```text 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](#clientprofile-property-oauth-module) is set to *ocpApplication*. By default, the class 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. | Configuration Setting | Description | | --- | --- | | [ResponseSuccessHeading](#ResponseSuccessHeading) | Short header text indicating success. The default value is Authorization Successful | | [ResponseSuccessMessage](#ResponseSuccessMessage) | A description for a successful authorization. The default value is Access to your account was successfully authorized. You may now close this window. | | [ResponseFailureHeading](#ResponseFailureHeading) | Short header text indicating failure. The default value is Authorization Failed | | [ResponseFailureMessage](#ResponseFailureMessage) | A description for a failed authorization. The default value is Access to your account could not be authorized. Please check your user and connection details and try again. | | [ResponseHelpURL](#ResponseHelpURL) | A URL to a help page or other resource. If set, a Help link will be displayed and point to this URL. | | [ResponseLicenseURL](#ResponseLicenseURL) | A URL to licensing terms. If set, a License link will be displayed and point to this URL. | | [ResponseProductURL](#ResponseProductURL) | A URL to a product page or similar resource. This is used in conjunction with [ResponseProductImage](#ResponseProductImage). | | [ResponseProductImage](#ResponseProductImage) | A URL or full path to a product image. If set, the image will be displayed and will be a hyperlink to [ResponseProductURL](#ResponseProductURL). | | [ResponseCompanyURL](#ResponseCompanyURL) | A URL to the company website or similar resource. This is used in conjunction with [ResponseCompanyImage](#ResponseCompanyImage). | | [ResponseCompanyImage](#ResponseCompanyImage) | A URL or full path to a company logo. If set, the image will be displayed and will be a hyperlink to [ResponseCompanyURL](#ResponseCompanyURL). | Alternatively, for complete control, set the [WebServerResponse](#WebServerResponse) and [WebServerFailedResponse](#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 module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AccessToken](#accesstoken-property-oauth-module) | The access token returned by the authorization server. | | [AccessTokenExp](#accesstokenexp-property-oauth-module) | The lifetime of the access token. | | [AuthorizationCode](#authorizationcode-property-oauth-module) | The authorization code that is exchanged for an access token. | | [AuthorizationScope](#authorizationscope-property-oauth-module) | The scope request or response parameter used during authorization. | | [ClientId](#clientid-property-oauth-module) | The Id of the client assigned when registering the application. | | [ClientProfile](#clientprofile-property-oauth-module) | The type of client that is requesting authorization. | | [ClientSecret](#clientsecret-property-oauth-module) | The secret value for the client assigned when registering the application. | | [Connected](#connected-property-oauth-module) | Whether the module is connected. | | [Cookies](#cookies-property-oauth-module) | A collection of cookies. | | [Firewall](#firewall-property-oauth-module) | A set of properties related to firewall access. | | [FollowRedirects](#followredirects-property-oauth-module) | Determines what happens when the server issues a redirect. | | [GrantType](#granttype-property-oauth-module) | The OAuth grant type used to acquire an OAuth access token. | | [Idle](#idle-property-oauth-module) | The current status of the module. | | [LocalHost](#localhost-property-oauth-module) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [OtherHeaders](#otherheaders-property-oauth-module) | Other headers as determined by the user (optional). | | [Params](#params-property-oauth-module) | The parameters to be included in the request to the authorization server or received in the response. | | [Proxy](#proxy-property-oauth-module) | A set of properties related to proxy access. | | [RefreshToken](#refreshtoken-property-oauth-module) | The refresh token received from or sent to the authorization server. | | [ReturnURL](#returnurl-property-oauth-module) | The URL where the user (browser) returns after authenticating. | | [ServerAuthURL](#serverauthurl-property-oauth-module) | The URL of the authorization server. | | [ServerTokenURL](#servertokenurl-property-oauth-module) | The URL used to obtain the access token. | | [SSLAcceptServerCert](#sslacceptservercert-property-oauth-module) | Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. | | [SSLCert](#sslcert-property-oauth-module) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [SSLProvider](#sslprovider-property-oauth-module) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [SSLServerCert](#sslservercert-property-oauth-module) | The server certificate for the last established connection. | | [Timeout](#timeout-property-oauth-module) | The timeout for the module. | | [TransferredData](#transferreddata-property-oauth-module) | The contents of the last response from the server. | | [TransferredHeaders](#transferredheaders-property-oauth-module) | The full set of headers as received from the server. | | [UsePKCE](#usepkce-property-oauth-module) | Whether Proof Key for Code Exchange (PKCE) should be used. | | [WebServerPort](#webserverport-property-oauth-module) | The local port on which the embedded web server listens. | | [WebServerSSLCert](#webserversslcert-property-oauth-module) | The certificate with the private key to use when a Secure Sockets Layer (SSL) is enabled. | | [WebServerSSLEnabled](#webserversslenabled-property-oauth-module) | Whether the web server requires Secure Sockets Layer (SSL) connections. | ## Method List *The following is the full list of the methods of the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddCookie](#addcookie-method-oauth-module) | Adds a cookie and the corresponding value to the outgoing request headers. | | [AddParam](#addparam-method-oauth-module) | Adds a name-value pair to the query string parameters of the outgoing request. | | [Config](#config-method-oauth-module) | Sets or retrieves a configuration setting. | | [DoEvents](#doevents-method-oauth-module) | This method processes events from the internal message queue. | | [GetAuthorization](#getauthorization-method-oauth-module) | Gets the authorization string required to access the protected resource. | | [GetAuthorizationURL](#getauthorizationurl-method-oauth-module) | Builds and returns the URL to which the user should be redirected for authorization. | | [GetParam](#getparam-method-oauth-module) | Gets a specific parameter from a query string. | | [Interrupt](#interrupt-method-oauth-module) | This method interrupts the current method. | | [Reset](#reset-method-oauth-module) | This method will reset the module. | | [StartWebServer](#startwebserver-method-oauth-module) | Starts the embedded web server. | | [StopWebServer](#stopwebserver-method-oauth-module) | Stops the embedded web server. | ## Event List *The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connected](#connected-event-oauth-module) | Fired immediately after a connection completes (or fails). | | [ConnectionStatus](#connectionstatus-event-oauth-module) | Fired to indicate changes in the connection state. | | [Disconnected](#disconnected-event-oauth-module) | Fired when a connection is closed. | | [EndTransfer](#endtransfer-event-oauth-module) | Fired when a document finishes transferring. | | [Error](#error-event-oauth-module) | Fired when information is available about errors during data delivery. | | [Header](#header-event-oauth-module) | Fired every time a header line comes in. | | [LaunchBrowser](#launchbrowser-event-oauth-module) | Fires before launching a browser with the authorization URL. | | [Log](#log-event-oauth-module) | Fired once for each log message. | | [Redirect](#redirect-event-oauth-module) | Fired when a redirection is received from the server. | | [ReturnURL](#returnurl-event-oauth-module) | Fired when the user is redirected to the embedded web server. | | [SetCookie](#setcookie-event-oauth-module) | Fired for every cookie set by the server. | | [SSLServerAuthentication](#sslserverauthentication-event-oauth-module) | Fired after the server presents its certificate to the client. | | [SSLStatus](#sslstatus-event-oauth-module) | Fired when secure connection progress messages are available. | | [StartTransfer](#starttransfer-event-oauth-module) | Fired when a document starts transferring (after the headers). | | [Status](#status-event-oauth-module) | Fired when the HTTP status line is received from the server. | | [Transfer](#transfer-event-oauth-module) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthMethod](#AuthMethod) | Specifies how the client credentials are sent to the token server. | | [AuthorizationTokenType](#AuthorizationTokenType) | The type of access token returned. | | [DeviceGrantType](#DeviceGrantType) | The grant type to be used when the ClientProfile is set to ocpDevice. | | [DeviceUserCode](#DeviceUserCode) | The device's user code when the ClientProfile is set to ocpDevice. | | [FormVarCount](#FormVarCount) | Specifies the number of additional form variables to include in the request. | | [FormVarName\[i\]](#FormVarName[i]) | Specifies the form variable name at the specified index. | | [FormVarValue\[i\]](#FormVarValue[i]) | Specifies the form variable value at the specified index. | | [IncludeClientCredsInBody](#IncludeClientCredsInBody) | Whether to include the client credentials in the header or request body. | | [IncludeEmptyRedirectURI](#IncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. | | [JWTAudience](#JWTAudience) | The JWT audience when the ClientProfile is set to ocpJWT. | | [JWTCertStore](#JWTCertStore) | The name of the certificate store for the JWT signing certificate. | | [JWTCertStorePassword](#JWTCertStorePassword) | The JWT signing certificate password. | | [JWTCertStoreType](#JWTCertStoreType) | The type of certificate store. | | [JWTCertSubject](#JWTCertSubject) | The JWT signing certificate subject. | | [JWTIssuer](#JWTIssuer) | The JWT issuer when the ClientProfile is set to ocpJWT. | | [JWTJSONKey](#JWTJSONKey) | The data or file path of the JWT JSON Key. | | [JWTPayload](#JWTPayload) | The payload of the JWT access token, if present. | | [JWTServiceProvider](#JWTServiceProvider) | The service provider to which authentication is being performed. | | [JWTSignatureAlgorithm](#JWTSignatureAlgorithm) | The signature algorithm used to sign the JWT. | | [JWTSubject](#JWTSubject) | The subject field in the JWT. | | [JWTValidityTime](#JWTValidityTime) | The amount of time in seconds for which the assertion in the JWT is valid. | | [JWTXChildCount](#JWTXChildCount) | The number of child elements of the current element. | | [JWTXChildName\[i\]](#JWTXChildName[i]) | The name of the child element. | | [JWTXChildXText\[i\]](#JWTXChildXText[i]) | The inner text of the child element. | | [JWTXElement](#JWTXElement) | The name of the current element. | | [JWTXParent](#JWTXParent) | The parent of the current element. | | [JWTXPath](#JWTXPath) | Points to a specific element in the returned payload of a JWT based access token. | | [JWTXSubTree](#JWTXSubTree) | A snapshot of the current element in the document. | | [JWTXText](#JWTXText) | The text of the current element. | | [Microsoft365AdminConsentError](#Microsoft365AdminConsentError) | The error message returned when the admin denies consent to the scopes. | | [Microsoft365AdminConsentErrorDesc](#Microsoft365AdminConsentErrorDesc) | The error description returned when the admin denies consent to the scopes. | | [Microsoft365AdminConsentTenant](#Microsoft365AdminConsentTenant) | The tenant ID returned after the admin consents to the scopes. | | [Office365ServiceAPIVersion](#Office365ServiceAPIVersion) | The API version of the Office 365 service being discovered. | | [Office365ServiceCapability](#Office365ServiceCapability) | The API capability of the Office 365 service being discovered. | | [Office365ServiceEndpoint](#Office365ServiceEndpoint) | The Office 365 endpoint for the service that matches the criteria specified. | | [PasswordGrantUsername](#PasswordGrantUsername) | The Username field when using the password grant type. | | [PKCEChallengeEncoding](#PKCEChallengeEncoding) | The PKCE code challenge method to use. | | [PKCEVerifier](#PKCEVerifier) | The PKCE verifier used to generate the challenge. | | [PollingInterval](#PollingInterval) | The interval in seconds between polling requests when the device client profile is used. | | [ResponseMode](#ResponseMode) | The value of the response_mode parameter. | | [TokenInfoFieldCount](#TokenInfoFieldCount) | The number of fields in the tokeninfo service response. | | [TokenInfoFieldName\[i\]](#TokenInfoFieldName[i]) | The name of the tokeninfo service response field. | | [TokenInfoFieldValue\[i\]](#TokenInfoFieldValue[i]) | The value of the tokeninfo service response field. | | [TokenInfoURL](#TokenInfoURL) | The URL of the tokeninfo service. | | [ValidateToken](#ValidateToken) | Validates the specified access token with a tokeninfo service. | | [BrowserResponseTimeout](#BrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. | | [ResponseCompanyImage](#ResponseCompanyImage) | A URL or full path to a company logo. | | [ResponseCompanyURL](#ResponseCompanyURL) | A URL to the company website or similar resource. | | [ResponseFailureHeading](#ResponseFailureHeading) | Short header text indicating failure. | | [ResponseFailureMessage](#ResponseFailureMessage) | A description for a failed authorization. | | [ResponseHelpURL](#ResponseHelpURL) | A URL to a help page or other resource. | | [ResponseLicenseURL](#ResponseLicenseURL) | A URL to licensing terms. | | [ResponseProductImage](#ResponseProductImage) | A URL or full path to a product image. | | [ResponseProductURL](#ResponseProductURL) | A URL to a product page or similar resource. | | [ResponseSuccessHeading](#ResponseSuccessHeading) | Short header text indicating success. | | [ResponseSuccessMessage](#ResponseSuccessMessage) | A description for a successful authorization. | | [WebServerFailedResponse](#WebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. | | [WebServerHost](#WebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. | | [WebServerResponse](#WebServerResponse) | The custom response that is displayed to the user. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the module. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the module will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the module. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the module. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the module whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the module binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # AccessToken Property ([OAuth](#oauth-module) Module) The access token returned by the authorization server. ## Syntax ```text public var accessToken: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property will be populated with the access token returned by the authorization server after a call to [GetAuthorization](#getauthorization-method-oauth-module). This will be the raw access token, whereas the return value from the [GetAuthorization](#getauthorization-method-oauth-module) 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. # AccessTokenExp Property ([OAuth](#oauth-module) Module) The lifetime of the access token. ## Syntax ```text public var accessTokenExp: Int32 { get {...} } ``` ## 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. # AuthorizationCode Property ([OAuth](#oauth-module) Module) The authorization code that is exchanged for an access token. ## Syntax ```text public var authorizationCode: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property is used with the AuthorizationCode [GrantType](#granttype-property-oauth-module). When [ClientProfile](#clientprofile-property-oauth-module) is set to ocpApplication (Application flow), this property will be informational only, as the [GetAuthorization](#getauthorization-method-oauth-module) method will automatically exchange this code for a token with the authorization server specified in [ServerTokenURL](#servertokenurl-property-oauth-module). When [ClientProfile](#clientprofile-property-oauth-module) 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](#clientprofile-property-oauth-module) for more information. If this property is set before calling [GetAuthorization](#getauthorization-method-oauth-module), the class 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. # AuthorizationScope Property ([OAuth](#oauth-module) Module) The scope request or response parameter used during authorization. ## Syntax ```text public var authorizationScope: String { get {...} set {...} } ``` ## 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](#getauthorization-method-oauth-module), this property will be updated with the scope sent in the response from the server and will indicate the scope that was actually granted. # ClientId Property ([OAuth](#oauth-module) Module) The Id of the client assigned when registering the application. ## Syntax ```text public var clientId: String { get {...} set {...} } ``` ## 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](#getauthorization-method-oauth-module) or [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). # ClientProfile Property ([OAuth](#oauth-module) Module) The type of client that is requesting authorization. ## Syntax ```text public var clientProfile: OAuthClientProfiles { get {...} set {...} } public enum OAuthClientProfiles: Int32 { case ocpApplication = 0 case ocpWeb = 1 case ocpDevice = 2 case ocpMobile = 3 case ocpJWT = 4 } ``` ## Default Value 0 ## Remarks This defines the type of client that will be requesting authorization. Set this before calling [GetAuthorization](#getauthorization-method-oauth-module) to inform the class to act accordingly. Possible values are as follows: | | | | --- | --- | | 0 (ocpApplication - default) | User application, such as a Windows form application | | 1 (ocpWeb) | Server-side application, such as a website | | 2 (ocpDevice) | Device application without a browser, such as a game console | | 3 (ocpMobile) | Mobile application with browser support, such as a smart phone or tablet | | 4 (ocpJWT) | Server-to-Server authentication using a JWT Bearer Token | ## 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 class will use. Set the [ClientId](#clientid-property-oauth-module), [ClientSecret](#clientsecret-property-oauth-module), [ServerAuthURL](#serverauthurl-property-oauth-module), and [ServerTokenURL](#servertokenurl-property-oauth-module) to the values you obtained when registering your application. Second, call [GetAuthorization](#getauthorization-method-oauth-module) to begin the authorization process. When [GetAuthorization](#getauthorization-method-oauth-module) is called, the class will build the URL to which the user will be directed and fire the [LaunchBrowser](#launchbrowser-event-oauth-module) event. The class will then launch the browser using the command and URL shown in the [LaunchBrowser](#launchbrowser-event-oauth-module) event and await the response. The duration for which the class will wait for a response is defined by [BrowserResponseTimeout](#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](#getauthorization-method-oauth-module) was called. At this time, the [ReturnURL](#returnurl-event-oauth-module) 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 class will then automatically exchange the grant that was returned by the authorization server for the access token using the HTTP endpoint specified in [ServerTokenURL](#servertokenurl-property-oauth-module). The authorization is now complete and the [GetAuthorization](#getauthorization-method-oauth-module) 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: ```text 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](#clientid-property-oauth-module), [ClientSecret](#clientsecret-property-oauth-module), [ServerAuthURL](#serverauthurl-property-oauth-module), and [ServerTokenURL](#servertokenurl-property-oauth-module) to the values you obtained when registering your application. Set [ReturnURL](#returnurl-property-oauth-module) to the page on your site that will be the endpoint the user is redirected back to after authentication. Second, call [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). 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](#returnurl-property-oauth-module), parse the "code" query string parameter from the incoming request to get the authorization code from the authorization server. Then, set [AuthorizationCode](#authorizationcode-property-oauth-module) property to the parsed value. Fourth, after [AuthorizationCode](#authorizationcode-property-oauth-module) is set, call [GetAuthorization](#getauthorization-method-oauth-module) to exchange the code specified in [AuthorizationCode](#authorizationcode-property-oauth-module) for a token from the server specified by [ServerTokenURL](#servertokenurl-property-oauth-module). [GetAuthorization](#getauthorization-method-oauth-module) 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 class will use. Set the [ClientId](#clientid-property-oauth-module), [ClientSecret](#clientsecret-property-oauth-module), [ServerAuthURL](#serverauthurl-property-oauth-module), and [ServerTokenURL](#servertokenurl-property-oauth-module) to the values you obtained when registering your application. Do not set [ReturnURL](#returnurl-property-oauth-module). Second, call [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). The class will automatically make a request to [ServerAuthURL](#serverauthurl-property-oauth-module) to obtain a user code for the device. The [GetAuthorizationURL](#getauthorizationurl-method-oauth-module) method will return the URL your user must visit from another device or computer that has web browser support. The [GetAuthorizationURL](#getauthorizationurl-method-oauth-module) method will also populate [DeviceUserCode](#DeviceUserCode). This device user code must be provided to the user. The user will enter the code at the URL returned by [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). Third, at this time, call [GetAuthorization](#getauthorization-method-oauth-module). The class will begin polling the server specified in [ServerTokenURL](#servertokenurl-property-oauth-module). The polling interval is specified (in seconds) by the [PollingInterval](#PollingInterval) setting. Fourth, after the user has authenticated, the [GetAuthorization](#getauthorization-method-oauth-module) 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](#launchbrowser-event-oauth-module) event will fire but the class 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](#authorizationscope-property-oauth-module) [ServerTokenURL](#servertokenurl-property-oauth-module) and [JWTServiceProvider](#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](#JWTJSONKey) configuration setting, which will parse the necessary information automatically, or manually specify the following configuration settings: - [JWTIssuer](#JWTIssuer) (required) - [JWTAudience](#JWTAudience) (required) - [JWTCertStoreType](#JWTCertStoreType) (required) - [JWTCertStore](#JWTCertStore) (required) - [JWTCertStorePassword](#JWTCertStorePassword) (required) - [JWTCertSubject](#JWTCertSubject) (required) - [JWTSubject](#JWTSubject) - [JWTValidityTime](#JWTValidityTime) - [JWTSignatureAlgorithm](#JWTSignatureAlgorithm) Additional fields may be added to the JWT using the [AddParam](#addparam-method-oauth-module) method. **Example 1. Google:** ```text 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:** ```text 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(); ``` # ClientSecret Property ([OAuth](#oauth-module) Module) The secret value for the client assigned when registering the application. ## Syntax ```text public var clientSecret: String { get {...} set {...} } ``` ## 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](#getauthorization-method-oauth-module) or [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). # Connected Property ([OAuth](#oauth-module) Module) Whether the module is connected. ## Syntax ```text public var connected: Bool { get {...} } ``` ## Default Value False ## Remarks This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection. This property is read-only. # Cookies Property ([OAuth](#oauth-module) Module) A collection of cookies. ## Syntax ```text public var cookies: Array { get {...} } ``` ## Default Value False ## Remarks This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type [HTTPCookie](#httpcookie-type)) to this collection. To see cookies that are set by the server, use the [SetCookie](#setcookie-event-oauth-module) event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies. [MaxHTTPCookies](#MaxHTTPCookies) can be used to control the maximum number of cookies saved. # Firewall Property ([OAuth](#oauth-module) Module) A set of properties related to firewall access. ## Syntax ```text public var firewall: Firewall { get {...} set {...} } ``` ## Default Value False ## Remarks This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect. # FollowRedirects Property ([OAuth](#oauth-module) Module) Determines what happens when the server issues a redirect. ## Syntax ```text public var followRedirects: OAuthFollowRedirects { get {...} set {...} } public enum OAuthFollowRedirects: Int32 { case frNever = 0 case frAlways = 1 case 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 . 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](#redirect-event-oauth-module) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-oauth-module) 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 instead. # GrantType Property ([OAuth](#oauth-module) Module) The OAuth grant type used to acquire an OAuth access token. ## Syntax ```text public var grantType: OAuthGrantTypes { get {...} set {...} } public enum OAuthGrantTypes: Int32 { case ogtAuthorizationCode = 0 case ogtImplicit = 1 case ogtPassword = 2 case ogtClientCredentials = 3 case ogtAdminConsent = 4 } ``` ## Default Value 0 ## 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: | | | | --- | --- | | 0 (ogtAuthorizationCode - Default) | Authorization Code grant type | | 1 (ogtImplicit) | Implicit grant type | | 2 (ogtPassword) | Resource Owner Password Credentials grant type | | 3 (ogtClientCredentials) | Client Credentials grant type | | 4 (ogtAdminConsent) | Admin consent for Microsoft API application scopes | For all grant types listed set [ClientProfile](#clientprofile-property-oauth-module) 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](#oauth-module) 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](#clientid-property-oauth-module) - [ClientSecret](#clientsecret-property-oauth-module) - [ServerAuthURL](#serverauthurl-property-oauth-module) And call [GetAuthorization](#getauthorization-method-oauth-module). 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](#PasswordGrantUsername) to the username of the resource owner - [ClientSecret](#clientsecret-property-oauth-module) to the password of the resource owner - [ClientId](#clientid-property-oauth-module) optional, set to the client id for the resource - [ServerTokenURL](#servertokenurl-property-oauth-module) And call [GetAuthorization](#getauthorization-method-oauth-module). 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](#clientid-property-oauth-module) - [ClientSecret](#clientsecret-property-oauth-module) - [ServerTokenURL](#servertokenurl-property-oauth-module) And call [GetAuthorization](#getauthorization-method-oauth-module). The *AdminConsent* grant type is used when setting up application permissions for apps that authenticate to Microsoft. To use this grant type set: - [ClientId](#clientid-property-oauth-module) And call [GetAuthorization](#getauthorization-method-oauth-module). The class will then start the embedded web server, fire the [LaunchBrowser](#launchbrowser-event-oauth-module) event, and open the admin consent page URL. If the Admin consents to the scopes, the tenant ID can be accessed through the [Microsoft365AdminConsentTenant](#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](#Microsoft365AdminConsentError) configuration setting and the error description can be found in the [Microsoft365AdminConsentErrorDesc](#Microsoft365AdminConsentErrorDesc) configuration setting. # Idle Property ([OAuth](#oauth-module) Module) The current status of the module. ## Syntax ```text public var idle: Bool { get {...} } ``` ## Default Value True ## Remarks This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times. This property is read-only. # LocalHost Property ([OAuth](#oauth-module) Module) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public var localHost: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window. # OtherHeaders Property ([OAuth](#oauth-module) Module) Other headers as determined by the user (optional). ## Syntax ```text public var otherHeaders: String { get {...} set {...} } ``` ## 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 . 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. # Params Property ([OAuth](#oauth-module) Module) The parameters to be included in the request to the authorization server or received in the response. ## Syntax ```text public var params: Array { get {...} } ``` ## Default Value False ## 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. # Proxy Property ([OAuth](#oauth-module) Module) A set of properties related to proxy access. ## Syntax ```text public var proxy: Proxy { get {...} set {...} } ``` ## Default Value False ## Remarks This property contains fields describing the proxy through which the class will attempt to connect. # RefreshToken Property ([OAuth](#oauth-module) Module) The refresh token received from or sent to the authorization server. ## Syntax ```text public var refreshToken: String { get {...} set {...} } ``` ## Default Value "" ## Remarks When [GetAuthorization](#getauthorization-method-oauth-module) 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](#getauthorization-method-oauth-module), and the class will use this token to retrieve a new access token. The new authorization string will be returned by the [GetAuthorization](#getauthorization-method-oauth-module) method. No user interaction is required when refreshing an access token. # ReturnURL Property ([OAuth](#oauth-module) Module) The URL where the user (browser) returns after authenticating. ## Syntax ```text public var returnURL: String { get {...} set {...} } ``` ## Default Value "" ## Remarks When [ClientProfile](#clientprofile-property-oauth-module) 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](#getauthorizationurl-method-oauth-module), which is common when [ClientProfile](#clientprofile-property-oauth-module) 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. # ServerAuthURL Property ([OAuth](#oauth-module) Module) The URL of the authorization server. ## Syntax ```text public var serverAuthURL: String { get {...} set {...} } ``` ## Default Value "" ## Remarks This property specifies the URL of the authorization server used when [GetAuthorization](#getauthorization-method-oauth-module) 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](#getauthorization-method-oauth-module). # ServerTokenURL Property ([OAuth](#oauth-module) Module) The URL used to obtain the access token. ## Syntax ```text public var serverTokenURL: String { get {...} set {...} } ``` ## 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](#getauthorization-method-oauth-module). # SSLAcceptServerCert Property ([OAuth](#oauth-module) Module) Instructs the module to unconditionally accept the server certificate that matches the supplied certificate. ## Syntax ```text public var sslAcceptServerCert: Certificate { get {...} set {...} } ``` ## Default Value False ## 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 ([OAuth](#oauth-module) Module) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public var sslCert: Certificate { get {...} set {...} } ``` ## Default Value False ## 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 field to the encoded certificate. To select a certificate, use the store and subject fields. # SSLProvider Property ([OAuth](#oauth-module) Module) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public var sslProvider: OAuthSSLProviders { get {...} set {...} } public enum OAuthSSLProviders: Int32 { case sslpAutomatic = 0 case sslpPlatform = 1 case 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: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition. # SSLServerCert Property ([OAuth](#oauth-module) Module) The server certificate for the last established connection. ## Syntax ```text public var sslServerCert: Certificate { get {...} } ``` ## Default Value False ## Remarks This property contains the server certificate for the last established connection. SSLServerCert is reset every time a new connection is attempted. # Timeout Property ([OAuth](#oauth-module) Module) The timeout for the module. ## Syntax ```text public var timeout: Int32 { get {...} set {...} } ``` ## 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](#doevents-method-oauth-module) 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 . NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the Timeout property is 60 seconds. # TransferredData Property ([OAuth](#oauth-module) Module) The contents of the last response from the server. ## Syntax ```text public var transferredData: String { get {...} } public var transferredDataB: Data { get {...} } ``` ## Default Value "" ## Remarks This property contains the contents of the last response from the server. [TransferredDataLimit](#TransferredDataLimit) controls the maximum amount of data accumulated in TransferredData (by default, there is no limit). This property is read-only. # TransferredHeaders Property ([OAuth](#oauth-module) Module) The full set of headers as received from the server. ## Syntax ```text public var transferredHeaders: String { get {...} } ``` ## Default Value "" ## Remarks This property returns the complete set of raw headers as received from the server. The [Header](#header-event-oauth-module) event shows the individual headers as parsed by the class. This property is read-only. # UsePKCE Property ([OAuth](#oauth-module) Module) Whether Proof Key for Code Exchange (PKCE) should be used. ## Syntax ```text public var usePKCE: Bool { get {...} set {...} } ``` ## Default Value False ## Remarks If specified, Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when [GetAuthorization](#getauthorization-method-oauth-module) is called. This applies when using the Authorization Code [GrantType](#granttype-property-oauth-module). The [PKCEChallengeEncoding](#PKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used. When using the ocpWeb [ClientProfile](#clientprofile-property-oauth-module), the [PKCEVerifier](#PKCEVerifier) configuration setting can be used to get/set the verifier that was used to generate the challenge. See the [PKCEVerifier](#PKCEVerifier) documentation for more information. # WebServerPort Property ([OAuth](#oauth-module) Module) The local port on which the embedded web server listens. ## Syntax ```text public var webServerPort: Int32 { get {...} set {...} } ``` ## 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 ([OAuth](#oauth-module) Module) The certificate with the private key to use when a Secure Sockets Layer (SSL) is enabled. ## Syntax ```text public var webServerSSLCert: Certificate { get {...} set {...} } ``` ## Default Value False ## 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](#webserversslenabled-property-oauth-module) is set to *True*. # WebServerSSLEnabled Property ([OAuth](#oauth-module) Module) Whether the web server requires Secure Sockets Layer (SSL) connections. ## Syntax ```text public var webServerSSLEnabled: Bool { get {...} set {...} } ``` ## Default Value False ## Remarks This setting specifies whether the embedded web server uses a Secure Sockets Layer (SSL). If set to *True*, [WebServerSSLCert](#webserversslcert-property-oauth-module) is required and the server will accept only SSL connections. If set to *False*, only plaintext connects are supported. # AddCookie Method ([OAuth](#oauth-module) Module) Adds a cookie and the corresponding value to the outgoing request headers. ## Syntax ```text public func addCookie(cookieName: String, cookieValue: String) throws -> Void ``` ## Remarks This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the [Cookies](#cookies-property-oauth-module) property for more information on cookies and how they are managed. # AddParam Method ([OAuth](#oauth-module) Module) Adds a name-value pair to the query string parameters of the outgoing request. ## Syntax ```text public func addParam(paramName: String, paramValue: String) throws -> Void ``` ## 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](#clientprofile-property-oauth-module) 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](#oauth-module) Module) Sets or retrieves a configuration setting. ## Syntax ```text public func config(configurationString: String) throws -> String ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-oauth-module) 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](#config-settings-oauth-module), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoEvents Method ([OAuth](#oauth-module) Module) This method processes events from the internal message queue. ## Syntax ```text public func doEvents() throws -> Void ``` ## 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. # GetAuthorization Method ([OAuth](#oauth-module) Module) Gets the authorization string required to access the protected resource. ## Syntax ```text public func getAuthorization() throws -> String ``` ## Remarks This method performs several operations automatically depending on the value of [ClientProfile](#clientprofile-property-oauth-module). Please see the introduction section for the [OAuth](#oauth-module) class 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](#accesstoken-property-oauth-module) property should be cleared before calling this method. # GetAuthorizationURL Method ([OAuth](#oauth-module) Module) Builds and returns the URL to which the user should be redirected for authorization. ## Syntax ```text public func getAuthorizationURL() throws -> String ``` ## Remarks When this method is called, the class will return the URL used for authorization. The class 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](#clientprofile-property-oauth-module) is set to ocpWeb. Before calling this method, set the following: - [ClientId](#clientid-property-oauth-module) - [ClientSecret](#clientsecret-property-oauth-module) - [ReturnURL](#returnurl-property-oauth-module) - [AuthorizationScope](#authorizationscope-property-oauth-module) (optional) # GetParam Method ([OAuth](#oauth-module) Module) Gets a specific parameter from a query string. ## Syntax ```text public func getParam(paramName: String) throws -> String ``` ## 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](#returnurl-event-oauth-module) event to query the parameters that are returned from the authorization server. Then, it can be called after [GetAuthorization](#getauthorization-method-oauth-module) completes to query the parameters that the token server responded with. ```text string authorizationString = oauth.GetAuthorization(); string stateValue = oauth.GetParam("state"); ``` # Interrupt Method ([OAuth](#oauth-module) Module) This method interrupts the current method. ## Syntax ```text public func interrupt() throws -> Void ``` ## Remarks If there is no method in progress, Interrupt simply returns, doing nothing. # Reset Method ([OAuth](#oauth-module) Module) This method will reset the component. ## Syntax ```text public func reset() throws -> Void ``` ## Remarks This method will reset the class's properties to their default values. # StartWebServer Method ([OAuth](#oauth-module) Module) Starts the embedded web server. ## Syntax ```text public func startWebServer() throws -> Void ``` ## 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](#getauthorization-method-oauth-module) is called. You may decide, however, to start the web server manually before calling [GetAuthorization](#getauthorization-method-oauth-module). When called, this method will also populate [ReturnURL](#returnurl-property-oauth-module) with the address of the embedded server. # StopWebServer Method ([OAuth](#oauth-module) Module) Stops the embedded web server. ## Syntax ```text public func stopWebServer() throws -> Void ``` ## Remarks This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authorization process when [GetAuthorization](#getauthorization-method-oauth-module) is called. # Connected Event ([OAuth](#oauth-module) Module) Fired immediately after a connection completes (or fails). ## Syntax ```text func onConnected(statusCode: Int32, description: String) ``` ## 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](#trappable-errors-oauth-module) section for more information. # ConnectionStatus Event ([OAuth](#oauth-module) Module) Fired to indicate changes in the connection state. ## Syntax ```text func onConnectionStatus(connectionEvent: String, statusCode: Int32, description: String) ``` ## Remarks This 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: | | | | --- | --- | | | Firewall connection complete. | | | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | | | Remote host connection complete. | | | Remote host disconnected. | | | SSL or S/Shell connection broken. | | | Firewall host disconnected. | *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. # Disconnected Event ([OAuth](#oauth-module) Module) Fired when a connection is closed. ## Syntax ```text func onDisconnected(statusCode: Int32, description: String) ``` ## 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](#trappable-errors-oauth-module) section for more information. # EndTransfer Event ([OAuth](#oauth-module) Module) Fired when a document finishes transferring. ## Syntax ```text func onEndTransfer(direction: Int32) ``` ## Remarks This 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](#oauth-module) Module) Fired when information is available about errors during data delivery. ## Syntax ```text func onError(errorCode: Int32, description: String) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . 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](#trappable-errors-oauth-module) section. # Header Event ([OAuth](#oauth-module) Module) Fired every time a header line comes in. ## Syntax ```text func onHeader(field: String, value: String) ``` ## 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](#oauth-module) Module) Fires before launching a browser with the authorization URL. ## Syntax ```text func onLaunchBrowser(url: inout String, command: inout String) ``` ## Remarks When the [ClientProfile](#clientprofile-property-oauth-module) property is set to ocpApplication and [GetAuthorization](#getauthorization-method-oauth-module) 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. If *Command* is not empty, the URL will be appended to the end. 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](#oauth-module) Module) Fired once for each log message. ## Syntax ```text func onLog(logLevel: Int32, message: String, logType: String) ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of message. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # Redirect Event ([OAuth](#oauth-module) Module) Fired when a redirection is received from the server. ## Syntax ```text func onRedirect(location: String, accept: inout Bool) ``` ## 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 . *Location* is the location to which the client is being redirected. Further control over redirection is provided in the [FollowRedirects](#followredirects-property-oauth-module) property. # ReturnURL Event ([OAuth](#oauth-module) Module) Fired when the user is redirected to the embedded web server. ## Syntax ```text func onReturnURL(urlPath: String, queryString: String, responseHeaders: inout String, responseBody: inout String) ``` ## Remarks When [ClientProfile](#clientprofile-property-oauth-module) 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](#params-property-oauth-module) collection will be populated. This allows the [GetParam](#getparam-method-oauth-module) method to be used to get a specific parameter returned from the authorization server when used within this event. # SetCookie Event ([OAuth](#oauth-module) Module) Fired for every cookie set by the server. ## Syntax ```text func onSetCookie(name: String, value: String, expires: String, domain: String, path: String, secure: Bool) ``` ## Remarks This 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](#oauth-module) Module) Fired after the server presents its certificate to the client. ## Syntax ```text func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool) ``` ## 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](#oauth-module) Module) Fired when secure connection progress messages are available. ## Syntax ```text func onSSLStatus(message: String) ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # StartTransfer Event ([OAuth](#oauth-module) Module) Fired when a document starts transferring (after the headers). ## Syntax ```text func onStartTransfer(direction: Int32) ``` ## Remarks This 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](#oauth-module) Module) Fired when the HTTP status line is received from the server. ## Syntax ```text func onStatus(httpVersion: String, statusCode: Int32, description: String) ``` ## 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](#oauth-module) Module) Fired while a document transfers (delivers document). ## Syntax ```text func onTransfer(direction: Int32, bytesTransferred: Int64, percentDone: Int32, text: Data) ``` ## 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. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **effectiveDate** *String (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **expirationDate** *String (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **extendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **fingerprint** *String (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **fingerprintSHA1** *String (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **fingerprintSHA256** *String (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **privateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **privateKeyAvailable** *Bool (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **privateKeyContainer** *String (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **publicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **publicKeyAlgorithm** *String (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **publicKeyLength** *Int32 (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **serialNumber** *String (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **signatureAlgorithm** *String (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **storeB** *Data* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **storePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **storeType** *CertStoreTypes* *Default Value: 0* The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **subjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **thumbprintMD5** *String (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **thumbprintSHA1** *String (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **thumbprintSHA256** *String (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **usage** *String (read-only)* *Default Value: ""* The text description of . This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **usageFlags** *Int32 (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **subject** *String* *Default Value: ""* 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=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. **encodedB** *Data* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors *Swift Syntax* ```text public init() ``` Creates a instance whose properties can be set. *Swift Syntax* ```text public init(encoded: ) ``` Parses * Encoded * as an X.509 public key. *Swift Syntax* ```text public init(storeType: , store: , storePassword: , subject: ) ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. *Swift Syntax* ```text public init(storeType: , store: , storePassword: , subject: ) ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. # Firewall Type The firewall the component will connect through. ## Remarks When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the . The following fields are available: - [AutoDetect](#Firewall_f_AutoDetect) - [FirewallType](#Firewall_f_FirewallType) - [Host](#Firewall_f_Host) - [Password](#Firewall_f_Password) - [Port](#Firewall_f_Port) - [User](#Firewall_f_User) ## Fields **autoDetect** *Bool* *Default Value: False* Whether to automatically detect and use firewall system settings, if available. **firewallType** *FirewallTypes* *Default Value: 0* The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [](#f_Port) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [](#f_Port) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [](#f_Port) is set to 1080. | **host** *String* *Default Value: ""* The name or IP address of the firewall (optional). If a 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 class . **password** *String* *Default Value: ""* A password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class . **port** *Int32* *Default Value: 0* The Transmission Control Protocol (TCP) port for the firewall . See the description of the property for details. NOTE: This property is set automatically when is set to a valid value. See the description of the property for details. **user** *String* *Default Value: ""* A username if authentication is to be used when connecting through a firewall. If is specified, this property and the property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class . ## Constructors *Swift Syntax* ```text public init() ``` # HTTPCookie Type An HTTP cookie can be either sent to or received from the server. ## Remarks An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server. Cookies that are to be sent to the server must have the and fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an **HTTPCookie** are filled out accordingly. The following fields are available: - [Domain](#HTTPCookie_f_Domain) - [Expiration](#HTTPCookie_f_Expiration) - [Name](#HTTPCookie_f_Name) - [Path](#HTTPCookie_f_Path) - [Secure](#HTTPCookie_f_Secure) - [Value](#HTTPCookie_f_Value) ## Fields **domain** *String (read-only)* *Default Value: ""* 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. **expiration** *String (read-only)* *Default Value: ""* 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. **name** *String* *Default Value: ""* The name of the cookie. This property, along with , stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties. **path** *String (read-only)* *Default Value: ""* 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. **secure** *Bool (read-only)* *Default Value: False* 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. **value** *String* *Default Value: ""* The value of the cookie. A corresponding value is associated with the cookie specified by . This property holds that value. The SetCookie event provides the cookies set by the server. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(name: , value: ) ``` # OAuthParam Type This is the parameter to be used in the request or received in the response. ## Remarks This type describes a parameter that is used in a request or received in the response. The following fields are available: - [Name](#OAuthParam_f_Name) - [Value](#OAuthParam_f_Value) ## Fields **name** *String* *Default Value: ""* The name of the parameter to be used in the request or returned in the response. **value** *String* *Default Value: ""* The value of the parameter to be used in the request or returned in the response. When issuing a request, the class will URL encode the value specified here. Returned values will be automatically URL decoded. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(name: , value: ) ``` # Proxy Type The proxy the component will connect to. ## Remarks When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the . The following fields are available: - [AuthScheme](#Proxy_f_AuthScheme) - [AutoDetect](#Proxy_f_AutoDetect) - [Password](#Proxy_f_Password) - [Port](#Proxy_f_Port) - [Server](#Proxy_f_Server) - [SSL](#Proxy_f_SSL) - [User](#Proxy_f_User) ## Fields **authScheme** *ProxyAuthSchemes* *Default Value: 0* The type of authorization to perform when connecting to the proxy. This is used only when the and properties are set. should be set to authNone (3) when no authentication is expected. By default, is authBasic (0), and if the and properties are set, the class will attempt basic authentication. If is set to authDigest (1), digest authentication will be attempted instead. If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token. If is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of and . **autoDetect** *Bool* *Default Value: False* Whether to automatically detect and use proxy system settings, if available. The default value is *false*. **password** *String* *Default Value: ""* A password if authentication is to be used for the proxy. If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server. If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation. **port** *Int32* *Default Value: 80* The Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details. **server** *String* *Default Value: ""* If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned. **ssl** *ProxySSLTypes* *Default Value: 0* When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | **user** *String* *Default Value: ""* A username if authentication is to be used for the proxy. If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server. If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation. ## Constructors *Swift Syntax* ```text public init() ``` *Swift Syntax* ```text public init(server: , port: ) ``` *Swift Syntax* ```text public init(server: , port: , user: , password: ) ``` # Config Settings ([OAuth](#oauth-module) Module) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-oauth-module) method. ### OAuth Config Settings **AuthMethod**: Specifies how the client credentials are sent to the token server.This configuration setting specifies how the [ClientId](#clientid-property-oauth-module) and [ClientSecret](#clientsecret-property-oauth-module) are provided when making a request to the token server. By default (0) the [ClientId](#clientid-property-oauth-module) and [ClientSecret](#clientsecret-property-oauth-module) are provided to the token server through the *client_id* and *client_secret* form parameters. If set to 1, then the component will provide the [ClientId](#clientid-property-oauth-module) and [ClientSecret](#clientsecret-property-oauth-module) through the basic *Authorization* HTTP header. Note that this does not apply when the [GrantType](#granttype-property-oauth-module) property is set to **ogtClientCredentials**, where the [IncludeClientCredsInBody](#IncludeClientCredsInBody) setting should be used instead. **AuthorizationTokenType**: The type of access token returned.Applicable values for this configuration setting include the following: | | | | --- | --- | | Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [GetAuthorization](#getauthorization-method-oauth-module) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP authorization header. | **DeviceGrantType**: The grant type to be used when the ClientProfile is set to ocpDevice.This configuration setting is used to specify a different grant type to use for device flow. By default this is set to "http://oauth.net/grant_type/device/1.0". Another commonly used grant type is "urn:ietf:params:oauth:grant-type:device_code". **DeviceUserCode**: The device's user code when the ClientProfile is set to ocpDevice.When [ClientProfile](#clientprofile-property-oauth-module) is set to ocpDevice and [GetAuthorizationURL](#getauthorizationurl-method-oauth-module) is called, the class will request a device user code from the server specified by [ServerAuthURL](#serverauthurl-property-oauth-module). This configuration setting will be populated with the device user code returned by the server. Provide this value along with the URL returned by [GetAuthorizationURL](#getauthorizationurl-method-oauth-module) to the user. **FormVarCount**: Specifies the number of additional form variables to include in the request.This configuration setting may be used to specify additional form variables made in the request to exchange [AuthorizationCode](#authorizationcode-property-oauth-module) for an access token. This is useful in cases in which the OAuth server requires additional fields. This is used in conjunction with [FormVarName\[i\]](#FormVarName[i]) and [FormVarValue\[i\]](#FormVarValue[i]). For instance: ```text component.Config("FormVarCount=2"); component.Config("FormVarName[0]=myvar"); component.Config("FormVarValue[0]=myvalue"); component.Config("FormVarName[1]=testname"); component.Config("FormVarValue[1]=testvalue"); ``` The value will be URL encoded by the class **FormVarName[i]**: Specifies the form variable name at the specified index.This configuration setting specifies the form variable name at the index specified. See [FormVarCount](#FormVarCount) for details. **FormVarValue[i]**: Specifies the form variable value at the specified index.This configuration setting specifies the form variable value at the index specified. See [FormVarCount](#FormVarCount) for details. **IncludeClientCredsInBody**: Whether to include the client credentials in the header or request body.This configuration setting specifies whether the [ClientId](#clientid-property-oauth-module) and [ClientSecret](#clientsecret-property-oauth-module) properties are included in the authorization header or the request body when a request is made by [GetAuthorization](#getauthorization-method-oauth-module). This only applies to request when the [GrantType](#granttype-property-oauth-module) property is set to **ogtClientCredentials**. If set to False (default), the credentials are provided through the authorization header. If set to True, the credentials are added as form entries to the request body. **IncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This configuration setting specifies whether *redirect_uri* is included in the request made by [GetAuthorization](#getauthorization-method-oauth-module) if it is empty. In most cases, redirect_uri will contain a value and will be sent; if, however, [ClientProfile](#clientprofile-property-oauth-module) is set to Mobile or Device, this will be empty. If set to True (default), the *redirect_uri* will be sent in all cases. If set to False, the *redirect_uri* will be sent only if it has a value. **JWTAudience**: The JWT audience when the ClientProfile is set to ocpJWT.This configuration setting specifies the audience that the JWT is intended for. This is required when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. When using Google service accounts, this value must be "https://www.googleapis.com/oauth2/v3/token". **JWTCertStore**: The name of the certificate store for the JWT signing certificate.The is the name of the certificate store for the JWT signing certificate. The [JWTCertStoreType](#JWTCertStoreType) field specifies the type of certificate store specified by [JWTCertStore](#JWTCertStore). If the store is password protected, specify the password in [JWTCertStorePassword](#JWTCertStorePassword). [JWTCertStore](#JWTCertStore) is used in conjunction with the [JWTCertSubject](#JWTCertSubject) field to specify the JWT signing certificate. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). NOTE: This is required when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. **JWTCertStorePassword**: The JWT signing certificate password.If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store. NOTE: This is applicable only when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. **JWTCertStoreType**: The type of certificate store.This configuration specifies the type of certificate store. Possible values are as follows: | | | | --- | --- | | 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. | | 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. | | 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. | | 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is available only in Java. | | 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. | | 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. | NOTE: This is required when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. **JWTCertSubject**: The JWT signing certificate subject.The is the subject of the JWT signing certificate. 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=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. NOTE: This is required when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. **JWTIssuer**: The JWT issuer when the ClientProfile is set to ocpJWT.This configuration setting specifies the issuer of the JWT (JSON Web Token). This is required when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. When using Google service accounts, this value is the email address of the service account. **JWTJSONKey**: The data or file path of the JWT JSON Key.This configuration setting specifies the file path of the JWT JSON Key, or a string containing its content, provided for the service account. If this setting is specified, the class will attempt to parse the values for [ClientId](#clientid-property-oauth-module), [JWTAudience](#JWTAudience), [JWTCertStore](#JWTCertStore), [JWTIssuer](#JWTIssuer), [ServerAuthURL](#serverauthurl-property-oauth-module), and [ServerTokenURL](#servertokenurl-property-oauth-module) from the JSON data. It will also initialize the values for [JWTCertStoreType](#JWTCertStoreType), [JWTCertStorePassword](#JWTCertStorePassword), and [JWTCertSubject](#JWTCertSubject). **JWTPayload**: The payload of the JWT access token, if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service. This setting is not used when setting up the class for authentication when the [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. To parse the payload for specific claims, see [JWTXPath](#JWTXPath). **JWTServiceProvider**: The service provider to which authentication is being performed.This configuration setting specifies the service provider that is being authenticated to. Possible values are as follows: - 0 (Google - Default) - 1 (Microsoft) NOTE: This is required when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. **JWTSignatureAlgorithm**: The signature algorithm used to sign the JWT.This configuration setting specifies the signature algorithm used to sign the JWT. Possible values are as follows: - RSA-SHA256 NOTE: This is applicable only when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. **JWTSubject**: The subject field in the JWT.This configuration setting optionally specifies the subject field in the JWT. For Google service accounts, this is the email address of the user for which the application is requesting delegated access. The meaning of this value varies from service to service. Please consult the documentation for the service to which you are authenticating to determine if the "sub" field is applicable. **JWTValidityTime**: The amount of time in seconds for which the assertion in the JWT is valid.The is the amount of time in seconds for which the assertion in the JWT is valid. The default value is 3600 (one hour). NOTE: This is applicable only when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpJWT. **JWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([JWTXChildCount](#JWTXChildCount) - 1). The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXElement**: The name of the current element.Provides the name of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXParent**: The parent of the current element.Provides the parent of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXPath**: Points to a specific element in the returned payload of a JWT based access token.The [JWTXPath](#JWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token. XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the */* character, for example: */A/B/C/D*. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | Here are some examples of valid XPaths and some common claims: | Description | JSON XPath | | --- | --- | | Document root | /json | | Specific element | /json/element_one | | Username Claim (Microsoft Specific) | /json/preferred_username | | Registered Application Name Claim (Microsoft Specific) | /json/app_displayname | This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see [JWTXText](#JWTXText). **JWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements). The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **JWTXText**: The text of the current element.Provides the inner text of the current element. The current element is specified in the [JWTXPath](#JWTXPath) configuration setting. This configuration setting is read-only. **Microsoft365AdminConsentError**: The error message returned when the admin denies consent to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the error message in the event that the admin does not consent to the scope of the application. This configuration setting is read-only. **Microsoft365AdminConsentErrorDesc**: The error description returned when the admin denies consent to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the description of the error message in the event that the admin does not consent to the scope of the application. This configuration setting is read-only. **Microsoft365AdminConsentTenant**: The tenant ID returned after the admin consents to the scopes.When using the Microsoft365AdminConsent profile, this configuration setting will hold the tenant Id that is returned after the admin consents to the scopes. This configuration setting is read-only. **Office365ServiceAPIVersion**: The API version of the Office 365 service being discovered.This configuration setting specifies the API version of the Office 365 service for which a search is initiated. See [Office365ServiceEndpoint](#Office365ServiceEndpoint) for details. **Office365ServiceCapability**: The API capability of the Office 365 service being discovered.This configuration setting specifies the capability of the Office 365 service for which a search is initiated. See [Office365ServiceEndpoint](#Office365ServiceEndpoint) for details. **Office365ServiceEndpoint**: The Office 365 endpoint for the service that matches the criteria specified.When obtaining authorization to access an Office 365 resource, it may be necessary to discover a list of services that match a certain criteria and then select a specific resource from that list. For instance, OneDrive for Business requires discovery of the Office 365 service that can be used with the OneDrive API. When [GetAuthorization](#getauthorization-method-oauth-module) is called, if [Office365ServiceAPIVersion](#Office365ServiceAPIVersion) and [Office365ServiceCapability](#Office365ServiceCapability) are specified, the class will attempt to discover the Office 365 services for which the user has access and find a service that matches the requirements specified in [Office365ServiceAPIVersion](#Office365ServiceAPIVersion) and [Office365ServiceCapability](#Office365ServiceCapability). If a service is found, the class will then obtain authorization to access that service. If authorization is successful, [Office365ServiceEndpoint](#Office365ServiceEndpoint) will hold the service endpoint URL to which requests should be made. **Example. OneDrive for Business:** ```text oauth.Config("Office365ServiceCapability=MyFiles"); oauth.Config("Office365ServiceAPIVersion=v2.0"); string authString = oauth.GetAuthorization(); string endpointURL = oauth.Config("Office365ServiceEndpoint"); ``` **PasswordGrantUsername**: The Username field when using the password grant type.This configuration setting is used to set the username field when the [GrantType](#granttype-property-oauth-module) is set to the password grant type and [GetAuthorization](#getauthorization-method-oauth-module) is called. **PKCEChallengeEncoding**: The PKCE code challenge method to use.This configuration setting controls the PKCE code challenge method used when [UsePKCE](#usepkce-property-oauth-module) is set to True. This value controls the PKCE code challenge method. Possible values are as follows: - 1 (Plain) - 2 (S256/SHA256 - default) **PKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [GetAuthorization](#getauthorization-method-oauth-module) and [GetAuthorizationURL](#getauthorizationurl-method-oauth-module) methods when [UsePKCE](#usepkce-property-oauth-module) is set to true. When using the ocpWeb [ClientProfile](#clientprofile-property-oauth-module), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request. **PollingInterval**: The interval in seconds between polling requests when the device client profile is used.When [ClientProfile](#clientprofile-property-oauth-module) is set to ocpDevice, this configuration setting determines the interval (in seconds) between polling requests made to [ServerTokenURL](#servertokenurl-property-oauth-module). The default value is 5. **ResponseMode**: The value of the response_mode parameter.This configuration setting is used to set the response_mode parameter when building the authorization URL after calling [GetAuthorization](#getauthorization-method-oauth-module) or [GetAuthorizationURL](#getauthorizationurl-method-oauth-module). If left empty (default) the parameter will not be set in the request. This informs the authorization server to use the defaults described by the OAuth 2.0 specification. For authorization code, this will be the *query* mode. For implicit, this will typically be the *fragment* mode. Support modes are as follows: | Mode | Description | | --- | --- | | query | The response parameters are encoded in a query string when the user is redirected back to the class. | | fragment | The response parameters are encoded in a fragment when the user is redirected back to the class. | | form_post | The response parameters are encoded as HTML form values and posted (rather than redirected) back to the class. This mode is an extension of the OAuth 2.0 protocol and may not be supported by the authorization server. | **TokenInfoFieldCount**: The number of fields in the tokeninfo service response.This configuration setting returns the number of fields present in the tokeninfo service response. This is populated after calling [ValidateToken](#ValidateToken). **TokenInfoFieldName[i]**: The name of the tokeninfo service response field.This configuration setting returns the name of the tokeninfo service response field specified by index *i*. Valid values are from 0 to [TokenInfoFieldCount](#TokenInfoFieldCount) -1. **TokenInfoFieldValue[i]**: The value of the tokeninfo service response field.This configuration setting returns the value of the tokeninfo service response field specified by index *i*. Valid values are from 0 to [TokenInfoFieldCount](#TokenInfoFieldCount) -1. **TokenInfoURL**: The URL of the tokeninfo service.This configuration setting specifies the URL of the tokeninfo service to which a request is made when [ValidateToken](#ValidateToken) is called. The default value is "https://www.googleapis.com/oauth2/v1/tokeninfo". **ValidateToken**: Validates the specified access token with a tokeninfo service.This configuration setting will post the [AccessToken](#accesstoken-property-oauth-module) to the tokeninfo service specified by [TokenInfoURL](#TokenInfoURL). This allows a token to be queried for validity and other information before use. When this configuration setting is queried, the class will immediately make a request to the server. [TokenInfoFieldCount](#TokenInfoFieldCount), [TokenInfoFieldName\[i\]](#TokenInfoFieldName[i]), and [TokenInfoFieldValue\[i\]](#TokenInfoFieldValue[i])] may be used to iterate over the fields in the response. ### WebServer Config Settings **BrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This configuration setting specifies the amount of time (in seconds) the component will wait for a response from the browser in the [LaunchBrowser](#launchbrowser-event-oauth-module) event. The default value is 120. **ResponseCompanyImage**: A URL or full path to a company logo.This configuration setting specifies a URL or full path to a company logo. If set, the image will be displayed and will be a hyperlink to [ResponseCompanyURL](#ResponseCompanyURL). **ResponseCompanyURL**: A URL to the company website or similar resource.This configuration setting specifies a URL to the company website or similar resource. This is used in conjunction with [ResponseCompanyImage](#ResponseCompanyImage). **ResponseFailureHeading**: Short header text indicating failure.This configuration setting specifies short header text indicating failure. The default value is *Authorization Failed*. **ResponseFailureMessage**: A description for a failed authorization.This configuration setting specifies a description for a failed authorization. The default value is *Access to your account could not be authorized. Please check your user and connection details and try again.* **ResponseHelpURL**: A URL to a help page or other resource.This configuration setting specifies a URL to a help page or other resource. If set, a *Help* link will be displayed and point to this URL. **ResponseLicenseURL**: A URL to licensing terms.This configuration setting specifies a URL to licensing terms. If set, a *License* link will be displayed and point to this URL. **ResponseProductImage**: A URL or full path to a product image.This configuration setting specifies a URL or full path to a product image. If set, the image will be displayed and will be a hyperlink to [ResponseProductURL](#ResponseProductURL). **ResponseProductURL**: A URL to a product page or similar resource.This configuration setting specifies a URL to a product page or similar resource. This is used in conjunction with [ResponseProductImage](#ResponseProductImage). **ResponseSuccessHeading**: Short header text indicating success.This configuration setting specifies a short header text indicating success. The default value is *Authorization Successful*. **ResponseSuccessMessage**: A description for a successful authorization.This configuration setting specifies a description for a successful authorization. The default value is *Access to your account was successfully authorized. You may now close this window.* **WebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [GetAuthorization](#getauthorization-method-oauth-module) is called, the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication fails, the HTML specified here will be sent to the user's browser. **WebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This configuration setting specifies the hostname used by the embedded web server when [ClientProfile](#clientprofile-property-oauth-module) is set to ocpApplication. This specifies the interface on which the embedded web server listens and also the value displayed in the [ReturnURL](#returnurl-property-oauth-module). This should be set to the hostname only, and not to the full URL. The default value is "localhost". **WebServerResponse**: The custom response that is displayed to the user.When [GetAuthorization](#getauthorization-method-oauth-module) is called, the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms. When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0". If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [Transfer](#transfer-event-oauth-module) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class . **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A [Redirect](#redirect-event-oauth-module) event is fired for every URL the product is redirected to. In the case of automatic redirections, the [Redirect](#redirect-event-oauth-module) event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#log-event-oauth-module) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When [FollowRedirects](#followredirects-property-oauth-module) is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme. **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to *True*. When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-oauth-module) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class . NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-oauth-module) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the [LocalHost](#localhost-property-oauth-module) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-oauth-module) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-oauth-module) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-oauth-module) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-oauth-module) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-oauth-module) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class . When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class . When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-oauth-module) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [SSLProvider](#sslprovider-property-oauth-module) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-oauth-module) is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when [SSLProvider](#sslprovider-property-oauth-module) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-oauth-module) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-oauth-module) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-oauth-module) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-oauth-module) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-oauth-module) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-oauth-module) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-oauth-module) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-oauth-module) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-oauth-module) event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-oauth-module) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-oauth-module) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class . The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-oauth-module) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-oauth-module) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. # Trappable Errors ([OAuth](#oauth-module) Module) ### OAuth Errors | | | | --- | --- | | 169 | Invalid parameter index (out of range). | | 801 | No token specified in Token property. | | 802 | No authorization URL specified. | | 803 | No client Id specified in ClientId property. | | 804 | No client secret specified in ClientSecret property. | | 805 | No request token URL specified. | | 806 | Unknown signature method. | | 807 | Invalid URL. | | 808 | Cryptographic error. | | 809 | No verifier specified. | | 810 | No access token URL specified. | | 811 | Protocol error. | | 812 | Invalid OAuth data. | ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in URL. | | 153 | Specified URLScheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | Interrupted. | | 302 | Cannot open AttachedFile. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the [LocalHost](#localhost-property-oauth-module) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |