OAuth Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

OAuth

Remarks

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

The OAuth 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 and ClientSecret as well as the ServerAuthURL and ServerTokenURL for the authorization server. Then set ClientProfile to the client profile that best describes your situation and call GetAuthorization.

The following client profiles are currently supported by the 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 to ocpApplication. This defines the profile the class will use. Set the ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application.

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

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

Fourth, the 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.

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

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

Web Profile

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

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

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

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

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

Device Profile

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

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

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

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

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

Mobile Profile

The Mobile profile is applicable to applications that are run on devices for which a web browser can be used. For instance, a mobile phone or tablet would use the Mobile profile. The behavior when using this profile is very similar to the Application profile. The only difference between the Mobile and Application profiles is the way the browser is launched. When set to the Mobile profile, the LaunchBrowser event will fire but the 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 ServerTokenURL and JWTServiceProvider.

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

Additional fields may be added to the JWT using the AddParam method.

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

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

Custom Responses

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

By default, the 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 Short header text indicating success. The default value is Authorization Successful
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 Short header text indicating failure. The default value is Authorization Failed
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 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. If set, a License link will be displayed and point to this URL.
ResponseProductURL A URL to a product page or similar resource. This is used in conjunction with 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.
ResponseCompanyURL A URL to the company website or similar resource. This is used in conjunction with 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.

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

Property List


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

AccessTokenThis property includes the access token returned by the authorization server.
AccessTokenExpThis property includes the lifetime of the access token.
AuthorizationCodeThis property includes the authorization code that is exchanged for an access token.
AuthorizationScopeThis property includes the scope request or response parameter used during authorization.
ClientIdThis property includes the Id of the client assigned when registering the application.
ClientProfileThis property includes the type of client that is requesting authorization.
ClientSecretThis property includes the secret value for the client assigned when registering the application.
ConnectedThis shows whether the class is connected.
CookieCountThe number of records in the Cookie arrays.
CookieDomainThis is the domain of a received cookie.
CookieExpirationThis property contains an expiration time for the cookie (if provided by the server).
CookieNameThis property, contains the name of the cookie.
CookiePathThis property contains a path name to limit the cookie to (if provided by the server).
CookieSecureThis property contains the security flag of the received cookie.
CookieValueThis property contains the value of the cookie.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirectsThis property determines what happens when the server issues a redirect.
GrantTypeThis property includes the OAuth grant type used to acquire an OAuth access token.
IdleThe current status of the class.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OtherHeadersThis property includes other headers as determined by the user (optional).
ParamCountThe number of records in the Param arrays.
ParamNameThis property contains the name of the parameter to be used in the request or returned in the response.
ParamValueThis property contains the value of the parameter to be used in the request or returned in the response.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RefreshTokenThis property specifies the refresh token received from or sent to the authorization server.
ReturnURLThis property includes the URL where the user (browser) returns after authenticating.
ServerAuthURLThis property includes the URL of the authorization server.
ServerTokenURLThis property includes the URL used to obtain the access token.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
TimeoutA timeout for the class.
TransferredDataThis property includes the contents of the last response from the server.
TransferredHeadersThis property includes the full set of headers as received from the server.
UsePKCEThis property specifies if Proof Key for Code Exchange (PKCE) should be used.
WebServerPortThis property includes the local port on which the embedded web server listens.
WebServerSSLCertStoreThis is the name of the certificate store for the client certificate.
WebServerSSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
WebServerSSLCertStoreTypeThis is the type of certificate store for this certificate.
WebServerSSLCertSubjectThis is the subject of the certificate used for client authentication.
WebServerSSLEnabledThis property specifies whether the web server requires Secure Sockets Layer (SSL) connections.

Method List


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

AddCookieThis method adds a cookie and the corresponding value to the outgoing request headers.
AddParamThis method adds a name-value pair to the query string parameters of outgoing request.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
GetAuthorizationThis method gets the authorization string required to access the protected resource.
GetAuthorizationURLThis method builds and returns the URL to which the user should be redirected for authorization.
GetParamThis method gets a specific parameter from a query string.
InterruptInterrupt the current method.
ResetReset the class.
StartWebServerThis method starts the embedded web server.
StopWebServerThis method stops the embedded web server.

Event List


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

ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionStatusThis event is fired to indicate changes in the connection state.
DisconnectedThis event is fired when a connection is closed.
EndTransferThis event is fired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderThis event is fired every time a header line comes in.
LaunchBrowserThis event fires before launching a browser with the authorization URL.
LogThis event fires once for each log message.
RedirectThis event is fired when a redirection is received from the server.
ReturnURLThis event fires when the user is redirected to the embedded web server.
SetCookieThis event is fired for every cookie set by the server.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferThis event is fired when a document starts transferring (after the headers).
StatusThis event is fired when the HTTP status line is received from the server.
TransferThis event is fired while a document transfers (delivers document).

Config Settings


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

