SAML Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SAML

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

The application's Uniform Resource Name (URN).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApplicationURN();
int SetApplicationURN(const char* lpszApplicationURN);

Unicode (Windows)
LPWSTR GetApplicationURN();
INT SetApplicationURN(LPCWSTR lpszApplicationURN);

char* ipworksauth_saml_getapplicationurn(void* lpObj);
int ipworksauth_saml_setapplicationurn(void* lpObj, const char* lpszApplicationURN);

QString GetApplicationURN();
int SetApplicationURN(QString qsApplicationURN);

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

The assertion id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionId();

Unicode (Windows)
LPWSTR GetAssertionId();

char* ipworksauth_saml_getassertionid(void* lpObj);

QString GetAssertionId();

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

The time in UTC that the assertion was issued.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionIssueInstant();

Unicode (Windows)
LPWSTR GetAssertionIssueInstant();

char* ipworksauth_saml_getassertionissueinstant(void* lpObj);

QString GetAssertionIssueInstant();

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

The assertion issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionIssuer();

Unicode (Windows)
LPWSTR GetAssertionIssuer();

char* ipworksauth_saml_getassertionissuer(void* lpObj);

QString GetAssertionIssuer();

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

The date on which the assertion becomes valid.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionNotBefore();

Unicode (Windows)
LPWSTR GetAssertionNotBefore();

char* ipworksauth_saml_getassertionnotbefore(void* lpObj);

QString GetAssertionNotBefore();

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

The time at which the assertion expires.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionNotOnOrAfter();

Unicode (Windows)
LPWSTR GetAssertionNotOnOrAfter();

char* ipworksauth_saml_getassertionnotonorafter(void* lpObj);

QString GetAssertionNotOnOrAfter();

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

The subject of the assertion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionSubject();

Unicode (Windows)
LPWSTR GetAssertionSubject();

char* ipworksauth_saml_getassertionsubject(void* lpObj);

QString GetAssertionSubject();

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

The version of the assertion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertionVersion();
int SetAssertionVersion(int iAssertionVersion);

Unicode (Windows)
INT GetAssertionVersion();
INT SetAssertionVersion(INT iAssertionVersion);

SV_SAMLV_11(0), 
SV_SAMLV_20(1)

int ipworksauth_saml_getassertionversion(void* lpObj);
int ipworksauth_saml_setassertionversion(void* lpObj, int iAssertionVersion);

int GetAssertionVersion();
int SetAssertionVersion(int iAssertionVersion);

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

The assertion XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAssertionXML();

Unicode (Windows)
LPWSTR GetAssertionXML();

char* ipworksauth_saml_getassertionxml(void* lpObj);

QString GetAssertionXML();

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

The authentication mode.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthMode();
int SetAuthMode(int iAuthMode);

Unicode (Windows)
INT GetAuthMode();
INT SetAuthMode(INT iAuthMode);

CAM_SHARE_POINT_ONLINE(0), 
CAM_DYNAMICS_CRM(1), 
CAM_ADFS(2), 
CAM_CUSTOM(3)

int ipworksauth_saml_getauthmode(void* lpObj);
int ipworksauth_saml_setauthmode(void* lpObj, int iAuthMode);

int GetAuthMode();
int SetAuthMode(int iAuthMode);

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

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertEncoded(char* &lpCertEncoded, int &lenCertEncoded);
int SetCertEncoded(const char* lpCertEncoded, int lenCertEncoded);

Unicode (Windows)
INT GetCertEncoded(LPSTR &lpCertEncoded, INT &lenCertEncoded);
INT SetCertEncoded(LPCSTR lpCertEncoded, INT lenCertEncoded);

int ipworksauth_saml_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksauth_saml_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);

QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStore(char* &lpCertStore, int &lenCertStore);
int SetCertStore(const char* lpCertStore, int lenCertStore);

Unicode (Windows)
INT GetCertStore(LPSTR &lpCertStore, INT &lenCertStore);
INT SetCertStore(LPCSTR lpCertStore, INT lenCertStore);

int ipworksauth_saml_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksauth_saml_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);

QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertStorePassword();
int SetCertStorePassword(const char* lpszCertStorePassword);

