SAML Class

Properties   Methods   Events   Config Settings   Errors  

The SAML class is used to obtain security tokens and assertions.

Class Name

IPWorksAuth_SAML

Procedural Interface

 ipworksauth_saml_open();
 ipworksauth_saml_close($res);
 ipworksauth_saml_register_callback($res, $id, $function);
 ipworksauth_saml_get_last_error($res);
 ipworksauth_saml_get_last_error_code($res);
 ipworksauth_saml_set($res, $id, $index, $value);
 ipworksauth_saml_get($res, $id, $index);
 ipworksauth_saml_do_config($res, $configurationstring);
 ipworksauth_saml_do_getassertion($res);
 ipworksauth_saml_do_getsecuritytoken($res);
 ipworksauth_saml_do_parseassertion($res, $assertion);

Remarks

The SAML class provides an easy-to-use interface to obtain security tokens and assertions. The class can also be used to parse assertions and inspect the claims within.

The component has built in support for working with Microsoft SharePoint Online and Microsoft Dynamics CRM Online. This support means only a minimum of information needs to be supplied to the component.

Microsoft SharePoint Online and Dynamics CRM Online

To begin working with SharePoint Online or Dynamics CRM Online first set the AuthMode to the appropriate value. The class will automatically populate several properties to known values. Set the User, Password, ApplicationURN properties and call GetSecurityToken. For instance:

component.AuthMode = SAMLAuthModes.amDynamicsCRM; //dynamic crm component.User = "user@mycrm.onmicrosoft.com"; component.Password = "password"; component.ApplicationURN = "urn:crmapac:dynamics.com"; component.GetSecurityToken(); After calling GetSecurityToken the SecurityTokenXML property will be populated.

ADFS and Others

When working with ADFS or another Security Token Service (STS) the GetAssertion method may be used to obtain an assertion. To begin set AuthMode to either amADFS or amCustom. Then set LocalSTS, User, Password, and ApplicationURN. For instance:

component.AuthMode = SAMLAuthModes.amADFS; component.User = "administrator"; component.Password = "admin"; component.LocalSTS = "https://adfs.contoso.com"; component.ApplicationURN = "https://fsweb.contoso.com/ClaimsAwareWebAppWithManagedSTS/"; component.GetAssertion(); If the assertion is signed the class will use the certificate specified in SignerCert to verify the signature. If SignerCert is not set the class will attempt to parse the certificate present in the assertion to perform verification.

After the assertion is parsed and the signature is verified (if present) the following properties will be populated:

• AssertionId
• AssertionIssueInstant
• AssertionIssuer
• AssertionNotBefore
• AssertionNotOnOrAfter
• AssertionSubject
• AssertionVersion
• AssertionXML
• Claim* properties

Parsing an Assertion

The class may also be used to parse an existing assertion without contacting a STS. To parse an existing assertion call ParseAssertion with the assertion XML. If the assertion is signed the class will use the certificate specified in SignerCert to verify the signature. If SignerCert is not set the class will attempt to parse the certificate present in the assertion to perform verification.

After the assertion is parsed and the signature is verified (if present) the following properties will be populated:

• AssertionId
• AssertionIssueInstant
• AssertionIssuer
• AssertionNotBefore
• AssertionNotOnOrAfter
• AssertionSubject
• AssertionVersion
• AssertionXML
• Claim* properties

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.

ApplicationURN Property (IPWorksAuth_SAML Class)

The application's Uniform Resource Name (URN).

Object Oriented Interface

public function getApplicationURN();


public function setApplicationURN($value);

Procedural Interface

ipworksauth_saml_get($res, 1 );


ipworksauth_saml_set($res, 1, $value );

Default Value

''

Remarks

This property specifies the application's Uniform Resource Name (URN). This must be set before calling GetAssertion or GetSecurityToken.

When AuthMode is set to amDynamicsCRM the value specified here depends on the location of the account. Valid values are:

When AuthMode is set to camSharePointOnline this value is typically the URL to your site. For instance: "https://mycrm.sharepoint.com".

This property is not available at design time.

Data Type

String

AssertionId Property (IPWorksAuth_SAML Class)

The assertion id.

Object Oriented Interface

public function getAssertionId();

Procedural Interface