AuthMethodSpecifies how the client credentials are sent to the token server.
AuthorizationTokenTypeThe type of access token returned.
BrowserResponseTimeoutSpecifies the amount of time to wait for a response from the browser.
DeviceGrantTypeThe grant type to be used when the ClientProfile is set to ocpDevice.
DeviceUserCodeThe device's user code when the ClientProfile is set to ocpDevice.
FormVarCountSpecifies the number of additional form variables to include in the request.
FormVarName[i]Specifies the form variable name at the specified index.
FormVarValue[i]Specifies the form variable value at the specified index.
IncludeClientCredsInBodyWhether to include the client credentials in the header or request body.
IncludeEmptyRedirectURIWhether an empty redirect_uri parameter is included in requests.
JWTAudienceThe JWT audience when the ClientProfile is set to ocpJWT.
JWTCertStoreThe name of the certificate store for the JWT signing certificate.
JWTCertStorePasswordThe JWT signing certificate password.
JWTCertStoreTypeThe type of certificate store.
JWTCertSubjectThe JWT signing certificate subject.
JWTIssuerThe JWT issuer when the ClientProfile is set to ocpJWT.
JWTJSONKeyThe data or file path of the JWT JSON Key.
JWTPayloadThe payload of the JWT access token if present.
JWTServiceProviderThe service provider to which authentication is being performed.
JWTSignatureAlgorithmThe signature algorithm used to sign the JWT.
JWTSubjectThe subject field in the JWT.
JWTValidityTimeThe amount of time in seconds for which the assertion in the JWT is valid.
JWTXChildCountThe number of child elements of the current element.
JWTXChildName[i]The name of the child element.
JWTXChildXText[i]The inner text of the child element.
JWTXElementThe name of the current element.
JWTXParentThe parent of the current element.
JWTXPathProvides a way to point to a specific element in the returned payload of a JWT based access token.
JWTXSubTreeA snapshot of the current element in the document.
JWTXTextThe text of the current element.
Microsoft365AdminConsentErrorThe error message returned when the admin denies consent to the scopes.
Microsoft365AdminConsentErrorDescThe error description returned when the admin denies consent to the scopes.
Microsoft365AdminConsentTenantThe tenant ID returned after the admin consents to the scopes.
Office365ServiceAPIVersionThe API version of the Office 365 service being discovered.
Office365ServiceCapabilityThe API capability of the Office 365 service being discovered.
Office365ServiceEndpointThe Office 365 endpoint for the service that matches the criteria specified.
PasswordGrantUsernameThe Username field when using the password grant type.
PKCEChallengeEncodingThe PKCE code challenge method to use.
PKCEVerifierThe PKCE verifier used to generate the challenge.
PollingIntervalThe interval in seconds between polling requests when the device client profile is used.
ResponseCompanyImageA URL or full path to a company logo.
ResponseCompanyURLA URL to the company website or similar resource.
ResponseFailureHeadingShort header text indicating failure.
ResponseFailureMessageA description for a failed authorization.
ResponseHelpURLA URL to a help page or other resource.
ResponseLicenseURLA URL to licensing terms.
ResponseProductImageA URL or full path to a product image.
ResponseProductURLA URL to a product page or similar resource.
ResponseSuccessHeadingShort header text indicating success.
ResponseSuccessMessageA description for a successful authorization.
ReUseWebServerDetermines if the same server instance is used between requests.
TokenInfoFieldCountThe number of fields in the tokeninfo service response.
TokenInfoFieldName[i]The name of the tokeninfo service response field.
TokenInfoFieldValue[i]The value of the tokeninfo service response field.
TokenInfoURLThe URL of the tokeninfo service.
ValidateTokenValidates the specified access token with a tokeninfo service.
WebServerFailedResponseThe custom response that will be displayed to the user if authentication failed.
WebServerHostThe hostname used by the embedded web server displayed in the ReturnURL.
WebServerResponseThe custom response that will be displayed to the user.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

AccessToken Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetAccessToken();
int SetAccessToken(const char* lpszAccessToken); Unicode (Windows) LPWSTR GetAccessToken();
INT SetAccessToken(LPCWSTR lpszAccessToken);
char* ipworksauth_oauth_getaccesstoken(void* lpObj);
int ipworksauth_oauth_setaccesstoken(void* lpObj, const char* lpszAccessToken);
QString GetAccessToken();
int SetAccessToken(QString qsAccessToken);

Default Value

""

Remarks

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

Data Type

String

AccessTokenExp Property (OAuth Class)

This property includes the lifetime of the access token.

Syntax

ANSI (Cross Platform)
int GetAccessTokenExp();

Unicode (Windows)
INT GetAccessTokenExp();
int ipworksauth_oauth_getaccesstokenexp(void* lpObj);
int GetAccessTokenExp();

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

AuthorizationCode Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetAuthorizationCode();
int SetAuthorizationCode(const char* lpszAuthorizationCode); Unicode (Windows) LPWSTR GetAuthorizationCode();
INT SetAuthorizationCode(LPCWSTR lpszAuthorizationCode);
char* ipworksauth_oauth_getauthorizationcode(void* lpObj);
int ipworksauth_oauth_setauthorizationcode(void* lpObj, const char* lpszAuthorizationCode);
QString GetAuthorizationCode();
int SetAuthorizationCode(QString qsAuthorizationCode);

Default Value

""

Remarks

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

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

If this property is set before calling GetAuthorization, the 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.

This property is not available at design time.

Data Type

String

AuthorizationScope Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetAuthorizationScope();
int SetAuthorizationScope(const char* lpszAuthorizationScope); Unicode (Windows) LPWSTR GetAuthorizationScope();
INT SetAuthorizationScope(LPCWSTR lpszAuthorizationScope);
char* ipworksauth_oauth_getauthorizationscope(void* lpObj);
int ipworksauth_oauth_setauthorizationscope(void* lpObj, const char* lpszAuthorizationScope);
QString GetAuthorizationScope();
int SetAuthorizationScope(QString qsAuthorizationScope);

Default Value

""

Remarks

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

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

Data Type

String

ClientId Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetClientId();
int SetClientId(const char* lpszClientId); Unicode (Windows) LPWSTR GetClientId();
INT SetClientId(LPCWSTR lpszClientId);
char* ipworksauth_oauth_getclientid(void* lpObj);
int ipworksauth_oauth_setclientid(void* lpObj, const char* lpszClientId);
QString GetClientId();
int SetClientId(QString qsClientId);

Default Value

""

Remarks

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

Data Type

String

ClientProfile Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetClientProfile();
int SetClientProfile(int iClientProfile); Unicode (Windows) INT GetClientProfile();
INT SetClientProfile(INT iClientProfile);

Possible Values

OCP_APPLICATION(0), 
OCP_WEB(1),
OCP_DEVICE(2),
OCP_MOBILE(3),
OCP_JWT(4)
int ipworksauth_oauth_getclientprofile(void* lpObj);
int ipworksauth_oauth_setclientprofile(void* lpObj, int iClientProfile);
int GetClientProfile();
int SetClientProfile(int iClientProfile);

Default Value

0

Remarks

