OpenID Class

Properties   Methods   Events   Config Settings   Errors  

The OpenID class is used to verify the identify of a user as well as get basic profile information.

Class Name

IPWorksAuth_OpenID

Procedural Interface

 ipworksauth_openid_open();
 ipworksauth_openid_close($res);
 ipworksauth_openid_register_callback($res, $id, $function);
 ipworksauth_openid_get_last_error($res);
 ipworksauth_openid_get_last_error_code($res);
 ipworksauth_openid_set($res, $id, $index, $value);
 ipworksauth_openid_get($res, $id, $index);
 ipworksauth_openid_do_addcookie($res, $cookiename, $cookievalue);
 ipworksauth_openid_do_addparam($res, $paramname, $paramvalue);
 ipworksauth_openid_do_config($res, $configurationstring);
 ipworksauth_openid_do_doevents($res);
 ipworksauth_openid_do_getauthorization($res);
 ipworksauth_openid_do_getauthorizationurl($res);
 ipworksauth_openid_do_getdiscoverydoc($res, $url);
 ipworksauth_openid_do_getparam($res, $paramname);
 ipworksauth_openid_do_getuserinfo($res);
 ipworksauth_openid_do_interrupt($res);
 ipworksauth_openid_do_reset($res);
 ipworksauth_openid_do_startwebserver($res);
 ipworksauth_openid_do_stopwebserver($res);

Remarks

The OpenID class implements an OpenID Connect (OIDC) Relying Party (RP) capable of authenticating a user and retrieving user information. OIDC is a simple identity layer on top of OAuth 2.0 and re-uses much of the functionality and concepts defined by OAuth 2.0.

To begin using the class you will first need to register your application with the service you want to use. During this process you should obtain a ClientId and ClientSecret. The following sections discuss the typical steps to verify the identity of a user and obtain profile information.

Get the Discovery Document

Many OpenID Providers (OPs) provide information via a Discovery Document. The discovery document defines information such as the endpoint URLs for authentication, tokens, and user information requests. Additionally, details about parameters such as supported authorization scopes are defined in this document. The document is found at a URL which can be fetched and parsed by calling the GetDiscoveryDoc method.

The discovery document URL is typically published by an OpenID Provider (OP) and must be known before calling this method. The format of the URL is standardized and typically takes the form:

https://www.youropenidserver.com/.well-known/openid-configuration

Call GetDiscoveryDoc before calling GetAuthorization to populate the class properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method the following properties are populated:

• ServerAuthURL
• ServerTokenURL
• ServerUserInfoURL
• SignerCertURL

The above values may be stored, and later populated from the stored values, to avoid the requirement of calling GetDiscoveryDoc on subsequent authorization requests.

The following discovery document fields are populated after GetDiscoveryDoc returns:

• DiscoveryDocDetailsAuthorizationURL
• DiscoveryDocDetailsClaimsParamSupported
• DiscoveryDocDetailsIssuer
• DiscoveryDocDetailsSignerCertURL
• DiscoveryDocDetailsRegistrationURL
• DiscoveryDocDetailsServiceDocsURL
• DiscoveryDocDetailsSupportedClaims
• DiscoveryDocDetailsSupportedDisplays
• DiscoveryDocDetailsSupportedGrantTypes
• DiscoveryDocDetailsSupportedResponseTypes
• DiscoveryDocDetailsSupportedScopes
• DiscoveryDocDetailsTokenURL
• DiscoveryDocDetailsUserInfoURL

To access values not automatically parsed by the class the XPath configuration setting may be set to retrieve a specific value. Alternatively the RawJSON setting returns the entire JSON document which may be parsed separately.

Note: Calling GetDiscoveryDoc is not mandatory. If server information was stored from a previous call or is otherwise known ahead of time the following properties may be set in place of calling GetDiscoveryDoc:

• ServerAuthURL
• ServerTokenURL
• ServerUserInfoURL
• SignerCertURL or SignerCert

Examples of the above points: openid.GetDiscoveryDoc("https://accounts.google.com/.well-known/openid-configuration"); // ... or ... openid.ServerAuthURL = "https://accounts.google.com/o/oauth2/v2/auth"; openid.ServerTokenURL = "https://oauth2.googleapis.com/token"; openid.ServerUserInfoURL = "https://openidconnect.googleapis.com/v1/userinfo"; openid.SignerCertURL = "https://www.googleapis.com/oauth2/v3/certs"; // ... or ... string rawjson = openid.Config("RawJSON");

Get Authorization

Before calling GetAuthorization the class may be configured for one of several flows defined by the GrantType property. These flows determine which information is returned by the authorization server and which information (if any) is returned by the Token server.

Possible values for GrantType are:

• 0 (Authorization Code - Default)
• 1 (Implicit)
• 2 (Hybrid)

When using 0 (Authorization Code Flow - Default), an authorization code is returned from the ServerAuthURL and the class automatically contacts the ServerTokenURL and exchanges the authorization code for an ID Token and access token.

When using 1 (Implicit Flow), the ServerAuthURL returns an ID Token and access token directly. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself.

When using 2 (Hybrid Flow), an authorization code and potentially one or more tokens are returned by the ServerAuthURL. The class will automatically contact the ServerTokenURL to exchange the authorization code for an ID Token and access token.

When GrantType and any other optional settings are set as desired, call GetAuthorization.

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

After authorization is complete, UserDetails will be populated with the claims parsed from the ID Token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the AuthorizationScope property. If access to another resource was requested, then the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).

GetUserInfo may be called after calling this method.

The following properties are applicable when calling this method:

• ClientId (required)
• ClientSecret (required)
• ServerAuthURL (required - populated by GetDiscoveryDoc.)
• ServerTokenURL (required - populated by GetDiscoveryDoc.)
• SignerCertURL (conditional - populated by GetDiscoveryDoc. Required if SignerCert is not set.)
• SignerCert (conditional - required if SignerCertURL is not set.)
• AuthorizationScope
• ClientProfile
• GrantType
• Params
• RefreshToken
• ReturnURL
• State
• Timeout
• Display
• Prompt
• IdTokenHint
• LoginHint
• ResponseType

For the default Authorization Code flow, GetAuthorization could work like this: openid.ClientId = "client id"; openid.ClientSecret = "client secret"; openid.AuthorizationScope += " profile email"; // default value is 'openid' openid.State = "application state"; string authToken = openid.GetAuthorization();

Get User Info

When GetAuthorization returns, the UserDetails property is populated with information about the user as returned in the ID Token from the authorization server. An additional operation, GetUserInfo may optionally be called to query the ServerUserInfoURL for information about the user.

Before calling the GetUserInfo method, a successful call to GetAuthorization must be made. The access token returned by GetAuthorization is used by the OpenID provider at ServerUserInfoURL to identify the user for which claims are being retrieved.

When this method is called the class requests the claims about the user from the ServerUserInfoURL. The resulting claims are available in the UserDetails property.

Note: The GetUserInfo method will populate the UserDetails property with the claims returned in the ID Token during the authorization process. This method may not need to be called in order to access the desired claims about the user.

openid.GetUserInfo(); // ... use the user info in the remainder of your application ...

Client Profile Notes

The ClientProfile defines the environment in which the class is being used, and controls how the class behaves in order to best suit that environment. Choose the profile that is closest to the runtime environment.

The following client types are currently supported by the class:

• Application (desktop application)
• WebServer (server side application such as a web site)
• Device (an application without browser access such as a game console)
• Mobile (phone or tablet application)
• Browser (javascript application)
• JWT (server to server authentication using a JWT bearer token such as Google service account authentication)

Application Profile

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

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

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

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

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

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

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

Web Profile

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

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

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

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

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

For additional details for less common profile types please see ClientProfile.

Property List

---

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

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

The access token returned by the authorization server.

Object Oriented Interface