ipworksauth_saml_get($res, 2 );

Default Value

''

Remarks

This property hold the id of the assertion.

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

Data Type

String

AssertionIssueInstant Property (IPWorksAuth_SAML Class)

The time in UTC that the assertion was issued.

Object Oriented Interface

public function getAssertionIssueInstant();

Procedural Interface

ipworksauth_saml_get($res, 3 );

Default Value

''

Remarks

This property holds the time that the assertion was issued.

This is in the standard xsd:dateTime format "YYYY-MM-DDThh:mm:ss". The date is specified in UTC.

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

Data Type

String

AssertionIssuer Property (IPWorksAuth_SAML Class)

The assertion issuer.

Object Oriented Interface

public function getAssertionIssuer();

Procedural Interface

ipworksauth_saml_get($res, 4 );

Default Value

''

Remarks

This property holds the issuer of the assertion.

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

Data Type

String

AssertionNotBefore Property (IPWorksAuth_SAML Class)

The date on which the assertion becomes valid.

Object Oriented Interface

public function getAssertionNotBefore();

Procedural Interface

ipworksauth_saml_get($res, 5 );

Default Value

''

Remarks

This property specifies the earliest time instant at which the assertion is valid.

This is in the standard xsd:dateTime format "YYYY-MM-DDThh:mm:ss". The date is specified in UTC.

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

Data Type

String

AssertionNotOnOrAfter Property (IPWorksAuth_SAML Class)

The time at which the assertion expires.

Object Oriented Interface

public function getAssertionNotOnOrAfter();

Procedural Interface

ipworksauth_saml_get($res, 6 );

Default Value

''

Remarks

This property specifies the time instant at which the assertion has expired.

This is in the standard xsd:dateTime format "YYYY-MM-DDThh:mm:ss". The date is specified in UTC.

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

Data Type

String

AssertionSubject Property (IPWorksAuth_SAML Class)

The subject of the assertion.

Object Oriented Interface

public function getAssertionSubject();

Procedural Interface

ipworksauth_saml_get($res, 7 );

Default Value

''

Remarks

This property holds the subject of the assertion.

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

Data Type

String

AssertionVersion Property (IPWorksAuth_SAML Class)

The version of the assertion.

Object Oriented Interface

public function getAssertionVersion();


public function setAssertionVersion($value);

Procedural Interface

ipworksauth_saml_get($res, 8 );


ipworksauth_saml_set($res, 8, $value );

Default Value

0

Remarks

This property specifies the version of the assertion. This may be set before calling GetAssertion. This will be populated after calling ParseAssertion. Possible values are:

This property is not available at design time.

Data Type

Integer

AssertionXML Property (IPWorksAuth_SAML Class)

The assertion XML.

Object Oriented Interface

public function getAssertionXML();

Procedural Interface

ipworksauth_saml_get($res, 9 );

Default Value

''

Remarks

This property holds the returned assertion. This is populated after calling GetAssertion.

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

Data Type

String

AuthMode Property (IPWorksAuth_SAML Class)

The authentication mode.

Object Oriented Interface

public function getAuthMode();


public function setAuthMode($value);

Procedural Interface

ipworksauth_saml_get($res, 10 );


ipworksauth_saml_set($res, 10, $value );

Default Value

0

Remarks

This property specifies the authentication mode. Possible values are:

When this property is set the component is initialized based on common settings for the selected mode.

Setting this property to 2 (camADFS) or 3 (camCustom) will clear the values in FederationURN, and FederationSTS. There is no functional difference between 2 (camADFS) and 3 (camCustom), they operate identically.

Setting this property to 0 (camSharePointOnline) or 1 (camDynamicsCRM) will populate FederationURN, and FederationSTS with known valid values for FederationURN, and FederationSTS.

The table below shows which properties are set depending on the value of this property.

The value 3 (camCustom) may be used with any STS as long as WS-TRUST is supported.

This property is not available at design time.

Data Type

Integer