This defines the type of client that will be requesting authorization. Set this before calling GetAuthorization 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 (ocpBrowser) Client-side browser application, such as JavaScript
5 (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, ClientSecret, ServerAuthURL, and ServerTokenURL to the values you obtained when registering your application.

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

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

Fourth, the 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.

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

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

Web Profile

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

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

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

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

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

Device Profile

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

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

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

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

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

Mobile Profile

The Mobile profile is applicable to applications that are run on devices for which a web browser can be used. For instance, a mobile phone or tablet would use the Mobile profile. The behavior when using this profile is very similar to the Application profile. The only difference between the Mobile and Application profiles is the way the browser is launched. When set to the Mobile profile, the LaunchBrowser event will fire but the 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 ServerTokenURL and JWTServiceProvider.

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

Additional fields may be added to the JWT using the AddParam method.

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

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

Data Type

Integer

ClientSecret Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetClientSecret();
int SetClientSecret(const char* lpszClientSecret); Unicode (Windows) LPWSTR GetClientSecret();
INT SetClientSecret(LPCWSTR lpszClientSecret);
char* ipworksauth_oauth_getclientsecret(void* lpObj);
int ipworksauth_oauth_setclientsecret(void* lpObj, const char* lpszClientSecret);
QString GetClientSecret();
int SetClientSecret(QString qsClientSecret);

Default Value

""

Remarks

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

Data Type

String

Connected Property (OAuth Class)

This shows whether the class is connected.

Syntax

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected); Unicode (Windows) BOOL GetConnected();
INT SetConnected(BOOL bConnected);
int ipworksauth_oauth_getconnected(void* lpObj);
int ipworksauth_oauth_setconnected(void* lpObj, int bConnected);
bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

Data Type

Boolean

CookieCount Property (OAuth Class)

The number of records in the Cookie arrays.

Syntax

ANSI (Cross Platform)
int GetCookieCount();
int SetCookieCount(int iCookieCount); Unicode (Windows) INT GetCookieCount();
INT SetCookieCount(INT iCookieCount);
int ipworksauth_oauth_getcookiecount(void* lpObj);
int ipworksauth_oauth_setcookiecount(void* lpObj, int iCookieCount);
int GetCookieCount();
int SetCookieCount(int iCookieCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (OAuth Class)

This is the domain of a received cookie.

Syntax

ANSI (Cross Platform)
char* GetCookieDomain(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieDomain(INT iCookieIndex);
char* ipworksauth_oauth_getcookiedomain(void* lpObj, int cookieindex);
QString GetCookieDomain(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieExpiration Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetCookieExpiration(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookieExpiration(INT iCookieIndex);
char* ipworksauth_oauth_getcookieexpiration(void* lpObj, int cookieindex);
QString GetCookieExpiration(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieName Property (OAuth Class)

This property, contains the name of the cookie.

Syntax

ANSI (Cross Platform)
char* GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, const char* lpszCookieName); Unicode (Windows) LPWSTR GetCookieName(INT iCookieIndex);
INT SetCookieName(INT iCookieIndex, LPCWSTR lpszCookieName);
char* ipworksauth_oauth_getcookiename(void* lpObj, int cookieindex);
int ipworksauth_oauth_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);
QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName);

Default Value

""

Remarks

This property, contains the name of the cookie.

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

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

This property is not available at design time.

Data Type

String

CookiePath Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetCookiePath(int iCookieIndex);

Unicode (Windows)
LPWSTR GetCookiePath(INT iCookieIndex);
char* ipworksauth_oauth_getcookiepath(void* lpObj, int cookieindex);
QString GetCookiePath(int iCookieIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

CookieSecure Property (OAuth Class)

This property contains the security flag of the received cookie.

Syntax

ANSI (Cross Platform)
int GetCookieSecure(int iCookieIndex);

Unicode (Windows)
BOOL GetCookieSecure(INT iCookieIndex);
int ipworksauth_oauth_getcookiesecure(void* lpObj, int cookieindex);
bool GetCookieSecure(int iCookieIndex);

Default Value

FALSE

Remarks

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

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

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

Data Type

Boolean

CookieValue Property (OAuth Class)

This property contains the value of the cookie.

Syntax

ANSI (Cross Platform)
char* GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, const char* lpszCookieValue); Unicode (Windows) LPWSTR GetCookieValue(INT iCookieIndex);
INT SetCookieValue(INT iCookieIndex, LPCWSTR lpszCookieValue);
char* ipworksauth_oauth_getcookievalue(void* lpObj, int cookieindex);
int ipworksauth_oauth_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);
QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);

Default Value

""

Remarks

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

The SetCookie event provides the cookies set by the server.

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
int ipworksauth_oauth_getfirewallautodetect(void* lpObj);
int ipworksauth_oauth_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (OAuth Class)

This property determines the type of firewall to connect through.

Syntax

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

Possible Values

FW_NONE(0), 
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int ipworksauth_oauth_getfirewalltype(void* lpObj);
int ipworksauth_oauth_setfirewalltype(void* lpObj, int iFirewallType);
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines 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. FirewallPort is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
char* ipworksauth_oauth_getfirewallhost(void* lpObj);
int ipworksauth_oauth_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

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

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
char* ipworksauth_oauth_getfirewallpassword(void* lpObj);
int ipworksauth_oauth_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
int ipworksauth_oauth_getfirewallport(void* lpObj);
int ipworksauth_oauth_setfirewallport(void* lpObj, int iFirewallPort);
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
char* ipworksauth_oauth_getfirewalluser(void* lpObj);
int ipworksauth_oauth_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

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

Data Type

String

FollowRedirects Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects); Unicode (Windows) INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

Possible Values

FR_NEVER(0), 
FR_ALWAYS(1),
FR_SAME_SCHEME(2)
int ipworksauth_oauth_getfollowredirects(void* lpObj);
int ipworksauth_oauth_setfollowredirects(void* lpObj, int iFollowRedirects);
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

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 fails with an error.

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

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

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

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

Data Type

Integer