public function getAccessToken();
public function setAccessToken($value);

Procedural Interface

ipworksauth_openid_get($res, 1 );
ipworksauth_openid_set($res, 1, $value );

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

The lifetime of the access token.

Object Oriented Interface

public function getAccessTokenExp();

Procedural Interface

ipworksauth_openid_get($res, 2 );

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

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getAuthorizationCode();
public function setAuthorizationCode($value);

Procedural Interface

ipworksauth_openid_get($res, 3 );
ipworksauth_openid_set($res, 3, $value );

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

The authorization scope used during authorization.

Object Oriented Interface

public function getAuthorizationScope();
public function setAuthorizationScope($value);

Procedural Interface

ipworksauth_openid_get($res, 4 );
ipworksauth_openid_set($res, 4, $value );

Default Value

'openid'

Remarks

This property specifies the authorization scopes sent in the authorization request. The value specified here must be a space separated list of scopes. For instance openid profile email.

The openid scope is always required to be present. The default value is openid.

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

Data Type

String

ClientId Property (IPWorksAuth_OpenID Class)

The Id of the client assigned when registering the application.

Object Oriented Interface

public function getClientId();
public function setClientId($value);

Procedural Interface

ipworksauth_openid_get($res, 5 );
ipworksauth_openid_set($res, 5, $value );

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

The type of client that is requesting authorization.

Object Oriented Interface

public function getClientProfile();
public function setClientProfile($value);

Procedural Interface

ipworksauth_openid_get($res, 6 );
ipworksauth_openid_set($res, 6, $value );

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

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

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

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

Data Type

Integer

ClientSecret Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getClientSecret();
public function setClientSecret($value);

Procedural Interface

ipworksauth_openid_get($res, 7 );
ipworksauth_openid_set($res, 7, $value );

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

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksauth_openid_get($res, 8 );

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

CookieCount Property (IPWorksAuth_OpenID Class)

The number of records in the Cookie arrays.

Object Oriented Interface

public function getCookieCount();
public function setCookieCount($value);

Procedural Interface