Unicode (Windows)
LPWSTR GetCertStorePassword();
INT SetCertStorePassword(LPCWSTR lpszCertStorePassword);

char* ipworksauth_saml_getcertstorepassword(void* lpObj);
int ipworksauth_saml_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);

QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);

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

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

Unicode (Windows)
INT GetCertStoreType();
INT SetCertStoreType(INT iCertStoreType);

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

int ipworksauth_saml_getcertstoretype(void* lpObj);
int ipworksauth_saml_setcertstoretype(void* lpObj, int iCertStoreType);

int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCertSubject();
int SetCertSubject(const char* lpszCertSubject);

Unicode (Windows)
LPWSTR GetCertSubject();
INT SetCertSubject(LPCWSTR lpszCertSubject);

char* ipworksauth_saml_getcertsubject(void* lpObj);
int ipworksauth_saml_setcertsubject(void* lpObj, const char* lpszCertSubject);

QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);

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

The number of records in the Claim arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClaimCount();

Unicode (Windows)
INT GetClaimCount();

int ipworksauth_saml_getclaimcount(void* lpObj);

int GetClaimCount();

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

The name of the issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClaimIssuerName(int iClaimIndex);

Unicode (Windows)
LPWSTR GetClaimIssuerName(INT iClaimIndex);

char* ipworksauth_saml_getclaimissuername(void* lpObj, int claimindex);

QString GetClaimIssuerName(int iClaimIndex);

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

The name of the original issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClaimOriginalIssuer(int iClaimIndex);

Unicode (Windows)
LPWSTR GetClaimOriginalIssuer(INT iClaimIndex);

char* ipworksauth_saml_getclaimoriginalissuer(void* lpObj, int claimindex);

QString GetClaimOriginalIssuer(int iClaimIndex);

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

The number of properties in the claim.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClaimPropertyCount(int iClaimIndex);

Unicode (Windows)
INT GetClaimPropertyCount(INT iClaimIndex);

int ipworksauth_saml_getclaimpropertycount(void* lpObj, int claimindex);

int GetClaimPropertyCount(int iClaimIndex);

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

Selects a property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClaimPropertyIndex(int iClaimIndex);
int SetClaimPropertyIndex(int iClaimIndex, int iClaimPropertyIndex);

Unicode (Windows)
INT GetClaimPropertyIndex(INT iClaimIndex);
INT SetClaimPropertyIndex(INT iClaimIndex, INT iClaimPropertyIndex);

int ipworksauth_saml_getclaimpropertyindex(void* lpObj, int claimindex);
int ipworksauth_saml_setclaimpropertyindex(void* lpObj, int claimindex, int iClaimPropertyIndex);

int GetClaimPropertyIndex(int iClaimIndex);
int SetClaimPropertyIndex(int iClaimIndex, int iClaimPropertyIndex);

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

The name of the property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClaimPropertyName(int iClaimIndex);

Unicode (Windows)
LPWSTR GetClaimPropertyName(INT iClaimIndex);

char* ipworksauth_saml_getclaimpropertyname(void* lpObj, int claimindex);

QString GetClaimPropertyName(int iClaimIndex);

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

The value of the property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClaimPropertyValue(int iClaimIndex);

Unicode (Windows)
LPWSTR GetClaimPropertyValue(INT iClaimIndex);

char* ipworksauth_saml_getclaimpropertyvalue(void* lpObj, int claimindex);

QString GetClaimPropertyValue(int iClaimIndex);

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

The type name of the claim.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClaimTypeName(int iClaimIndex);

Unicode (Windows)
LPWSTR GetClaimTypeName(INT iClaimIndex);

char* ipworksauth_saml_getclaimtypename(void* lpObj, int claimindex);

QString GetClaimTypeName(int iClaimIndex);

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

The value of the claim.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClaimValue(int iClaimIndex);

Unicode (Windows)
LPWSTR GetClaimValue(INT iClaimIndex);

char* ipworksauth_saml_getclaimvalue(void* lpObj, int claimindex);

QString GetClaimValue(int iClaimIndex);

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

The type of value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClaimValueType(int iClaimIndex);

Unicode (Windows)
LPWSTR GetClaimValueType(INT iClaimIndex);