GrantType Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetGrantType();
int SetGrantType(int iGrantType); Unicode (Windows) INT GetGrantType();
INT SetGrantType(INT iGrantType);

Possible Values

OGT_AUTHORIZATION_CODE(0), 
OGT_IMPLICIT(1),
OGT_PASSWORD(2),
OGT_CLIENT_CREDENTIALS(3),
OGT_ADMIN_CONSENT(4)
int ipworksauth_oauth_getgranttype(void* lpObj);
int ipworksauth_oauth_setgranttype(void* lpObj, int iGrantType);
int GetGrantType();
int SetGrantType(int iGrantType);

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 to Application.

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

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

And call GetAuthorization.

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:

And call GetAuthorization.

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:

And call GetAuthorization.

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

And call GetAuthorization. The class will then start the embedded web server, fire the LaunchBrowser event, and open the admin consent page URL.

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

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

Data Type

Integer

Idle Property (OAuth Class)

The current status of the class.

Syntax

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();
int ipworksauth_oauth_getidle(void* lpObj);
bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

LocalHost Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworksauth_oauth_getlocalhost(void* lpObj);
int ipworksauth_oauth_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

Data Type

String

OtherHeaders Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders); Unicode (Windows) LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);
char* ipworksauth_oauth_getotherheaders(void* lpObj);
int ipworksauth_oauth_setotherheaders(void* lpObj, const char* lpszOtherHeaders);
QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

ParamCount Property (OAuth Class)

The number of records in the Param arrays.

Syntax

ANSI (Cross Platform)
int GetParamCount();
int SetParamCount(int iParamCount); Unicode (Windows) INT GetParamCount();
INT SetParamCount(INT iParamCount);
int ipworksauth_oauth_getparamcount(void* lpObj);
int ipworksauth_oauth_setparamcount(void* lpObj, int iParamCount);
int GetParamCount();
int SetParamCount(int iParamCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

ParamName Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetParamName(int iParamIndex);
int SetParamName(int iParamIndex, const char* lpszParamName); Unicode (Windows) LPWSTR GetParamName(INT iParamIndex);
INT SetParamName(INT iParamIndex, LPCWSTR lpszParamName);
char* ipworksauth_oauth_getparamname(void* lpObj, int paramindex);
int ipworksauth_oauth_setparamname(void* lpObj, int paramindex, const char* lpszParamName);
QString GetParamName(int iParamIndex);
int SetParamName(int iParamIndex, QString qsParamName);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

ParamValue Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetParamValue(int iParamIndex);
int SetParamValue(int iParamIndex, const char* lpszParamValue); Unicode (Windows) LPWSTR GetParamValue(INT iParamIndex);
INT SetParamValue(INT iParamIndex, LPCWSTR lpszParamValue);
char* ipworksauth_oauth_getparamvalue(void* lpObj, int paramindex);
int ipworksauth_oauth_setparamvalue(void* lpObj, int paramindex, const char* lpszParamValue);
QString GetParamValue(int iParamIndex);
int SetParamValue(int iParamIndex, QString qsParamValue);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
int ipworksauth_oauth_getproxyauthscheme(void* lpObj);
int ipworksauth_oauth_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int ipworksauth_oauth_getproxyautodetect(void* lpObj);
int ipworksauth_oauth_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* ipworksauth_oauth_getproxypassword(void* lpObj);
int ipworksauth_oauth_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int ipworksauth_oauth_getproxyport(void* lpObj);
int ipworksauth_oauth_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* ipworksauth_oauth_getproxyserver(void* lpObj);
int ipworksauth_oauth_setproxyserver(void* lpObj, const char* lpszProxyServer);
QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

Possible Values

PS_AUTOMATIC(0), 
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int ipworksauth_oauth_getproxyssl(void* lpObj);
int ipworksauth_oauth_setproxyssl(void* lpObj, int iProxySSL);
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines 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.

Data Type

Integer

ProxyUser Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
char* ipworksauth_oauth_getproxyuser(void* lpObj);
int ipworksauth_oauth_setproxyuser(void* lpObj, const char* lpszProxyUser);
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

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

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

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

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

Data Type

String

RefreshToken Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetRefreshToken();
int SetRefreshToken(const char* lpszRefreshToken); Unicode (Windows) LPWSTR GetRefreshToken();
INT SetRefreshToken(LPCWSTR lpszRefreshToken);
char* ipworksauth_oauth_getrefreshtoken(void* lpObj);
int ipworksauth_oauth_setrefreshtoken(void* lpObj, const char* lpszRefreshToken);
QString GetRefreshToken();
int SetRefreshToken(QString qsRefreshToken);

Default Value

""

Remarks

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

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

Data Type

String

ReturnURL Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetReturnURL();
int SetReturnURL(const char* lpszReturnURL); Unicode (Windows) LPWSTR GetReturnURL();
INT SetReturnURL(LPCWSTR lpszReturnURL);
char* ipworksauth_oauth_getreturnurl(void* lpObj);
int ipworksauth_oauth_setreturnurl(void* lpObj, const char* lpszReturnURL);
QString GetReturnURL();
int SetReturnURL(QString qsReturnURL);

Default Value

""

Remarks

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

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

This property corresponds to the redirect_uri query string parameter.

Data Type

String

ServerAuthURL Property (OAuth Class)

This property includes the URL of the authorization server.

Syntax

ANSI (Cross Platform)
char* GetServerAuthURL();
int SetServerAuthURL(const char* lpszServerAuthURL); Unicode (Windows) LPWSTR GetServerAuthURL();
INT SetServerAuthURL(LPCWSTR lpszServerAuthURL);
char* ipworksauth_oauth_getserverauthurl(void* lpObj);
int ipworksauth_oauth_setserverauthurl(void* lpObj, const char* lpszServerAuthURL);
QString GetServerAuthURL();
int SetServerAuthURL(QString qsServerAuthURL);

Default Value

""

Remarks

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

This should be specified before calling GetAuthorization.

Data Type

String

ServerTokenURL Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetServerTokenURL();
int SetServerTokenURL(const char* lpszServerTokenURL); Unicode (Windows) LPWSTR GetServerTokenURL();
INT SetServerTokenURL(LPCWSTR lpszServerTokenURL);
char* ipworksauth_oauth_getservertokenurl(void* lpObj);
int ipworksauth_oauth_setservertokenurl(void* lpObj, const char* lpszServerTokenURL);
QString GetServerTokenURL();
int SetServerTokenURL(QString qsServerTokenURL);

Default Value

""

Remarks

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

This must be set before calling GetAuthorization.

Data Type

String

SSLAcceptServerCertEncoded Property (OAuth Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int ipworksauth_oauth_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksauth_oauth_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (OAuth Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int ipworksauth_oauth_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksauth_oauth_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int ipworksauth_oauth_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksauth_oauth_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Data Type

Binary String

SSLCertStorePassword Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* ipworksauth_oauth_getsslcertstorepassword(void* lpObj);
int ipworksauth_oauth_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (OAuth Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksauth_oauth_getsslcertstoretype(void* lpObj);
int ipworksauth_oauth_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is 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:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* ipworksauth_oauth_getsslcertsubject(void* lpObj);
int ipworksauth_oauth_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (OAuth Class)

This specifies the SSL/TLS implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworksauth_oauth_getsslprovider(void* lpObj);
int ipworksauth_oauth_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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:

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, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (OAuth Class)

This is the certificate (PEM/base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int ipworksauth_oauth_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

Timeout Property (OAuth Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworksauth_oauth_gettimeout(void* lpObj);
int ipworksauth_oauth_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class fails with an error.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetTransferredData(char* &lpTransferredData, int &lenTransferredData);

Unicode (Windows)
INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);
int ipworksauth_oauth_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);
QByteArray GetTransferredData();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

TransferredHeaders Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();
char* ipworksauth_oauth_gettransferredheaders(void* lpObj);
QString GetTransferredHeaders();

Default Value

""

Remarks

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

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

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

Data Type

String

UsePKCE Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetUsePKCE();
int SetUsePKCE(int bUsePKCE); Unicode (Windows) BOOL GetUsePKCE();
INT SetUsePKCE(BOOL bUsePKCE);
int ipworksauth_oauth_getusepkce(void* lpObj);
int ipworksauth_oauth_setusepkce(void* lpObj, int bUsePKCE);
bool GetUsePKCE();
int SetUsePKCE(bool bUsePKCE);

Default Value

FALSE

Remarks

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

Data Type

Boolean

WebServerPort Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetWebServerPort();
int SetWebServerPort(int iWebServerPort); Unicode (Windows) INT GetWebServerPort();
INT SetWebServerPort(INT iWebServerPort);
int ipworksauth_oauth_getwebserverport(void* lpObj);
int ipworksauth_oauth_setwebserverport(void* lpObj, int iWebServerPort);
int GetWebServerPort();
int SetWebServerPort(int iWebServerPort);

Default Value

0

Remarks

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

Data Type

Integer

WebServerSSLCertStore Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetWebServerSSLCertStore(char* &lpWebServerSSLCertStore, int &lenWebServerSSLCertStore);
int SetWebServerSSLCertStore(const char* lpWebServerSSLCertStore, int lenWebServerSSLCertStore); Unicode (Windows) INT GetWebServerSSLCertStore(LPSTR &lpWebServerSSLCertStore, INT &lenWebServerSSLCertStore);
INT SetWebServerSSLCertStore(LPCSTR lpWebServerSSLCertStore, INT lenWebServerSSLCertStore);
int ipworksauth_oauth_getwebserversslcertstore(void* lpObj, char** lpWebServerSSLCertStore, int* lenWebServerSSLCertStore);
int ipworksauth_oauth_setwebserversslcertstore(void* lpObj, const char* lpWebServerSSLCertStore, int lenWebServerSSLCertStore);
QByteArray GetWebServerSSLCertStore();
int SetWebServerSSLCertStore(QByteArray qbaWebServerSSLCertStore);

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Data Type

Binary String

WebServerSSLCertStorePassword Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetWebServerSSLCertStorePassword();
int SetWebServerSSLCertStorePassword(const char* lpszWebServerSSLCertStorePassword); Unicode (Windows) LPWSTR GetWebServerSSLCertStorePassword();
INT SetWebServerSSLCertStorePassword(LPCWSTR lpszWebServerSSLCertStorePassword);
char* ipworksauth_oauth_getwebserversslcertstorepassword(void* lpObj);
int ipworksauth_oauth_setwebserversslcertstorepassword(void* lpObj, const char* lpszWebServerSSLCertStorePassword);
QString GetWebServerSSLCertStorePassword();
int SetWebServerSSLCertStorePassword(QString qsWebServerSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

WebServerSSLCertStoreType Property (OAuth Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetWebServerSSLCertStoreType();
int SetWebServerSSLCertStoreType(int iWebServerSSLCertStoreType); Unicode (Windows) INT GetWebServerSSLCertStoreType();
INT SetWebServerSSLCertStoreType(INT iWebServerSSLCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksauth_oauth_getwebserversslcertstoretype(void* lpObj);
int ipworksauth_oauth_setwebserversslcertstoretype(void* lpObj, int iWebServerSSLCertStoreType);
int GetWebServerSSLCertStoreType();
int SetWebServerSSLCertStoreType(int iWebServerSSLCertStoreType);

Default Value

0

Remarks

This is 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:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the WebServerSSLCertStore and set WebServerSSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

WebServerSSLCertSubject Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetWebServerSSLCertSubject();
int SetWebServerSSLCertSubject(const char* lpszWebServerSSLCertSubject); Unicode (Windows) LPWSTR GetWebServerSSLCertSubject();
INT SetWebServerSSLCertSubject(LPCWSTR lpszWebServerSSLCertSubject);
char* ipworksauth_oauth_getwebserversslcertsubject(void* lpObj);
int ipworksauth_oauth_setwebserversslcertsubject(void* lpObj, const char* lpszWebServerSSLCertSubject);
QString GetWebServerSSLCertSubject();
int SetWebServerSSLCertSubject(QString qsWebServerSSLCertSubject);

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

WebServerSSLEnabled Property (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int GetWebServerSSLEnabled();
int SetWebServerSSLEnabled(int bWebServerSSLEnabled); Unicode (Windows) BOOL GetWebServerSSLEnabled();
INT SetWebServerSSLEnabled(BOOL bWebServerSSLEnabled);
int ipworksauth_oauth_getwebserversslenabled(void* lpObj);
int ipworksauth_oauth_setwebserversslenabled(void* lpObj, int bWebServerSSLEnabled);
bool GetWebServerSSLEnabled();
int SetWebServerSSLEnabled(bool bWebServerSSLEnabled);

Default Value

FALSE

Remarks

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

Data Type

Boolean

AddCookie Method (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int AddCookie(const char* lpszCookieName, const char* lpszCookieValue);

Unicode (Windows)
INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);
int ipworksauth_oauth_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);
int AddCookie(const QString& qsCookieName, const QString& qsCookieValue);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddParam Method (OAuth Class)

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

Syntax

ANSI (Cross Platform)
int AddParam(const char* lpszParamName, const char* lpszParamValue);

Unicode (Windows)
INT AddParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue);
int ipworksauth_oauth_addparam(void* lpObj, const char* lpszParamName, const char* lpszParamValue);
int AddParam(const QString& qsParamName, const QString& qsParamValue);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (OAuth Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksauth_oauth_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoEvents Method (OAuth Class)

Processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
int ipworksauth_oauth_doevents(void* lpObj);
int DoEvents();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetAuthorization Method (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetAuthorization();

Unicode (Windows)
LPWSTR GetAuthorization();
char* ipworksauth_oauth_getauthorization(void* lpObj);
QString GetAuthorization();

Remarks

This method performs several operations automatically depending on the value of ClientProfile. Please see the introduction section for the OAuth 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 property should be cleared before calling this method.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetAuthorizationURL Method (OAuth Class)

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

Syntax

ANSI (Cross Platform)
char* GetAuthorizationURL();

Unicode (Windows)
LPWSTR GetAuthorizationURL();
char* ipworksauth_oauth_getauthorizationurl(void* lpObj);
QString GetAuthorizationURL();

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 is set to ocpWeb. Before calling this method, set the following:

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetParam Method (OAuth Class)

This method gets a specific parameter from a query string.

Syntax

ANSI (Cross Platform)
char* GetParam(const char* lpszParamName);

Unicode (Windows)
LPWSTR GetParam(LPCWSTR lpszParamName);
char* ipworksauth_oauth_getparam(void* lpObj, const char* lpszParamName);
QString GetParam(const QString& qsParamName);

Remarks

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

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

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

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (OAuth Class)

Interrupt the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
int ipworksauth_oauth_interrupt(void* lpObj);
int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (OAuth Class)

Reset the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworksauth_oauth_reset(void* lpObj);
int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartWebServer Method (OAuth Class)

This method starts the embedded web server.

Syntax

ANSI (Cross Platform)
int StartWebServer();

Unicode (Windows)
INT StartWebServer();
int ipworksauth_oauth_startwebserver(void* lpObj);
int StartWebServer();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopWebServer Method (OAuth Class)

This method stops the embedded web server.

Syntax

ANSI (Cross Platform)
int StopWebServer();

Unicode (Windows)
INT StopWebServer();
int ipworksauth_oauth_stopwebserver(void* lpObj);
int StopWebServer();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (OAuth Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireConnected(OAuthConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } OAuthConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(OAuthConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } OAuthConnectedEventParams;
#define EID_OAUTH_CONNECTED 1

virtual INT IPWORKSAUTH_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);
class OAuthConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Connected(OAuthConnectedEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireConnected(OAuthConnectedEventParams *e) {...}

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (OAuth Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireConnectionStatus(OAuthConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } OAuthConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(OAuthConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } OAuthConnectionStatusEventParams;
#define EID_OAUTH_CONNECTIONSTATUS 2

virtual INT IPWORKSAUTH_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);
class OAuthConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ConnectionStatus(OAuthConnectionStatusEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireConnectionStatus(OAuthConnectionStatusEventParams *e) {...}

Remarks

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

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

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

This event is fired when a connection is closed.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnected(OAuthDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } OAuthDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(OAuthDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } OAuthDisconnectedEventParams;
#define EID_OAUTH_DISCONNECTED 3

virtual INT IPWORKSAUTH_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);
class OAuthDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Disconnected(OAuthDisconnectedEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireDisconnected(OAuthDisconnectedEventParams *e) {...}

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (OAuth Class)

This event is fired when a document finishes transferring.

Syntax

ANSI (Cross Platform)
virtual int FireEndTransfer(OAuthEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } OAuthEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(OAuthEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } OAuthEndTransferEventParams;
#define EID_OAUTH_ENDTRANSFER 4

virtual INT IPWORKSAUTH_CALL FireEndTransfer(INT &iDirection);
class OAuthEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void EndTransfer(OAuthEndTransferEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireEndTransfer(OAuthEndTransferEventParams *e) {...}

Remarks

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

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

Error Event (OAuth Class)

Information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(OAuthErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } OAuthErrorEventParams;
Unicode (Windows) virtual INT FireError(OAuthErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } OAuthErrorEventParams;
#define EID_OAUTH_ERROR 5

virtual INT IPWORKSAUTH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class OAuthErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(OAuthErrorEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireError(OAuthErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

Header Event (OAuth Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireHeader(OAuthHeaderEventParams *e);
typedef struct {
const char *Field;
const char *Value; int reserved; } OAuthHeaderEventParams;
Unicode (Windows) virtual INT FireHeader(OAuthHeaderEventParams *e);
typedef struct {
LPCWSTR Field;
LPCWSTR Value; INT reserved; } OAuthHeaderEventParams;
#define EID_OAUTH_HEADER 6

virtual INT IPWORKSAUTH_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);
class OAuthHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Header(OAuthHeaderEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireHeader(OAuthHeaderEventParams *e) {...}

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

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

Syntax

ANSI (Cross Platform)
virtual int FireLaunchBrowser(OAuthLaunchBrowserEventParams *e);
typedef struct {
char *URL;
char *Command; int reserved; } OAuthLaunchBrowserEventParams;
Unicode (Windows) virtual INT FireLaunchBrowser(OAuthLaunchBrowserEventParams *e);
typedef struct {
LPWSTR URL;
LPWSTR Command; INT reserved; } OAuthLaunchBrowserEventParams;
#define EID_OAUTH_LAUNCHBROWSER 7

virtual INT IPWORKSAUTH_CALL FireLaunchBrowser(LPSTR &lpszURL, LPSTR &lpszCommand);
class OAuthLaunchBrowserEventParams {
public:
  const QString &URL();
  void SetURL(const QString &qsURL);

  const QString &Command();
  void SetCommand(const QString &qsCommand);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void LaunchBrowser(OAuthLaunchBrowserEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireLaunchBrowser(OAuthLaunchBrowserEventParams *e) {...}

Remarks

When the ClientProfile property is set to ocpApplication and GetAuthorization 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.

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

This event fires once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(OAuthLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } OAuthLogEventParams;
Unicode (Windows) virtual INT FireLog(OAuthLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } OAuthLogEventParams;
#define EID_OAUTH_LOG 8

virtual INT IPWORKSAUTH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class OAuthLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Log(OAuthLogEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireLog(OAuthLogEventParams *e) {...}

Remarks

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

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

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

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

Syntax

ANSI (Cross Platform)
virtual int FireRedirect(OAuthRedirectEventParams *e);
typedef struct {
const char *Location;
int Accept; int reserved; } OAuthRedirectEventParams;
Unicode (Windows) virtual INT FireRedirect(OAuthRedirectEventParams *e);
typedef struct {
LPCWSTR Location;
BOOL Accept; INT reserved; } OAuthRedirectEventParams;
#define EID_OAUTH_REDIRECT 9

virtual INT IPWORKSAUTH_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);
class OAuthRedirectEventParams {
public:
  const QString &Location();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Redirect(OAuthRedirectEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireRedirect(OAuthRedirectEventParams *e) {...}

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 fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

ReturnURL Event (OAuth Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireReturnURL(OAuthReturnURLEventParams *e);
typedef struct {
const char *URLPath;
const char *QueryString;
char *ResponseHeaders;
char *ResponseBody; int reserved; } OAuthReturnURLEventParams;
Unicode (Windows) virtual INT FireReturnURL(OAuthReturnURLEventParams *e);
typedef struct {
LPCWSTR URLPath;
LPCWSTR QueryString;
LPWSTR ResponseHeaders;
LPWSTR ResponseBody; INT reserved; } OAuthReturnURLEventParams;
#define EID_OAUTH_RETURNURL 10

virtual INT IPWORKSAUTH_CALL FireReturnURL(LPSTR &lpszURLPath, LPSTR &lpszQueryString, LPSTR &lpszResponseHeaders, LPSTR &lpszResponseBody);
class OAuthReturnURLEventParams {
public:
  const QString &URLPath();

  const QString &QueryString();

  const QString &ResponseHeaders();
  void SetResponseHeaders(const QString &qsResponseHeaders);

  const QString &ResponseBody();
  void SetResponseBody(const QString &qsResponseBody);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ReturnURL(OAuthReturnURLEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireReturnURL(OAuthReturnURLEventParams *e) {...}

Remarks

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

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

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

SetCookie Event (OAuth Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSetCookie(OAuthSetCookieEventParams *e);
typedef struct {
const char *Name;
const char *Value;
const char *Expires;
const char *Domain;
const char *Path;
int Secure; int reserved; } OAuthSetCookieEventParams;
Unicode (Windows) virtual INT FireSetCookie(OAuthSetCookieEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR Value;
LPCWSTR Expires;
LPCWSTR Domain;
LPCWSTR Path;
BOOL Secure; INT reserved; } OAuthSetCookieEventParams;
#define EID_OAUTH_SETCOOKIE 11

virtual INT IPWORKSAUTH_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);
class OAuthSetCookieEventParams {
public:
  const QString &Name();

  const QString &Value();

  const QString &Expires();

  const QString &Domain();

  const QString &Path();

  bool Secure();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SetCookie(OAuthSetCookieEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireSetCookie(OAuthSetCookieEventParams *e) {...}

Remarks

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

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

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

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

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

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

SSLServerAuthentication Event (OAuth Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(OAuthSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } OAuthSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(OAuthSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } OAuthSSLServerAuthenticationEventParams;
#define EID_OAUTH_SSLSERVERAUTHENTICATION 12

virtual INT IPWORKSAUTH_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class OAuthSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(OAuthSSLServerAuthenticationEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireSSLServerAuthentication(OAuthSSLServerAuthenticationEventParams *e) {...}

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

Shows the progress of the secure connection.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(OAuthSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } OAuthSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(OAuthSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } OAuthSSLStatusEventParams;
#define EID_OAUTH_SSLSTATUS 13

virtual INT IPWORKSAUTH_CALL FireSSLStatus(LPSTR &lpszMessage);
class OAuthSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLStatus(OAuthSSLStatusEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireSSLStatus(OAuthSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (OAuth Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStartTransfer(OAuthStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } OAuthStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(OAuthStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } OAuthStartTransferEventParams;
#define EID_OAUTH_STARTTRANSFER 14

virtual INT IPWORKSAUTH_CALL FireStartTransfer(INT &iDirection);
class OAuthStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void StartTransfer(OAuthStartTransferEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireStartTransfer(OAuthStartTransferEventParams *e) {...}

Remarks

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

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

Status Event (OAuth Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStatus(OAuthStatusEventParams *e);
typedef struct {
const char *HTTPVersion;
int StatusCode;
const char *Description; int reserved; } OAuthStatusEventParams;
Unicode (Windows) virtual INT FireStatus(OAuthStatusEventParams *e);
typedef struct {
LPCWSTR HTTPVersion;
INT StatusCode;
LPCWSTR Description; INT reserved; } OAuthStatusEventParams;
#define EID_OAUTH_STATUS 15

virtual INT IPWORKSAUTH_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);
class OAuthStatusEventParams {
public:
  const QString &HTTPVersion();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Status(OAuthStatusEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireStatus(OAuthStatusEventParams *e) {...}

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

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

Syntax

ANSI (Cross Platform)
virtual int FireTransfer(OAuthTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText; int reserved; } OAuthTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(OAuthTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText; INT reserved; } OAuthTransferEventParams;
#define EID_OAUTH_TRANSFER 16

virtual INT IPWORKSAUTH_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);
class OAuthTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Transfer(OAuthTransferEventParams *e);
// Or, subclass OAuth and override this emitter function. virtual int FireTransfer(OAuthTransferEventParams *e) {...}

Remarks

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

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

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

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

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

Config Settings (OAuth Class)

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

OAuth Config Settings

AuthMethod:   Specifies how the client credentials are sent to the token server.

This configuration setting specifies how the ClientId and ClientSecret are provided when making a request to the token server. By default (0) the ClientId and ClientSecret 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 and ClientSecret through the basic Authorization HTTP header.

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 will be in the format "Bearer access_token". This can be supplied as the value of the HTTP authorization header.
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 event. The default value is 0, meaning that the component will wait indefinitely.

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 is set to ocpDevice and GetAuthorizationURL is called, the class will request a device user code from the server specified by ServerAuthURL. 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 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 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] and FormVarValue[i]. For instance: 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 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 for details.

IncludeClientCredsInBody:   Whether to include the client credentials in the header or request body.

This configuration setting specifies whether the ClientId and ClientSecret properties are included in the authorization header or the request body when a request is made by GetAuthorization. This only applies to request when the GrantType 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 if it is empty. In most cases, redirect_uri will contain a value and will be sent; if, however, ClientProfile 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 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 field specifies the type of certificate store specified by JWTCertStore. If the store is password protected, specify the password in JWTCertStorePassword.

JWTCertStore is used in conjunction with the 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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Note: This is required when ClientProfile 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 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 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=support@nsoftware.com". Common fields and their meanings are as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Note: This is required when ClientProfile 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 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, JWTAudience, JWTCertStore, JWTIssuer, ServerAuthURL, and ServerTokenURL from the JSON data. It will also initialize the values for JWTCertStoreType, JWTCertStorePassword, and 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 is set to ocpJWT.

To parse the payload for specific claims, see 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 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 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 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 - 1).

The current element is specified in the 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 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 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 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 configuration setting. This configuration setting is read-only.

JWTXPath:   Provides a way to point to a specific element in the returned payload of a JWT based access token.

The JWTXPath setting allows you to point to specific claims within the payload of a JWT based access token.

XPath Syntax

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:
DescriptionJSON 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.

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 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 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 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 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 is called, if Office365ServiceAPIVersion and 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 and Office365ServiceCapability. If a service is found, the class will then obtain authorization to access that service. If authorization is successful, Office365ServiceEndpoint will hold the service endpoint URL to which requests should be made.

Example. OneDrive for Business: 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 is set to the password grant type and GetAuthorization is called.

PKCEChallengeEncoding:   The PKCE code challenge method to use.

This configuration setting controls the PKCE code challenge method used when UsePKCE 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 and GetAuthorizationURL methods when UsePKCE is set to true. When using the ocpWeb ClientProfile, 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 is set to ocpDevice, this configuration setting determines the interval (in seconds) between polling requests made to ServerTokenURL. The default value is 5.

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

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

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.

ReUseWebServer:   Determines if the same server instance is used between requests.

If this is set to True (default), the same embedded web server instance will be used for multiple requests. If set to False, the embedded web server will be created and destroyed on each call to GetAuthorization.

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.

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 -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 -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 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 to the tokeninfo service specified by 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, TokenInfoFieldName[i], and TokenInfoFieldValue[i]] may be used to iterate over the fields in the response.

WebServerFailedResponse:   The custom response that will be displayed to the user if authentication failed.

When GetAuthorization 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 is set to ocpApplication. This specifies the interface on which the embedded web server listens and also the value displayed in the ReturnURL. This should be set to the hostname only, and not to the full URL.

The default value is "localhost".

WebServerResponse:   The custom response that will be displayed to the user.

When GetAuthorization 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 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 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 fails with an error 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 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 event, by BytesTransferred.

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

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

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

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

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the 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 fails with an error.

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 event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error 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"), 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 after calling a method. The 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: Sat, 29 Oct 2017 19:43:31 GMT.

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

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

The default value for KeepAlive is false.

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

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

LogLevel:   The level of detail that is logged.

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

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

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

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

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

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

When FollowRedirects 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 CRLF ("\r\n") .

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

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

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

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If 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 classs 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 classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs 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 classs 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 classs 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 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 Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the 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 setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

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

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

Note: This setting is applicable only to Mac/iOS editions.

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 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 classs that do not directly expose Firewall properties.

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

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

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

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

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

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

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

FirewallPort:   The TCP port for the FirewallHost;.

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

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

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

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

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

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

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

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

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

Note: This value is not applicable in macOS.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

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

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

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

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

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

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

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the 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 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 multi-homed 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 classs) only through that interface.

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

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

This 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; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

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

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

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

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

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

MaxTransferRate:   The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config 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:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

Socket Config Settings

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

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

Note: This option is not valid for 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 TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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.
MaskSensitive:   Whether sensitive data is masked in log messages.

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

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

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

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.

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

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (OAuth Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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.

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

HTTP Errors

118   Firewall Error. Error description contains 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   Can't open AttachedFile.

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

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 at this time. A connection is in progress.
112   You cannot change 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.

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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).