OpenID Class
Properties Methods Events Config Settings Errors
The OpenID class is used to verify the identify of a user as well as get basic profile information.
Syntax
OpenID
Remarks
The OpenID class implements an OpenID Connect (OIDC) Relying Party (RP) capable of authenticating a user and retrieving user information. OIDC is a simple identity layer on top of OAuth 2.0 and re-uses much of the functionality and concepts defined by OAuth 2.0.
To begin using the class you will first need to register your application with the service you want to use. During this process you should obtain a ClientId and ClientSecret. The following sections discuss the typical steps to verify the identity of a user and obtain profile information.
Get the Discovery Document
Many OpenID Providers (OPs) provide information via a Discovery Document. The discovery document defines information such as the endpoint URLs for authentication, tokens, and user information requests. Additionally, details about parameters such as supported authorization scopes are defined in this document. The document is found at a URL which can be fetched and parsed by calling the GetDiscoveryDoc method.
The discovery document URL is typically published by an OpenID Provider (OP) and must be known before calling this method. The format of the URL is standardized and typically takes the form:
https://www.youropenidserver.com/.well-known/openid-configuration
Call GetDiscoveryDoc before calling GetAuthorization to populate the class properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method the following properties are populated:
The above values may be stored, and later populated from the stored values, to avoid the requirement of calling GetDiscoveryDoc on subsequent authorization requests.
The following discovery document fields are populated after GetDiscoveryDoc returns:
- AuthorizationURL
- ClaimsParamSupported
- Issuer
- SignerCertURL
- RegistrationURL
- ServiceDocsURL
- SupportedClaims
- SupportedDisplays
- SupportedGrantTypes
- SupportedResponseTypes
- SupportedScopes
- TokenURL
- UserInfoURL
To access values not automatically parsed by the class the XPath configuration setting may be set to retrieve a specific value. Alternatively the RawJSON setting returns the entire JSON document which may be parsed separately.
Note: Calling GetDiscoveryDoc is not mandatory. If server information was stored from a previous call or is otherwise known ahead of time the following properties may be set in place of calling GetDiscoveryDoc:
Examples of the above points:
openid.GetDiscoveryDoc("https://accounts.google.com/.well-known/openid-configuration");
// ... or ...
openid.ServerAuthURL = "https://accounts.google.com/o/oauth2/v2/auth";
openid.ServerTokenURL = "https://oauth2.googleapis.com/token";
openid.ServerUserInfoURL = "https://openidconnect.googleapis.com/v1/userinfo";
openid.SignerCertURL = "https://www.googleapis.com/oauth2/v3/certs";
// ... or ...
string rawjson = openid.Config("RawJSON");
Get Authorization
Before calling GetAuthorization the class may be configured for one of several flows defined by the GrantType property. These flows determine which information is returned by the authorization server and which information (if any) is returned by the Token server.
Possible values for GrantType are:
- 0 (Authorization Code - Default)
- 1 (Implicit)
- 2 (Hybrid)
When using 0 (Authorization Code Flow - Default), an authorization code is returned from the ServerAuthURL and the class automatically contacts the ServerTokenURL and exchanges the authorization code for an ID Token and access token.
When using 1 (Implicit Flow), the ServerAuthURL returns an ID Token and access token directly. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself.
When using 2 (Hybrid Flow), an authorization code and potentially one or more tokens are returned by the ServerAuthURL. The class will automatically contact the ServerTokenURL to exchange the authorization code for an ID Token and access token.
When GrantType and any other optional settings are set as desired, call GetAuthorization.
GetAuthorization performs several operations automatically depending on the value of ClientProfile. Please see the introduction section for the OpenID class for a detailed overview of the typical scenarios.
After authorization is complete, UserDetails will be populated with the claims parsed from the ID Token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the AuthorizationScope property. If access to another resource was requested, then the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).
GetUserInfo may be called after calling this method.
The following properties are applicable when calling this method:
- ClientId (required)
- ClientSecret (required)
- ServerAuthURL (required - populated by GetDiscoveryDoc.)
- ServerTokenURL (required - populated by GetDiscoveryDoc.)
- SignerCertURL (conditional - populated by GetDiscoveryDoc. Required if SignerCert is not set.)
- SignerCert (conditional - required if SignerCertURL is not set.)
- AuthorizationScope
- ClientProfile
- GrantType
- Params
- RefreshToken
- ReturnURL
- State
- Timeout
- Display
- Prompt
- IDTokenHint
- LoginHint
- ResponseType
For the default Authorization Code flow, GetAuthorization could work like this:
openid.ClientId = "client id";
openid.ClientSecret = "client secret";
openid.AuthorizationScope += " profile email"; // default value is 'openid'
openid.State = "application state";
string authToken = openid.GetAuthorization();
Get User Info
When GetAuthorization returns, the UserDetails property is populated with information about the user as returned in the ID Token from the authorization server. An additional operation, GetUserInfo may optionally be called to query the ServerUserInfoURL for information about the user.
Before calling the GetUserInfo method, a successful call to GetAuthorization must be made. The access token returned by GetAuthorization is used by the OpenID provider at ServerUserInfoURL to identify the user for which claims are being retrieved.
When this method is called the class requests the claims about the user from the ServerUserInfoURL. The resulting claims are available in the UserDetails property.
Note: The GetUserInfo method will populate the UserDetails property with the claims returned in the ID Token during the authorization process. This method may not need to be called in order to access the desired claims about the user.
openid.GetUserInfo();
// ... use the user info in the remainder of your application ...
Client Profile Notes
The ClientProfile defines the environment in which the class is being used, and controls how the class behaves in order to best suit that environment. Choose the profile that is closest to the runtime environment.
The following client types are currently supported by the class:
- Application (desktop application)
- WebServer (server side application such as a web site)
- Device (an application without browser access such as a game console)
- Mobile (phone or tablet application)
- Browser (javascript application)
- JWT (server to server authentication using a JWT bearer token such as Google service account authentication)
Application Profile
The Application profile is applicable to applications that are run directly by the user. For instance, a Windows form application would use the Application profile. To authorize your application (client) using the Application profile, use the following steps:
First, set ClientProfile to ocpApplication. This defines the profile the 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.
For additional details for less common profile types please see ClientProfile.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AccessToken | The access token returned by the authorization server. |
AccessTokenExp | The lifetime of the access token. |
AuthorizationCode | The authorization code that is exchanged for an access token. |
AuthorizationScope | The authorization scope used during authorization. |
ClientId | The Id of the client assigned when registering the application. |
ClientProfile | The type of client that is requesting authorization. |
ClientSecret | The secret value for the client assigned when registering the application. |
Connected | This property shows whether the class is connected. |
Cookies | This property includes a collection of cookies. |
DiscoveryDocDetails | Details about the OpenID provider's discovery document. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | This property determines what happens when the server issues a redirect. |
GrantType | The grant type defining the authentication flow. |
Idle | This property specifies the current status of the class. |
IdTokenInfo | Information about the current ID Token. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Params | The parameters to be included in the request to the authorization server or received in the response. |
Proxy | A set of properties related to proxy access. |
RefreshToken | The refresh token received from or sent to the authorization server. |
ReturnURL | The URL where the user (browser) returns after authenticating. |
ServerAuthURL | The URL of the authorization server. |
ServerTokenURL | The URL used to obtain the access token. |
ServerUserInfoURL | The URL of the OpenID provider's user info endpoint. |
SignerCert | The JWT public signer certificate. |
SignerCertURL | The URL of the OpenID provider's signing certificate. |
SSLAcceptServerCert | This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | This property includes the server certificate for the last established connection. |
State | The opaque value used to maintain state between the request and response. |
Timeout | This property includes the timeout for the class. |
TransferredData | The contents of the last response from the server. |
TransferredHeaders | This property includes the full set of headers as received from the server. |
UsePKCE | Whether Proof Key for Code Exchange (PKCE) should be used. |
UserDetails | The claims about the user. |
WebServerPort | The local port on which the embedded web server listens. |
WebServerSSLCert | The certificate with the private key to use when a Secure Sockets Layer (SSL) is enabled. |
WebServerSSLEnabled | 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.
AddCookie | This method adds a cookie and the corresponding value to the outgoing request headers. |
AddParam | Adds a name-value pair to the query string parameters of the outgoing request. |
Config | Sets or retrieves a configuration setting. |
DoEvents | This method processes events from the internal message queue. |
GetAuthorization | Gets the authorization string required to access the protected resource. |
GetAuthorizationURL | Builds and returns the URL to which the user should be redirected for authorization. |
GetDiscoveryDoc | Gets the OpenID Discovery Document. |
GetParam | Gets a specific parameter from a query string. |
GetUserInfo | Retrieves claims about the user. |
Interrupt | This method interrupts the current method. |
Reset | This method will reset the class. |
StartWebServer | Starts the embedded web server. |
StopWebServer | 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.
Connected | This event is fired immediately after a connection completes (or fails). |
ConnectionStatus | This event is fired to indicate changes in the connection state. |
Disconnected | This event is fired when a connection is closed. |
EndTransfer | This event is fired when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
Header | This event is fired every time a header line comes in. |
LaunchBrowser | Fires before launching a browser with the authorization URL. |
Log | This event fires once for each log message. |
Redirect | This event is fired when a redirection is received from the server. |
ReturnURL | Fired when the user is redirected to the embedded web server. |
SetCookie | This event is fired for every cookie set by the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event is fired when a document starts transferring (after the headers). |
Status | This event is fired when the HTTP status line is received from the server. |
Transfer | This 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.
Display | The requested display options to present to the end user. |
IDToken | The raw ID Token returned after authorization. |
IDTokenHint | An ID Token value to be used as a hint about the user's session. |
LoginHint | The login hint sent to the authorization server. |
Prompt | The requested conditions under which the authorization server prompts for login. |
RawJSON | A JSON string holding the last response. |
ResponseType | The value of the response_type request parameter. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AuthMethod | Specifies how the client credentials are sent to the token server. |
AuthorizationTokenType | The type of access token returned. |
BrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
DeviceGrantType | The grant type to be used when the ClientProfile is set to ocpDevice. |
DeviceUserCode | The device's user code when the ClientProfile is set to ocpDevice. |
FormVarCount | Specifies 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. |
IncludeClientCredsInBody | Whether to include the client credentials in the header or request body. |
IncludeEmptyRedirectURI | Whether an empty redirect_uri parameter is included in requests. |
JWTAudience | The JWT audience when the ClientProfile is set to ocpJWT. |
JWTCertStore | The name of the certificate store for the JWT signing certificate. |
JWTCertStorePassword | The JWT signing certificate password. |
JWTCertStoreType | The type of certificate store. |
JWTCertSubject | The JWT signing certificate subject. |
JWTIssuer | The JWT issuer when the ClientProfile is set to ocpJWT. |
JWTJSONKey | The data or file path of the JWT JSON Key. |
JWTPayload | The payload of the JWT access token, if present. |
JWTServiceProvider | The service provider to which authentication is being performed. |
JWTSignatureAlgorithm | The signature algorithm used to sign the JWT. |
JWTSubject | The subject field in the JWT. |
JWTValidityTime | The amount of time in seconds for which the assertion in the JWT is valid. |
JWTXChildCount | The 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. |
JWTXElement | The name of the current element. |
JWTXParent | The parent of the current element. |
JWTXPath | Points to a specific element in the returned payload of a JWT based access token. |
JWTXSubTree | A snapshot of the current element in the document. |
JWTXText | The text of the current element. |
Microsoft365AdminConsentError | The error message returned when the admin denies consent to the scopes. |
Microsoft365AdminConsentErrorDesc | The error description returned when the admin denies consent to the scopes. |
Microsoft365AdminConsentTenant | The tenant ID returned after the admin consents to the scopes. |
Office365ServiceAPIVersion | The API version of the Office 365 service being discovered. |
Office365ServiceCapability | The API capability of the Office 365 service being discovered. |
Office365ServiceEndpoint | The Office 365 endpoint for the service that matches the criteria specified. |
PasswordGrantUsername | The Username field when using the password grant type. |
PKCEChallengeEncoding | The PKCE code challenge method to use. |
PKCEVerifier | The PKCE verifier used to generate the challenge. |
PollingInterval | The interval in seconds between polling requests when the device client profile is used. |
ResponseCompanyImage | A URL or full path to a company logo. |
ResponseCompanyURL | A URL to the company website or similar resource. |
ResponseFailureHeading | Short header text indicating failure. |
ResponseFailureMessage | A description for a failed authorization. |
ResponseHelpURL | A URL to a help page or other resource. |
ResponseLicenseURL | A URL to licensing terms. |
ResponseProductImage | A URL or full path to a product image. |
ResponseProductURL | A URL to a product page or similar resource. |
ResponseSuccessHeading | Short header text indicating success. |
ResponseSuccessMessage | A description for a successful authorization. |
ReUseWebServer | Determines if the same server instance is used between requests. |
TokenInfoFieldCount | The 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. |
TokenInfoURL | The URL of the tokeninfo service. |
ValidateToken | Validates the specified access token with a tokeninfo service. |
WebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
WebServerHost | The hostname used by the embedded web server displayed in the ReturnURL. |
WebServerResponse | The custom response that is displayed to the user. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccessToken Property (OpenID Class)
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_openid_getaccesstoken(void* lpObj);
int ipworksauth_openid_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 (OpenID Class)
The lifetime of the access token.
Syntax
ANSI (Cross Platform) int GetAccessTokenExp(); Unicode (Windows) INT GetAccessTokenExp();
int ipworksauth_openid_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 (OpenID Class)
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_openid_getauthorizationcode(void* lpObj);
int ipworksauth_openid_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 (OpenID Class)
The authorization scope used during authorization.
Syntax
ANSI (Cross Platform) char* GetAuthorizationScope();
int SetAuthorizationScope(const char* lpszAuthorizationScope); Unicode (Windows) LPWSTR GetAuthorizationScope();
INT SetAuthorizationScope(LPCWSTR lpszAuthorizationScope);
char* ipworksauth_openid_getauthorizationscope(void* lpObj);
int ipworksauth_openid_setauthorizationscope(void* lpObj, const char* lpszAuthorizationScope);
QString GetAuthorizationScope();
int SetAuthorizationScope(QString qsAuthorizationScope);
Default Value
"openid"
Remarks
This property specifies the authorization scopes sent in the authorization request. The value specified here must be a space separated list of scopes. For instance openid profile email.
The openid scope is always required to be present. The default value is openid.
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 (OpenID Class)
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_openid_getclientid(void* lpObj);
int ipworksauth_openid_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 (OpenID Class)
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_openid_getclientprofile(void* lpObj);
int ipworksauth_openid_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:
- JWTIssuer (required)
- JWTAudience (required)
- JWTCertStoreType (required)
- JWTCertStore (required)
- JWTCertStorePassword (required)
- JWTCertSubject (required)
- JWTSubject
- JWTValidityTime
- JWTSignatureAlgorithm
Example 1. Google:
oauth.AuthorizationScope = "https://www.googleapis.com/auth/analytics";
oauth.ServerTokenURL = "https://www.googleapis.com/oauth2/v3/token";
oauth.ClientProfile = OauthClientProfiles.ocpJWT;
oauth.Config("JWTServiceProvider=0");
oauth.Config("JWTIssuer=CLIENT_ID");
oauth.Config("JWTAudience=https://www.googleapis.com/oauth2/v3/token");
oauth.Config("JWTCertStoreType=2");
oauth.Config("JWTCertStore=C:\\MyCertificate.p12");
oauth.Config("JWTCertStorePassword=password");
oauth.Config("JWTCertSubject=*");
oauth.Config("JWTValidityTime=5400"); //in seconds
string authStr = oauth.GetAuthorization();
Example 2. Microsoft:
oauth.ClientId = "Client_Id";
oauth.ClientProfile = OauthClientProfiles.ocpJWT;
oauth.AuthorizationScope = "https://graph.microsoft.com/.default";
oauth.ServerTokenURL = "https://login.microsoftonline.com/" + tenant_id + "/oauth2/V2.0/token";
oauth.Config("JWTServiceProvider=1");
oauth.Config("JWTIssuer=" + CLIENT_ID);
oauth.Config("JWTSubject=" + CLIENT_ID);
oauth.Config("JWTCertStoreType=2");
oauth.Config("JWTCertStore=C:\\MyCertificate.p12");
oauth.Config("JWTCertStorePassword=password");
oauth.Config("JWTCertSubject=*");
oauth.Config("JWTValidityTime=3600");
oauth.Config("JWTAudience=https://login.microsoftonline.com/"+ tenant_id + "/oauth2/V2.0/token");
string authStr = oauth.GetAuthorization();
Data Type
Integer
ClientSecret Property (OpenID Class)
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_openid_getclientsecret(void* lpObj);
int ipworksauth_openid_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 (OpenID Class)
This property shows whether the class is connected.
Syntax
ANSI (Cross Platform) int GetConnected(); Unicode (Windows) BOOL GetConnected();
int ipworksauth_openid_getconnected(void* lpObj);
bool GetConnected();
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.
This property is read-only and not available at design time.
Data Type
Boolean
Cookies Property (OpenID Class)
This property includes a collection of cookies.
Syntax
IPWorksAuthList<IPWorksAuthHTTPCookie>* GetCookies(); int SetCookies(IPWorksAuthList<IPWorksAuthHTTPCookie>* val);
int ipworksauth_openid_getcookiecount(void* lpObj);
int ipworksauth_openid_setcookiecount(void* lpObj, int iCookieCount);
char* ipworksauth_openid_getcookiedomain(void* lpObj, int cookieindex);
char* ipworksauth_openid_getcookieexpiration(void* lpObj, int cookieindex);
char* ipworksauth_openid_getcookiename(void* lpObj, int cookieindex);
int ipworksauth_openid_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);
char* ipworksauth_openid_getcookiepath(void* lpObj, int cookieindex);
int ipworksauth_openid_getcookiesecure(void* lpObj, int cookieindex);
char* ipworksauth_openid_getcookievalue(void* lpObj, int cookieindex);
int ipworksauth_openid_setcookievalue(void* lpObj, int cookieindex, const char* lpszCookieValue);
int GetCookieCount();
int SetCookieCount(int iCookieCount); QString GetCookieDomain(int iCookieIndex); QString GetCookieExpiration(int iCookieIndex); QString GetCookieName(int iCookieIndex);
int SetCookieName(int iCookieIndex, QString qsCookieName); QString GetCookiePath(int iCookieIndex); bool GetCookieSecure(int iCookieIndex); QString GetCookieValue(int iCookieIndex);
int SetCookieValue(int iCookieIndex, QString qsCookieValue);
Remarks
This property contains a collection of cookies. To add cookies to outgoing HTTP requests, add cookies (of type HTTPCookie) to this collection.
To see cookies that are set by the server, use the SetCookie event, which displays the cookies and their properties as set by the server. Those cookies also are added to Cookies.
MaxHTTPCookies can be used to control the maximum number of cookies saved.
This property is not available at design time.
Data Type
DiscoveryDocDetails Property (OpenID Class)
Details about the OpenID provider's discovery document.
Syntax
IPWorksAuthDiscoveryDocDetails* GetDiscoveryDocDetails();
char* ipworksauth_openid_getdiscoverydocdetailsauthorizationurl(void* lpObj);
int ipworksauth_openid_getdiscoverydocdetailsclaimsparamsupported(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailscontent(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailsissuer(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailslogouturl(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailsregistrationurl(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailsservicedocsurl(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailssignercerturl(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailssupportedclaims(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailssupporteddisplays(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailssupportedgranttypes(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailssupportedresponsetypes(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailssupportedscopes(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailstokenurl(void* lpObj);
char* ipworksauth_openid_getdiscoverydocdetailsuserinfourl(void* lpObj);
QString GetDiscoveryDocDetailsAuthorizationURL(); bool GetDiscoveryDocDetailsClaimsParamSupported(); QString GetDiscoveryDocDetailsContent(); QString GetDiscoveryDocDetailsIssuer(); QString GetDiscoveryDocDetailsLogoutURL(); QString GetDiscoveryDocDetailsRegistrationURL(); QString GetDiscoveryDocDetailsServiceDocsURL(); QString GetDiscoveryDocDetailsSignerCertURL(); QString GetDiscoveryDocDetailsSupportedClaims(); QString GetDiscoveryDocDetailsSupportedDisplays(); QString GetDiscoveryDocDetailsSupportedGrantTypes(); QString GetDiscoveryDocDetailsSupportedResponseTypes(); QString GetDiscoveryDocDetailsSupportedScopes(); QString GetDiscoveryDocDetailsTokenURL(); QString GetDiscoveryDocDetailsUserInfoURL();
Remarks
This property holds details parsed from the discovery document after GetDiscoveryDoc is called. See GetDiscoveryDoc for more details.
This property is read-only and not available at design time.
Data Type
IPWorksAuthDiscoveryDocDetails
Firewall Property (OpenID Class)
A set of properties related to firewall access.
Syntax
IPWorksAuthFirewall* GetFirewall(); int SetFirewall(IPWorksAuthFirewall* val);
int ipworksauth_openid_getfirewallautodetect(void* lpObj);
int ipworksauth_openid_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
int ipworksauth_openid_getfirewalltype(void* lpObj);
int ipworksauth_openid_setfirewalltype(void* lpObj, int iFirewallType);
char* ipworksauth_openid_getfirewallhost(void* lpObj);
int ipworksauth_openid_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
char* ipworksauth_openid_getfirewallpassword(void* lpObj);
int ipworksauth_openid_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
int ipworksauth_openid_getfirewallport(void* lpObj);
int ipworksauth_openid_setfirewallport(void* lpObj, int iFirewallPort);
char* ipworksauth_openid_getfirewalluser(void* lpObj);
int ipworksauth_openid_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect); int GetFirewallType();
int SetFirewallType(int iFirewallType); QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost); QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword); int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);
Remarks
This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.
Data Type
FollowRedirects Property (OpenID 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_openid_getfollowredirects(void* lpObj);
int ipworksauth_openid_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 (OpenID Class)
The grant type defining the authentication flow.
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_HYBRID(2)
int ipworksauth_openid_getgranttype(void* lpObj);
int ipworksauth_openid_setgranttype(void* lpObj, int iGrantType);
int GetGrantType();
int SetGrantType(int iGrantType);
Default Value
0
Remarks
This property defines the grant type used when performing authentication. The value specified here controls the authentication flow.
Possible values for GrantType are:
- 0 (Authorization Code - Default)
- 1 (Implicit)
- 2 (Hybrid)
When using 0 (Authorization Code Flow - Default), an authorization code is returned from the ServerAuthURL and the class automatically contacts the ServerTokenURL and exchanges the authorization code for an ID Token and access token.
When using 1 (Implicit Flow), the ServerAuthURL returns an ID Token and access token directly. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself.
When using 2 (Hybrid Flow), an authorization code and potentially one or more tokens are returned by the ServerAuthURL. The class will automatically contact the ServerTokenURL to exchange the authorization code for an ID Token and access token.
Additional Notes
The response_type request parameter is automatically set based on the value specified here. In some cases multiple values are acceptable and a default value is chosen automatically. To explicitly specify a response_type value for the chosen grant type set ResponseType after setting this property.
Data Type
Integer
Idle Property (OpenID Class)
This property specifies the current status of the class.
Syntax
ANSI (Cross Platform) int GetIdle(); Unicode (Windows) BOOL GetIdle();
int ipworksauth_openid_getidle(void* lpObj);
bool GetIdle();
Default Value
TRUE
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
IdTokenInfo Property (OpenID Class)
Information about the current ID Token.
Syntax
IPWorksAuthIdTokenInfo* GetIdTokenInfo();
char* ipworksauth_openid_getidtokenaudiences(void* lpObj);
int64 ipworksauth_openid_getidtokenauthtime(void* lpObj);
int64 ipworksauth_openid_getidtokenexptime(void* lpObj);
char* ipworksauth_openid_getidtokenidtokencontent(void* lpObj);
int64 ipworksauth_openid_getidtokenissuedtime(void* lpObj);
char* ipworksauth_openid_getidtokenissuer(void* lpObj);
QString GetIdTokenAudiences(); qint64 GetIdTokenAuthTime(); qint64 GetIdTokenExpTime(); QString GetIdTokenIdTokenContent(); qint64 GetIdTokenIssuedTime(); QString GetIdTokenIssuer();
Remarks
This property holds details about the ID Token.
When GetAuthorization is called, this property is populated with the claims from the ID Token.
This property is read-only and not available at design time.
Data Type
LocalHost Property (OpenID Class)
This property includes 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_openid_getlocalhost(void* lpObj);
int ipworksauth_openid_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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
OtherHeaders Property (OpenID 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_openid_getotherheaders(void* lpObj);
int ipworksauth_openid_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
Params Property (OpenID Class)
The parameters to be included in the request to the authorization server or received in the response.
Syntax
IPWorksAuthList<IPWorksAuthOAuthParam>* GetParams(); int SetParams(IPWorksAuthList<IPWorksAuthOAuthParam>* val);
int ipworksauth_openid_getparamcount(void* lpObj);
int ipworksauth_openid_setparamcount(void* lpObj, int iParamCount);
char* ipworksauth_openid_getparamname(void* lpObj, int paramindex);
int ipworksauth_openid_setparamname(void* lpObj, int paramindex, const char* lpszParamName);
char* ipworksauth_openid_getparamvalue(void* lpObj, int paramindex);
int ipworksauth_openid_setparamvalue(void* lpObj, int paramindex, const char* lpszParamValue);
int GetParamCount();
int SetParamCount(int iParamCount); QString GetParamName(int iParamIndex);
int SetParamName(int iParamIndex, QString qsParamName); QString GetParamValue(int iParamIndex);
int SetParamValue(int iParamIndex, QString qsParamValue);
Remarks
This is a collection of query string parameters to be added in the request when creating the authorization URL. This will also hold the parameters returned in the response.
This property is not available at design time.
Data Type
Proxy Property (OpenID Class)
A set of properties related to proxy access.
Syntax
IPWorksAuthProxy* GetProxy(); int SetProxy(IPWorksAuthProxy* val);
int ipworksauth_openid_getproxyauthscheme(void* lpObj);
int ipworksauth_openid_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int ipworksauth_openid_getproxyautodetect(void* lpObj);
int ipworksauth_openid_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
char* ipworksauth_openid_getproxypassword(void* lpObj);
int ipworksauth_openid_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int ipworksauth_openid_getproxyport(void* lpObj);
int ipworksauth_openid_setproxyport(void* lpObj, int iProxyPort);
char* ipworksauth_openid_getproxyserver(void* lpObj);
int ipworksauth_openid_setproxyserver(void* lpObj, const char* lpszProxyServer);
int ipworksauth_openid_getproxyssl(void* lpObj);
int ipworksauth_openid_setproxyssl(void* lpObj, int iProxySSL);
char* ipworksauth_openid_getproxyuser(void* lpObj);
int ipworksauth_openid_setproxyuser(void* lpObj, const char* lpszProxyUser);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); QString GetProxyServer();
int SetProxyServer(QString qsProxyServer); int GetProxySSL();
int SetProxySSL(int iProxySSL); QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
Data Type
RefreshToken Property (OpenID Class)
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_openid_getrefreshtoken(void* lpObj);
int ipworksauth_openid_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 (OpenID Class)
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_openid_getreturnurl(void* lpObj);
int ipworksauth_openid_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 (OpenID Class)
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_openid_getserverauthurl(void* lpObj);
int ipworksauth_openid_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 (OpenID Class)
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_openid_getservertokenurl(void* lpObj);
int ipworksauth_openid_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
ServerUserInfoURL Property (OpenID Class)
The URL of the OpenID provider's user info endpoint.
Syntax
ANSI (Cross Platform) char* GetServerUserInfoURL();
int SetServerUserInfoURL(const char* lpszServerUserInfoURL); Unicode (Windows) LPWSTR GetServerUserInfoURL();
INT SetServerUserInfoURL(LPCWSTR lpszServerUserInfoURL);
char* ipworksauth_openid_getserveruserinfourl(void* lpObj);
int ipworksauth_openid_setserveruserinfourl(void* lpObj, const char* lpszServerUserInfoURL);
QString GetServerUserInfoURL();
int SetServerUserInfoURL(QString qsServerUserInfoURL);
Default Value
""
Remarks
This property holds the URL of the OpenID provider's user info endpoint. This value is required when calling GetUserInfo.
This property is populated when GetDiscoveryDoc is called.
Data Type
String
SignerCert Property (OpenID Class)
The JWT public signer certificate.
Syntax
IPWorksAuthCertificate* GetSignerCert(); int SetSignerCert(IPWorksAuthCertificate* val);
char* ipworksauth_openid_getsignercerteffectivedate(void* lpObj);
char* ipworksauth_openid_getsignercertexpirationdate(void* lpObj);
char* ipworksauth_openid_getsignercertextendedkeyusage(void* lpObj);
char* ipworksauth_openid_getsignercertfingerprint(void* lpObj);
char* ipworksauth_openid_getsignercertfingerprintsha1(void* lpObj);
char* ipworksauth_openid_getsignercertfingerprintsha256(void* lpObj);
char* ipworksauth_openid_getsignercertissuer(void* lpObj);
char* ipworksauth_openid_getsignercertprivatekey(void* lpObj);
int ipworksauth_openid_getsignercertprivatekeyavailable(void* lpObj);
char* ipworksauth_openid_getsignercertprivatekeycontainer(void* lpObj);
char* ipworksauth_openid_getsignercertpublickey(void* lpObj);
char* ipworksauth_openid_getsignercertpublickeyalgorithm(void* lpObj);
int ipworksauth_openid_getsignercertpublickeylength(void* lpObj);
char* ipworksauth_openid_getsignercertserialnumber(void* lpObj);
char* ipworksauth_openid_getsignercertsignaturealgorithm(void* lpObj);
int ipworksauth_openid_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksauth_openid_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);
char* ipworksauth_openid_getsignercertstorepassword(void* lpObj);
int ipworksauth_openid_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);
int ipworksauth_openid_getsignercertstoretype(void* lpObj);
int ipworksauth_openid_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);
char* ipworksauth_openid_getsignercertsubjectaltnames(void* lpObj);
char* ipworksauth_openid_getsignercertthumbprintmd5(void* lpObj);
char* ipworksauth_openid_getsignercertthumbprintsha1(void* lpObj);
char* ipworksauth_openid_getsignercertthumbprintsha256(void* lpObj);
char* ipworksauth_openid_getsignercertusage(void* lpObj);
int ipworksauth_openid_getsignercertusageflags(void* lpObj);
char* ipworksauth_openid_getsignercertversion(void* lpObj);
char* ipworksauth_openid_getsignercertsubject(void* lpObj);
int ipworksauth_openid_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);
int ipworksauth_openid_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksauth_openid_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);
QString GetSignerCertEffectiveDate(); QString GetSignerCertExpirationDate(); QString GetSignerCertExtendedKeyUsage(); QString GetSignerCertFingerprint(); QString GetSignerCertFingerprintSHA1(); QString GetSignerCertFingerprintSHA256(); QString GetSignerCertIssuer(); QString GetSignerCertPrivateKey(); bool GetSignerCertPrivateKeyAvailable(); QString GetSignerCertPrivateKeyContainer(); QString GetSignerCertPublicKey(); QString GetSignerCertPublicKeyAlgorithm(); int GetSignerCertPublicKeyLength(); QString GetSignerCertSerialNumber(); QString GetSignerCertSignatureAlgorithm(); QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore); QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword); int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType); QString GetSignerCertSubjectAltNames(); QString GetSignerCertThumbprintMD5(); QString GetSignerCertThumbprintSHA1(); QString GetSignerCertThumbprintSHA256(); QString GetSignerCertUsage(); int GetSignerCertUsageFlags(); QString GetSignerCertVersion(); QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject); QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);
Remarks
This property specifies the public certificate of JWT signer. When GetAuthorization is called, the returned ID Token is typically signed. The public certificate specified in this property is used to verify the signature.
If this property is not set, the certificate is automatically retrieved from the SignerCertURL.
Data Type
SignerCertURL Property (OpenID Class)
The URL of the OpenID provider's signing certificate.
Syntax
ANSI (Cross Platform) char* GetSignerCertURL();
int SetSignerCertURL(const char* lpszSignerCertURL); Unicode (Windows) LPWSTR GetSignerCertURL();
INT SetSignerCertURL(LPCWSTR lpszSignerCertURL);
char* ipworksauth_openid_getsignercerturl(void* lpObj);
int ipworksauth_openid_setsignercerturl(void* lpObj, const char* lpszSignerCertURL);
QString GetSignerCertURL();
int SetSignerCertURL(QString qsSignerCertURL);
Default Value
""
Remarks
This property holds the URL of the OpenID provider's signing certificate. The signing certificate is used to verify the signature of the ID Token returned when calling GetAuthorization.
When calling GetAuthorization either SignerCertURL or SignerCert must be specified.
This property is populated when GetDiscoveryDoc is called.
Data Type
String
SSLAcceptServerCert Property (OpenID Class)
This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
IPWorksAuthCertificate* GetSSLAcceptServerCert(); int SetSSLAcceptServerCert(IPWorksAuthCertificate* val);
char* ipworksauth_openid_getsslacceptservercerteffectivedate(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertexpirationdate(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertextendedkeyusage(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertfingerprint(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertfingerprintsha1(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertfingerprintsha256(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertissuer(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertprivatekey(void* lpObj);
int ipworksauth_openid_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertpublickey(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int ipworksauth_openid_getsslacceptservercertpublickeylength(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertserialnumber(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertsignaturealgorithm(void* lpObj);
int ipworksauth_openid_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksauth_openid_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* ipworksauth_openid_getsslacceptservercertstorepassword(void* lpObj);
int ipworksauth_openid_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int ipworksauth_openid_getsslacceptservercertstoretype(void* lpObj);
int ipworksauth_openid_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* ipworksauth_openid_getsslacceptservercertsubjectaltnames(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertthumbprintmd5(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertthumbprintsha1(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertthumbprintsha256(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertusage(void* lpObj);
int ipworksauth_openid_getsslacceptservercertusageflags(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertversion(void* lpObj);
char* ipworksauth_openid_getsslacceptservercertsubject(void* lpObj);
int ipworksauth_openid_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int ipworksauth_openid_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksauth_openid_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QString GetSSLAcceptServerCertEffectiveDate(); QString GetSSLAcceptServerCertExpirationDate(); QString GetSSLAcceptServerCertExtendedKeyUsage(); QString GetSSLAcceptServerCertFingerprint(); QString GetSSLAcceptServerCertFingerprintSHA1(); QString GetSSLAcceptServerCertFingerprintSHA256(); QString GetSSLAcceptServerCertIssuer(); QString GetSSLAcceptServerCertPrivateKey(); bool GetSSLAcceptServerCertPrivateKeyAvailable(); QString GetSSLAcceptServerCertPrivateKeyContainer(); QString GetSSLAcceptServerCertPublicKey(); QString GetSSLAcceptServerCertPublicKeyAlgorithm(); int GetSSLAcceptServerCertPublicKeyLength(); QString GetSSLAcceptServerCertSerialNumber(); QString GetSSLAcceptServerCertSignatureAlgorithm(); QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore); QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword); int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType); QString GetSSLAcceptServerCertSubjectAltNames(); QString GetSSLAcceptServerCertThumbprintMD5(); QString GetSSLAcceptServerCertThumbprintSHA1(); QString GetSSLAcceptServerCertThumbprintSHA256(); QString GetSSLAcceptServerCertUsage(); int GetSSLAcceptServerCertUsageFlags(); QString GetSSLAcceptServerCertVersion(); QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject); QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Data Type
SSLCert Property (OpenID Class)
This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
IPWorksAuthCertificate* GetSSLCert(); int SetSSLCert(IPWorksAuthCertificate* val);
char* ipworksauth_openid_getsslcerteffectivedate(void* lpObj);
char* ipworksauth_openid_getsslcertexpirationdate(void* lpObj);
char* ipworksauth_openid_getsslcertextendedkeyusage(void* lpObj);
char* ipworksauth_openid_getsslcertfingerprint(void* lpObj);
char* ipworksauth_openid_getsslcertfingerprintsha1(void* lpObj);
char* ipworksauth_openid_getsslcertfingerprintsha256(void* lpObj);
char* ipworksauth_openid_getsslcertissuer(void* lpObj);
char* ipworksauth_openid_getsslcertprivatekey(void* lpObj);
int ipworksauth_openid_getsslcertprivatekeyavailable(void* lpObj);
char* ipworksauth_openid_getsslcertprivatekeycontainer(void* lpObj);
char* ipworksauth_openid_getsslcertpublickey(void* lpObj);
char* ipworksauth_openid_getsslcertpublickeyalgorithm(void* lpObj);
int ipworksauth_openid_getsslcertpublickeylength(void* lpObj);
char* ipworksauth_openid_getsslcertserialnumber(void* lpObj);
char* ipworksauth_openid_getsslcertsignaturealgorithm(void* lpObj);
int ipworksauth_openid_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksauth_openid_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* ipworksauth_openid_getsslcertstorepassword(void* lpObj);
int ipworksauth_openid_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int ipworksauth_openid_getsslcertstoretype(void* lpObj);
int ipworksauth_openid_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* ipworksauth_openid_getsslcertsubjectaltnames(void* lpObj);
char* ipworksauth_openid_getsslcertthumbprintmd5(void* lpObj);
char* ipworksauth_openid_getsslcertthumbprintsha1(void* lpObj);
char* ipworksauth_openid_getsslcertthumbprintsha256(void* lpObj);
char* ipworksauth_openid_getsslcertusage(void* lpObj);
int ipworksauth_openid_getsslcertusageflags(void* lpObj);
char* ipworksauth_openid_getsslcertversion(void* lpObj);
char* ipworksauth_openid_getsslcertsubject(void* lpObj);
int ipworksauth_openid_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int ipworksauth_openid_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksauth_openid_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QString GetSSLCertEffectiveDate(); QString GetSSLCertExpirationDate(); QString GetSSLCertExtendedKeyUsage(); QString GetSSLCertFingerprint(); QString GetSSLCertFingerprintSHA1(); QString GetSSLCertFingerprintSHA256(); QString GetSSLCertIssuer(); QString GetSSLCertPrivateKey(); bool GetSSLCertPrivateKeyAvailable(); QString GetSSLCertPrivateKeyContainer(); QString GetSSLCertPublicKey(); QString GetSSLCertPublicKeyAlgorithm(); int GetSSLCertPublicKeyLength(); QString GetSSLCertSerialNumber(); QString GetSSLCertSignatureAlgorithm(); QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore); QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword); int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); QString GetSSLCertSubjectAltNames(); QString GetSSLCertThumbprintMD5(); QString GetSSLCertThumbprintSHA1(); QString GetSSLCertThumbprintSHA256(); QString GetSSLCertUsage(); int GetSSLCertUsageFlags(); QString GetSSLCertVersion(); QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject); QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Data Type
SSLProvider Property (OpenID Class)
This property specifies the Secure Sockets Layer/Transport Layer Security (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_openid_getsslprovider(void* lpObj);
int ipworksauth_openid_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 as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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
SSLServerCert Property (OpenID Class)
This property includes the server certificate for the last established connection.
Syntax
IPWorksAuthCertificate* GetSSLServerCert();
char* ipworksauth_openid_getsslservercerteffectivedate(void* lpObj);
char* ipworksauth_openid_getsslservercertexpirationdate(void* lpObj);
char* ipworksauth_openid_getsslservercertextendedkeyusage(void* lpObj);
char* ipworksauth_openid_getsslservercertfingerprint(void* lpObj);
char* ipworksauth_openid_getsslservercertfingerprintsha1(void* lpObj);
char* ipworksauth_openid_getsslservercertfingerprintsha256(void* lpObj);
char* ipworksauth_openid_getsslservercertissuer(void* lpObj);
char* ipworksauth_openid_getsslservercertprivatekey(void* lpObj);
int ipworksauth_openid_getsslservercertprivatekeyavailable(void* lpObj);
char* ipworksauth_openid_getsslservercertprivatekeycontainer(void* lpObj);
char* ipworksauth_openid_getsslservercertpublickey(void* lpObj);
char* ipworksauth_openid_getsslservercertpublickeyalgorithm(void* lpObj);
int ipworksauth_openid_getsslservercertpublickeylength(void* lpObj);
char* ipworksauth_openid_getsslservercertserialnumber(void* lpObj);
char* ipworksauth_openid_getsslservercertsignaturealgorithm(void* lpObj);
int ipworksauth_openid_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* ipworksauth_openid_getsslservercertstorepassword(void* lpObj);
int ipworksauth_openid_getsslservercertstoretype(void* lpObj);
char* ipworksauth_openid_getsslservercertsubjectaltnames(void* lpObj);
char* ipworksauth_openid_getsslservercertthumbprintmd5(void* lpObj);
char* ipworksauth_openid_getsslservercertthumbprintsha1(void* lpObj);
char* ipworksauth_openid_getsslservercertthumbprintsha256(void* lpObj);
char* ipworksauth_openid_getsslservercertusage(void* lpObj);
int ipworksauth_openid_getsslservercertusageflags(void* lpObj);
char* ipworksauth_openid_getsslservercertversion(void* lpObj);
char* ipworksauth_openid_getsslservercertsubject(void* lpObj);
int ipworksauth_openid_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QString GetSSLServerCertEffectiveDate(); QString GetSSLServerCertExpirationDate(); QString GetSSLServerCertExtendedKeyUsage(); QString GetSSLServerCertFingerprint(); QString GetSSLServerCertFingerprintSHA1(); QString GetSSLServerCertFingerprintSHA256(); QString GetSSLServerCertIssuer(); QString GetSSLServerCertPrivateKey(); bool GetSSLServerCertPrivateKeyAvailable(); QString GetSSLServerCertPrivateKeyContainer(); QString GetSSLServerCertPublicKey(); QString GetSSLServerCertPublicKeyAlgorithm(); int GetSSLServerCertPublicKeyLength(); QString GetSSLServerCertSerialNumber(); QString GetSSLServerCertSignatureAlgorithm(); QByteArray GetSSLServerCertStore(); QString GetSSLServerCertStorePassword(); int GetSSLServerCertStoreType(); QString GetSSLServerCertSubjectAltNames(); QString GetSSLServerCertThumbprintMD5(); QString GetSSLServerCertThumbprintSHA1(); QString GetSSLServerCertThumbprintSHA256(); QString GetSSLServerCertUsage(); int GetSSLServerCertUsageFlags(); QString GetSSLServerCertVersion(); QString GetSSLServerCertSubject(); QByteArray GetSSLServerCertEncoded();
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Data Type
State Property (OpenID Class)
The opaque value used to maintain state between the request and response.
Syntax
ANSI (Cross Platform) char* GetState();
int SetState(const char* lpszState); Unicode (Windows) LPWSTR GetState();
INT SetState(LPCWSTR lpszState);
char* ipworksauth_openid_getstate(void* lpObj);
int ipworksauth_openid_setstate(void* lpObj, const char* lpszState);
QString GetState();
int SetState(QString qsState);
Default Value
""
Remarks
This property optionally holds a string value which will be returned by the authorization server with the response.
Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes (for instance to prevent Cross-Site Request Forgery). The contents of this property are treated as an opaque value.
When ClientProfile is set to ocpApplication the ReturnURL event provides the state value returned by the authorization server.
Data Type
String
Timeout Property (OpenID Class)
This property includes the timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int ipworksauth_openid_gettimeout(void* lpObj);
int ipworksauth_openid_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.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
TransferredData Property (OpenID Class)
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_openid_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 (OpenID 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_openid_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 (OpenID Class)
Whether 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_openid_getusepkce(void* lpObj);
int ipworksauth_openid_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
UserDetails Property (OpenID Class)
The claims about the user.
Syntax
IPWorksAuthUserDetails* GetUserDetails();
char* ipworksauth_openid_getuserdetailsaddrcountry(void* lpObj);
char* ipworksauth_openid_getuserdetailsaddrformatted(void* lpObj);
char* ipworksauth_openid_getuserdetailsaddrlocality(void* lpObj);
char* ipworksauth_openid_getuserdetailsaddrpostalcode(void* lpObj);
char* ipworksauth_openid_getuserdetailsaddrregion(void* lpObj);
char* ipworksauth_openid_getuserdetailsaddrstreetaddr(void* lpObj);
char* ipworksauth_openid_getuserdetailsbirthday(void* lpObj);
char* ipworksauth_openid_getuserdetailsemail(void* lpObj);
int ipworksauth_openid_getuserdetailsemailverified(void* lpObj);
char* ipworksauth_openid_getuserdetailsfirstname(void* lpObj);
char* ipworksauth_openid_getuserdetailsgender(void* lpObj);
char* ipworksauth_openid_getuserdetailslastname(void* lpObj);
char* ipworksauth_openid_getuserdetailslocale(void* lpObj);
char* ipworksauth_openid_getuserdetailsmiddlename(void* lpObj);
char* ipworksauth_openid_getuserdetailsname(void* lpObj);
char* ipworksauth_openid_getuserdetailsnickname(void* lpObj);
char* ipworksauth_openid_getuserdetailsphonenumber(void* lpObj);
int ipworksauth_openid_getuserdetailsphonenumberverified(void* lpObj);
char* ipworksauth_openid_getuserdetailspictureurl(void* lpObj);
char* ipworksauth_openid_getuserdetailspreferredusername(void* lpObj);
char* ipworksauth_openid_getuserdetailsprofileurl(void* lpObj);
char* ipworksauth_openid_getuserdetailssubject(void* lpObj);
int64 ipworksauth_openid_getuserdetailsupdatedat(void* lpObj);
char* ipworksauth_openid_getuserdetailswebsite(void* lpObj);
char* ipworksauth_openid_getuserdetailszoneinfo(void* lpObj);
QString GetUserDetailsAddrCountry(); QString GetUserDetailsAddrFormatted(); QString GetUserDetailsAddrLocality(); QString GetUserDetailsAddrPostalCode(); QString GetUserDetailsAddrRegion(); QString GetUserDetailsAddrStreetAddr(); QString GetUserDetailsBirthday(); QString GetUserDetailsEmail(); bool GetUserDetailsEmailVerified(); QString GetUserDetailsFirstName(); QString GetUserDetailsGender(); QString GetUserDetailsLastName(); QString GetUserDetailsLocale(); QString GetUserDetailsMiddleName(); QString GetUserDetailsName(); QString GetUserDetailsNickname(); QString GetUserDetailsPhoneNumber(); bool GetUserDetailsPhoneNumberVerified(); QString GetUserDetailsPictureURL(); QString GetUserDetailsPreferredUsername(); QString GetUserDetailsProfileURL(); QString GetUserDetailsSubject(); qint64 GetUserDetailsUpdatedAt(); QString GetUserDetailsWebsite(); QString GetUserDetailsZoneInfo();
Remarks
This property holds details about the user.
When GetAuthorization is called this property is populated with the claims from the ID Token.
When GetUserInfo is called this property is populated from the returned claims.
This property is read-only and not available at design time.
Data Type
WebServerPort Property (OpenID Class)
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_openid_getwebserverport(void* lpObj);
int ipworksauth_openid_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
WebServerSSLCert Property (OpenID Class)
The certificate with the private key to use when a Secure Sockets Layer (SSL) is enabled.
Syntax
IPWorksAuthCertificate* GetWebServerSSLCert(); int SetWebServerSSLCert(IPWorksAuthCertificate* val);
char* ipworksauth_openid_getwebserversslcerteffectivedate(void* lpObj);
char* ipworksauth_openid_getwebserversslcertexpirationdate(void* lpObj);
char* ipworksauth_openid_getwebserversslcertextendedkeyusage(void* lpObj);
char* ipworksauth_openid_getwebserversslcertfingerprint(void* lpObj);
char* ipworksauth_openid_getwebserversslcertfingerprintsha1(void* lpObj);
char* ipworksauth_openid_getwebserversslcertfingerprintsha256(void* lpObj);
char* ipworksauth_openid_getwebserversslcertissuer(void* lpObj);
char* ipworksauth_openid_getwebserversslcertprivatekey(void* lpObj);
int ipworksauth_openid_getwebserversslcertprivatekeyavailable(void* lpObj);
char* ipworksauth_openid_getwebserversslcertprivatekeycontainer(void* lpObj);
char* ipworksauth_openid_getwebserversslcertpublickey(void* lpObj);
char* ipworksauth_openid_getwebserversslcertpublickeyalgorithm(void* lpObj);
int ipworksauth_openid_getwebserversslcertpublickeylength(void* lpObj);
char* ipworksauth_openid_getwebserversslcertserialnumber(void* lpObj);
char* ipworksauth_openid_getwebserversslcertsignaturealgorithm(void* lpObj);
int ipworksauth_openid_getwebserversslcertstore(void* lpObj, char** lpWebServerSSLCertStore, int* lenWebServerSSLCertStore);
int ipworksauth_openid_setwebserversslcertstore(void* lpObj, const char* lpWebServerSSLCertStore, int lenWebServerSSLCertStore);
char* ipworksauth_openid_getwebserversslcertstorepassword(void* lpObj);
int ipworksauth_openid_setwebserversslcertstorepassword(void* lpObj, const char* lpszWebServerSSLCertStorePassword);
int ipworksauth_openid_getwebserversslcertstoretype(void* lpObj);
int ipworksauth_openid_setwebserversslcertstoretype(void* lpObj, int iWebServerSSLCertStoreType);
char* ipworksauth_openid_getwebserversslcertsubjectaltnames(void* lpObj);
char* ipworksauth_openid_getwebserversslcertthumbprintmd5(void* lpObj);
char* ipworksauth_openid_getwebserversslcertthumbprintsha1(void* lpObj);
char* ipworksauth_openid_getwebserversslcertthumbprintsha256(void* lpObj);
char* ipworksauth_openid_getwebserversslcertusage(void* lpObj);
int ipworksauth_openid_getwebserversslcertusageflags(void* lpObj);
char* ipworksauth_openid_getwebserversslcertversion(void* lpObj);
char* ipworksauth_openid_getwebserversslcertsubject(void* lpObj);
int ipworksauth_openid_setwebserversslcertsubject(void* lpObj, const char* lpszWebServerSSLCertSubject);
int ipworksauth_openid_getwebserversslcertencoded(void* lpObj, char** lpWebServerSSLCertEncoded, int* lenWebServerSSLCertEncoded);
int ipworksauth_openid_setwebserversslcertencoded(void* lpObj, const char* lpWebServerSSLCertEncoded, int lenWebServerSSLCertEncoded);
QString GetWebServerSSLCertEffectiveDate(); QString GetWebServerSSLCertExpirationDate(); QString GetWebServerSSLCertExtendedKeyUsage(); QString GetWebServerSSLCertFingerprint(); QString GetWebServerSSLCertFingerprintSHA1(); QString GetWebServerSSLCertFingerprintSHA256(); QString GetWebServerSSLCertIssuer(); QString GetWebServerSSLCertPrivateKey(); bool GetWebServerSSLCertPrivateKeyAvailable(); QString GetWebServerSSLCertPrivateKeyContainer(); QString GetWebServerSSLCertPublicKey(); QString GetWebServerSSLCertPublicKeyAlgorithm(); int GetWebServerSSLCertPublicKeyLength(); QString GetWebServerSSLCertSerialNumber(); QString GetWebServerSSLCertSignatureAlgorithm(); QByteArray GetWebServerSSLCertStore();
int SetWebServerSSLCertStore(QByteArray qbaWebServerSSLCertStore); QString GetWebServerSSLCertStorePassword();
int SetWebServerSSLCertStorePassword(QString qsWebServerSSLCertStorePassword); int GetWebServerSSLCertStoreType();
int SetWebServerSSLCertStoreType(int iWebServerSSLCertStoreType); QString GetWebServerSSLCertSubjectAltNames(); QString GetWebServerSSLCertThumbprintMD5(); QString GetWebServerSSLCertThumbprintSHA1(); QString GetWebServerSSLCertThumbprintSHA256(); QString GetWebServerSSLCertUsage(); int GetWebServerSSLCertUsageFlags(); QString GetWebServerSSLCertVersion(); QString GetWebServerSSLCertSubject();
int SetWebServerSSLCertSubject(QString qsWebServerSSLCertSubject); QByteArray GetWebServerSSLCertEncoded();
int SetWebServerSSLCertEncoded(QByteArray qbaWebServerSSLCertEncoded);
Remarks
This property specifies the certificate with the private key to use when the embedded web server is used. This setting is applicable only when WebServerSSLEnabled is set to True.
Data Type
WebServerSSLEnabled Property (OpenID Class)
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_openid_getwebserversslenabled(void* lpObj);
int ipworksauth_openid_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 (OpenID 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_openid_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 (OpenID Class)
Adds a name-value pair to the query string parameters of the outgoing request.
Syntax
ANSI (Cross Platform) int AddParam(const char* lpszParamName, const char* lpszParamValue); Unicode (Windows) INT AddParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue);
int ipworksauth_openid_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 (OpenID Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksauth_openid_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 (OpenID Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworksauth_openid_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 (OpenID Class)
Gets the authorization string required to access the protected resource.
Syntax
ANSI (Cross Platform) char* GetAuthorization(); Unicode (Windows) LPWSTR GetAuthorization();
char* ipworksauth_openid_getauthorization(void* lpObj);
QString GetAuthorization();
Remarks
GetAuthorization performs several operations automatically depending on the value of ClientProfile. Please see the introduction section for the OpenID class for a detailed overview of the typical scenarios.
After authorization is complete, UserDetails will be populated with the claims parsed from the ID Token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the AuthorizationScope property. If access to another resource was requested, then the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).
GetUserInfo may be called after calling this method.
The following properties are applicable when calling this method:
- ClientId (required)
- ClientSecret (required)
- ServerAuthURL (required - populated by GetDiscoveryDoc.)
- ServerTokenURL (required - populated by GetDiscoveryDoc.)
- SignerCertURL (conditional - populated by GetDiscoveryDoc. Required if SignerCert is not set.)
- SignerCert (conditional - required if SignerCertURL is not set.)
- AuthorizationScope
- ClientProfile
- GrantType
- Params
- RefreshToken
- ReturnURL
- State
- Timeout
- Display
- Prompt
- IDTokenHint
- LoginHint
- ResponseType
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 (OpenID Class)
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_openid_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.
GetDiscoveryDoc Method (OpenID Class)
Gets the OpenID Discovery Document.
Syntax
ANSI (Cross Platform) int GetDiscoveryDoc(const char* lpszURL); Unicode (Windows) INT GetDiscoveryDoc(LPCWSTR lpszURL);
int ipworksauth_openid_getdiscoverydoc(void* lpObj, const char* lpszURL);
int GetDiscoveryDoc(const QString& qsURL);
Remarks
This method gets the OpenID Connect Discovery Document specified by the URL parameter and parses the response. The discover document contains details about the OpenID Provider configuration including endpoint URLs, supported claims and response types, and more.
The discovery document URL is typically published by an OpenID Provider (OP) and must be known before calling this method. The format of the URL is standardized and typically takes the form:
https://www.youropenidserver.com/.well-known/openid-configuration
Call GetDiscoveryDoc before calling GetAuthorization to populate the class properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method the following properties are populated:
The above values may be stored, and later populated from the stored values, to avoid the requirement of calling GetDiscoveryDoc on subsequent authorization requests.
The following discovery document fields are populated after GetDiscoveryDoc returns:
- AuthorizationURL
- ClaimsParamSupported
- Issuer
- SignerCertURL
- RegistrationURL
- ServiceDocsURL
- SupportedClaims
- SupportedDisplays
- SupportedGrantTypes
- SupportedResponseTypes
- SupportedScopes
- TokenURL
- UserInfoURL
To access values not automatically parsed by the class the XPath configuration setting may be set to retrieve a specific value. Alternatively the RawJSON setting returns the entire JSON document which may be parsed separately.
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.)
GetParam Method (OpenID Class)
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_openid_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.
GetUserInfo Method (OpenID Class)
Retrieves claims about the user.
Syntax
ANSI (Cross Platform) int GetUserInfo(); Unicode (Windows) INT GetUserInfo();
int ipworksauth_openid_getuserinfo(void* lpObj);
int GetUserInfo();
Remarks
This method retrieves claims about the user. Before calling the GetUserInfo method, a successful call to GetAuthorization must be made. The access token returned by GetAuthorization is used by the OpenID provider at ServerUserInfoURL to identify the user for which claims are being retrieved.
When this method is called the class requests the claims about the user from the ServerUserInfoURL. The resulting claims are available in the UserDetails property.
Note: The GetUserInfo method will populate the UserDetails property with the claims returned in the ID Token during the authorization process. This method may not need to be called in order to access the desired claims about the user.
openid.GetUserInfo();
// ... use the user info in the remainder of 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.)
Interrupt Method (OpenID Class)
This method interrupts the current method.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int ipworksauth_openid_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 (OpenID Class)
This method will reset the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksauth_openid_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 (OpenID Class)
Starts the embedded web server.
Syntax
ANSI (Cross Platform) int StartWebServer(); Unicode (Windows) INT StartWebServer();
int ipworksauth_openid_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 (OpenID Class)
Stops the embedded web server.
Syntax
ANSI (Cross Platform) int StopWebServer(); Unicode (Windows) INT StopWebServer();
int ipworksauth_openid_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 (OpenID Class)
This event is fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(OpenIDConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } OpenIDConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(OpenIDConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } OpenIDConnectedEventParams;
#define EID_OPENID_CONNECTED 1 virtual INT IPWORKSAUTH_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);
class OpenIDConnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connected(OpenIDConnectedEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireConnected(OpenIDConnectedEventParams *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 (OpenID Class)
This event is fired to indicate changes in the connection state.
Syntax
ANSI (Cross Platform) virtual int FireConnectionStatus(OpenIDConnectionStatusEventParams *e);
typedef struct {
const char *ConnectionEvent;
int StatusCode;
const char *Description; int reserved; } OpenIDConnectionStatusEventParams;
Unicode (Windows) virtual INT FireConnectionStatus(OpenIDConnectionStatusEventParams *e);
typedef struct {
LPCWSTR ConnectionEvent;
INT StatusCode;
LPCWSTR Description; INT reserved; } OpenIDConnectionStatusEventParams;
#define EID_OPENID_CONNECTIONSTATUS 2 virtual INT IPWORKSAUTH_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);
class OpenIDConnectionStatusEventParams { 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(OpenIDConnectionStatusEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireConnectionStatus(OpenIDConnectionStatusEventParams *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. |
Disconnected Event (OpenID Class)
This event is fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(OpenIDDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } OpenIDDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(OpenIDDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } OpenIDDisconnectedEventParams;
#define EID_OPENID_DISCONNECTED 3 virtual INT IPWORKSAUTH_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);
class OpenIDDisconnectedEventParams { public: int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnected(OpenIDDisconnectedEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireDisconnected(OpenIDDisconnectedEventParams *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 (OpenID Class)
This event is fired when a document finishes transferring.
Syntax
ANSI (Cross Platform) virtual int FireEndTransfer(OpenIDEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } OpenIDEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(OpenIDEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } OpenIDEndTransferEventParams;
#define EID_OPENID_ENDTRANSFER 4 virtual INT IPWORKSAUTH_CALL FireEndTransfer(INT &iDirection);
class OpenIDEndTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EndTransfer(OpenIDEndTransferEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireEndTransfer(OpenIDEndTransferEventParams *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 (OpenID Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(OpenIDErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } OpenIDErrorEventParams;
Unicode (Windows) virtual INT FireError(OpenIDErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } OpenIDErrorEventParams;
#define EID_OPENID_ERROR 5 virtual INT IPWORKSAUTH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class OpenIDErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(OpenIDErrorEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireError(OpenIDErrorEventParams *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 (OpenID Class)
This event is fired every time a header line comes in.
Syntax
ANSI (Cross Platform) virtual int FireHeader(OpenIDHeaderEventParams *e);
typedef struct {
const char *Field;
const char *Value; int reserved; } OpenIDHeaderEventParams;
Unicode (Windows) virtual INT FireHeader(OpenIDHeaderEventParams *e);
typedef struct {
LPCWSTR Field;
LPCWSTR Value; INT reserved; } OpenIDHeaderEventParams;
#define EID_OPENID_HEADER 6 virtual INT IPWORKSAUTH_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);
class OpenIDHeaderEventParams { 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(OpenIDHeaderEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireHeader(OpenIDHeaderEventParams *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 (OpenID Class)
Fires before launching a browser with the authorization URL.
Syntax
ANSI (Cross Platform) virtual int FireLaunchBrowser(OpenIDLaunchBrowserEventParams *e);
typedef struct {
char *URL;
char *Command; int reserved; } OpenIDLaunchBrowserEventParams;
Unicode (Windows) virtual INT FireLaunchBrowser(OpenIDLaunchBrowserEventParams *e);
typedef struct {
LPWSTR URL;
LPWSTR Command; INT reserved; } OpenIDLaunchBrowserEventParams;
#define EID_OPENID_LAUNCHBROWSER 7 virtual INT IPWORKSAUTH_CALL FireLaunchBrowser(LPSTR &lpszURL, LPSTR &lpszCommand);
class OpenIDLaunchBrowserEventParams { 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(OpenIDLaunchBrowserEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireLaunchBrowser(OpenIDLaunchBrowserEventParams *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
Log Event (OpenID Class)
This event fires once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(OpenIDLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } OpenIDLogEventParams;
Unicode (Windows) virtual INT FireLog(OpenIDLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } OpenIDLogEventParams;
#define EID_OPENID_LOG 8 virtual INT IPWORKSAUTH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class OpenIDLogEventParams { 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(OpenIDLogEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireLog(OpenIDLogEventParams *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 (OpenID Class)
This event is fired when a redirection is received from the server.
Syntax
ANSI (Cross Platform) virtual int FireRedirect(OpenIDRedirectEventParams *e);
typedef struct {
const char *Location;
int Accept; int reserved; } OpenIDRedirectEventParams;
Unicode (Windows) virtual INT FireRedirect(OpenIDRedirectEventParams *e);
typedef struct {
LPCWSTR Location;
BOOL Accept; INT reserved; } OpenIDRedirectEventParams;
#define EID_OPENID_REDIRECT 9 virtual INT IPWORKSAUTH_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);
class OpenIDRedirectEventParams { 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(OpenIDRedirectEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireRedirect(OpenIDRedirectEventParams *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 (OpenID Class)
Fired when the user is redirected to the embedded web server.
Syntax
ANSI (Cross Platform) virtual int FireReturnURL(OpenIDReturnURLEventParams *e);
typedef struct {
const char *URLPath;
const char *QueryString;
const char *State;
char *ResponseHeaders;
char *ResponseBody; int reserved; } OpenIDReturnURLEventParams;
Unicode (Windows) virtual INT FireReturnURL(OpenIDReturnURLEventParams *e);
typedef struct {
LPCWSTR URLPath;
LPCWSTR QueryString;
LPCWSTR State;
LPWSTR ResponseHeaders;
LPWSTR ResponseBody; INT reserved; } OpenIDReturnURLEventParams;
#define EID_OPENID_RETURNURL 10 virtual INT IPWORKSAUTH_CALL FireReturnURL(LPSTR &lpszURLPath, LPSTR &lpszQueryString, LPSTR &lpszState, LPSTR &lpszResponseHeaders, LPSTR &lpszResponseBody);
class OpenIDReturnURLEventParams { public: const QString &URLPath(); const QString &QueryString(); const QString &State(); 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(OpenIDReturnURLEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireReturnURL(OpenIDReturnURLEventParams *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 authorization server back to the local embedded web server. The event provides an opportunity to set the ResponseHeaders and ResponseBody and 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.
State holds the value of the state parameter that was originally sent with the authorization request. This may be used to maintain state between the request and response. See State for more details.
SetCookie Event (OpenID Class)
This event is fired for every cookie set by the server.
Syntax
ANSI (Cross Platform) virtual int FireSetCookie(OpenIDSetCookieEventParams *e);
typedef struct {
const char *Name;
const char *Value;
const char *Expires;
const char *Domain;
const char *Path;
int Secure; int reserved; } OpenIDSetCookieEventParams;
Unicode (Windows) virtual INT FireSetCookie(OpenIDSetCookieEventParams *e);
typedef struct {
LPCWSTR Name;
LPCWSTR Value;
LPCWSTR Expires;
LPCWSTR Domain;
LPCWSTR Path;
BOOL Secure; INT reserved; } OpenIDSetCookieEventParams;
#define EID_OPENID_SETCOOKIE 11 virtual INT IPWORKSAUTH_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);
class OpenIDSetCookieEventParams { 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(OpenIDSetCookieEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireSetCookie(OpenIDSetCookieEventParams *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 (OpenID Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(OpenIDSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } OpenIDSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(OpenIDSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } OpenIDSSLServerAuthenticationEventParams;
#define EID_OPENID_SSLSERVERAUTHENTICATION 12 virtual INT IPWORKSAUTH_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class OpenIDSSLServerAuthenticationEventParams { 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(OpenIDSSLServerAuthenticationEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireSSLServerAuthentication(OpenIDSSLServerAuthenticationEventParams *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 (OpenID Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(OpenIDSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } OpenIDSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(OpenIDSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } OpenIDSSLStatusEventParams;
#define EID_OPENID_SSLSTATUS 13 virtual INT IPWORKSAUTH_CALL FireSSLStatus(LPSTR &lpszMessage);
class OpenIDSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(OpenIDSSLStatusEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireSSLStatus(OpenIDSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (OpenID Class)
This event is fired when a document starts transferring (after the headers).
Syntax
ANSI (Cross Platform) virtual int FireStartTransfer(OpenIDStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } OpenIDStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(OpenIDStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } OpenIDStartTransferEventParams;
#define EID_OPENID_STARTTRANSFER 14 virtual INT IPWORKSAUTH_CALL FireStartTransfer(INT &iDirection);
class OpenIDStartTransferEventParams { public: int Direction(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void StartTransfer(OpenIDStartTransferEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireStartTransfer(OpenIDStartTransferEventParams *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 (OpenID Class)
This event is fired when the HTTP status line is received from the server.
Syntax
ANSI (Cross Platform) virtual int FireStatus(OpenIDStatusEventParams *e);
typedef struct {
const char *HTTPVersion;
int StatusCode;
const char *Description; int reserved; } OpenIDStatusEventParams;
Unicode (Windows) virtual INT FireStatus(OpenIDStatusEventParams *e);
typedef struct {
LPCWSTR HTTPVersion;
INT StatusCode;
LPCWSTR Description; INT reserved; } OpenIDStatusEventParams;
#define EID_OPENID_STATUS 15 virtual INT IPWORKSAUTH_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);
class OpenIDStatusEventParams { 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(OpenIDStatusEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireStatus(OpenIDStatusEventParams *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 (OpenID Class)
This event is fired while a document transfers (delivers document).
Syntax
ANSI (Cross Platform) virtual int FireTransfer(OpenIDTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText; int reserved; } OpenIDTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(OpenIDTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText; INT reserved; } OpenIDTransferEventParams;
#define EID_OPENID_TRANSFER 16 virtual INT IPWORKSAUTH_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);
class OpenIDTransferEventParams { 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(OpenIDTransferEventParams *e);
// Or, subclass OpenID and override this emitter function. virtual int FireTransfer(OpenIDTransferEventParams *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.
Certificate Type
This is the digital certificate being used.
Syntax
IPWorksAuthCertificate (declared in ipworksauth.h)
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
char* (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
char* (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
char* (read-only)
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
char* (read-only)
Default Value: ""
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
char* (read-only)
Default Value: ""
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
char* (read-only)
Default Value: ""
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
char* (read-only)
Default Value: ""
This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
PrivateKey
char* (read-only)
Default Value: ""
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
int (read-only)
Default Value: FALSE
This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
char* (read-only)
Default Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
char* (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
char* (read-only)
Default Value: ""
This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
char* (read-only)
Default Value: ""
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
char*
Default Value: "MY"
This is the name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
char*
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
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 field can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr 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 Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
char* (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
char* (read-only)
Default Value: ""
This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
char* (read-only)
Default Value: ""
This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
char* (read-only)
Default Value: ""
This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
char* (read-only)
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
char* (read-only)
Default Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
char*
Default Value: ""
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 field 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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
char*
Default Value: ""
This is the certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
Certificate()
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
Certificate(const char* lpEncoded, int lenEncoded)
Parses Encoded as an X.509 public key.
Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
DiscoveryDocDetails Type
Details about the OpenID provider's discovery document.
Syntax
IPWorksAuthDiscoveryDocDetails (declared in ipworksauth.h)
Remarks
The fields of this type correspond to metadata details from an OpenID provider's discovery document.
Fields
AuthorizationURL
char* (read-only)
Default Value: ""
This field holds the server authorization endpoint URL.
This setting corresponds to the authorization_endpoint parameter in the discovery document.
ClaimsParamSupported
int (read-only)
Default Value: FALSE
This field indicates whether the claims request parameter is supported by the Open ID provider.
This setting corresponds to the claims_parameter_supported parameter in the discovery document.
Content
char* (read-only)
Default Value: ""
This field contains the raw discovery document JSON.
Issuer
char* (read-only)
Default Value: ""
This field holds the issuer identifier of the OpenID provider. This value is the same as the iss claim returned in ID Tokens issued from this provider. The value is a URL with the https scheme with no query string or fragment component.
This setting corresponds to the issuer parameter in the discovery document.
LogoutURL
char* (read-only)
Default Value: ""
This field holds the logout endpoint URL.
This setting corresponds to the optional end_session_endpoint parameter that may be found in the discovery document. If a user is directed to this URL, they will be asked to log out of their account.
RegistrationURL
char* (read-only)
Default Value: ""
This field holds the dynamic client registration URL.
This setting corresponds to the registration_endpoint parameter in the discovery document.
ServiceDocsURL
char* (read-only)
Default Value: ""
This field contains the URL of the human-readable service documentation. The information at this URL is intended for developers integrating with the OpenID provider and may contain useful information.
This setting corresponds to the service_documentation parameter in the discovery document.
SignerCertURL
char* (read-only)
Default Value: ""
This field holds the URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. The signer keys are automatically retrieved by the class when the ID Token signature verification is performed.
This setting corresponds to the jwks_uri parameter in the discovery document.
SupportedClaims
char* (read-only)
Default Value: ""
This field holds a comma separated list of claims that are supported by the OpenID provider. For instance: aud,email,email_verified,exp,family_name,given_name,iat,iss,locale,name,picture,sub
This setting corresponds to the claims_supported parameter in the discovery document.
SupportedDisplays
char* (read-only)
Default Value: ""
This field holds a comma separated list of display values that are supported by the OpenID provider.
This setting corresponds to the display_values_supported parameter in the discovery document.
SupportedGrantTypes
char* (read-only)
Default Value: ""
This field holds a comma separated list of grant types supported by the OpenID provider. If this value is not specified by the OpenID provider it is specified that authorization_code and implicit are supported by the OpenID provider.
This setting corresponds to the grant_types_supported parameter in the discovery document.
SupportedResponseTypes
char* (read-only)
Default Value: ""
This field hold a comma separated list of response types supported by the OpenID provider. If this value is not specified by the OpenID provider it is defined that the OpenID provider supports (at a minimum) code, id_token, and token id_token values.
This setting corresponds to the response_types_supported parameter in the discovery document.
SupportedScopes
char* (read-only)
Default Value: ""
This field hold a comma separated list of scopes that are supported by the OpenID provider. For instance: openid,email,profile
This setting corresponds to the scopes_supported parameter in the discovery document.
TokenURL
char* (read-only)
Default Value: ""
This field holds the token endpoint URL.
This setting corresponds to the token_endpoint parameter in the discovery document.
UserInfoURL
char* (read-only)
Default Value: ""
This field holds the user info endpoint URL.
This setting corresponds to the userinfo_endpoint parameter in the discovery document.
Constructors
DiscoveryDocDetails()
Firewall Type
The firewall the component will connect through.
Syntax
IPWorksAuthFirewall (declared in ipworksauth.h)
Remarks
When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.
Fields
AutoDetect
int
Default Value: FALSE
This field tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType
int
Default Value: 0
This field 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. Port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. Port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. Port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. Port is set to 1080. |
Host
char*
Default Value: ""
This field contains the name or IP address of the firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.
If this field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this field is set to the corresponding address. If the search is not successful, the class fails with an error.
Password
char*
Default Value: ""
This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Port
int
Default Value: 0
This field contains the Transmission Control Protocol (TCP) port for the firewall Host. See the description of the Host field for details.
Note: This field is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.
User
char*
Default Value: ""
This field contains a username if authentication is to be used when connecting through a firewall. If Host is specified, this field and the Password field are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.
Constructors
Firewall()
HTTPCookie Type
An HTTP cookie can be either sent to or received from the server.
Syntax
IPWorksAuthHTTPCookie (declared in ipworksauth.h)
Remarks
An HTTP cookie can store the cookies that are to be sent to the server. It also may store the cookies sent by the server.
Cookies that are to be sent to the server must have the Name and Value fields supplied before submitting the URL. When the SetCookie event is fired, however, all of the fields of an HTTPCookie are filled out accordingly.
Fields
Domain
char* (read-only)
Default Value: ""
This is the domain of a received cookie. This field contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this field will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.
Expiration
char* (read-only)
Default Value: ""
This field 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 field will contain an empty string. The convention is to drop the cookie at the end of the session.
Name
char*
Default Value: ""
This field, contains the name of the cookie.
This field, along with Value, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.
Path
char* (read-only)
Default Value: ""
This field 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 field will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.
Secure
int (read-only)
Default Value: FALSE
This field contains the security flag of the received cookie. This field specifies whether the cookie is secure. If the value of this field is True, the cookie value must be submitted only through a secure (HTTPS) connection.
Value
char*
Default Value: ""
This field contains the value of the cookie. A corresponding value is associated with the cookie specified by Name. This property holds that value.
The SetCookie event provides the cookies set by the server.
Constructors
HTTPCookie()
HTTPCookie(const char* lpszName, const char* lpszValue)
IdTokenInfo Type
This type holds details about an ID Token.
Syntax
IPWorksAuthIdTokenInfo (declared in ipworksauth.h)
Remarks
The fields of this type correspond to claims from the ID Token.
Fields
Audiences
char* (read-only)
Default Value: ""
This field contains a comma separated list of audiences for which the ID Token is intended.
AuthTime
int64 (read-only)
Default Value: 0
This field holds the time when the end user authenticates with the authorization server.
The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
ExpTime
int64
Default Value: 0
This field holds the time when the ID Token expires.
The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
IdTokenContent
char*
Default Value: ""
This field holds the raw value of the ID Token.
IssuedTime
int64
Default Value: 0
This field holds the time when the authentication for this ID Token occurred.
The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
Issuer
char*
Default Value: ""
This field contains the issuer, or authorization server, that constructed the ID Token.
Constructors
IdTokenInfo()
OAuthParam Type
This is the parameter to be used in the request or received in the response.
Syntax
IPWorksAuthOAuthParam (declared in ipworksauth.h)
Remarks
This type describes a parameter that is used in a request or received in the response.
Fields
Name
char*
Default Value: ""
This field contains the name of the parameter to be used in the request or returned in the response.
Value
char*
Default Value: ""
This field 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.
Constructors
OAuthParam()
OAuthParam(const char* lpszName, const char* lpszValue)
Proxy Type
The proxy the component will connect to.
Syntax
IPWorksAuthProxy (declared in ipworksauth.h)
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
int
Default Value: 0
This field is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this field will clear the values of User and Password.
AutoDetect
int
Default Value: FALSE
This field tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Password
char*
Default Value: ""
This field contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Port
int
Default Value: 80
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
char*
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.
SSL
int
Default Value: 0
This field 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. |
User
char*
Default Value: ""
This field contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Constructors
Proxy()
Proxy(const char* lpszServer, int iPort)
Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)
UserDetails Type
This type holds details about the user.
Syntax
IPWorksAuthUserDetails (declared in ipworksauth.h)
Remarks
The fields of this type correspond to claims about the user.
Fields
AddrCountry
char* (read-only)
Default Value: ""
This field holds the country name portion of the user's address.
AddrFormatted
char* (read-only)
Default Value: ""
This field holds the full mailing address of the user, formatted for display or use on a mailing label. This value may contain multiple lines.
AddrLocality
char* (read-only)
Default Value: ""
This field holds the city or locality portion of the user's address.
AddrPostalCode
char* (read-only)
Default Value: ""
This field holds the zip code or postal code portion of the user's address.
AddrRegion
char* (read-only)
Default Value: ""
This field holds the state, province, prefecture, or region portion of the user's address.
AddrStreetAddr
char* (read-only)
Default Value: ""
This field holds the street address portion of the user's address. This is the full street address which may include house number, street name, post office box, and multi-line extended street information. This value may contain multiple lines.
Birthday
char* (read-only)
Default Value: ""
This field contains the user's birthday. The format of the value is YYYY-MM-DD or YYYY. The year may be 0000 to indicate it was omitted.
Email
char* (read-only)
Default Value: ""
This field contains the user's preferred email address.
EmailVerified
int (read-only)
Default Value: FALSE
This field indicates whether the user's email address has been verified. To be considered verified the end-user must prove the email address was under the user's control at the time of verification.
FirstName
char* (read-only)
Default Value: ""
This field holds the first name of the user. If multiple names are present they are space separated.
Gender
char* (read-only)
Default Value: ""
This field holds the user's gender. Defined values are male and female but other values may also be used.
LastName
char* (read-only)
Default Value: ""
This field holds the last name of the user. If multiple names are present they are space separated.
Locale
char* (read-only)
Default Value: ""
This field holds the end user's locale. This is represented as a BCP47 (RFC 5646) language tag. For instance en-US or en_US.
MiddleName
char* (read-only)
Default Value: ""
This field holds the middle name of the user. If multiple names are present they are space separated.
Name
char* (read-only)
Default Value: ""
This field contains the user's full name in displayable form including all name parts. This may include titles and suffixes.
Nickname
char* (read-only)
Default Value: ""
This field holds the casual name of the user. This may or may not be the same as FirstName.
PhoneNumber
char* (read-only)
Default Value: ""
This field holds the user's phone number. This may be in E.164 format, for instance +1 (425) 555-1212. If an extension is present it may be represented according to RFC 3966. For instance: +1 (604) 555-1234;ext=5678.
PhoneNumberVerified
int (read-only)
Default Value: FALSE
This field indicates whether the user's phone number has been verified. To be considered verified the end-user must prove the phone number was under the user's control at the time of verification.
PictureURL
char* (read-only)
Default Value: ""
This field holds the URL of the user's profile picture.
PreferredUsername
char* (read-only)
Default Value: ""
This field holds the shorthand name by which the end-user wishes to be referred.
ProfileURL
char* (read-only)
Default Value: ""
This field holds the URL of the user's profile page.
Subject
char* (read-only)
Default Value: ""
This field contains the subject of the user that is being represented. This field is set when parsed from an ID Token or after retrieving the user info. Typically this represents the user of the application.
UpdatedAt
int64 (read-only)
Default Value: 0
This field holds the time when the user's information was last updated.
The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
Website
char* (read-only)
Default Value: ""
This field holds the URL of the user's website.
ZoneInfo
char* (read-only)
Default Value: ""
This field holds the user's time zone. For instance: America/Los_Angeles.
Constructors
UserDetails()
IPWorksAuthList Type
Syntax
IPWorksAuthList<T> (declared in ipworksauth.h)
Remarks
IPWorksAuthList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the OpenID class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (OpenID 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.OpenID Config Settings
page | The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. |
popup | The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. |
touch | The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. |
wap | The Authorization Server SHOULD display the authentication and consent UI consistent with a "feature phone" type display. |
The value for this setting is the raw IDToken received from a previous authorization.
This setting corresponds to the login_hint request parameter.
none | The Authorization Server MUST NOT display any authentication or consent user interface pages. An error is returned if an End-User is not already authenticated or the Client does not have pre-configured consent for the requested Claims or does not fulfill other conditions for processing the request. The error code will typically be login_required, interaction_required, or another code defined in Section 3.1.2.6 of the OpenID specification. This can be used as a method to check for existing authentication and/or consent. |
login | The Authorization Server SHOULD prompt the End-User for reauthentication. If it cannot reauthenticate the End-User, it MUST return an error, typically login_required. |
consent | The Authorization Server SHOULD prompt the End-User for consent before returning information to the Client. If it cannot obtain consent, it MUST return an error, typically consent_required. |
select_account | The Authorization Server SHOULD prompt the End-User to select a user account. This enables an End-User who has multiple accounts at the Authorization Server to select amongst the multiple accounts that they might have current sessions for. If it cannot obtain an account selection choice made by the End-User, it MUST return an error, typically account_selection_required. |
The prompt parameter can be used to make sure that the End-User is still present for the current session or to bring attention to the request. If this parameter contains none with any other value, an error is returned.
After GetDiscoveryDoc is called this method returns the entire discovery document JSON.
After GetAuthorization is called this method returns the ID Token JSON.
After GetUserInfo is called this method returns the response JSON.
GrantType | Default value | Possible values |
0 (Authorization Code) | code |
|
1 (Implicit) | id_token token |
|
2 (Hybrid) | code id_token |
|
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.
XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example, /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.
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. |
name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair.
Supports single and double quotes. (XML Only) |
. | The current element. |
.. | The parent element. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
Description | XML XPath | JSON XPath |
Document root | / | /json |
Specific element | /firstlevel/one | /json/firstlevel/one |
i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] |
This list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
OAuth Config Settings
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. |
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
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.
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Note: This is required when ClientProfile is set to ocpJWT.
Note: This is applicable only when ClientProfile is set to ocpJWT.
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. |
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Note: This is required when ClientProfile is set to ocpJWT.
To parse the payload for specific claims, see JWTXPath.
- 0 (Google - Default)
- 1 (Microsoft)
- RSA-SHA256
Note: This is applicable only when ClientProfile is set to ocpJWT.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only.
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. |
Description | JSON XPath |
Document root | /json |
Specific element | /json/element_one |
Username Claim (Microsoft Specific) | /json/preferred_username |
Registered Application Name Claim (Microsoft Specific) | /json/app_displayname |
This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see JWTXText.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only.
The current element is specified in the JWTXPath configuration setting. This configuration setting is read-only.
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");
- 1 (Plain)
- 2 (S256/SHA256 - default)
The default value is "localhost".
HTTP Config Settings
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.
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.
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]".
The default value is False.
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
- "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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
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).
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.
.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"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
Note: This setting is applicable only to Mac/iOS editions.
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.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.
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.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server 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 multihomed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- 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.
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.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that 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 applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
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 (OpenID 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.
OpenID Errors
900 | Invalid discovery document. The data is not a properly formatted discovery document. |
901 | Invalid ID Token. The ID Token could not be parsed. |
902 | Invalid ResponseType specified. The supplied ResponseType was unrecognized. |
903 | ID Token verification failed. |
910 | ID Token verification failed. ID Token has expired. |
911 | ID Token verification failed. ID Token issuer does not match expected issuer. |
912 | ID Token verification failed. ID Token audience does not match the expected audience. |
913 | ID Token verification failed. ID Token is missing a required claim. |
914 | ID Token verification failed. ID Token is meant for future use. |
915 | ID Token verification failed. ID Token has an invalid issued time. |
920 | ID Token verification failed. Could not validate signature. |
921 | ID Token verification failed. Could not find a valid Signer Certificate. |
922 | ID Token verification failed. Could not find a Signer Certificate that matches ID Token Headers. |
923 | ID Token verification failed. Could not find signature. |
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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |