OAuth Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

OAuth

Remarks

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

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

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

The following client profiles are currently supported by the class:

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

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();

Custom Responses

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AccessToken Property (OAuth Class)

The access token returned by the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccessToken();
int SetAccessToken(const char* lpszAccessToken);

Unicode (Windows)
LPWSTR GetAccessToken();
INT SetAccessToken(LPCWSTR lpszAccessToken);

char* ipworksauth_oauth_getaccesstoken(void* lpObj);
int ipworksauth_oauth_setaccesstoken(void* lpObj, const char* lpszAccessToken);

QString GetAccessToken();
int SetAccessToken(QString qsAccessToken);

Default Value

""

Remarks

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

Data Type

String

AccessTokenExp Property (OAuth Class)

The lifetime of the access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAccessTokenExp();

Unicode (Windows)
INT GetAccessTokenExp();

int ipworksauth_oauth_getaccesstokenexp(void* lpObj);

int GetAccessTokenExp();

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

AuthorizationCode Property (OAuth Class)

The authorization code that is exchanged for an access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorizationCode();
int SetAuthorizationCode(const char* lpszAuthorizationCode);

Unicode (Windows)
LPWSTR GetAuthorizationCode();
INT SetAuthorizationCode(LPCWSTR lpszAuthorizationCode);

char* ipworksauth_oauth_getauthorizationcode(void* lpObj);
int ipworksauth_oauth_setauthorizationcode(void* lpObj, const char* lpszAuthorizationCode);

QString GetAuthorizationCode();
int SetAuthorizationCode(QString qsAuthorizationCode);

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

AuthorizationScope Property (OAuth Class)

The scope request or response parameter used during authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorizationScope();
int SetAuthorizationScope(const char* lpszAuthorizationScope);

Unicode (Windows)
LPWSTR GetAuthorizationScope();
INT SetAuthorizationScope(LPCWSTR lpszAuthorizationScope);

char* ipworksauth_oauth_getauthorizationscope(void* lpObj);
int ipworksauth_oauth_setauthorizationscope(void* lpObj, const char* lpszAuthorizationScope);

QString GetAuthorizationScope();
int SetAuthorizationScope(QString qsAuthorizationScope);

Default Value

""

Remarks

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

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

Data Type

String

ClientId Property (OAuth Class)

The Id of the client assigned when registering the application.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientId();
int SetClientId(const char* lpszClientId);

Unicode (Windows)
LPWSTR GetClientId();
INT SetClientId(LPCWSTR lpszClientId);

char* ipworksauth_oauth_getclientid(void* lpObj);
int ipworksauth_oauth_setclientid(void* lpObj, const char* lpszClientId);

QString GetClientId();
int SetClientId(QString qsClientId);

Default Value

""

Remarks

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

Data Type

String

ClientProfile Property (OAuth Class)

The type of client that is requesting authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientProfile();
int SetClientProfile(int iClientProfile);

Unicode (Windows)
INT GetClientProfile();
INT SetClientProfile(INT iClientProfile);

OCP_APPLICATION(0), 
OCP_WEB(1), 
OCP_DEVICE(2), 
OCP_MOBILE(3), 
OCP_JWT(4)

int ipworksauth_oauth_getclientprofile(void* lpObj);
int ipworksauth_oauth_setclientprofile(void* lpObj, int iClientProfile);

int GetClientProfile();
int SetClientProfile(int iClientProfile);

Default Value

0

Remarks

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

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientSecret();
int SetClientSecret(const char* lpszClientSecret);

Unicode (Windows)
LPWSTR GetClientSecret();
INT SetClientSecret(LPCWSTR lpszClientSecret);

char* ipworksauth_oauth_getclientsecret(void* lpObj);
int ipworksauth_oauth_setclientsecret(void* lpObj, const char* lpszClientSecret);

QString GetClientSecret();
int SetClientSecret(QString qsClientSecret);

Default Value

""

Remarks

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

Data Type

String

Connected Property (OAuth Class)

Whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksauth_oauth_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 (OAuth Class)

A collection of cookies.

Syntax

• C++
• C
• Qt

IPWorksAuthList<IPWorksAuthHTTPCookie>* GetCookies();
int SetCookies(IPWorksAuthList<IPWorksAuthHTTPCookie>* val);