ipworksauth_openid_get($res, 9 );
ipworksauth_openid_set($res, 9, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

This property is not available at design time.

Data Type

Integer

CookieDomain Property (IPWorksAuth_OpenID Class)

The domain of a received cookie.

Object Oriented Interface

public function getCookieDomain($cookieindex);

Procedural Interface

ipworksauth_openid_get($res, 10 , $cookieindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CookieExpiration Property (IPWorksAuth_OpenID Class)

An expiration time for the cookie (if provided by the server).

Object Oriented Interface

public function getCookieExpiration($cookieindex);

Procedural Interface

ipworksauth_openid_get($res, 11 , $cookieindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CookieName Property (IPWorksAuth_OpenID Class)

The name of the cookie.

Object Oriented Interface

public function getCookieName($cookieindex);
public function setCookieName($cookieindex, $value);

Procedural Interface

ipworksauth_openid_get($res, 12 , $cookieindex);
ipworksauth_openid_set($res, 12, $value , $cookieindex);

Default Value

''

Remarks

The name of the cookie.

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

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

This property is not available at design time.

Data Type

String

CookiePath Property (IPWorksAuth_OpenID Class)

A path name to limit the cookie to (if provided by the server).

Object Oriented Interface

public function getCookiePath($cookieindex);

Procedural Interface

ipworksauth_openid_get($res, 13 , $cookieindex);

Default Value

''

Remarks

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

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

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

Data Type

String

CookieSecure Property (IPWorksAuth_OpenID Class)

The security flag of the received cookie.

Object Oriented Interface

public function getCookieSecure($cookieindex);

Procedural Interface

ipworksauth_openid_get($res, 14 , $cookieindex);

Default Value

false

Remarks

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

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

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

Data Type

Boolean

CookieValue Property (IPWorksAuth_OpenID Class)

The value of the cookie.

Object Oriented Interface

public function getCookieValue($cookieindex);
public function setCookieValue($cookieindex, $value);

Procedural Interface

ipworksauth_openid_get($res, 15 , $cookieindex);
ipworksauth_openid_set($res, 15, $value , $cookieindex);

Default Value

''

Remarks

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

The SetCookie event provides the cookies set by the server.

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

This property is not available at design time.

Data Type

String

DiscoveryDocDetailsAuthorizationURL Property (IPWorksAuth_OpenID Class)

The server authorization endpoint URL.

Object Oriented Interface

public function getDiscoveryDocDetailsAuthorizationURL();

Procedural Interface

ipworksauth_openid_get($res, 16 );

Default Value

''

Remarks

The server authorization endpoint URL.

This setting corresponds to the authorization_endpoint parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsClaimsParamSupported Property (IPWorksAuth_OpenID Class)

Whether the claims request parameter is supported by the Open ID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsClaimsParamSupported();

Procedural Interface

ipworksauth_openid_get($res, 17 );

Default Value

false

Remarks

Whether the claims request parameter is supported by the Open ID provider.

This setting corresponds to the claims_parameter_supported parameter in the discovery document.

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

Data Type

Boolean

DiscoveryDocDetailsContent Property (IPWorksAuth_OpenID Class)

The raw discovery document JSON.

Object Oriented Interface

public function getDiscoveryDocDetailsContent();

Procedural Interface

ipworksauth_openid_get($res, 18 );

Default Value

''

Remarks

The raw discovery document JSON.

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

Data Type

String

DiscoveryDocDetailsIssuer Property (IPWorksAuth_OpenID Class)

The issuer identifier of the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsIssuer();

Procedural Interface

ipworksauth_openid_get($res, 19 );

Default Value

''

Remarks

The issuer identifier of the OpenID provider. This value is the same as the iss claim returned in ID Tokens issued from this provider. The value is a URL with the https scheme with no query string or fragment component.

This setting corresponds to the issuer parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsLogoutURL Property (IPWorksAuth_OpenID Class)

The logout endpoint URL.

Object Oriented Interface

public function getDiscoveryDocDetailsLogoutURL();

Procedural Interface

ipworksauth_openid_get($res, 20 );

Default Value

''

Remarks

The logout endpoint URL.

This setting corresponds to the optional end_session_endpoint parameter that may be found in the discovery document. If a user is directed to this URL, they will be asked to log out of their account.

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

Data Type

String

DiscoveryDocDetailsRegistrationURL Property (IPWorksAuth_OpenID Class)

The dynamic client registration URL.

Object Oriented Interface

public function getDiscoveryDocDetailsRegistrationURL();

Procedural Interface

ipworksauth_openid_get($res, 21 );

Default Value

''

Remarks

The dynamic client registration URL.

This setting corresponds to the registration_endpoint parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsServiceDocsURL Property (IPWorksAuth_OpenID Class)

The URL of the human-readable service documentation.

Object Oriented Interface

public function getDiscoveryDocDetailsServiceDocsURL();

Procedural Interface

ipworksauth_openid_get($res, 22 );

Default Value

''

Remarks

The URL of the human-readable service documentation. The information at this URL is intended for developers integrating with the OpenID provider and may contain useful information.

This setting corresponds to the service_documentation parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsSignerCertURL Property (IPWorksAuth_OpenID Class)

The URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSignerCertURL();

Procedural Interface

ipworksauth_openid_get($res, 23 );

Default Value

''

Remarks

The URL of the JSON Web Key Set used to verify signatures on values returned by the OpenID provider. The signer keys are automatically retrieved by the class when the ID Token signature verification is performed.

This setting corresponds to the jwks_uri parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsSupportedClaims Property (IPWorksAuth_OpenID Class)

A comma-separated list of claims that are supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedClaims();

Procedural Interface

ipworksauth_openid_get($res, 24 );

Default Value

''

Remarks

A comma-separated list of claims that are supported by the OpenID provider. For instance: aud,email,email_verified,exp,family_name,given_name,iat,iss,locale,name,picture,sub

This setting corresponds to the claims_supported parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsSupportedDisplays Property (IPWorksAuth_OpenID Class)

A comma-separated list of display values that are supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedDisplays();

Procedural Interface

ipworksauth_openid_get($res, 25 );

Default Value

''

Remarks

A comma-separated list of display values that are supported by the OpenID provider.

This setting corresponds to the display_values_supported parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsSupportedGrantTypes Property (IPWorksAuth_OpenID Class)

A comma-separated list of grant types supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedGrantTypes();

Procedural Interface

ipworksauth_openid_get($res, 26 );

Default Value

''

Remarks

A comma-separated list of grant types supported by the OpenID provider. If this value is not specified by the OpenID provider, it is specified that authorization_code and implicit are supported by the OpenID provider.

This setting corresponds to the grant_types_supported parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsSupportedResponseTypes Property (IPWorksAuth_OpenID Class)

A comma-separated list of response types supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedResponseTypes();

Procedural Interface

ipworksauth_openid_get($res, 27 );

Default Value

''

Remarks

A comma-separated list of response types supported by the OpenID provider. If this value is not specified by the OpenID provider, it is defined that the OpenID provider supports (at a minimum) the code, id_token, and token id_token values.

This setting corresponds to the response_types_supported parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsSupportedScopes Property (IPWorksAuth_OpenID Class)

A comma-separated list of scopes that are supported by the OpenID provider.

Object Oriented Interface

public function getDiscoveryDocDetailsSupportedScopes();

Procedural Interface

ipworksauth_openid_get($res, 28 );

Default Value

''

Remarks

A comma-separated list of scopes that are supported by the OpenID provider. For instance: openid,email,profile

This setting corresponds to the scopes_supported parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsTokenURL Property (IPWorksAuth_OpenID Class)

The token endpoint URL.

Object Oriented Interface

public function getDiscoveryDocDetailsTokenURL();

Procedural Interface

ipworksauth_openid_get($res, 29 );

Default Value

''

Remarks

The token endpoint URL.

This setting corresponds to the token_endpoint parameter in the discovery document.

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

Data Type

String

DiscoveryDocDetailsUserInfoURL Property (IPWorksAuth_OpenID Class)

The user info endpoint URL.

Object Oriented Interface

public function getDiscoveryDocDetailsUserInfoURL();

Procedural Interface

ipworksauth_openid_get($res, 30 );

Default Value

''

Remarks

The user info endpoint URL.

This setting corresponds to the userinfo_endpoint parameter in the discovery document.

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

Data Type

String

FirewallAutoDetect Property (IPWorksAuth_OpenID Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksauth_openid_get($res, 31 );
ipworksauth_openid_set($res, 31, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksAuth_OpenID Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksauth_openid_get($res, 32 );
ipworksauth_openid_set($res, 32, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksAuth_OpenID Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksauth_openid_get($res, 33 );
ipworksauth_openid_set($res, 33, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallPassword Property (IPWorksAuth_OpenID Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworksauth_openid_get($res, 34 );
ipworksauth_openid_set($res, 34, $value );

Default Value

''

Remarks

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

Data Type

String

FirewallPort Property (IPWorksAuth_OpenID Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksauth_openid_get($res, 35 );
ipworksauth_openid_set($res, 35, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

Integer

FirewallUser Property (IPWorksAuth_OpenID Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksauth_openid_get($res, 36 );
ipworksauth_openid_set($res, 36, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FollowRedirects Property (IPWorksAuth_OpenID Class)

Determines what happens when the server issues a redirect.

Object Oriented Interface

public function getFollowRedirects();
public function setFollowRedirects($value);

Procedural Interface

ipworksauth_openid_get($res, 37 );
ipworksauth_openid_set($res, 37, $value );

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

The grant type defining the authentication flow.

Object Oriented Interface

public function getGrantType();
public function setGrantType($value);

Procedural Interface

ipworksauth_openid_get($res, 38 );
ipworksauth_openid_set($res, 38, $value );

Default Value

0

Remarks

This property defines the grant type used when performing authentication. The value specified here controls the authentication flow.

Possible values for GrantType are:

• 0 (Authorization Code - Default)
• 1 (Implicit)
• 2 (Hybrid)

When using 0 (Authorization Code Flow - Default), an authorization code is returned from the ServerAuthURL and the class automatically contacts the ServerTokenURL and exchanges the authorization code for an ID Token and access token.

When using 1 (Implicit Flow), the ServerAuthURL returns an ID Token and access token directly. This is only recommended for implementations that are in-browser, as this potentially exposes the tokens to the end-user and user agent itself.

When using 2 (Hybrid Flow), an authorization code and potentially one or more tokens are returned by the ServerAuthURL. The class will automatically contact the ServerTokenURL to exchange the authorization code for an ID Token and access token.

Additional Notes

The response_type request parameter is automatically set based on the value specified here. In some cases multiple values are acceptable and a default value is chosen automatically. To explicitly specify a response_type value for the chosen grant type set ResponseType after setting this property.

Data Type

Integer

Idle Property (IPWorksAuth_OpenID Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworksauth_openid_get($res, 39 );

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

IdTokenAudiences Property (IPWorksAuth_OpenID Class)

A comma-separated list of audiences for which the ID Token is intended.

Object Oriented Interface

public function getIdTokenAudiences();

Procedural Interface

ipworksauth_openid_get($res, 40 );

Default Value

''

Remarks

A comma-separated list of audiences for which the ID Token is intended.

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

Data Type

String

IdTokenAuthTime Property (IPWorksAuth_OpenID Class)

The time when the end user authenticates with the authorization server.

Object Oriented Interface

public function getIdTokenAuthTime();

Procedural Interface

ipworksauth_openid_get($res, 41 );

Default Value

0

Remarks

The time when the end user authenticates with the authorization server.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

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

Data Type

Long64

IdTokenExpTime Property (IPWorksAuth_OpenID Class)

The time when the ID Token expires.

Object Oriented Interface

public function getIdTokenExpTime();

Procedural Interface

ipworksauth_openid_get($res, 42 );

Default Value

0

Remarks

The time when the ID Token expires.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

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

Data Type

Long64

IdTokenIdTokenContent Property (IPWorksAuth_OpenID Class)

The raw value of the ID Token.

Object Oriented Interface

public function getIdTokenIdTokenContent();
public function setIdTokenIdTokenContent($value);

Procedural Interface

ipworksauth_openid_get($res, 43 );
ipworksauth_openid_set($res, 43, $value );

Default Value

''

Remarks

The raw value of the ID Token.

This property is not available at design time.

Data Type

String

IdTokenIssuedTime Property (IPWorksAuth_OpenID Class)

The time when the authentication for this ID Token occurred.

Object Oriented Interface

public function getIdTokenIssuedTime();

Procedural Interface

ipworksauth_openid_get($res, 44 );

Default Value

0

Remarks

The time when the authentication for this ID Token occurred.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

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

Data Type

Long64

IdTokenIssuer Property (IPWorksAuth_OpenID Class)

The issuer, or authorization server, that constructed the ID Token.

Object Oriented Interface

public function getIdTokenIssuer();

Procedural Interface

ipworksauth_openid_get($res, 45 );

Default Value

''

Remarks

The issuer, or authorization server, that constructed the ID Token.

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

Data Type

String

LocalHost Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksauth_openid_get($res, 46 );
ipworksauth_openid_set($res, 46, $value );

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

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworksauth_openid_get($res, 47 );
ipworksauth_openid_set($res, 47, $value );

Default Value

''

Remarks

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

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

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

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

This property is not available at design time.

Data Type

String

ParamCount Property (IPWorksAuth_OpenID Class)

The number of records in the Param arrays.

Object Oriented Interface

public function getParamCount();
public function setParamCount($value);

Procedural Interface

ipworksauth_openid_get($res, 48 );
ipworksauth_openid_set($res, 48, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParamName
• ParamValue

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

This property is not available at design time.

Data Type

Integer

ParamName Property (IPWorksAuth_OpenID Class)

The name of the parameter to be used in the request or returned in the response.

Object Oriented Interface

public function getParamName($paramindex);
public function setParamName($paramindex, $value);

Procedural Interface

ipworksauth_openid_get($res, 49 , $paramindex);
ipworksauth_openid_set($res, 49, $value , $paramindex);

Default Value

''

Remarks

The name of the parameter to be used in the request or returned in the response.

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

This property is not available at design time.

Data Type

String

ParamValue Property (IPWorksAuth_OpenID Class)

The value of the parameter to be used in the request or returned in the response.

Object Oriented Interface

public function getParamValue($paramindex);
public function setParamValue($paramindex, $value);

Procedural Interface

ipworksauth_openid_get($res, 50 , $paramindex);
ipworksauth_openid_set($res, 50, $value , $paramindex);

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (IPWorksAuth_OpenID Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworksauth_openid_get($res, 51 );
ipworksauth_openid_set($res, 51, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (IPWorksAuth_OpenID Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworksauth_openid_get($res, 52 );
ipworksauth_openid_set($res, 52, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorksAuth_OpenID Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworksauth_openid_get($res, 53 );
ipworksauth_openid_set($res, 53, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

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

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

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

Data Type

String

ProxyPort Property (IPWorksAuth_OpenID Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworksauth_openid_get($res, 54 );
ipworksauth_openid_set($res, 54, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworksauth_openid_get($res, 55 );
ipworksauth_openid_set($res, 55, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (IPWorksAuth_OpenID Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworksauth_openid_get($res, 56 );
ipworksauth_openid_set($res, 56, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (IPWorksAuth_OpenID Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworksauth_openid_get($res, 57 );
ipworksauth_openid_set($res, 57, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

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

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

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

Data Type

String

RefreshToken Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getRefreshToken();
public function setRefreshToken($value);

Procedural Interface

ipworksauth_openid_get($res, 58 );
ipworksauth_openid_set($res, 58, $value );

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

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

Object Oriented Interface

public function getReturnURL();
public function setReturnURL($value);

Procedural Interface

ipworksauth_openid_get($res, 59 );
ipworksauth_openid_set($res, 59, $value );

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

The URL of the authorization server.

Object Oriented Interface

public function getServerAuthURL();
public function setServerAuthURL($value);

Procedural Interface

ipworksauth_openid_get($res, 60 );
ipworksauth_openid_set($res, 60, $value );

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

The URL used to obtain the access token.

Object Oriented Interface

public function getServerTokenURL();
public function setServerTokenURL($value);

Procedural Interface

ipworksauth_openid_get($res, 61 );
ipworksauth_openid_set($res, 61, $value );

Default Value

''

Remarks

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

This must be set before calling GetAuthorization.

Data Type

String

ServerUserInfoURL Property (IPWorksAuth_OpenID Class)

The URL of the OpenID provider's user info endpoint.

Object Oriented Interface

public function getServerUserInfoURL();
public function setServerUserInfoURL($value);

Procedural Interface

ipworksauth_openid_get($res, 62 );
ipworksauth_openid_set($res, 62, $value );

Default Value

''

Remarks

This property holds the URL of the OpenID provider's user info endpoint. This value is required when calling GetUserInfo.

This property is populated when GetDiscoveryDoc is called.

Data Type

String

SignerCertEffectiveDate Property (IPWorksAuth_OpenID Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSignerCertEffectiveDate();

Procedural Interface

ipworksauth_openid_get($res, 63 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SignerCertExpirationDate Property (IPWorksAuth_OpenID Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSignerCertExpirationDate();

Procedural Interface

ipworksauth_openid_get($res, 64 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SignerCertExtendedKeyUsage Property (IPWorksAuth_OpenID Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSignerCertExtendedKeyUsage();

Procedural Interface

ipworksauth_openid_get($res, 65 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SignerCertFingerprint Property (IPWorksAuth_OpenID Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSignerCertFingerprint();

Procedural Interface

ipworksauth_openid_get($res, 66 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SignerCertFingerprintSHA1 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSignerCertFingerprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 67 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SignerCertFingerprintSHA256 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSignerCertFingerprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 68 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SignerCertIssuer Property (IPWorksAuth_OpenID Class)

The issuer of the certificate.

Object Oriented Interface

public function getSignerCertIssuer();

Procedural Interface

ipworksauth_openid_get($res, 69 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SignerCertPrivateKey Property (IPWorksAuth_OpenID Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSignerCertPrivateKey();

Procedural Interface

ipworksauth_openid_get($res, 70 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SignerCertPrivateKey may be available but not exportable. In this case, SignerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SignerCertPrivateKeyAvailable Property (IPWorksAuth_OpenID Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSignerCertPrivateKeyAvailable();

Procedural Interface

ipworksauth_openid_get($res, 71 );

Default Value

false

Remarks

Whether a SignerCertPrivateKey is available for the selected certificate. If SignerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SignerCertPrivateKeyContainer Property (IPWorksAuth_OpenID Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSignerCertPrivateKeyContainer();

Procedural Interface

ipworksauth_openid_get($res, 72 );

Default Value

''

Remarks

The name of the SignerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SignerCertPublicKey Property (IPWorksAuth_OpenID Class)

The public key of the certificate.

Object Oriented Interface

public function getSignerCertPublicKey();

Procedural Interface

ipworksauth_openid_get($res, 73 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SignerCertPublicKeyAlgorithm Property (IPWorksAuth_OpenID Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSignerCertPublicKeyAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 74 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SignerCertPublicKeyLength Property (IPWorksAuth_OpenID Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSignerCertPublicKeyLength();

Procedural Interface

ipworksauth_openid_get($res, 75 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SignerCertSerialNumber Property (IPWorksAuth_OpenID Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSignerCertSerialNumber();

Procedural Interface

ipworksauth_openid_get($res, 76 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SignerCertSignatureAlgorithm Property (IPWorksAuth_OpenID Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSignerCertSignatureAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 77 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SignerCertStore Property (IPWorksAuth_OpenID Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSignerCertStore();
public function setSignerCertStore($value);

Procedural Interface

ipworksauth_openid_get($res, 78 );
ipworksauth_openid_set($res, 78, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password-protected, specify the password in SignerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SignerCertStorePassword Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getSignerCertStorePassword();
public function setSignerCertStorePassword($value);

Procedural Interface

ipworksauth_openid_get($res, 79 );
ipworksauth_openid_set($res, 79, $value );

Default Value

''

Remarks

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

Data Type

String

SignerCertStoreType Property (IPWorksAuth_OpenID Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSignerCertStoreType();
public function setSignerCertStoreType($value);

Procedural Interface

ipworksauth_openid_get($res, 80 );
ipworksauth_openid_set($res, 80, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SignerCertSubjectAltNames Property (IPWorksAuth_OpenID Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSignerCertSubjectAltNames();

Procedural Interface

ipworksauth_openid_get($res, 81 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SignerCertThumbprintMD5 Property (IPWorksAuth_OpenID Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintMD5();

Procedural Interface

ipworksauth_openid_get($res, 82 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertThumbprintSHA1 Property (IPWorksAuth_OpenID Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 83 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertThumbprintSHA256 Property (IPWorksAuth_OpenID Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSignerCertThumbprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 84 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SignerCertUsage Property (IPWorksAuth_OpenID Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSignerCertUsage();

Procedural Interface

ipworksauth_openid_get($res, 85 );

Default Value

''

Remarks

The text description of SignerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SignerCertUsageFlags Property (IPWorksAuth_OpenID Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSignerCertUsageFlags();

Procedural Interface

ipworksauth_openid_get($res, 86 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SignerCertUsageFlags is a combination of the following flags:

Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SignerCertVersion Property (IPWorksAuth_OpenID Class)

The certificate's version number.

Object Oriented Interface

public function getSignerCertVersion();

Procedural Interface

ipworksauth_openid_get($res, 87 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SignerCertSubject Property (IPWorksAuth_OpenID Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSignerCertSubject();
public function setSignerCertSubject($value);

Procedural Interface

ipworksauth_openid_get($res, 88 );
ipworksauth_openid_set($res, 88, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SignerCertEncoded Property (IPWorksAuth_OpenID Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSignerCertEncoded();
public function setSignerCertEncoded($value);

Procedural Interface

ipworksauth_openid_get($res, 89 );
ipworksauth_openid_set($res, 89, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SignerCertURL Property (IPWorksAuth_OpenID Class)

The URL of the OpenID provider's signing certificate.

Object Oriented Interface

public function getSignerCertURL();
public function setSignerCertURL($value);

Procedural Interface

ipworksauth_openid_get($res, 90 );
ipworksauth_openid_set($res, 90, $value );

Default Value

''

Remarks

This property holds the URL of the OpenID provider's signing certificate. The signing certificate is used to verify the signature of the ID Token returned when calling GetAuthorization.

When calling GetAuthorization either SignerCertURL or SignerCert must be specified.

This property is populated when GetDiscoveryDoc is called.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (IPWorksAuth_OpenID Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksauth_openid_get($res, 91 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksAuth_OpenID Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksauth_openid_get($res, 92 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksAuth_OpenID Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksauth_openid_get($res, 93 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksAuth_OpenID Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksauth_openid_get($res, 94 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 95 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 96 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksAuth_OpenID Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksauth_openid_get($res, 97 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksAuth_OpenID Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksauth_openid_get($res, 98 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksAuth_OpenID Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksauth_openid_get($res, 99 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksAuth_OpenID Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksauth_openid_get($res, 100 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksAuth_OpenID Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksauth_openid_get($res, 101 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksAuth_OpenID Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 102 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksAuth_OpenID Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksauth_openid_get($res, 103 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksAuth_OpenID Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksauth_openid_get($res, 104 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksAuth_OpenID Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 105 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksAuth_OpenID Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksauth_openid_get($res, 106 );
ipworksauth_openid_set($res, 106, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksauth_openid_get($res, 107 );
ipworksauth_openid_set($res, 107, $value );

Default Value

''

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorksAuth_OpenID Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksauth_openid_get($res, 108 );
ipworksauth_openid_set($res, 108, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorksAuth_OpenID Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksauth_openid_get($res, 109 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksAuth_OpenID Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksauth_openid_get($res, 110 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksAuth_OpenID Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 111 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksAuth_OpenID Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 112 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksAuth_OpenID Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksauth_openid_get($res, 113 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksAuth_OpenID Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksauth_openid_get($res, 114 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksAuth_OpenID Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksauth_openid_get($res, 115 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksAuth_OpenID Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksauth_openid_get($res, 116 );
ipworksauth_openid_set($res, 116, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksAuth_OpenID Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksauth_openid_get($res, 117 );
ipworksauth_openid_set($res, 117, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorksAuth_OpenID Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksauth_openid_get($res, 118 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksAuth_OpenID Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksauth_openid_get($res, 119 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksAuth_OpenID Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksauth_openid_get($res, 120 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksAuth_OpenID Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksauth_openid_get($res, 121 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 122 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 123 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksAuth_OpenID Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksauth_openid_get($res, 124 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksAuth_OpenID Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksauth_openid_get($res, 125 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksAuth_OpenID Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksauth_openid_get($res, 126 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksAuth_OpenID Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksauth_openid_get($res, 127 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksAuth_OpenID Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksauth_openid_get($res, 128 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksAuth_OpenID Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 129 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksAuth_OpenID Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksauth_openid_get($res, 130 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksAuth_OpenID Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksauth_openid_get($res, 131 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksAuth_OpenID Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 132 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksAuth_OpenID Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksauth_openid_get($res, 133 );
ipworksauth_openid_set($res, 133, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksauth_openid_get($res, 134 );
ipworksauth_openid_set($res, 134, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (IPWorksAuth_OpenID Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksauth_openid_get($res, 135 );
ipworksauth_openid_set($res, 135, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksAuth_OpenID Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksauth_openid_get($res, 136 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksAuth_OpenID Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksauth_openid_get($res, 137 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksAuth_OpenID Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 138 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksAuth_OpenID Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 139 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksAuth_OpenID Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksauth_openid_get($res, 140 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksAuth_OpenID Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksauth_openid_get($res, 141 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksAuth_OpenID Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksauth_openid_get($res, 142 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksAuth_OpenID Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksauth_openid_get($res, 143 );
ipworksauth_openid_set($res, 143, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSLCertEncoded Property (IPWorksAuth_OpenID Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksauth_openid_get($res, 144 );
ipworksauth_openid_set($res, 144, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworksauth_openid_get($res, 145 );
ipworksauth_openid_set($res, 145, $value );

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:

Additional Notes

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorksAuth_OpenID Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworksauth_openid_get($res, 146 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorksAuth_OpenID Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworksauth_openid_get($res, 147 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorksAuth_OpenID Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworksauth_openid_get($res, 148 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorksAuth_OpenID Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworksauth_openid_get($res, 149 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 150 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 151 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorksAuth_OpenID Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworksauth_openid_get($res, 152 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorksAuth_OpenID Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworksauth_openid_get($res, 153 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorksAuth_OpenID Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworksauth_openid_get($res, 154 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorksAuth_OpenID Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworksauth_openid_get($res, 155 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorksAuth_OpenID Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworksauth_openid_get($res, 156 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorksAuth_OpenID Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 157 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorksAuth_OpenID Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworksauth_openid_get($res, 158 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorksAuth_OpenID Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworksauth_openid_get($res, 159 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorksAuth_OpenID Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 160 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorksAuth_OpenID Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworksauth_openid_get($res, 161 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworksauth_openid_get($res, 162 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorksAuth_OpenID Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworksauth_openid_get($res, 163 );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorksAuth_OpenID Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworksauth_openid_get($res, 164 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorksAuth_OpenID Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworksauth_openid_get($res, 165 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorksAuth_OpenID Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 166 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorksAuth_OpenID Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 167 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorksAuth_OpenID Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworksauth_openid_get($res, 168 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorksAuth_OpenID Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworksauth_openid_get($res, 169 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorksAuth_OpenID Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworksauth_openid_get($res, 170 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorksAuth_OpenID Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworksauth_openid_get($res, 171 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorksAuth_OpenID Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksauth_openid_get($res, 172 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

State Property (IPWorksAuth_OpenID Class)

The opaque value used to maintain state between the request and response.

Object Oriented Interface

public function getState();
public function setState($value);

Procedural Interface

ipworksauth_openid_get($res, 173 );
ipworksauth_openid_set($res, 173, $value );

Default Value

''

Remarks

This property optionally holds a string value which will be returned by the authorization server with the response.

Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes (for instance to prevent Cross-Site Request Forgery). The contents of this property are treated as an opaque value.

When ClientProfile is set to ocpApplication the ReturnURL event provides the state value returned by the authorization server.

Data Type

String

Timeout Property (IPWorksAuth_OpenID Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksauth_openid_get($res, 174 );
ipworksauth_openid_set($res, 174, $value );

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

The contents of the last response from the server.

Object Oriented Interface

public function getTransferredData();

Procedural Interface

ipworksauth_openid_get($res, 175 );

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

The full set of headers as received from the server.

Object Oriented Interface

public function getTransferredHeaders();

Procedural Interface

ipworksauth_openid_get($res, 176 );

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

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

Object Oriented Interface

public function getUsePKCE();
public function setUsePKCE($value);

Procedural Interface

ipworksauth_openid_get($res, 177 );
ipworksauth_openid_set($res, 177, $value );

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

UserDetailsAddrCountry Property (IPWorksAuth_OpenID Class)

The country name portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrCountry();

Procedural Interface

ipworksauth_openid_get($res, 178 );

Default Value

''

Remarks

The country name portion of the user's address.

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

Data Type

String

UserDetailsAddrFormatted Property (IPWorksAuth_OpenID Class)

The full mailing address of the user, formatted for display or use on a mailing label.

Object Oriented Interface

public function getUserDetailsAddrFormatted();

Procedural Interface

ipworksauth_openid_get($res, 179 );

Default Value

''

Remarks

The full mailing address of the user, formatted for display or use on a mailing label. This value may contain multiple lines.

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

Data Type

String

UserDetailsAddrLocality Property (IPWorksAuth_OpenID Class)

The city or locality portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrLocality();

Procedural Interface

ipworksauth_openid_get($res, 180 );

Default Value

''

Remarks

The city or locality portion of the user's address.

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

Data Type

String

UserDetailsAddrPostalCode Property (IPWorksAuth_OpenID Class)

The zip code or postal code portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrPostalCode();

Procedural Interface

ipworksauth_openid_get($res, 181 );

Default Value

''

Remarks

The zip code or postal code portion of the user's address.

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

Data Type

String

UserDetailsAddrRegion Property (IPWorksAuth_OpenID Class)

The state, province, prefecture, or region portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrRegion();

Procedural Interface

ipworksauth_openid_get($res, 182 );

Default Value

''

Remarks

The state, province, prefecture, or region portion of the user's address.

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

Data Type

String

UserDetailsAddrStreetAddr Property (IPWorksAuth_OpenID Class)

The street address portion of the user's address.

Object Oriented Interface

public function getUserDetailsAddrStreetAddr();

Procedural Interface

ipworksauth_openid_get($res, 183 );

Default Value

''

Remarks

The street address portion of the user's address. This is the full street address which may include house number, street name, post office box, and multi-line extended street information. This value may contain multiple lines.

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

Data Type

String

UserDetailsBirthday Property (IPWorksAuth_OpenID Class)

The user's birthday.

Object Oriented Interface

public function getUserDetailsBirthday();

Procedural Interface

ipworksauth_openid_get($res, 184 );

Default Value

''

Remarks

The user's birthday. The format of the value is YYYY-MM-DD or YYYY. The year may be 0000 to indicate that it was omitted.

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

Data Type

String

UserDetailsEmail Property (IPWorksAuth_OpenID Class)

The user's preferred email address.

Object Oriented Interface

public function getUserDetailsEmail();

Procedural Interface

ipworksauth_openid_get($res, 185 );

Default Value

''

Remarks

The user's preferred email address.

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

Data Type

String

UserDetailsEmailVerified Property (IPWorksAuth_OpenID Class)

Whether the user's email address has been verified.

Object Oriented Interface

public function getUserDetailsEmailVerified();

Procedural Interface

ipworksauth_openid_get($res, 186 );

Default Value

false

Remarks

Whether the user's email address has been verified. To be considered verified, the end-user must prove the email address was under the user's control at the time of verification.

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

Data Type

Boolean

UserDetailsFirstName Property (IPWorksAuth_OpenID Class)

The first name of the user.

Object Oriented Interface

public function getUserDetailsFirstName();

Procedural Interface

ipworksauth_openid_get($res, 187 );

Default Value

''

Remarks

The first name of the user. If multiple names are present, they are space-separated.

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

Data Type

String

UserDetailsGender Property (IPWorksAuth_OpenID Class)

The user's gender.

Object Oriented Interface

public function getUserDetailsGender();

Procedural Interface

ipworksauth_openid_get($res, 188 );

Default Value

''

Remarks

The user's gender. Defined values are male and female, but other values may also be used.

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

Data Type

String

UserDetailsLastName Property (IPWorksAuth_OpenID Class)

The last name of the user.

Object Oriented Interface

public function getUserDetailsLastName();

Procedural Interface

ipworksauth_openid_get($res, 189 );

Default Value

''

Remarks

The last name of the user. If multiple names are present, they are space-separated.

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

Data Type

String

UserDetailsLocale Property (IPWorksAuth_OpenID Class)

The end user's locale.

Object Oriented Interface

public function getUserDetailsLocale();

Procedural Interface

ipworksauth_openid_get($res, 190 );

Default Value

''

Remarks

The end user's locale. This is represented as a BCP47 (RFC 5646) language tag. For instance, en-US or en_US.

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

Data Type

String

UserDetailsMiddleName Property (IPWorksAuth_OpenID Class)

The middle name of the user.

Object Oriented Interface

public function getUserDetailsMiddleName();

Procedural Interface

ipworksauth_openid_get($res, 191 );

Default Value

''

Remarks

The middle name of the user. If multiple names are present, they are space-separated.

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

Data Type

String

UserDetailsName Property (IPWorksAuth_OpenID Class)

The user's full name in displayable form including all name parts.

Object Oriented Interface

public function getUserDetailsName();

Procedural Interface

ipworksauth_openid_get($res, 192 );

Default Value

''

Remarks

The user's full name in displayable form including all name parts. This may include titles and suffixes.

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

Data Type

String

UserDetailsNickname Property (IPWorksAuth_OpenID Class)

The casual name of the user.

Object Oriented Interface

public function getUserDetailsNickname();

Procedural Interface

ipworksauth_openid_get($res, 193 );

Default Value

''

Remarks

The casual name of the user. This may or may not be the same as UserDetailsFirstName.

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

Data Type

String

UserDetailsPhoneNumber Property (IPWorksAuth_OpenID Class)

The user's phone number.

Object Oriented Interface

public function getUserDetailsPhoneNumber();

Procedural Interface

ipworksauth_openid_get($res, 194 );

Default Value

''

Remarks

The user's phone number. This may be in E.164 format, for instance +1 (425) 555-1212. If an extension is present, it may be represented according to RFC 3966. For instance: +1 (604) 555-1234;ext=5678.

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

Data Type

String

UserDetailsPhoneNumberVerified Property (IPWorksAuth_OpenID Class)

Whether the user's phone number has been verified.

Object Oriented Interface

public function getUserDetailsPhoneNumberVerified();

Procedural Interface

ipworksauth_openid_get($res, 195 );

Default Value

false

Remarks

Whether the user's phone number has been verified. To be considered verified, the end-user must prove the phone number was under the user's control at the time of verification.

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

Data Type

Boolean

UserDetailsPictureURL Property (IPWorksAuth_OpenID Class)

The URL of the user's profile picture.

Object Oriented Interface

public function getUserDetailsPictureURL();

Procedural Interface

ipworksauth_openid_get($res, 196 );

Default Value

''

Remarks

The URL of the user's profile picture.

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

Data Type

String

UserDetailsPreferredUsername Property (IPWorksAuth_OpenID Class)

The shorthand name by which the end-user wishes to be referred.

Object Oriented Interface

public function getUserDetailsPreferredUsername();

Procedural Interface

ipworksauth_openid_get($res, 197 );

Default Value

''

Remarks

The shorthand name by which the end-user wishes to be referred.

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

Data Type

String

UserDetailsProfileURL Property (IPWorksAuth_OpenID Class)

The URL of the user's profile page.

Object Oriented Interface

public function getUserDetailsProfileURL();

Procedural Interface

ipworksauth_openid_get($res, 198 );

Default Value

''

Remarks

The URL of the user's profile page.

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

Data Type

String

UserDetailsSubject Property (IPWorksAuth_OpenID Class)

The subject of the user that is being represented.

Object Oriented Interface

public function getUserDetailsSubject();

Procedural Interface

ipworksauth_openid_get($res, 199 );

Default Value

''

Remarks

The subject of the user that is being represented. This property is set when parsed from an ID Token or after retrieving the user info. Typically this represents the user of the application.

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

Data Type

String

UserDetailsUpdatedAt Property (IPWorksAuth_OpenID Class)

The time when the user's information was last updated.

Object Oriented Interface

public function getUserDetailsUpdatedAt();

Procedural Interface

ipworksauth_openid_get($res, 200 );

Default Value

0

Remarks

The time when the user's information was last updated.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

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

Data Type

Long64

UserDetailsWebsite Property (IPWorksAuth_OpenID Class)

The URL of the user's website.

Object Oriented Interface

public function getUserDetailsWebsite();

Procedural Interface

ipworksauth_openid_get($res, 201 );

Default Value

''

Remarks

The URL of the user's website.

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

Data Type

String

UserDetailsZoneInfo Property (IPWorksAuth_OpenID Class)

The user's time zone.

Object Oriented Interface

public function getUserDetailsZoneInfo();

Procedural Interface

ipworksauth_openid_get($res, 202 );

Default Value

''

Remarks

The user's time zone. For instance: America/Los_Angeles.

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

Data Type

String

WebServerPort Property (IPWorksAuth_OpenID Class)

The local port on which the embedded web server listens.

Object Oriented Interface

public function getWebServerPort();
public function setWebServerPort($value);

Procedural Interface

ipworksauth_openid_get($res, 203 );
ipworksauth_openid_set($res, 203, $value );

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

WebServerSSLCertEffectiveDate Property (IPWorksAuth_OpenID Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getWebServerSSLCertEffectiveDate();

Procedural Interface

ipworksauth_openid_get($res, 204 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

WebServerSSLCertExpirationDate Property (IPWorksAuth_OpenID Class)

The date on which the certificate expires.

Object Oriented Interface

public function getWebServerSSLCertExpirationDate();

Procedural Interface

ipworksauth_openid_get($res, 205 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

WebServerSSLCertExtendedKeyUsage Property (IPWorksAuth_OpenID Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getWebServerSSLCertExtendedKeyUsage();

Procedural Interface

ipworksauth_openid_get($res, 206 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

WebServerSSLCertFingerprint Property (IPWorksAuth_OpenID Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getWebServerSSLCertFingerprint();

Procedural Interface

ipworksauth_openid_get($res, 207 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

WebServerSSLCertFingerprintSHA1 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getWebServerSSLCertFingerprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 208 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

WebServerSSLCertFingerprintSHA256 Property (IPWorksAuth_OpenID Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getWebServerSSLCertFingerprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 209 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

WebServerSSLCertIssuer Property (IPWorksAuth_OpenID Class)

The issuer of the certificate.

Object Oriented Interface

public function getWebServerSSLCertIssuer();

Procedural Interface

ipworksauth_openid_get($res, 210 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

WebServerSSLCertPrivateKey Property (IPWorksAuth_OpenID Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getWebServerSSLCertPrivateKey();

Procedural Interface

ipworksauth_openid_get($res, 211 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The WebServerSSLCertPrivateKey may be available but not exportable. In this case, WebServerSSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

WebServerSSLCertPrivateKeyAvailable Property (IPWorksAuth_OpenID Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getWebServerSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksauth_openid_get($res, 212 );

Default Value

false

Remarks

Whether a WebServerSSLCertPrivateKey is available for the selected certificate. If WebServerSSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

WebServerSSLCertPrivateKeyContainer Property (IPWorksAuth_OpenID Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getWebServerSSLCertPrivateKeyContainer();

Procedural Interface

ipworksauth_openid_get($res, 213 );

Default Value

''

Remarks

The name of the WebServerSSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

WebServerSSLCertPublicKey Property (IPWorksAuth_OpenID Class)

The public key of the certificate.

Object Oriented Interface

public function getWebServerSSLCertPublicKey();

Procedural Interface

ipworksauth_openid_get($res, 214 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

WebServerSSLCertPublicKeyAlgorithm Property (IPWorksAuth_OpenID Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getWebServerSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 215 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

WebServerSSLCertPublicKeyLength Property (IPWorksAuth_OpenID Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getWebServerSSLCertPublicKeyLength();

Procedural Interface

ipworksauth_openid_get($res, 216 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

WebServerSSLCertSerialNumber Property (IPWorksAuth_OpenID Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getWebServerSSLCertSerialNumber();

Procedural Interface

ipworksauth_openid_get($res, 217 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

WebServerSSLCertSignatureAlgorithm Property (IPWorksAuth_OpenID Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getWebServerSSLCertSignatureAlgorithm();

Procedural Interface

ipworksauth_openid_get($res, 218 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

WebServerSSLCertStore Property (IPWorksAuth_OpenID Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getWebServerSSLCertStore();
public function setWebServerSSLCertStore($value);

Procedural Interface

ipworksauth_openid_get($res, 219 );
ipworksauth_openid_set($res, 219, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

WebServerSSLCertStorePassword Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getWebServerSSLCertStorePassword();
public function setWebServerSSLCertStorePassword($value);

Procedural Interface

ipworksauth_openid_get($res, 220 );
ipworksauth_openid_set($res, 220, $value );

Default Value

''

Remarks

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

Data Type

String

WebServerSSLCertStoreType Property (IPWorksAuth_OpenID Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getWebServerSSLCertStoreType();
public function setWebServerSSLCertStoreType($value);

Procedural Interface

ipworksauth_openid_get($res, 221 );
ipworksauth_openid_set($res, 221, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

WebServerSSLCertSubjectAltNames Property (IPWorksAuth_OpenID Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getWebServerSSLCertSubjectAltNames();

Procedural Interface

ipworksauth_openid_get($res, 222 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

WebServerSSLCertThumbprintMD5 Property (IPWorksAuth_OpenID Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getWebServerSSLCertThumbprintMD5();

Procedural Interface

ipworksauth_openid_get($res, 223 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

WebServerSSLCertThumbprintSHA1 Property (IPWorksAuth_OpenID Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getWebServerSSLCertThumbprintSHA1();

Procedural Interface

ipworksauth_openid_get($res, 224 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

WebServerSSLCertThumbprintSHA256 Property (IPWorksAuth_OpenID Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getWebServerSSLCertThumbprintSHA256();

Procedural Interface

ipworksauth_openid_get($res, 225 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

WebServerSSLCertUsage Property (IPWorksAuth_OpenID Class)

The text description of UsageFlags .

Object Oriented Interface

public function getWebServerSSLCertUsage();

Procedural Interface

ipworksauth_openid_get($res, 226 );

Default Value

''

Remarks

The text description of WebServerSSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

WebServerSSLCertUsageFlags Property (IPWorksAuth_OpenID Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getWebServerSSLCertUsageFlags();

Procedural Interface

ipworksauth_openid_get($res, 227 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of WebServerSSLCertUsageFlags is a combination of the following flags:

Please see the WebServerSSLCertUsage property for a text representation of WebServerSSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

WebServerSSLCertVersion Property (IPWorksAuth_OpenID Class)

The certificate's version number.

Object Oriented Interface

public function getWebServerSSLCertVersion();

Procedural Interface

ipworksauth_openid_get($res, 228 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

WebServerSSLCertSubject Property (IPWorksAuth_OpenID Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getWebServerSSLCertSubject();
public function setWebServerSSLCertSubject($value);

Procedural Interface

ipworksauth_openid_get($res, 229 );
ipworksauth_openid_set($res, 229, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

WebServerSSLCertEncoded Property (IPWorksAuth_OpenID Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getWebServerSSLCertEncoded();
public function setWebServerSSLCertEncoded($value);

Procedural Interface

ipworksauth_openid_get($res, 230 );
ipworksauth_openid_set($res, 230, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

WebServerSSLEnabled Property (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function getWebServerSSLEnabled();
public function setWebServerSSLEnabled($value);

Procedural Interface

ipworksauth_openid_get($res, 231 );
ipworksauth_openid_set($res, 231, $value );

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

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

Object Oriented Interface

public function doAddCookie($cookiename, $cookievalue);

Procedural Interface

ipworksauth_openid_do_addcookie($res, $cookiename, $cookievalue);

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.

AddParam Method (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function doAddParam($paramname, $paramvalue);

Procedural Interface

ipworksauth_openid_do_addparam($res, $paramname, $paramvalue);

Remarks

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

Config Method (IPWorksAuth_OpenID Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksauth_openid_do_config($res, $configurationstring);

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.

DoEvents Method (IPWorksAuth_OpenID Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksauth_openid_do_doevents($res);

Remarks

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

GetAuthorization Method (IPWorksAuth_OpenID Class)

Gets the authorization string required to access the protected resource.

Object Oriented Interface

public function doGetAuthorization();

Procedural Interface

ipworksauth_openid_do_getauthorization($res);

Remarks

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

After authorization is complete, UserDetails will be populated with the claims parsed from the ID Token. This method also returns an authorization string. The authorization string grants access to additional resources as requested via the AuthorizationScope property. If access to another resource was requested, then the access token returned here may be set in the Authorization property of any other class (or passed as the value of the HTTP Authorization header).

GetUserInfo may be called after calling this method.

The following properties are applicable when calling this method:

• ClientId (required)
• ClientSecret (required)
• ServerAuthURL (required - populated by GetDiscoveryDoc.)
• ServerTokenURL (required - populated by GetDiscoveryDoc.)
• SignerCertURL (conditional - populated by GetDiscoveryDoc. Required if SignerCert is not set.)
• SignerCert (conditional - required if SignerCertURL is not set.)
• AuthorizationScope
• ClientProfile
• GrantType
• Params
• RefreshToken
• ReturnURL
• State
• Timeout
• Display
• Prompt
• IdTokenHint
• LoginHint
• ResponseType

GetAuthorizationURL Method (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function doGetAuthorizationURL();

Procedural Interface

ipworksauth_openid_do_getauthorizationurl($res);

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)

GetDiscoveryDoc Method (IPWorksAuth_OpenID Class)

Gets the OpenID Discovery Document.

Object Oriented Interface

public function doGetDiscoveryDoc($url);

Procedural Interface

ipworksauth_openid_do_getdiscoverydoc($res, $url);

Remarks

This method gets the OpenID Connect Discovery Document specified by the URL parameter and parses the response. The discover document contains details about the OpenID Provider configuration including endpoint URLs, supported claims and response types, and more.

The discovery document URL is typically published by an OpenID Provider (OP) and must be known before calling this method. The format of the URL is standardized and typically takes the form:

https://www.youropenidserver.com/.well-known/openid-configuration

Call GetDiscoveryDoc before calling GetAuthorization to populate the class properties with information required to complete the authorization. The retrieved information includes endpoint URLs as well as the OpenID public certificates used to verify the signature on the ID Token. After calling this method the following properties are populated:

• ServerAuthURL
• ServerTokenURL
• ServerUserInfoURL
• SignerCertURL

The above values may be stored, and later populated from the stored values, to avoid the requirement of calling GetDiscoveryDoc on subsequent authorization requests.

The following discovery document fields are populated after GetDiscoveryDoc returns:

• DiscoveryDocDetailsAuthorizationURL
• DiscoveryDocDetailsClaimsParamSupported
• DiscoveryDocDetailsIssuer
• DiscoveryDocDetailsSignerCertURL
• DiscoveryDocDetailsRegistrationURL
• DiscoveryDocDetailsServiceDocsURL
• DiscoveryDocDetailsSupportedClaims
• DiscoveryDocDetailsSupportedDisplays
• DiscoveryDocDetailsSupportedGrantTypes
• DiscoveryDocDetailsSupportedResponseTypes
• DiscoveryDocDetailsSupportedScopes
• DiscoveryDocDetailsTokenURL
• DiscoveryDocDetailsUserInfoURL

To access values not automatically parsed by the class the XPath configuration setting may be set to retrieve a specific value. Alternatively the RawJSON setting returns the entire JSON document which may be parsed separately.

GetParam Method (IPWorksAuth_OpenID Class)

Gets a specific parameter from a query string.

Object Oriented Interface

public function doGetParam($paramname);

Procedural Interface

ipworksauth_openid_do_getparam($res, $paramname);

Remarks

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

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

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

GetUserInfo Method (IPWorksAuth_OpenID Class)

Retrieves claims about the user.

Object Oriented Interface

public function doGetUserInfo();

Procedural Interface

ipworksauth_openid_do_getuserinfo($res);

Remarks

This method retrieves claims about the user. Before calling the GetUserInfo method, a successful call to GetAuthorization must be made. The access token returned by GetAuthorization is used by the OpenID provider at ServerUserInfoURL to identify the user for which claims are being retrieved.

When this method is called the class requests the claims about the user from the ServerUserInfoURL. The resulting claims are available in the UserDetails property.

Note: The GetUserInfo method will populate the UserDetails property with the claims returned in the ID Token during the authorization process. This method may not need to be called in order to access the desired claims about the user.

openid.GetUserInfo(); // ... use the user info in the remainder of your application ...

Interrupt Method (IPWorksAuth_OpenID Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksauth_openid_do_interrupt($res);

Remarks

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

Reset Method (IPWorksAuth_OpenID Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksauth_openid_do_reset($res);

Remarks

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

StartWebServer Method (IPWorksAuth_OpenID Class)

Starts the embedded web server.

Object Oriented Interface

public function doStartWebServer();

Procedural Interface

ipworksauth_openid_do_startwebserver($res);

Remarks

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

StopWebServer Method (IPWorksAuth_OpenID Class)

Stops the embedded web server.

Object Oriented Interface

public function doStopWebServer();

Procedural Interface

ipworksauth_openid_do_stopwebserver($res);

Remarks

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

Connected Event (IPWorksAuth_OpenID Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

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

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

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:

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

Disconnected Event (IPWorksAuth_OpenID Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

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

Fired when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 4, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

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

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

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

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 6, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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

Fires before launching a browser with the authorization URL.

Object Oriented Interface

public function fireLaunchBrowser($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 7, array($this, 'fireLaunchBrowser'));

Parameter List

 'url'
 'command'

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

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 8, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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

Fired when a redirection is received from the server.

Object Oriented Interface

public function fireRedirect($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 9, array($this, 'fireRedirect'));

Parameter List

 'location'
 'accept'

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

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

Object Oriented Interface

public function fireReturnURL($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 10, array($this, 'fireReturnURL'));

Parameter List

 'urlpath'
 'querystring'
 'state'
 'responseheaders'
 'responsebody'

Remarks

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

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

State holds the value of the state parameter that was originally sent with the authorization request. This may be used to maintain state between the request and response. See State for more details.

SetCookie Event (IPWorksAuth_OpenID Class)

Fired for every cookie set by the server.

Object Oriented Interface

public function fireSetCookie($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 11, array($this, 'fireSetCookie'));

Parameter List

 'name'
 'value'
 'expires'
 'domain'
 'path'
 'secure'

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

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 12, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 13, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (IPWorksAuth_OpenID Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 14, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

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

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

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 15, array($this, 'fireStatus'));

Parameter List

 'httpversion'
 'statuscode'
 'description'

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

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksauth_openid_register_callback($res, 16, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

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

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

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

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

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

Config Settings (OpenID Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

OpenID Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (OpenID Class)

OpenID Errors

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

HTTP Errors

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

TCPClient Errors

TCP/IP Errors