char* ipworksauth_saml_getclaimvaluetype(void* lpObj, int claimindex);

QString GetClaimValueType(int iClaimIndex);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFederationSTS();
int SetFederationSTS(const char* lpszFederationSTS);

Unicode (Windows)
LPWSTR GetFederationSTS();
INT SetFederationSTS(LPCWSTR lpszFederationSTS);

char* ipworksauth_saml_getfederationsts(void* lpObj);
int ipworksauth_saml_setfederationsts(void* lpObj, const char* lpszFederationSTS);

QString GetFederationSTS();
int SetFederationSTS(QString qsFederationSTS);

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

The federation Uniform Resource Name (URN).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFederationURN();
int SetFederationURN(const char* lpszFederationURN);

Unicode (Windows)
LPWSTR GetFederationURN();
INT SetFederationURN(LPCWSTR lpszFederationURN);

char* ipworksauth_saml_getfederationurn(void* lpObj);
int ipworksauth_saml_setfederationurn(void* lpObj, const char* lpszFederationURN);

QString GetFederationURN();
int SetFederationURN(QString qsFederationURN);

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

The local Security Token Service (STS).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalSTS();
int SetLocalSTS(const char* lpszLocalSTS);

Unicode (Windows)
LPWSTR GetLocalSTS();
INT SetLocalSTS(LPCWSTR lpszLocalSTS);

char* ipworksauth_saml_getlocalsts(void* lpObj);
int ipworksauth_saml_setlocalsts(void* lpObj, const char* lpszLocalSTS);

QString GetLocalSTS();
int SetLocalSTS(QString qsLocalSTS);

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

The user's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksauth_saml_getpassword(void* lpObj);
int ipworksauth_saml_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int ipworksauth_saml_getproxyauthscheme(void* lpObj);
int ipworksauth_saml_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int ipworksauth_saml_getproxyautodetect(void* lpObj);
int ipworksauth_saml_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* ipworksauth_saml_getproxypassword(void* lpObj);
int ipworksauth_saml_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int ipworksauth_saml_getproxyport(void* lpObj);
int ipworksauth_saml_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* ipworksauth_saml_getproxyserver(void* lpObj);
int ipworksauth_saml_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int ipworksauth_saml_getproxyssl(void* lpObj);
int ipworksauth_saml_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* ipworksauth_saml_getproxyuser(void* lpObj);
int ipworksauth_saml_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

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

The security token XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecurityTokenXML();

Unicode (Windows)
LPWSTR GetSecurityTokenXML();

char* ipworksauth_saml_getsecuritytokenxml(void* lpObj);

QString GetSecurityTokenXML();

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

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertEncoded(char* &lpSignerCertEncoded, int &lenSignerCertEncoded);
int SetSignerCertEncoded(const char* lpSignerCertEncoded, int lenSignerCertEncoded);

Unicode (Windows)
INT GetSignerCertEncoded(LPSTR &lpSignerCertEncoded, INT &lenSignerCertEncoded);
INT SetSignerCertEncoded(LPCSTR lpSignerCertEncoded, INT lenSignerCertEncoded);

int ipworksauth_saml_getsignercertencoded(void* lpObj, char** lpSignerCertEncoded, int* lenSignerCertEncoded);
int ipworksauth_saml_setsignercertencoded(void* lpObj, const char* lpSignerCertEncoded, int lenSignerCertEncoded);

QByteArray GetSignerCertEncoded();
int SetSignerCertEncoded(QByteArray qbaSignerCertEncoded);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStore(char* &lpSignerCertStore, int &lenSignerCertStore);
int SetSignerCertStore(const char* lpSignerCertStore, int lenSignerCertStore);

Unicode (Windows)
INT GetSignerCertStore(LPSTR &lpSignerCertStore, INT &lenSignerCertStore);
INT SetSignerCertStore(LPCSTR lpSignerCertStore, INT lenSignerCertStore);

int ipworksauth_saml_getsignercertstore(void* lpObj, char** lpSignerCertStore, int* lenSignerCertStore);
int ipworksauth_saml_setsignercertstore(void* lpObj, const char* lpSignerCertStore, int lenSignerCertStore);

QByteArray GetSignerCertStore();
int SetSignerCertStore(QByteArray qbaSignerCertStore);

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertStorePassword();
int SetSignerCertStorePassword(const char* lpszSignerCertStorePassword);

Unicode (Windows)
LPWSTR GetSignerCertStorePassword();
INT SetSignerCertStorePassword(LPCWSTR lpszSignerCertStorePassword);

char* ipworksauth_saml_getsignercertstorepassword(void* lpObj);
int ipworksauth_saml_setsignercertstorepassword(void* lpObj, const char* lpszSignerCertStorePassword);

QString GetSignerCertStorePassword();
int SetSignerCertStorePassword(QString qsSignerCertStorePassword);

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

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

Unicode (Windows)
INT GetSignerCertStoreType();
INT SetSignerCertStoreType(INT iSignerCertStoreType);

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

int ipworksauth_saml_getsignercertstoretype(void* lpObj);
int ipworksauth_saml_setsignercertstoretype(void* lpObj, int iSignerCertStoreType);

int GetSignerCertStoreType();
int SetSignerCertStoreType(int iSignerCertStoreType);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSignerCertSubject();
int SetSignerCertSubject(const char* lpszSignerCertSubject);

Unicode (Windows)
LPWSTR GetSignerCertSubject();
INT SetSignerCertSubject(LPCWSTR lpszSignerCertSubject);

char* ipworksauth_saml_getsignercertsubject(void* lpObj);
int ipworksauth_saml_setsignercertsubject(void* lpObj, const char* lpszSignerCertSubject);

QString GetSignerCertSubject();
int SetSignerCertSubject(QString qsSignerCertSubject);

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

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksauth_saml_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksauth_saml_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (SAML Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksauth_saml_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksauth_saml_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksauth_saml_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksauth_saml_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

The following 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 (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.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksauth_saml_getsslcertstorepassword(void* lpObj);
int ipworksauth_saml_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (SAML Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

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

int ipworksauth_saml_getsslcertstoretype(void* lpObj);
int ipworksauth_saml_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksauth_saml_getsslcertsubject(void* lpObj);
int ipworksauth_saml_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (SAML Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksauth_saml_getsslprovider(void* lpObj);
int ipworksauth_saml_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

0

Remarks

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

Possible values are:

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

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworksauth_saml_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

User Property (SAML Class)

The username.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksauth_saml_getuser(void* lpObj);
int ipworksauth_saml_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

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

The number of records in the Attr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrCount();
int SetAttrCount(int iAttrCount);

Unicode (Windows)
INT GetAttrCount();
INT SetAttrCount(INT iAttrCount);

int ipworksauth_saml_getattrcount(void* lpObj);
int ipworksauth_saml_setattrcount(void* lpObj, int iAttrCount);

int GetAttrCount();
int SetAttrCount(int iAttrCount);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrName(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrName(INT iAttrIndex);

char* ipworksauth_saml_getattrname(void* lpObj, int attrindex);

QString GetAttrName(int iAttrIndex);

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

Attribute namespace.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrNamespace(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrNamespace(INT iAttrIndex);

char* ipworksauth_saml_getattrnamespace(void* lpObj, int attrindex);

QString GetAttrNamespace(int iAttrIndex);

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

Attribute prefix (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrPrefix(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrPrefix(INT iAttrIndex);

char* ipworksauth_saml_getattrprefix(void* lpObj, int attrindex);

QString GetAttrPrefix(int iAttrIndex);

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

Attribute value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrValue(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrValue(INT iAttrIndex);

char* ipworksauth_saml_getattrvalue(void* lpObj, int attrindex);

QString GetAttrValue(int iAttrIndex);

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

The number of records in the XChild arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetXChildCount();
int SetXChildCount(int iXChildCount);

Unicode (Windows)
INT GetXChildCount();
INT SetXChildCount(INT iXChildCount);

int ipworksauth_saml_getxchildcount(void* lpObj);
int ipworksauth_saml_setxchildcount(void* lpObj, int iXChildCount);

int GetXChildCount();
int SetXChildCount(int iXChildCount);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildName(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildName(INT iXChildIndex);

char* ipworksauth_saml_getxchildname(void* lpObj, int xchildindex);

QString GetXChildName(int iXChildIndex);

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

Namespace of the element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildNamespace(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildNamespace(INT iXChildIndex);

char* ipworksauth_saml_getxchildnamespace(void* lpObj, int xchildindex);

QString GetXChildNamespace(int iXChildIndex);

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

Prefix of the element (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildPrefix(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildPrefix(INT iXChildIndex);

char* ipworksauth_saml_getxchildprefix(void* lpObj, int xchildindex);

QString GetXChildPrefix(int iXChildIndex);

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

The inner text of the element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildXText(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildXText(INT iXChildIndex);

char* ipworksauth_saml_getxchildxtext(void* lpObj, int xchildindex);

QString GetXChildXText(int iXChildIndex);

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

The name of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXElement();
int SetXElement(const char* lpszXElement);

Unicode (Windows)
LPWSTR GetXElement();
INT SetXElement(LPCWSTR lpszXElement);

char* ipworksauth_saml_getxelement(void* lpObj);
int ipworksauth_saml_setxelement(void* lpObj, const char* lpszXElement);

QString GetXElement();
int SetXElement(QString qsXElement);

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XNamespace Property (SAML Class)

The namespace of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXNamespace();
int SetXNamespace(const char* lpszXNamespace);

Unicode (Windows)
LPWSTR GetXNamespace();
INT SetXNamespace(LPCWSTR lpszXNamespace);

char* ipworksauth_saml_getxnamespace(void* lpObj);
int ipworksauth_saml_setxnamespace(void* lpObj, const char* lpszXNamespace);

QString GetXNamespace();
int SetXNamespace(QString qsXNamespace);

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XParent Property (SAML Class)

The parent of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXParent();

Unicode (Windows)
LPWSTR GetXParent();

char* ipworksauth_saml_getxparent(void* lpObj);

QString GetXParent();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPath();
int SetXPath(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);

char* ipworksauth_saml_getxpath(void* lpObj);
int ipworksauth_saml_setxpath(void* lpObj, const char* lpszXPath);

QString GetXPath();
int SetXPath(QString qsXPath);

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:

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

The prefix of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPrefix();
int SetXPrefix(const char* lpszXPrefix);

Unicode (Windows)
LPWSTR GetXPrefix();
INT SetXPrefix(LPCWSTR lpszXPrefix);

char* ipworksauth_saml_getxprefix(void* lpObj);
int ipworksauth_saml_setxprefix(void* lpObj, const char* lpszXPrefix);

QString GetXPrefix();
int SetXPrefix(QString qsXPrefix);

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

XSubTree Property (SAML Class)

A snapshot of the current element in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXSubTree();

Unicode (Windows)
LPWSTR GetXSubTree();

char* ipworksauth_saml_getxsubtree(void* lpObj);

QString GetXSubTree();

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

The text of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXText();
int SetXText(const char* lpszXText);

Unicode (Windows)
LPWSTR GetXText();
INT SetXText(LPCWSTR lpszXText);

char* ipworksauth_saml_getxtext(void* lpObj);
int ipworksauth_saml_setxtext(void* lpObj, const char* lpszXText);

QString GetXText();
int SetXText(QString qsXText);

Default Value

""

Remarks

The current element is specified via the XPath property.

Data Type

String

Config Method (SAML Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

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

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

GetAssertion Method (SAML Class)

Gets the assertion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAssertion();

Unicode (Windows)
INT GetAssertion();

int ipworksauth_saml_getassertion(void* lpObj);

int GetAssertion();

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

Error Handling (C++)

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

GetSecurityToken Method (SAML Class)

Gets the security token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSecurityToken();

Unicode (Windows)
INT GetSecurityToken();

int ipworksauth_saml_getsecuritytoken(void* lpObj);

int GetSecurityToken();

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

Error Handling (C++)

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

ParseAssertion Method (SAML Class)

Parses the specified assertion.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ParseAssertion(const char* lpszassertion);

Unicode (Windows)
INT ParseAssertion(LPCWSTR lpszassertion);

int ipworksauth_saml_parseassertion(void* lpObj, const char* lpszassertion);

int ParseAssertion(const QString& qsassertion);

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

Error Handling (C++)

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

Characters Event (SAML Class)

Fired for plain text segments of the input stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCharacters(SAMLCharactersEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} SAMLCharactersEventParams;


Unicode (Windows)
virtual INT FireCharacters(SAMLCharactersEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} SAMLCharactersEventParams;

#define EID_SAML_CHARACTERS 1

virtual INT IPWORKSAUTH_CALL FireCharacters(LPSTR &lpszText);

class SAMLCharactersEventParams {
public:
  const QString &Text();

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

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

// Or, subclass SAML and override this emitter function.
virtual int FireCharacters(SAMLCharactersEventParams *e) {...}

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

Fired when a comment section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireComment(SAMLCommentEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} SAMLCommentEventParams;


Unicode (Windows)
virtual INT FireComment(SAMLCommentEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} SAMLCommentEventParams;

#define EID_SAML_COMMENT 2

virtual INT IPWORKSAUTH_CALL FireComment(LPSTR &lpszText);

class SAMLCommentEventParams {
public:
  const QString &Text();

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

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

// Or, subclass SAML and override this emitter function.
virtual int FireComment(SAMLCommentEventParams *e) {...}

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

Fired when an end-element tag is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndElement(SAMLEndElementEventParams *e);

typedef struct {
  const char *Namespace;
  const char *Element;
  const char *QName;
  int IsEmpty;
  int reserved;
} SAMLEndElementEventParams;


Unicode (Windows)
virtual INT FireEndElement(SAMLEndElementEventParams *e);

typedef struct {
  LPCWSTR Namespace;
  LPCWSTR Element;
  LPCWSTR QName;
  BOOL IsEmpty;
  INT reserved;
} SAMLEndElementEventParams;

#define EID_SAML_ENDELEMENT 3

virtual INT IPWORKSAUTH_CALL FireEndElement(LPSTR &lpszNamespace, LPSTR &lpszElement, LPSTR &lpszQName, BOOL &bIsEmpty);

class SAMLEndElementEventParams {
public:
  const QString &Namespace();

  const QString &Element();

  const QString &QName();

  bool IsEmpty();

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

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

// Or, subclass SAML and override this emitter function.
virtual int FireEndElement(SAMLEndElementEventParams *e) {...}

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

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SAML_ERROR 4

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

class SAMLErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

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

Fired when a processing instruction section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePI(SAMLPIEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} SAMLPIEventParams;


Unicode (Windows)
virtual INT FirePI(SAMLPIEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} SAMLPIEventParams;

#define EID_SAML_PI 5

virtual INT IPWORKSAUTH_CALL FirePI(LPSTR &lpszText);

class SAMLPIEventParams {
public:
  const QString &Text();

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

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

// Or, subclass SAML and override this emitter function.
virtual int FirePI(SAMLPIEventParams *e) {...}

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

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SAML_SSLSERVERAUTHENTICATION 6

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

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

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

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

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

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

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

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

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_SAML_SSLSTATUS 7

virtual INT IPWORKSAUTH_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartElement Event (SAML Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartElement(SAMLStartElementEventParams *e);

typedef struct {
  const char *Namespace;
  const char *Element;
  const char *QName;
  int IsEmpty;
  int reserved;
} SAMLStartElementEventParams;


Unicode (Windows)
virtual INT FireStartElement(SAMLStartElementEventParams *e);

typedef struct {
  LPCWSTR Namespace;
  LPCWSTR Element;
  LPCWSTR QName;
  BOOL IsEmpty;
  INT reserved;
} SAMLStartElementEventParams;

#define EID_SAML_STARTELEMENT 8

virtual INT IPWORKSAUTH_CALL FireStartElement(LPSTR &lpszNamespace, LPSTR &lpszElement, LPSTR &lpszQName, BOOL &bIsEmpty);

class SAMLStartElementEventParams {
public:
  const QString &Namespace();

  const QString &Element();

  const QString &QName();

  bool IsEmpty();

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

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

// Or, subclass SAML and override this emitter function.
virtual int FireStartElement(SAMLStartElementEventParams *e) {...}

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)

SAML Config Settings

Base Config Settings

Trappable Errors (SAML Class)

Error Handling (C++)

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

SAML 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