int ipworksauth_oauth_getcookiecount(void* lpObj);
int ipworksauth_oauth_setcookiecount(void* lpObj, int iCookieCount);

char* ipworksauth_oauth_getcookiedomain(void* lpObj, int cookieindex);

char* ipworksauth_oauth_getcookieexpiration(void* lpObj, int cookieindex);

char* ipworksauth_oauth_getcookiename(void* lpObj, int cookieindex);
int ipworksauth_oauth_setcookiename(void* lpObj, int cookieindex, const char* lpszCookieName);

char* ipworksauth_oauth_getcookiepath(void* lpObj, int cookieindex);

int ipworksauth_oauth_getcookiesecure(void* lpObj, int cookieindex);

char* ipworksauth_oauth_getcookievalue(void* lpObj, int cookieindex);
int ipworksauth_oauth_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

IPWorksAuthHTTPCookie

Firewall Property (OAuth Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksAuthFirewall* GetFirewall();
int SetFirewall(IPWorksAuthFirewall* val);

int ipworksauth_oauth_getfirewallautodetect(void* lpObj);
int ipworksauth_oauth_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksauth_oauth_getfirewalltype(void* lpObj);
int ipworksauth_oauth_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksauth_oauth_getfirewallhost(void* lpObj);
int ipworksauth_oauth_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksauth_oauth_getfirewallpassword(void* lpObj);
int ipworksauth_oauth_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksauth_oauth_getfirewallport(void* lpObj);
int ipworksauth_oauth_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksauth_oauth_getfirewalluser(void* lpObj);
int ipworksauth_oauth_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

IPWorksAuthFirewall

FollowRedirects Property (OAuth Class)

Determines what happens when the server issues a redirect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Unicode (Windows)
INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

FR_NEVER(0), 
FR_ALWAYS(1), 
FR_SAME_SCHEME(2)

int ipworksauth_oauth_getfollowredirects(void* lpObj);
int ipworksauth_oauth_setfollowredirects(void* lpObj, int iFollowRedirects);

int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Default Value

0

Remarks

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

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class fails with an error.

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

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

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

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

Data Type

Integer

GrantType Property (OAuth Class)

The OAuth grant type used to acquire an OAuth access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGrantType();
int SetGrantType(int iGrantType);

Unicode (Windows)
INT GetGrantType();
INT SetGrantType(INT iGrantType);

OGT_AUTHORIZATION_CODE(0), 
OGT_IMPLICIT(1), 
OGT_PASSWORD(2), 
OGT_CLIENT_CREDENTIALS(3), 
OGT_ADMIN_CONSENT(4)

int ipworksauth_oauth_getgranttype(void* lpObj);
int ipworksauth_oauth_setgranttype(void* lpObj, int iGrantType);

int GetGrantType();
int SetGrantType(int iGrantType);

Default Value

0

Remarks

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

For all grant types listed set ClientProfile to Application.

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

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

• ClientId
• ClientSecret
• ServerAuthURL

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

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

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

• ClientId
• ClientSecret
• ServerTokenURL

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

• ClientId

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

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

Data Type

Integer

Idle Property (OAuth Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int ipworksauth_oauth_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

LocalHost Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksauth_oauth_getlocalhost(void* lpObj);
int ipworksauth_oauth_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server 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 (OAuth Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* ipworksauth_oauth_getotherheaders(void* lpObj);
int ipworksauth_oauth_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

Params Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

IPWorksAuthList<IPWorksAuthOAuthParam>* GetParams();
int SetParams(IPWorksAuthList<IPWorksAuthOAuthParam>* val);

int ipworksauth_oauth_getparamcount(void* lpObj);
int ipworksauth_oauth_setparamcount(void* lpObj, int iParamCount);

char* ipworksauth_oauth_getparamname(void* lpObj, int paramindex);
int ipworksauth_oauth_setparamname(void* lpObj, int paramindex, const char* lpszParamName);

char* ipworksauth_oauth_getparamvalue(void* lpObj, int paramindex);
int ipworksauth_oauth_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 property is a collection of query string parameters to be added in the request when creating the authorization URL. This will also hold the parameters returned in the response.

This property is not available at design time.

Data Type

IPWorksAuthOAuthParam

Proxy Property (OAuth Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

IPWorksAuthProxy* GetProxy();
int SetProxy(IPWorksAuthProxy* val);

int ipworksauth_oauth_getproxyauthscheme(void* lpObj);
int ipworksauth_oauth_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int ipworksauth_oauth_getproxyautodetect(void* lpObj);
int ipworksauth_oauth_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* ipworksauth_oauth_getproxypassword(void* lpObj);
int ipworksauth_oauth_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int ipworksauth_oauth_getproxyport(void* lpObj);
int ipworksauth_oauth_setproxyport(void* lpObj, int iProxyPort);

char* ipworksauth_oauth_getproxyserver(void* lpObj);
int ipworksauth_oauth_setproxyserver(void* lpObj, const char* lpszProxyServer);

int ipworksauth_oauth_getproxyssl(void* lpObj);
int ipworksauth_oauth_setproxyssl(void* lpObj, int iProxySSL);

char* ipworksauth_oauth_getproxyuser(void* lpObj);
int ipworksauth_oauth_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

IPWorksAuthProxy

RefreshToken Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRefreshToken();
int SetRefreshToken(const char* lpszRefreshToken);

Unicode (Windows)
LPWSTR GetRefreshToken();
INT SetRefreshToken(LPCWSTR lpszRefreshToken);

char* ipworksauth_oauth_getrefreshtoken(void* lpObj);
int ipworksauth_oauth_setrefreshtoken(void* lpObj, const char* lpszRefreshToken);

QString GetRefreshToken();
int SetRefreshToken(QString qsRefreshToken);

Default Value

""

Remarks

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

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

Data Type

String

ReturnURL Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReturnURL();
int SetReturnURL(const char* lpszReturnURL);

Unicode (Windows)
LPWSTR GetReturnURL();
INT SetReturnURL(LPCWSTR lpszReturnURL);

char* ipworksauth_oauth_getreturnurl(void* lpObj);
int ipworksauth_oauth_setreturnurl(void* lpObj, const char* lpszReturnURL);

QString GetReturnURL();
int SetReturnURL(QString qsReturnURL);

Default Value

""

Remarks

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

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

This property corresponds to the redirect_uri query string parameter.

Data Type

String

ServerAuthURL Property (OAuth Class)

The URL of the authorization server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerAuthURL();
int SetServerAuthURL(const char* lpszServerAuthURL);

Unicode (Windows)
LPWSTR GetServerAuthURL();
INT SetServerAuthURL(LPCWSTR lpszServerAuthURL);

char* ipworksauth_oauth_getserverauthurl(void* lpObj);
int ipworksauth_oauth_setserverauthurl(void* lpObj, const char* lpszServerAuthURL);

QString GetServerAuthURL();
int SetServerAuthURL(QString qsServerAuthURL);

Default Value

""

Remarks

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

This should be specified before calling GetAuthorization.

Data Type

String

ServerTokenURL Property (OAuth Class)

The URL used to obtain the access token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerTokenURL();
int SetServerTokenURL(const char* lpszServerTokenURL);

Unicode (Windows)
LPWSTR GetServerTokenURL();
INT SetServerTokenURL(LPCWSTR lpszServerTokenURL);

char* ipworksauth_oauth_getservertokenurl(void* lpObj);
int ipworksauth_oauth_setservertokenurl(void* lpObj, const char* lpszServerTokenURL);

QString GetServerTokenURL();
int SetServerTokenURL(QString qsServerTokenURL);

Default Value

""

Remarks

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

This must be set before calling GetAuthorization.

Data Type

String

SSLAcceptServerCert Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

IPWorksAuthCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksAuthCertificate* val);

char* ipworksauth_oauth_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertissuer(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertprivatekey(void* lpObj);

int ipworksauth_oauth_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertpublickey(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksauth_oauth_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksauth_oauth_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksauth_oauth_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksauth_oauth_getsslacceptservercertstorepassword(void* lpObj);
int ipworksauth_oauth_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksauth_oauth_getsslacceptservercertstoretype(void* lpObj);
int ipworksauth_oauth_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksauth_oauth_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertusage(void* lpObj);

int ipworksauth_oauth_getsslacceptservercertusageflags(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertversion(void* lpObj);

char* ipworksauth_oauth_getsslacceptservercertsubject(void* lpObj);
int ipworksauth_oauth_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksauth_oauth_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksauth_oauth_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

IPWorksAuthCertificate

SSLCert Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

IPWorksAuthCertificate* GetSSLCert();
int SetSSLCert(IPWorksAuthCertificate* val);

char* ipworksauth_oauth_getsslcerteffectivedate(void* lpObj);

char* ipworksauth_oauth_getsslcertexpirationdate(void* lpObj);

char* ipworksauth_oauth_getsslcertextendedkeyusage(void* lpObj);

char* ipworksauth_oauth_getsslcertfingerprint(void* lpObj);

char* ipworksauth_oauth_getsslcertfingerprintsha1(void* lpObj);

char* ipworksauth_oauth_getsslcertfingerprintsha256(void* lpObj);

char* ipworksauth_oauth_getsslcertissuer(void* lpObj);

char* ipworksauth_oauth_getsslcertprivatekey(void* lpObj);

int ipworksauth_oauth_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksauth_oauth_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksauth_oauth_getsslcertpublickey(void* lpObj);

char* ipworksauth_oauth_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksauth_oauth_getsslcertpublickeylength(void* lpObj);

char* ipworksauth_oauth_getsslcertserialnumber(void* lpObj);

char* ipworksauth_oauth_getsslcertsignaturealgorithm(void* lpObj);

int ipworksauth_oauth_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksauth_oauth_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksauth_oauth_getsslcertstorepassword(void* lpObj);
int ipworksauth_oauth_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksauth_oauth_getsslcertstoretype(void* lpObj);
int ipworksauth_oauth_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksauth_oauth_getsslcertsubjectaltnames(void* lpObj);

char* ipworksauth_oauth_getsslcertthumbprintmd5(void* lpObj);

char* ipworksauth_oauth_getsslcertthumbprintsha1(void* lpObj);

char* ipworksauth_oauth_getsslcertthumbprintsha256(void* lpObj);

char* ipworksauth_oauth_getsslcertusage(void* lpObj);

int ipworksauth_oauth_getsslcertusageflags(void* lpObj);

char* ipworksauth_oauth_getsslcertversion(void* lpObj);

char* ipworksauth_oauth_getsslcertsubject(void* lpObj);
int ipworksauth_oauth_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksauth_oauth_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksauth_oauth_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

IPWorksAuthCertificate

SSLProvider Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksauth_oauth_getsslprovider(void* lpObj);
int ipworksauth_oauth_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

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

Possible values are as follows:

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

When Automatic is selected, 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 (OAuth Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksAuthCertificate* GetSSLServerCert();

char* ipworksauth_oauth_getsslservercerteffectivedate(void* lpObj);

char* ipworksauth_oauth_getsslservercertexpirationdate(void* lpObj);

char* ipworksauth_oauth_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksauth_oauth_getsslservercertfingerprint(void* lpObj);

char* ipworksauth_oauth_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksauth_oauth_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksauth_oauth_getsslservercertissuer(void* lpObj);

char* ipworksauth_oauth_getsslservercertprivatekey(void* lpObj);

int ipworksauth_oauth_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksauth_oauth_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksauth_oauth_getsslservercertpublickey(void* lpObj);

char* ipworksauth_oauth_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksauth_oauth_getsslservercertpublickeylength(void* lpObj);

char* ipworksauth_oauth_getsslservercertserialnumber(void* lpObj);

char* ipworksauth_oauth_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksauth_oauth_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworksauth_oauth_getsslservercertstorepassword(void* lpObj);

int ipworksauth_oauth_getsslservercertstoretype(void* lpObj);

char* ipworksauth_oauth_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksauth_oauth_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksauth_oauth_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksauth_oauth_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksauth_oauth_getsslservercertusage(void* lpObj);

int ipworksauth_oauth_getsslservercertusageflags(void* lpObj);

char* ipworksauth_oauth_getsslservercertversion(void* lpObj);

char* ipworksauth_oauth_getsslservercertsubject(void* lpObj);

int ipworksauth_oauth_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

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksAuthCertificate

Timeout Property (OAuth Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksauth_oauth_gettimeout(void* lpObj);
int ipworksauth_oauth_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

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

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

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

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

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

The contents of the last response from the server.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetTransferredData(LPSTR &lpTransferredData, INT &lenTransferredData);

int ipworksauth_oauth_gettransferreddata(void* lpObj, char** lpTransferredData, int* lenTransferredData);

QByteArray GetTransferredData();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

TransferredHeaders Property (OAuth Class)

The full set of headers as received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransferredHeaders();

Unicode (Windows)
LPWSTR GetTransferredHeaders();

char* ipworksauth_oauth_gettransferredheaders(void* lpObj);

QString GetTransferredHeaders();

Default Value

""

Remarks

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

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

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

Data Type

String

UsePKCE Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUsePKCE();
int SetUsePKCE(int bUsePKCE);

Unicode (Windows)
BOOL GetUsePKCE();
INT SetUsePKCE(BOOL bUsePKCE);

int ipworksauth_oauth_getusepkce(void* lpObj);
int ipworksauth_oauth_setusepkce(void* lpObj, int bUsePKCE);

bool GetUsePKCE();
int SetUsePKCE(bool bUsePKCE);

Default Value

FALSE

Remarks

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

Data Type

Boolean

WebServerPort Property (OAuth Class)

The local port on which the embedded web server listens.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWebServerPort();
int SetWebServerPort(int iWebServerPort);

Unicode (Windows)
INT GetWebServerPort();
INT SetWebServerPort(INT iWebServerPort);

int ipworksauth_oauth_getwebserverport(void* lpObj);
int ipworksauth_oauth_setwebserverport(void* lpObj, int iWebServerPort);

int GetWebServerPort();
int SetWebServerPort(int iWebServerPort);

Default Value

0

Remarks

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

Data Type

Integer

WebServerSSLCert Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

IPWorksAuthCertificate* GetWebServerSSLCert();
int SetWebServerSSLCert(IPWorksAuthCertificate* val);

char* ipworksauth_oauth_getwebserversslcerteffectivedate(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertexpirationdate(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertextendedkeyusage(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertfingerprint(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertfingerprintsha1(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertfingerprintsha256(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertissuer(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertprivatekey(void* lpObj);

int ipworksauth_oauth_getwebserversslcertprivatekeyavailable(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertprivatekeycontainer(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertpublickey(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertpublickeyalgorithm(void* lpObj);

int ipworksauth_oauth_getwebserversslcertpublickeylength(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertserialnumber(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertsignaturealgorithm(void* lpObj);

int ipworksauth_oauth_getwebserversslcertstore(void* lpObj, char** lpWebServerSSLCertStore, int* lenWebServerSSLCertStore);
int ipworksauth_oauth_setwebserversslcertstore(void* lpObj, const char* lpWebServerSSLCertStore, int lenWebServerSSLCertStore);

char* ipworksauth_oauth_getwebserversslcertstorepassword(void* lpObj);
int ipworksauth_oauth_setwebserversslcertstorepassword(void* lpObj, const char* lpszWebServerSSLCertStorePassword);

int ipworksauth_oauth_getwebserversslcertstoretype(void* lpObj);
int ipworksauth_oauth_setwebserversslcertstoretype(void* lpObj, int iWebServerSSLCertStoreType);

char* ipworksauth_oauth_getwebserversslcertsubjectaltnames(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertthumbprintmd5(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertthumbprintsha1(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertthumbprintsha256(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertusage(void* lpObj);

int ipworksauth_oauth_getwebserversslcertusageflags(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertversion(void* lpObj);

char* ipworksauth_oauth_getwebserversslcertsubject(void* lpObj);
int ipworksauth_oauth_setwebserversslcertsubject(void* lpObj, const char* lpszWebServerSSLCertSubject);

int ipworksauth_oauth_getwebserversslcertencoded(void* lpObj, char** lpWebServerSSLCertEncoded, int* lenWebServerSSLCertEncoded);
int ipworksauth_oauth_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

IPWorksAuthCertificate

WebServerSSLEnabled Property (OAuth Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetWebServerSSLEnabled();
int SetWebServerSSLEnabled(int bWebServerSSLEnabled);

Unicode (Windows)
BOOL GetWebServerSSLEnabled();
INT SetWebServerSSLEnabled(BOOL bWebServerSSLEnabled);

int ipworksauth_oauth_getwebserversslenabled(void* lpObj);
int ipworksauth_oauth_setwebserversslenabled(void* lpObj, int bWebServerSSLEnabled);

bool GetWebServerSSLEnabled();
int SetWebServerSSLEnabled(bool bWebServerSSLEnabled);

Default Value

FALSE

Remarks

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

Data Type

Boolean

AddCookie Method (OAuth Class)

Adds a cookie and the corresponding value to the outgoing request headers.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT AddCookie(LPCWSTR lpszCookieName, LPCWSTR lpszCookieValue);

int ipworksauth_oauth_addcookie(void* lpObj, const char* lpszCookieName, const char* lpszCookieValue);

int AddCookie(const QString& qsCookieName, const QString& qsCookieValue);

Remarks

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

Error Handling (C++)

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

AddParam Method (OAuth Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT AddParam(LPCWSTR lpszParamName, LPCWSTR lpszParamValue);

int ipworksauth_oauth_addparam(void* lpObj, const char* lpszParamName, const char* lpszParamValue);

int AddParam(const QString& qsParamName, const QString& qsParamValue);

Remarks

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

Error Handling (C++)

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

Config Method (OAuth Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksauth_oauth_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

DoEvents Method (OAuth Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksauth_oauth_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

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

GetAuthorization Method (OAuth Class)

Gets the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();

Unicode (Windows)
LPWSTR GetAuthorization();

char* ipworksauth_oauth_getauthorization(void* lpObj);

QString GetAuthorization();

Remarks

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

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

The AccessToken property should be cleared before calling this method.

Error Handling (C++)

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

GetAuthorizationURL Method (OAuth Class)

Builds and returns the URL to which the user should be redirected for authorization.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorizationURL();

Unicode (Windows)
LPWSTR GetAuthorizationURL();

char* ipworksauth_oauth_getauthorizationurl(void* lpObj);

QString GetAuthorizationURL();

Remarks

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

• ClientId
• ClientSecret
• ReturnURL
• AuthorizationScope (optional)

Error Handling (C++)

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

GetParam Method (OAuth Class)

Gets a specific parameter from a query string.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetParam(LPCWSTR lpszParamName);

char* ipworksauth_oauth_getparam(void* lpObj, const char* lpszParamName);

QString GetParam(const QString& qsParamName);

Remarks

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

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

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

Error Handling (C++)

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

Interrupt Method (OAuth Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksauth_oauth_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

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

Reset Method (OAuth Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksauth_oauth_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

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

StartWebServer Method (OAuth Class)

Starts the embedded web server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartWebServer();

Unicode (Windows)
INT StartWebServer();

int ipworksauth_oauth_startwebserver(void* lpObj);

int StartWebServer();

Remarks

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

Error Handling (C++)

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

StopWebServer Method (OAuth Class)

Stops the embedded web server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopWebServer();

Unicode (Windows)
INT StopWebServer();

int ipworksauth_oauth_stopwebserver(void* lpObj);

int StopWebServer();

Remarks

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

Error Handling (C++)

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

Connected Event (OAuth Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(OAuthConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} OAuthConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(OAuthConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} OAuthConnectedEventParams;

#define EID_OAUTH_CONNECTED 1

virtual INT IPWORKSAUTH_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class OAuthConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(OAuthConnectedEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireConnected(OAuthConnectedEventParams *e) {...}

Remarks

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

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

Please refer to the Error Codes section for more information.

ConnectionStatus Event (OAuth Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(OAuthConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} OAuthConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(OAuthConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} OAuthConnectionStatusEventParams;

#define EID_OAUTH_CONNECTIONSTATUS 2

virtual INT IPWORKSAUTH_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class OAuthConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(OAuthConnectionStatusEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireConnectionStatus(OAuthConnectionStatusEventParams *e) {...}

Remarks

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

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

Disconnected Event (OAuth Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(OAuthDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} OAuthDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(OAuthDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} OAuthDisconnectedEventParams;

#define EID_OAUTH_DISCONNECTED 3

virtual INT IPWORKSAUTH_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class OAuthDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(OAuthDisconnectedEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireDisconnected(OAuthDisconnectedEventParams *e) {...}

Remarks

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

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

Please refer to the Error Codes section for more information.

EndTransfer Event (OAuth Class)

Fired when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(OAuthEndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} OAuthEndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(OAuthEndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} OAuthEndTransferEventParams;

#define EID_OAUTH_ENDTRANSFER 4

virtual INT IPWORKSAUTH_CALL FireEndTransfer(INT &iDirection);

class OAuthEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(OAuthEndTransferEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireEndTransfer(OAuthEndTransferEventParams *e) {...}

Remarks

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

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

Error Event (OAuth Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(OAuthErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} OAuthErrorEventParams;


Unicode (Windows)
virtual INT FireError(OAuthErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} OAuthErrorEventParams;

#define EID_OAUTH_ERROR 5

virtual INT IPWORKSAUTH_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class OAuthErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(OAuthErrorEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireError(OAuthErrorEventParams *e) {...}

Remarks

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

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

Header Event (OAuth Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(OAuthHeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} OAuthHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(OAuthHeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} OAuthHeaderEventParams;

#define EID_OAUTH_HEADER 6

virtual INT IPWORKSAUTH_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class OAuthHeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(OAuthHeaderEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireHeader(OAuthHeaderEventParams *e) {...}

Remarks

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

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

LaunchBrowser Event (OAuth Class)

Fires before launching a browser with the authorization URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLaunchBrowser(OAuthLaunchBrowserEventParams *e);

typedef struct {
  char *URL;
  char *Command;
  int reserved;
} OAuthLaunchBrowserEventParams;


Unicode (Windows)
virtual INT FireLaunchBrowser(OAuthLaunchBrowserEventParams *e);

typedef struct {
  LPWSTR URL;
  LPWSTR Command;
  INT reserved;
} OAuthLaunchBrowserEventParams;

#define EID_OAUTH_LAUNCHBROWSER 7

virtual INT IPWORKSAUTH_CALL FireLaunchBrowser(LPSTR &lpszURL, LPSTR &lpszCommand);

class OAuthLaunchBrowserEventParams {
public:
  const QString &URL();
  void SetURL(const QString &qsURL);

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void LaunchBrowser(OAuthLaunchBrowserEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireLaunchBrowser(OAuthLaunchBrowserEventParams *e) {...}

Remarks

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

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

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

• edit
• explore
• find
• open
• print

Log Event (OAuth Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(OAuthLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} OAuthLogEventParams;


Unicode (Windows)
virtual INT FireLog(OAuthLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} OAuthLogEventParams;

#define EID_OAUTH_LOG 8

virtual INT IPWORKSAUTH_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class OAuthLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(OAuthLogEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireLog(OAuthLogEventParams *e) {...}

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Redirect Event (OAuth Class)

Fired when a redirection is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRedirect(OAuthRedirectEventParams *e);

typedef struct {
  const char *Location;
  int Accept;
  int reserved;
} OAuthRedirectEventParams;


Unicode (Windows)
virtual INT FireRedirect(OAuthRedirectEventParams *e);

typedef struct {
  LPCWSTR Location;
  BOOL Accept;
  INT reserved;
} OAuthRedirectEventParams;

#define EID_OAUTH_REDIRECT 9

virtual INT IPWORKSAUTH_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);

class OAuthRedirectEventParams {
public:
  const QString &Location();

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Redirect(OAuthRedirectEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireRedirect(OAuthRedirectEventParams *e) {...}

Remarks

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

ReturnURL Event (OAuth Class)

Fired when the user is redirected to the embedded web server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReturnURL(OAuthReturnURLEventParams *e);

typedef struct {
  const char *URLPath;
  const char *QueryString;
  char *ResponseHeaders;
  char *ResponseBody;
  int reserved;
} OAuthReturnURLEventParams;


Unicode (Windows)
virtual INT FireReturnURL(OAuthReturnURLEventParams *e);

typedef struct {
  LPCWSTR URLPath;
  LPCWSTR QueryString;
  LPWSTR ResponseHeaders;
  LPWSTR ResponseBody;
  INT reserved;
} OAuthReturnURLEventParams;

#define EID_OAUTH_RETURNURL 10

virtual INT IPWORKSAUTH_CALL FireReturnURL(LPSTR &lpszURLPath, LPSTR &lpszQueryString, LPSTR &lpszResponseHeaders, LPSTR &lpszResponseBody);

class OAuthReturnURLEventParams {
public:
  const QString &URLPath();

  const QString &QueryString();

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

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReturnURL(OAuthReturnURLEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireReturnURL(OAuthReturnURLEventParams *e) {...}

Remarks

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

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

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

SetCookie Event (OAuth Class)

Fired for every cookie set by the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetCookie(OAuthSetCookieEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  const char *Expires;
  const char *Domain;
  const char *Path;
  int Secure;
  int reserved;
} OAuthSetCookieEventParams;


Unicode (Windows)
virtual INT FireSetCookie(OAuthSetCookieEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  LPCWSTR Expires;
  LPCWSTR Domain;
  LPCWSTR Path;
  BOOL Secure;
  INT reserved;
} OAuthSetCookieEventParams;

#define EID_OAUTH_SETCOOKIE 11

virtual INT IPWORKSAUTH_CALL FireSetCookie(LPSTR &lpszName, LPSTR &lpszValue, LPSTR &lpszExpires, LPSTR &lpszDomain, LPSTR &lpszPath, BOOL &bSecure);

class OAuthSetCookieEventParams {
public:
  const QString &Name();

  const QString &Value();

  const QString &Expires();

  const QString &Domain();

  const QString &Path();

  bool Secure();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SetCookie(OAuthSetCookieEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireSetCookie(OAuthSetCookieEventParams *e) {...}

Remarks

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

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

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

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

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

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

SSLServerAuthentication Event (OAuth Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(OAuthSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} OAuthSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(OAuthSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} OAuthSSLServerAuthenticationEventParams;

#define EID_OAUTH_SSLSERVERAUTHENTICATION 12

virtual INT IPWORKSAUTH_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class OAuthSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(OAuthSSLServerAuthenticationEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireSSLServerAuthentication(OAuthSSLServerAuthenticationEventParams *e) {...}

Remarks

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

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

SSLStatus Event (OAuth Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(OAuthSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} OAuthSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(OAuthSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} OAuthSSLStatusEventParams;

#define EID_OAUTH_SSLSTATUS 13

virtual INT IPWORKSAUTH_CALL FireSSLStatus(LPSTR &lpszMessage);

class OAuthSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(OAuthSSLStatusEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireSSLStatus(OAuthSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (OAuth Class)

Fired when a document starts transferring (after the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(OAuthStartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} OAuthStartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(OAuthStartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} OAuthStartTransferEventParams;

#define EID_OAUTH_STARTTRANSFER 14

virtual INT IPWORKSAUTH_CALL FireStartTransfer(INT &iDirection);

class OAuthStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(OAuthStartTransferEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireStartTransfer(OAuthStartTransferEventParams *e) {...}

Remarks

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

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

Status Event (OAuth Class)

Fired when the HTTP status line is received from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(OAuthStatusEventParams *e);

typedef struct {
  const char *HTTPVersion;
  int StatusCode;
  const char *Description;
  int reserved;
} OAuthStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(OAuthStatusEventParams *e);

typedef struct {
  LPCWSTR HTTPVersion;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} OAuthStatusEventParams;

#define EID_OAUTH_STATUS 15

virtual INT IPWORKSAUTH_CALL FireStatus(LPSTR &lpszHTTPVersion, INT &iStatusCode, LPSTR &lpszDescription);

class OAuthStatusEventParams {
public:
  const QString &HTTPVersion();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(OAuthStatusEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireStatus(OAuthStatusEventParams *e) {...}

Remarks

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

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

Transfer Event (OAuth Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(OAuthTransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} OAuthTransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(OAuthTransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} OAuthTransferEventParams;

#define EID_OAUTH_TRANSFER 16

virtual INT IPWORKSAUTH_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class OAuthTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(OAuthTransferEventParams *e);

// Or, subclass OAuth and override this emitter function.
virtual int FireTransfer(OAuthTransferEventParams *e) {...}

Remarks

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

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

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

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

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

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

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

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

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

Constructors

HTTPCookie()

HTTPCookie(const char* lpszName, const char* lpszValue)

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

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

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

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 OAuth class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (OAuth Class)

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

Socket Config Settings

Base Config Settings