CertEncoded Property (IPWorksAuth_SAML Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getCertEncoded();


public function setCertEncoded($value);

Procedural Interface

ipworksauth_saml_get($res, 12 );


ipworksauth_saml_set($res, 12, $value );

Default Value

''

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Binary String

CertStore Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getCertStore();


public function setCertStore($value);

Procedural Interface

ipworksauth_saml_get($res, 28 );


ipworksauth_saml_set($res, 28, $value );

Default Value

'MY'

Remarks

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

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

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

Designations of certificate stores are platform-dependent.

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

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

This property is not available at design time.

Data Type

Binary String

CertStorePassword Property (IPWorksAuth_SAML 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 getCertStorePassword();


public function setCertStorePassword($value);

Procedural Interface

ipworksauth_saml_get($res, 29 );


ipworksauth_saml_set($res, 29, $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.

This property is not available at design time.

Data Type

String

CertStoreType Property (IPWorksAuth_SAML Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getCertStoreType();


public function setCertStoreType($value);

Procedural Interface

ipworksauth_saml_get($res, 30 );


ipworksauth_saml_set($res, 30, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

This property is not available at design time.

Data Type

Integer

CertSubject Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getCertSubject();


public function setCertSubject($value);

Procedural Interface

ipworksauth_saml_get($res, 31 );


ipworksauth_saml_set($res, 31, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

ClaimCount Property (IPWorksAuth_SAML Class)

The number of records in the Claim arrays.

Object Oriented Interface

public function getClaimCount();

Procedural Interface

ipworksauth_saml_get($res, 39 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClaimIssuerName
• ClaimOriginalIssuer
• ClaimPropertyCount
• ClaimPropertyIndex
• ClaimPropertyName
• ClaimPropertyValue
• ClaimTypeName
• ClaimValue
• ClaimValueType

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

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

Data Type

Integer

ClaimIssuerName Property (IPWorksAuth_SAML Class)

The name of the issuer.

Object Oriented Interface

public function getClaimIssuerName($claimindex);

Procedural Interface

ipworksauth_saml_get($res, 40 , $claimindex);

Default Value

''

Remarks

The name of the issuer. This may be a URL like "http://adfs.contoso.com/adfs/services/trust".

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

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

Data Type

String

ClaimOriginalIssuer Property (IPWorksAuth_SAML Class)

The name of the original issuer.

Object Oriented Interface

public function getClaimOriginalIssuer($claimindex);

Procedural Interface

ipworksauth_saml_get($res, 41 , $claimindex);

Default Value

''

Remarks

The name of the original issuer. This may be a URL like "http://adfs.contoso.com/adfs/services/trust".

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

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

Data Type

String

ClaimPropertyCount Property (IPWorksAuth_SAML Class)

The number of properties in the claim.

Object Oriented Interface

public function getClaimPropertyCount($claimindex);

Procedural Interface

ipworksauth_saml_get($res, 42 , $claimindex);

Default Value

0

Remarks

The number of properties in the claim.

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

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

Data Type

Integer

ClaimPropertyIndex Property (IPWorksAuth_SAML Class)

Selects a property.

Object Oriented Interface

public function getClaimPropertyIndex($claimindex);


public function setClaimPropertyIndex($claimindex, $value);

Procedural Interface

ipworksauth_saml_get($res, 43 , $claimindex);


ipworksauth_saml_set($res, 43, $value , $claimindex);

Default Value

0

Remarks

Selects a property. This is valid from 0 to ClaimPropertyCount. To inspect a property, first set this property and then inspect ClaimPropertyName and ClaimPropertyValue. For instance: for(int i=0;i<component.Claims[0].PropertyCount;i++) { component.Claims[0].PropertyIndex = i; Console.WriteLine(component.Claims[0].PropertyName + ": " + component.Claims[0].PropertyValue); }

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

This property is not available at design time.

Data Type

Integer

ClaimPropertyName Property (IPWorksAuth_SAML Class)

The name of the property.

Object Oriented Interface

public function getClaimPropertyName($claimindex);

Procedural Interface

ipworksauth_saml_get($res, 44 , $claimindex);

Default Value

''

Remarks

The name of the property.

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

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

Data Type

String

ClaimPropertyValue Property (IPWorksAuth_SAML Class)

The value of the property.

Object Oriented Interface

public function getClaimPropertyValue($claimindex);

Procedural Interface

ipworksauth_saml_get($res, 45 , $claimindex);

Default Value

''

Remarks

The value of the property.

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

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

Data Type

String

ClaimTypeName Property (IPWorksAuth_SAML Class)

The type name of the claim.

Object Oriented Interface

public function getClaimTypeName($claimindex);

Procedural Interface

ipworksauth_saml_get($res, 46 , $claimindex);

Default Value

''

Remarks

The type name of the claim. This may be a value like "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier".

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

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

Data Type

String

ClaimValue Property (IPWorksAuth_SAML Class)

The value of the claim.

Object Oriented Interface

public function getClaimValue($claimindex);

Procedural Interface

ipworksauth_saml_get($res, 47 , $claimindex);

Default Value

''

Remarks

The value of the claim.

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

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

Data Type

String

ClaimValueType Property (IPWorksAuth_SAML Class)

The type of value.

Object Oriented Interface

public function getClaimValueType($claimindex);

Procedural Interface

ipworksauth_saml_get($res, 48 , $claimindex);

Default Value

''

Remarks

The type of value. This may be a value like "http://www.w3.org/2001/XMLSchema#string".

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

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

Data Type

String

FederationSTS Property (IPWorksAuth_SAML Class)

The URL of the federation Security Token Service (STS).

Object Oriented Interface

public function getFederationSTS();


public function setFederationSTS($value);

Procedural Interface

ipworksauth_saml_get($res, 49 );


ipworksauth_saml_set($res, 49, $value );

Default Value

''

Remarks

This property specifies the URL of the federation Security Token Service (STS). When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) this property is automatically populated.

This property is not available at design time.

Data Type

String

FederationURN Property (IPWorksAuth_SAML Class)

The federation Uniform Resource Name (URN).

Object Oriented Interface

public function getFederationURN();


public function setFederationURN($value);

Procedural Interface

ipworksauth_saml_get($res, 50 );


ipworksauth_saml_set($res, 50, $value );

Default Value

''

Remarks

This property specifies the federation Uniform Resource Name (URN). This property is automatically populated when AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM).

This property is not available at design time.

Data Type

String

LocalSTS Property (IPWorksAuth_SAML Class)

The local Security Token Service (STS).

Object Oriented Interface

public function getLocalSTS();


public function setLocalSTS($value);

Procedural Interface

ipworksauth_saml_get($res, 51 );


ipworksauth_saml_set($res, 51, $value );

Default Value

''

Remarks

This property specifies the URL of the local Security Token Service(STS).

When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) if this is not specified, then the class will attempt to determine this value automatically by querying the UserRealm.

When AuthMode is set to 2 (camADFS) or 3 (camCustom) this property is required.

This property is not available at design time.

Data Type

String

Password Property (IPWorksAuth_SAML Class)

The user's password.

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

ipworksauth_saml_get($res, 52 );


ipworksauth_saml_set($res, 52, $value );

Default Value

''

Remarks

This property specifies the user's password. This must be set before calling GetAssertion or GetSecurityToken.

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

ipworksauth_saml_get($res, 53 );


ipworksauth_saml_set($res, 53, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

ipworksauth_saml_get($res, 54 );


ipworksauth_saml_set($res, 54, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

ipworksauth_saml_get($res, 55 );


ipworksauth_saml_set($res, 55, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (IPWorksAuth_SAML Class)

This property contains 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_saml_get($res, 56 );


ipworksauth_saml_set($res, 56, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (IPWorksAuth_SAML 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_saml_get($res, 57 );


ipworksauth_saml_set($res, 57, $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_SAML Class)

This property determines 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_saml_get($res, 58 );


ipworksauth_saml_set($res, 58, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

ipworksauth_saml_get($res, 59 );


ipworksauth_saml_set($res, 59, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

SecurityTokenXML Property (IPWorksAuth_SAML Class)

The security token XML.

Object Oriented Interface

public function getSecurityTokenXML();

Procedural Interface

ipworksauth_saml_get($res, 60 );

Default Value

''

Remarks

This property holds the security token. This is populated after calling GetSecurityToken.

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

Data Type

String

SignerCertEncoded Property (IPWorksAuth_SAML Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSignerCertEncoded();


public function setSignerCertEncoded($value);

Procedural Interface

ipworksauth_saml_get($res, 62 );


ipworksauth_saml_set($res, 62, $value );

Default Value

''

Remarks

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

SignerCertStore Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getSignerCertStore();


public function setSignerCertStore($value);

Procedural Interface

ipworksauth_saml_get($res, 78 );


ipworksauth_saml_set($res, 78, $value );

Default Value

'MY'

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:

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

This property is not available at design time.

Data Type

Binary String

SignerCertStorePassword Property (IPWorksAuth_SAML 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_saml_get($res, 79 );


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

This property is not available at design time.

Data Type

String

SignerCertStoreType Property (IPWorksAuth_SAML Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSignerCertStoreType();


public function setSignerCertStoreType($value);

Procedural Interface

ipworksauth_saml_get($res, 80 );


ipworksauth_saml_set($res, 80, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

This property is not available at design time.

Data Type

Integer

SignerCertSubject Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getSignerCertSubject();


public function setSignerCertSubject($value);

Procedural Interface

ipworksauth_saml_get($res, 81 );


ipworksauth_saml_set($res, 81, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksAuth_SAML Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksauth_saml_get($res, 90 );


ipworksauth_saml_set($res, 90, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (IPWorksAuth_SAML Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

ipworksauth_saml_get($res, 118 );


ipworksauth_saml_set($res, 118, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

ipworksauth_saml_get($res, 134 );


ipworksauth_saml_set($res, 134, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (IPWorksAuth_SAML 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_saml_get($res, 135 );


ipworksauth_saml_set($res, 135, $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_SAML Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

ipworksauth_saml_get($res, 136 );


ipworksauth_saml_set($res, 136, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (IPWorksAuth_SAML Class)

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

ipworksauth_saml_get($res, 137 );


ipworksauth_saml_set($res, 137, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (IPWorksAuth_SAML Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

ipworksauth_saml_get($res, 145 );


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

Additional Notes

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

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

Data Type

Integer

SSLServerCertEncoded Property (IPWorksAuth_SAML Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworksauth_saml_get($res, 147 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

User Property (IPWorksAuth_SAML Class)

The username.

Object Oriented Interface

public function getUser();


public function setUser($value);

Procedural Interface

ipworksauth_saml_get($res, 174 );


ipworksauth_saml_set($res, 174, $value );

Default Value

''

Remarks

This property specifies the username. This must be set before calling GetAssertion or GetSecurityToken.

This property is not available at design time.

Data Type

String

AttrCount Property (IPWorksAuth_SAML Class)

The number of records in the Attr arrays.

Object Oriented Interface

public function getAttrCount();


public function setAttrCount($value);

Procedural Interface

ipworksauth_saml_get($res, 175 );


ipworksauth_saml_set($res, 175, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

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

This property is not available at design time.

Data Type

Integer

AttrName Property (IPWorksAuth_SAML Class)

The Name provides the local name (without prefix) of the attribute.

Object Oriented Interface

public function getAttrName($attrindex);

Procedural Interface

ipworksauth_saml_get($res, 176 , $attrindex);

Default Value

''

Remarks

The AttrName provides the local name (without prefix) of the attribute.

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

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

Data Type

String

AttrNamespace Property (IPWorksAuth_SAML Class)

Attribute namespace.

Object Oriented Interface

public function getAttrNamespace($attrindex);

Procedural Interface

ipworksauth_saml_get($res, 177 , $attrindex);

Default Value

''

Remarks

Attribute namespace.

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

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

Data Type

String

AttrPrefix Property (IPWorksAuth_SAML Class)

Attribute prefix (if any).

Object Oriented Interface

public function getAttrPrefix($attrindex);

Procedural Interface

ipworksauth_saml_get($res, 178 , $attrindex);

Default Value

''

Remarks

Attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

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

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

Data Type

String

AttrValue Property (IPWorksAuth_SAML Class)

Attribute value.

Object Oriented Interface

public function getAttrValue($attrindex);

Procedural Interface

ipworksauth_saml_get($res, 179 , $attrindex);

Default Value

''

Remarks

Attribute value.

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

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

Data Type

String

XChildCount Property (IPWorksAuth_SAML Class)

The number of records in the XChild arrays.

Object Oriented Interface

public function getXChildCount();


public function setXChildCount($value);

Procedural Interface

ipworksauth_saml_get($res, 180 );


ipworksauth_saml_set($res, 180, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

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

This property is not available at design time.

Data Type

Integer

XChildName Property (IPWorksAuth_SAML Class)

The Name property provides the local name (without prefix) of the element.

Object Oriented Interface

public function getXChildName($xchildindex);

Procedural Interface

ipworksauth_saml_get($res, 181 , $xchildindex);

Default Value

''

Remarks

The XChildName property provides the local name (without prefix) of the element.

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

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

Data Type

String

XChildNamespace Property (IPWorksAuth_SAML Class)

Namespace of the element.

Object Oriented Interface

public function getXChildNamespace($xchildindex);

Procedural Interface

ipworksauth_saml_get($res, 182 , $xchildindex);

Default Value

''

Remarks

Namespace of the element.

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

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

Data Type

String

XChildPrefix Property (IPWorksAuth_SAML Class)

Prefix of the element (if any).

Object Oriented Interface

public function getXChildPrefix($xchildindex);

Procedural Interface

ipworksauth_saml_get($res, 183 , $xchildindex);

Default Value

''

Remarks

Prefix of the element (if any). If the element does not have a prefix, this property is empty.

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

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

Data Type

String

XChildXText Property (IPWorksAuth_SAML Class)

The inner text of the element.

Object Oriented Interface

public function getXChildXText($xchildindex);

Procedural Interface

ipworksauth_saml_get($res, 184 , $xchildindex);

Default Value

''

Remarks

The inner text of the element.

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

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

Data Type

String

XElement Property (IPWorksAuth_SAML Class)

The name of the current element.

Object Oriented Interface

public function getXElement();


public function setXElement($value);

Procedural Interface

ipworksauth_saml_get($res, 185 );


ipworksauth_saml_set($res, 185, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XNamespace Property (IPWorksAuth_SAML Class)

The namespace of the current element.

Object Oriented Interface

public function getXNamespace();


public function setXNamespace($value);

Procedural Interface

ipworksauth_saml_get($res, 186 );


ipworksauth_saml_set($res, 186, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XParent Property (IPWorksAuth_SAML Class)

The parent of the current element.

Object Oriented Interface

public function getXParent();

Procedural Interface

ipworksauth_saml_get($res, 187 );

Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (IPWorksAuth_SAML Class)

Provides a way to point to a specific element in the document.

Object Oriented Interface

public function getXPath();


public function setXPath($value);

Procedural Interface

ipworksauth_saml_get($res, 188 );


ipworksauth_saml_set($res, 188, $value );

Default Value

''

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildName, XChildNamespace, XChildPrefix, XChildXText, and XText providing other properties of the element. The attributes of the current element are provided in the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath):

Data Type

String

XPrefix Property (IPWorksAuth_SAML Class)

The prefix of the current element.

Object Oriented Interface

public function getXPrefix();


public function setXPrefix($value);

Procedural Interface

ipworksauth_saml_get($res, 189 );


ipworksauth_saml_set($res, 189, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XSubTree Property (IPWorksAuth_SAML Class)

A snapshot of the current element in the document.

Object Oriented Interface

public function getXSubTree();

Procedural Interface

ipworksauth_saml_get($res, 190 );

Default Value

''

Remarks

The current element is specified via the XPath property. In order for this property to work you must have the CacheContent set to true.

This property is read-only.

Data Type

String

XText Property (IPWorksAuth_SAML Class)

The text of the current element.

Object Oriented Interface

public function getXText();


public function setXText($value);

Procedural Interface

ipworksauth_saml_get($res, 191 );


ipworksauth_saml_set($res, 191, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

Config Method (IPWorksAuth_SAML Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GetAssertion Method (IPWorksAuth_SAML Class)

Gets the assertion.

Object Oriented Interface

public function doGetAssertion();

Procedural Interface

ipworksauth_saml_do_getassertion($res);

Remarks

This method communicates with LocalSTS as to obtain an assertion.

When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) the class will automatically populate various properties to known values to reduce the number of required settings. Typically only the following properties are required:

• User
• Password
• ApplicationURN

When AuthMode is set to 2 (camADFS) or 3 (camCustom) the following properties are required:

• User
• Password
• ApplicationURN
• LocalSTS

If the assertion is signed the class will use the certificate specified in SignerCert to verify the signature. If SignerCert is not set the class will attempt to parse the certificate present in the assertion to perform verification.

After the assertion is parsed and the signature is verified (if present) the following properties will be populated:

• AssertionId
• AssertionIssueInstant
• AssertionIssuer
• AssertionNotBefore
• AssertionNotOnOrAfter
• AssertionSubject
• AssertionVersion
• AssertionXML
• Claim* properties

GetSecurityToken Method (IPWorksAuth_SAML Class)

Gets the security token.

Object Oriented Interface

public function doGetSecurityToken();

Procedural Interface

ipworksauth_saml_do_getsecuritytoken($res);

Remarks

This method communicates with FederationSTS and LocalSTS as applicable to obtain a security token. The SecurityTokenXML property will be populated with the retrieved token.

When AuthMode is set to 0 (camSharePointOnline) or 1 (camDynamicsCRM) the class will automatically populate various properties to known values to reduce the number of required settings. Typically only the following properties are required:

• User
• Password
• ApplicationURN

When AuthMode is set to 2 (camADFS) or 3 (camCustom) the following properties are required:

• User
• Password
• ApplicationURN
• LocalSTS
• FederationSTS
• FederationURN

ParseAssertion Method (IPWorksAuth_SAML Class)

Parses the specified assertion.

Object Oriented Interface

public function doParseAssertion($assertion);

Procedural Interface

ipworksauth_saml_do_parseassertion($res, $assertion);

Remarks

This method parses the assertion specified by the assertion parameter. If the assertion is signed the class will use the certificate specified in SignerCert to verify the signature. If SignerCert is not set the class will attempt to parse the certificate present in the assertion to perform verification.

After the assertion is parsed and the signature is verified (if present) the following properties will be populated:

• AssertionId
• AssertionIssueInstant
• AssertionIssuer
• AssertionNotBefore
• AssertionNotOnOrAfter
• AssertionSubject
• AssertionVersion
• AssertionXML
• Claim* properties

Characters Event (IPWorksAuth_SAML Class)

Fired for plain text segments of the input stream.

Object Oriented Interface

public function fireCharacters($param);

Procedural Interface

ipworksauth_saml_register_callback($res, 1, array($this, 'fireCharacters'));

Parameter List

 'text'

Remarks

The Characters event provides the plain text content of the XML document (i.e. the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end of line characters, except for ignorable whitespace which is fired through the IgnorableWhitespace event.

Comment Event (IPWorksAuth_SAML Class)

Fired when a comment section is encountered.

Object Oriented Interface

public function fireComment($param);

Procedural Interface

ipworksauth_saml_register_callback($res, 2, array($this, 'fireComment'));

Parameter List

 'text'

Remarks

The Comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

EndElement Event (IPWorksAuth_SAML Class)

Fired when an end-element tag is encountered.

Object Oriented Interface

public function fireEndElement($param);

Procedural Interface

ipworksauth_saml_register_callback($res, 3, array($this, 'fireEndElement'));

Parameter List

 'namespace'
 'element'
 'qname'
 'isempty'

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

Error Event (IPWorksAuth_SAML Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksauth_saml_register_callback($res, 4, 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.

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

PI Event (IPWorksAuth_SAML Class)

Fired when a processing instruction section is encountered.

Object Oriented Interface

public function firePI($param);

Procedural Interface

ipworksauth_saml_register_callback($res, 5, array($this, 'firePI'));

Parameter List

 'text'

Remarks

The PI event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

SSLServerAuthentication Event (IPWorksAuth_SAML Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksauth_saml_register_callback($res, 6, array($this, 'fireSSLServerAuthentication'));

Parameter List

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksauth_saml_register_callback($res, 7, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartElement Event (IPWorksAuth_SAML Class)

Fired when a begin-element tag is encountered in the document.

Object Oriented Interface

public function fireStartElement($param);

Procedural Interface

ipworksauth_saml_register_callback($res, 8, array($this, 'fireStartElement'));

Parameter List

 'namespace'
 'element'
 'qname'
 'isempty'

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

Config Settings (SAML 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.

SAML Config Settings

Base Config Settings

Trappable Errors (SAML Class)

SAML Errors

	603   Cannot obtain assertion. LocalSTS must be set.

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

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the class is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).