SAML Class

Properties   Methods   Events   Config Settings   Errors  

The SAML class provides an easy way to add SAML-based SSO to your application.

Syntax

SAML

Remarks

The Security Assertion Markup Language (SAML) protocol provides a standardized way to add Single Sign-on (SSO) to applications. Service Providers (i.e., your application) using SAML-based SSO can eliminate the need to store and manage user passwords. When using SAML, the responsibility of identifying a user can be shifted to the Identity Provider.

In a Web environment, this is typically done by redirecting a user with a SAMLRequest from your application to the Identity Provider's login page where a user already has an account. The user will login, and the Identity Provider will return an assertion in a SAMLResponse, which is a set of information about the user and the authentication steps taken to identify the user.

When a Service Provider (i.e., your web application) receives this SAMLResponse, it will verify both the SAMLResponse and its accompanying assertion to ensure that both were requested by the Service Provider and issued by the Identity Provider. Once the SAMLResponse and assertion have been verified, the assertion will typically contain attributes about the user and its profile with the Identity Provider.

SAML also supports Single Logout (SLO) that can be used to log a user out of the Identity Provider and, depending on the configuration of the Identity Provider, all other accounts that used the Identity Provider to authenticate the user.

Setup

To get started with the class information about the Identity Provider is needed. Typically, this information is provided by a SAML Metadata Document that is either provided during the setup or requested from a URI. The RequestIdentityMetadata and LoadIdentityMetadata methods are both ways to populate the IdentityProviderMetadata, IdentityProviderSigningCert, and IdentityProviderURIs properties.

Usage: Requesting and Reloading the Identity Provider Metadata Document

saml.RequestIdentityMetadata("https://example.com/federationmetadata/federationmetadata.xml"); string raw_document = saml.IdentityProviderMetadata.MetadataContent; //... saml.LoadIdentityMetadata(raw_document, true);

Additionally, the class needs to be configured with the information about the Service Provider (i.e., your application). The ServiceProviderMetadata, ServiceProviderSigningCert, and ServiceProviderURIs properties can be used to provide information about the Service Provider. These are used by the class to build a valid SAMLRequest and to verify the SAMLResponse and it's assertions. Additionally, to easily supply this information to an Identity Provider, the BuildServiceMetadata method can be used to create a SAML Metadata Document that describes your application (the Service Provider) to the Identity Provider.

Usage: Configuring Service Provider Metadata

saml.ServiceProviderMetadata.EntityId = "ServiceProviderId"; saml.ServiceProviderMetadata.AuthnRequestSigned = true; saml.ServiceProviderMetadata.WantAssertionsSigned = true; saml.ServiceProviderSigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); URI acs = new URI(); acs.URIType = SAMLURITypes.sutACS; acs.Location = "https://service_provider.com/acs/"; acs.BindingType = subPost; saml.ServiceProviderURIs.Add(acs); URI logout = new URI(); logout.URIType = SAMLURITypes.sutLogout; logout.Location = "https://service_provider.com/logout/"; logout.Binding = subRedirect; saml.ServiceProviderURIs.Add(acs); saml.BuildServiceMetadata();

Authentication Request

Once configured, the BuildAuthnRequest method can be used to build a SAMLRequest that has been configured by the SAMLRequestSettings. Additionally, to provide state information between the request and the response, the RelayState property can be set. Typically the RelayState property can be used to return a user back to the location within the application once they have been authenticated. After the request has been created, the Id and Issuer fields need to be saved for verification purposes. The Issuer field will be used to check that the SAMLResponse is meant for this Service Provider. The Id field is used to verify that the response corresponds to a request that was made by the Service Provider.

Usage: Building an Authn Request

saml.SAMLRequestSettings.Issuer = "ServiceProviderId"; saml.SAMLRequestSettings.RequestBinding = SAMLRequestBindings.srbHTTPRedirect; saml.SAMLRequestSettings.SignRequest = true; saml.RelayState = "https://service_provider.com/landing"; saml.BuildAuthnRequest(); string requestId = saml.SAMLRequestSettings.Id; //save for later

Depending on how the RequestBinding field is configured, the results will be provided through the SAMLRequestBody and SAMLRequestURL properties. Using the information from the properties, the user that needs identifying should be directed to the SAMLRequestURL. If using the srbHTTPRedirect binding, this is typically done by redirecting the user to the URL. This URL will contain the SAMLRequest and RelayState as query parameters that are parsed by the Identity Provider. If using the srbHTTPPost binding, this is done by using an HTML form post as seen below:

string htmlContent = $@" <!DOCTYPE html> <html> <head> <title>SAML POST</title> </head> <body onload='document.forms[0].submit()'> <form method='post' action='{saml.SAMLRequestURL}'> <input type='hidden' name='SAMLRequest' value='{saml.SAMLRequestBody}'/> <input type='hidden' name='RelayState' value='{saml.RelayState}'/> </form> </body> </html>";

Authentication Response

Once the user has completed authentication, the Identity Provider will return the user to the Assertion Consumer Service (ASC) URI that was configured in the ServiceProviderURIs properties. If authentication was successful, this response should also contain an assertion as well as information about the authentication context.

To handle an incoming HTTP request that contains the SAMLResponse, the ProcessSAMLResponse or ParseSAMLResponse methods can be used. To provide the HTTP headers and body that contain the SAMLResponse directly to the class, the SAMLResponseHeaders and SAMLResponseBody properties can be set before calling ParseSAMLResponse or ProcessSAMLResponse. For example:

saml.SAMLResponseBody = "HTTP Body"; saml.SAMLResponseHeaders = "HTTP Headers";

Once the HTTP request that contains the SAMLResponse has been provided, the application can then call the ProcessSAMLResponse method. While the ProcessSAMLResponse method processes the SAMLResponse, the class fires the SAMLResponse and Assertion events. These events can be used to provide the class the information needed to correctly verify the SAMLResponse such as the Id and Issuer fields that were saved after creating the SAMLRequest. If the SAMLResponse and assertion are valid, the method will return without any errors. Additionally, the SAMLResponseInfo, AssertionInfo, AssertionAttributeInfo, and AssertionAuthnInfo properties will be populated. saml.RequestIdentityMetadata("https://example.com/federationmetadata/federationmetadata.xml"); //Setup Service Provider URI acs = new URI(); acs.URIType = SAMLURITypes.sutACS; acs.Location = "https://service_provider.com/acs/"; acs.BindingType = URIBindings.subPost saml.ServiceProviderURIs.Add(acs); //Provide information about the SAMLRequest. saml.SAMLRequestSettings.Issuer = "ServiceProviderId"; saml.SAMLRequestSettings.Id = requestId; saml.ProcessSAMLResponse();

The ProcessSAMLResponse method performs multiple steps automatically, making it a simple method to handle the SAMLResponse. The method is the equivalent to calling the ParseSAMLResponse, ValidateSAMLResponse, ParseAssertion, and ValidateAssertion methods. These methods can be used in place of calling ProcessSAMLResponse if there are additional considerations or extra control is needed by your application. saml.ParseSAMLResponse(); saml.ValidateSAMLResponse(); saml.ParseAssertion(); saml.ValidateAssertion();

Assertions

The SAML 2.0 specification allows for Identity Providers many different options for what can be included in an assertion. In the Web SSO profile, typically the assertion will contain the Issuer, Signature, Subject, Conditions, AttributeStatement, and AuthnStatement. Information found from the Issuer, Signature, Subject, and Conditions sections of the assertion can be found in the AssertionInfo property. Along with providing information about the assertion, these fields are also used to verify the assertion. An important field to note is the SubjectNameId field. This field provides the unique identifier for the user which can be used for authorization purposes. See below for information about the AttributeStatement and AuthnStatement sections.

Assertion Authentication Context

The AuthnStatement section is used by the Identity Provider to provide the Service Provider with information about it's authentication session with the user. The statement is parsed to the AssertionAuthnInfo property. Some commonly used information is how the user authenticated with the Identity Provider (see ContextClassReference) and the session identifier created by the Identity Provider for the Service Provider (see SessionIndex).

Assertion Attributes

Along with the SubjectNameId, the Identity Provider may give additional information about the user in the AttributeStatement section. What exactly is provided depends on how the connection between the Identity Provider and Service Provider was configured. Since there is no defined list of attributes, the AssertionAttributeInfo collection will be populated with each attribute found. Each attribute has a name and one or more values. For example, take the following attribute that describes a list of emails attached to the user.

<Attribute Name="verified_emails"> <AttributeValue> email@test.com </AttributeValue>"; <AttributeValue> other@example.com </AttributeValue>"; </Attribute>";

In this assertion attribute statement, the user has two emails that have been verified. There are two ways to get this information using the SAML class. First, using the collection, the application can iterate through the collection for the attribute and then iterate through the values associated. Using this method is useful if there are multiple acceptable names for the attributes that could be accepted. For example: List<string> verified_emails = new List<string>(); for(int i = 0; i < saml.AssertionAttributeInfo.Count; i++){ if (saml.AssertionAttributeInfo[i].Name == "verified_emails" || saml.AssertionAttributeInfo[i].Name == "verified_email"){ for (int j = 0; j < saml.AssertionAttributeInfo[i].AttributeValueCount; j++) { saml.AssertionAttributeInfo[i].AttributeValueIndex = j; verified_emails.Add(saml.AssertionAttributeInfo[i].AttributeValueData); } } }

The other options is to use the GetAssertionAttribute method. This method will search the assertion's attribute statement for the first attribute with a matching name. Like in the example above, if the attribute has multiple values the method will return them in a semi-colon separated list. This method simplifies the process of searching the collection for a specific attribute if the name of the attribute is known ahead of time. For example: string[] verfied_emails = saml.GetAssertionAttribute("verified_emails").Split(';');

Property List


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

AssertionAttributeInfoInformation about the attributes found in an assertion.
AssertionAuthnInfoInformation about the AuthnStatement in an assertion.
AssertionInfoInformation about a parsed assertion.
FirewallA set of properties related to firewall access.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdentityProviderEncryptingCertThe certificate used to decrypt responses from an identity provider.
IdentityProviderMetadataInformation about the identity provider.
IdentityProviderSigningCertThe certificate used to verify signatures in responses from an identity provider.
IdentityProviderURIsThe URIs for an identity provider.
ProxyA set of properties related to proxy access.
RelayStateThe RelayState for a SAMLRequest or SAMLResponse.
SAMLRequestBodyThe HTTP body for a SAMLRequest.
SAMLRequestSettingsThe settings for a SAMLRequest.
SAMLRequestURLThe URL for SAMLRequests.
SAMLResponseBodyThe HTTP body for the current SAMLResponse.
SAMLResponseHeadersThe HTTP headers for the current SAMLResponse.
SAMLResponseInfoInformation about a SAMLResponse.
ServiceProviderMetadataInformation about a service provider's SAML metadata document.
ServiceProviderSigningCertThe certificate used by the service provider when signing a SAMLRequest or SAML metadata document.
ServiceProviderURIsInformation about the URIs for a service provider.
SSLAcceptServerCertInstructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProviderThe Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCertThe server certificate for the last established connection.

Method List


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

BuildAuthnRequestBuilds an Authentication Request.
BuildLogoutRequestBuilds a Single Logout request.
BuildServiceMetadataBuilds a metadata document for a service provider.
ConfigSets or retrieves a configuration setting.
DoEventsThis method processes events from the internal message queue.
GetAssertionAttributeSearches for a specific assertion attribute.
InterruptThis method interrupts the current method.
LoadIdentityMetadataLoads an identity provider's metadata document.
ParseAssertionParses an assertion.
ParseSAMLResponseParses a SAMLResponse.
ProcessSAMLResponseProcesses the SAMLResponse from the current HTTP request.
RequestIdentityMetadataRequests an identity provider's SAML metadata document.
ResetThis method will reset the class.
ValidateAssertionValidates an assertion.
ValidateSAMLResponseValidates a SAMLResponse.

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.

AssertionFired when an assertion is validated.
ErrorFired when information is available about errors during data delivery.
LogFired once for each log message.
RedirectFired when a redirection is received from the server.
SAMLResponseFired when a SAMLResponse is validated.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.

Config Settings


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

AssertionValidationFlagsThe checks that are ignored when validating an assertion.
AttributeNameProfileThe set of names that are used for common attributes.
SAMLRequestCustomConsentThe URI reference of a custom consent type.
SAMLRequestCustomNameIdFormatThe URI reference of a custom NameID format type.
SAMLResponseDetachedSignatureThe SAMLResponse's detached signature.
SAMLResponseDetachedSignatureAlgThe algorithm of a SAMLResponse's detached signature.
SAMLResponseValidationFlagsThe checks that are ignored when validating a SAMLResponse.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLClientCACertsA newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AssertionAttributeInfo Property (SAML Class)

Information about the attributes found in an assertion.

Syntax

CloudSSOList<CloudSSOAssertionAttribute>* GetAssertionAttributeInfo();
int SetAssertionAttributeInfo(CloudSSOList<CloudSSOAssertionAttribute>* val);
int cloudsso_saml_getassertionattributeinfocount(void* lpObj);
int cloudsso_saml_setassertionattributeinfocount(void* lpObj, int iAssertionAttributeInfoCount);
char* cloudsso_saml_getassertionattributeinfoattributecontent(void* lpObj, int assertionattributeinfoindex);
int cloudsso_saml_getassertionattributeinfoattributevaluecount(void* lpObj, int assertionattributeinfoindex);
char* cloudsso_saml_getassertionattributeinfoattributevaluedata(void* lpObj, int assertionattributeinfoindex);
int cloudsso_saml_getassertionattributeinfoattributevalueindex(void* lpObj, int assertionattributeinfoindex);
int cloudsso_saml_setassertionattributeinfoattributevalueindex(void* lpObj, int assertionattributeinfoindex, int iAssertionAttributeInfoAttributeValueIndex);
char* cloudsso_saml_getassertionattributeinfofriendlyname(void* lpObj, int assertionattributeinfoindex);
char* cloudsso_saml_getassertionattributeinfoname(void* lpObj, int assertionattributeinfoindex);
char* cloudsso_saml_getassertionattributeinfonameformat(void* lpObj, int assertionattributeinfoindex);
int GetAssertionAttributeInfoCount();
int SetAssertionAttributeInfoCount(int iAssertionAttributeInfoCount); QString GetAssertionAttributeInfoAttributeContent(int iAssertionAttributeInfoIndex); int GetAssertionAttributeInfoAttributeValueCount(int iAssertionAttributeInfoIndex); QString GetAssertionAttributeInfoAttributeValueData(int iAssertionAttributeInfoIndex); int GetAssertionAttributeInfoAttributeValueIndex(int iAssertionAttributeInfoIndex);
int SetAssertionAttributeInfoAttributeValueIndex(int iAssertionAttributeInfoIndex, int iAssertionAttributeInfoAttributeValueIndex); QString GetAssertionAttributeInfoFriendlyName(int iAssertionAttributeInfoIndex); QString GetAssertionAttributeInfoName(int iAssertionAttributeInfoIndex); QString GetAssertionAttributeInfoNameFormat(int iAssertionAttributeInfoIndex);

Remarks

This properties provides the information for each attribute in all of the AttributeStatement elements from the parsed assertion in the AssertionInfo property.

Data Type

CloudSSOAssertionAttribute

AssertionAuthnInfo Property (SAML Class)

Information about the AuthnStatement in an assertion.

Syntax

CloudSSOList<CloudSSOAuthnStatement>* GetAssertionAuthnInfo();
int SetAssertionAuthnInfo(CloudSSOList<CloudSSOAuthnStatement>* val);
int cloudsso_saml_getassertionauthninfocount(void* lpObj);
int cloudsso_saml_setassertionauthninfocount(void* lpObj, int iAssertionAuthnInfoCount);
char* cloudsso_saml_getassertionauthninfoauthenticatingauthorites(void* lpObj, int assertionauthninfoindex);
char* cloudsso_saml_getassertionauthninfoauthninstant(void* lpObj, int assertionauthninfoindex);
char* cloudsso_saml_getassertionauthninfocontextclassreference(void* lpObj, int assertionauthninfoindex);
char* cloudsso_saml_getassertionauthninfocontextdeclaration(void* lpObj, int assertionauthninfoindex);
char* cloudsso_saml_getassertionauthninfosessionexpiration(void* lpObj, int assertionauthninfoindex);
char* cloudsso_saml_getassertionauthninfosessionindex(void* lpObj, int assertionauthninfoindex);
char* cloudsso_saml_getassertionauthninfostatementcontent(void* lpObj, int assertionauthninfoindex);
int GetAssertionAuthnInfoCount();
int SetAssertionAuthnInfoCount(int iAssertionAuthnInfoCount); QString GetAssertionAuthnInfoAuthenticatingAuthorites(int iAssertionAuthnInfoIndex); QString GetAssertionAuthnInfoAuthnInstant(int iAssertionAuthnInfoIndex); QString GetAssertionAuthnInfoContextClassReference(int iAssertionAuthnInfoIndex); QString GetAssertionAuthnInfoContextDeclaration(int iAssertionAuthnInfoIndex); QString GetAssertionAuthnInfoSessionExpiration(int iAssertionAuthnInfoIndex); QString GetAssertionAuthnInfoSessionIndex(int iAssertionAuthnInfoIndex); QString GetAssertionAuthnInfoStatementContent(int iAssertionAuthnInfoIndex);

Remarks

This property provides information about the AuthnStatement from the parsed assertion in the AssertionInfo property.

Data Type

CloudSSOAuthnStatement

AssertionInfo Property (SAML Class)

Information about a parsed assertion.

Syntax

CloudSSOAssertionInfo* GetAssertionInfo();
int SetAssertionInfo(CloudSSOAssertionInfo* val);
int cloudsso_saml_getassertionassertioncontent(void* lpObj, char** lpAssertionAssertionContent, int* lenAssertionAssertionContent);
int cloudsso_saml_setassertionassertioncontent(void* lpObj, const char* lpAssertionAssertionContent, int lenAssertionAssertionContent);
char* cloudsso_saml_getassertionexpirationdate(void* lpObj);
char* cloudsso_saml_getassertionid(void* lpObj);
int cloudsso_saml_getassertionissigned(void* lpObj);
char* cloudsso_saml_getassertionissuedtime(void* lpObj);
char* cloudsso_saml_getassertionissuer(void* lpObj);
char* cloudsso_saml_getassertionnotbeforedate(void* lpObj);
int cloudsso_saml_getassertiononetimeuse(void* lpObj);
char* cloudsso_saml_getassertionsubjectnameid(void* lpObj);
char* cloudsso_saml_getassertionsubjectnameidformat(void* lpObj);
char* cloudsso_saml_getassertionuserinfoaddress(void* lpObj);
char* cloudsso_saml_getassertionuserinfoemail(void* lpObj);
char* cloudsso_saml_getassertionuserinfoname(void* lpObj);
QByteArray GetAssertionAssertionContent();
int SetAssertionAssertionContent(QByteArray qbaAssertionAssertionContent); QString GetAssertionExpirationDate(); QString GetAssertionId(); bool GetAssertionIsSigned(); QString GetAssertionIssuedTime(); QString GetAssertionIssuer(); QString GetAssertionNotBeforeDate(); bool GetAssertionOneTimeUse(); QString GetAssertionSubjectNameId(); QString GetAssertionSubjectNameIdFormat(); QString GetAssertionUserInfoAddress(); QString GetAssertionUserInfoEmail(); QString GetAssertionUserInfoName();

Remarks

This property provides information about the recently parsed assertion. It can also be used to provide a cached assertion manually to the class.

Data Type

CloudSSOAssertionInfo

Firewall Property (SAML Class)

A set of properties related to firewall access.

Syntax

CloudSSOFirewall* GetFirewall();
int SetFirewall(CloudSSOFirewall* val);
int cloudsso_saml_getfirewallautodetect(void* lpObj);
int cloudsso_saml_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
int cloudsso_saml_getfirewalltype(void* lpObj);
int cloudsso_saml_setfirewalltype(void* lpObj, int iFirewallType);
char* cloudsso_saml_getfirewallhost(void* lpObj);
int cloudsso_saml_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
char* cloudsso_saml_getfirewallpassword(void* lpObj);
int cloudsso_saml_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
int cloudsso_saml_getfirewallport(void* lpObj);
int cloudsso_saml_setfirewallport(void* lpObj, int iFirewallPort);
char* cloudsso_saml_getfirewalluser(void* lpObj);
int cloudsso_saml_setfirewalluser(void* lpObj, const char* lpszFirewallUser);
bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect); int GetFirewallType();
int SetFirewallType(int iFirewallType); QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost); QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword); int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

CloudSSOFirewall

FollowRedirects Property (SAML Class)

Determines what happens when the server issues a redirect.

Syntax

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects); Unicode (Windows) INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

Possible Values

FR_NEVER(0), 
FR_ALWAYS(1),
FR_SAME_SCHEME(2)
int cloudsso_saml_getfollowredirects(void* lpObj);
int cloudsso_saml_setfollowredirects(void* lpObj, int iFollowRedirects);
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Default Value

0

Remarks

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

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

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

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

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

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

Data Type

Integer

IdentityProviderEncryptingCert Property (SAML Class)

The certificate used to decrypt responses from an identity provider.

Syntax

CloudSSOCertificate* GetIdentityProviderEncryptingCert();
int SetIdentityProviderEncryptingCert(CloudSSOCertificate* val);
int cloudsso_saml_getidentityproviderencryptingcertstore(void* lpObj, char** lpIdentityProviderEncryptingCertStore, int* lenIdentityProviderEncryptingCertStore);
int cloudsso_saml_setidentityproviderencryptingcertstore(void* lpObj, const char* lpIdentityProviderEncryptingCertStore, int lenIdentityProviderEncryptingCertStore);
char* cloudsso_saml_getidentityproviderencryptingcertstorepassword(void* lpObj);
int cloudsso_saml_setidentityproviderencryptingcertstorepassword(void* lpObj, const char* lpszIdentityProviderEncryptingCertStorePassword);
int cloudsso_saml_getidentityproviderencryptingcertstoretype(void* lpObj);
int cloudsso_saml_setidentityproviderencryptingcertstoretype(void* lpObj, int iIdentityProviderEncryptingCertStoreType);
char* cloudsso_saml_getidentityproviderencryptingcertsubject(void* lpObj);
int cloudsso_saml_setidentityproviderencryptingcertsubject(void* lpObj, const char* lpszIdentityProviderEncryptingCertSubject);
int cloudsso_saml_getidentityproviderencryptingcertencoded(void* lpObj, char** lpIdentityProviderEncryptingCertEncoded, int* lenIdentityProviderEncryptingCertEncoded);
int cloudsso_saml_setidentityproviderencryptingcertencoded(void* lpObj, const char* lpIdentityProviderEncryptingCertEncoded, int lenIdentityProviderEncryptingCertEncoded);
QByteArray GetIdentityProviderEncryptingCertStore();
int SetIdentityProviderEncryptingCertStore(QByteArray qbaIdentityProviderEncryptingCertStore); QString GetIdentityProviderEncryptingCertStorePassword();
int SetIdentityProviderEncryptingCertStorePassword(QString qsIdentityProviderEncryptingCertStorePassword); int GetIdentityProviderEncryptingCertStoreType();
int SetIdentityProviderEncryptingCertStoreType(int iIdentityProviderEncryptingCertStoreType); QString GetIdentityProviderEncryptingCertSubject();
int SetIdentityProviderEncryptingCertSubject(QString qsIdentityProviderEncryptingCertSubject); QByteArray GetIdentityProviderEncryptingCertEncoded();
int SetIdentityProviderEncryptingCertEncoded(QByteArray qbaIdentityProviderEncryptingCertEncoded);

Remarks

This property contains the certificate used to decrypt if encryption is found while parsing. This certificate will need to have access to its private key to be able to successfully decrypt.

This property is not available at design time.

Data Type

CloudSSOCertificate

IdentityProviderMetadata Property (SAML Class)

Information about the identity provider.

Syntax

CloudSSOIdentityProviderMetadata* GetIdentityProviderMetadata();
int SetIdentityProviderMetadata(CloudSSOIdentityProviderMetadata* val);
char* cloudsso_saml_getidentityprovidermetadataentityid(void* lpObj);
int cloudsso_saml_setidentityprovidermetadataentityid(void* lpObj, const char* lpszIdentityProviderMetadataEntityId);
char* cloudsso_saml_getidentityprovidermetadataexpirationdate(void* lpObj);
int cloudsso_saml_getidentityprovidermetadatametadatacontent(void* lpObj, char** lpIdentityProviderMetadataMetadataContent, int* lenIdentityProviderMetadataMetadataContent);
int cloudsso_saml_setidentityprovidermetadatametadatacontent(void* lpObj, const char* lpIdentityProviderMetadataMetadataContent, int lenIdentityProviderMetadataMetadataContent);
int cloudsso_saml_getidentityprovidermetadatarequestssignedauthnrequests(void* lpObj);
int cloudsso_saml_setidentityprovidermetadatarequestssignedauthnrequests(void* lpObj, int bIdentityProviderMetadataRequestsSignedAuthnRequests);
int cloudsso_saml_getidentityprovidermetadatasignedmetadata(void* lpObj);
char* cloudsso_saml_getidentityprovidermetadatasupportedattributeprofiles(void* lpObj);
char* cloudsso_saml_getidentityprovidermetadatasupportedattributes(void* lpObj);
char* cloudsso_saml_getidentityprovidermetadatasupportednameidformats(void* lpObj);
QString GetIdentityProviderMetadataEntityId();
int SetIdentityProviderMetadataEntityId(QString qsIdentityProviderMetadataEntityId); QString GetIdentityProviderMetadataExpirationDate(); QByteArray GetIdentityProviderMetadataMetadataContent();
int SetIdentityProviderMetadataMetadataContent(QByteArray qbaIdentityProviderMetadataMetadataContent); bool GetIdentityProviderMetadataRequestsSignedAuthnRequests();
int SetIdentityProviderMetadataRequestsSignedAuthnRequests(bool bIdentityProviderMetadataRequestsSignedAuthnRequests); bool GetIdentityProviderMetadataSignedMetadata(); QString GetIdentityProviderMetadataSupportedAttributeProfiles(); QString GetIdentityProviderMetadataSupportedAttributes(); QString GetIdentityProviderMetadataSupportedNameIdFormats();

Remarks

This property contains information about the identity provider that is used when building requests or validating SAMLResponses or assertions. This can be set manually, by calling the LoadIdentityMetadata method, or by retrieving it using the RequestIdentityMetadata method.

Data Type

CloudSSOIdentityProviderMetadata

IdentityProviderSigningCert Property (SAML Class)

The certificate used to verify signatures in responses from an identity provider.

Syntax

CloudSSOCertificate* GetIdentityProviderSigningCert();
int SetIdentityProviderSigningCert(CloudSSOCertificate* val);
int cloudsso_saml_getidentityprovidersigningcertstore(void* lpObj, char** lpIdentityProviderSigningCertStore, int* lenIdentityProviderSigningCertStore);
int cloudsso_saml_setidentityprovidersigningcertstore(void* lpObj, const char* lpIdentityProviderSigningCertStore, int lenIdentityProviderSigningCertStore);
char* cloudsso_saml_getidentityprovidersigningcertstorepassword(void* lpObj);
int cloudsso_saml_setidentityprovidersigningcertstorepassword(void* lpObj, const char* lpszIdentityProviderSigningCertStorePassword);
int cloudsso_saml_getidentityprovidersigningcertstoretype(void* lpObj);
int cloudsso_saml_setidentityprovidersigningcertstoretype(void* lpObj, int iIdentityProviderSigningCertStoreType);
char* cloudsso_saml_getidentityprovidersigningcertsubject(void* lpObj);
int cloudsso_saml_setidentityprovidersigningcertsubject(void* lpObj, const char* lpszIdentityProviderSigningCertSubject);
int cloudsso_saml_getidentityprovidersigningcertencoded(void* lpObj, char** lpIdentityProviderSigningCertEncoded, int* lenIdentityProviderSigningCertEncoded);
int cloudsso_saml_setidentityprovidersigningcertencoded(void* lpObj, const char* lpIdentityProviderSigningCertEncoded, int lenIdentityProviderSigningCertEncoded);
QByteArray GetIdentityProviderSigningCertStore();
int SetIdentityProviderSigningCertStore(QByteArray qbaIdentityProviderSigningCertStore); QString GetIdentityProviderSigningCertStorePassword();
int SetIdentityProviderSigningCertStorePassword(QString qsIdentityProviderSigningCertStorePassword); int GetIdentityProviderSigningCertStoreType();
int SetIdentityProviderSigningCertStoreType(int iIdentityProviderSigningCertStoreType); QString GetIdentityProviderSigningCertSubject();
int SetIdentityProviderSigningCertSubject(QString qsIdentityProviderSigningCertSubject); QByteArray GetIdentityProviderSigningCertEncoded();
int SetIdentityProviderSigningCertEncoded(QByteArray qbaIdentityProviderSigningCertEncoded);

Remarks

This property contains the public certificate from the identity provider that will be used to verify any signatures found. Typically, this certificate is provided by the identity provider's SAML metadata document. See LoadIdentityMetadata and RequestIdentityMetadata for more information.

This property is not available at design time.

Data Type

CloudSSOCertificate

IdentityProviderURIs Property (SAML Class)

The URIs for an identity provider.

Syntax

CloudSSOList<CloudSSOURI>* GetIdentityProviderURIs();
int SetIdentityProviderURIs(CloudSSOList<CloudSSOURI>* val);
int cloudsso_saml_getidentityprovideruricount(void* lpObj);
int cloudsso_saml_setidentityprovideruricount(void* lpObj, int iIdentityProviderURICount);
char* cloudsso_saml_getidentityprovideruribindingref(void* lpObj, int identityprovideruriidx);
int cloudsso_saml_setidentityprovideruribindingref(void* lpObj, int identityprovideruriidx, const char* lpszIdentityProviderURIBindingRef);
int cloudsso_saml_getidentityprovideruribindingtype(void* lpObj, int identityprovideruriidx);
int cloudsso_saml_setidentityprovideruribindingtype(void* lpObj, int identityprovideruriidx, int iIdentityProviderURIBindingType);
int cloudsso_saml_getidentityprovideruriisdefault(void* lpObj, int identityprovideruriidx);
int cloudsso_saml_setidentityprovideruriisdefault(void* lpObj, int identityprovideruriidx, int bIdentityProviderURIIsDefault);
char* cloudsso_saml_getidentityproviderurilocation(void* lpObj, int identityprovideruriidx);
int cloudsso_saml_setidentityproviderurilocation(void* lpObj, int identityprovideruriidx, const char* lpszIdentityProviderURILocation);
int cloudsso_saml_getidentityprovideruriindex(void* lpObj, int identityprovideruriidx);
int cloudsso_saml_setidentityprovideruriindex(void* lpObj, int identityprovideruriidx, int iIdentityProviderURIIndex);
int cloudsso_saml_getidentityprovideruritype(void* lpObj, int identityprovideruriidx);
int cloudsso_saml_setidentityprovideruritype(void* lpObj, int identityprovideruriidx, int iIdentityProviderURIType);
int GetIdentityProviderURICount();
int SetIdentityProviderURICount(int iIdentityProviderURICount); QString GetIdentityProviderURIBindingRef(int iIdentityProviderURIIdx);
int SetIdentityProviderURIBindingRef(int iIdentityProviderURIIdx, QString qsIdentityProviderURIBindingRef); int GetIdentityProviderURIBindingType(int iIdentityProviderURIIdx);
int SetIdentityProviderURIBindingType(int iIdentityProviderURIIdx, int iIdentityProviderURIBindingType); bool GetIdentityProviderURIIsDefault(int iIdentityProviderURIIdx);
int SetIdentityProviderURIIsDefault(int iIdentityProviderURIIdx, bool bIdentityProviderURIIsDefault); QString GetIdentityProviderURILocation(int iIdentityProviderURIIdx);
int SetIdentityProviderURILocation(int iIdentityProviderURIIdx, QString qsIdentityProviderURILocation); int GetIdentityProviderURIIndex(int iIdentityProviderURIIdx);
int SetIdentityProviderURIIndex(int iIdentityProviderURIIdx, int iIdentityProviderURIIndex); int GetIdentityProviderURIType(int iIdentityProviderURIIdx);
int SetIdentityProviderURIType(int iIdentityProviderURIIdx, int iIdentityProviderURIType);

Remarks

This properties contains a list of URIs that are supported by the Identity Provider. Typically, these URIs are provided by the identity provider's SAML metadata document. See LoadIdentityMetadata and RequestIdentityMetadata for more information.

Data Type

CloudSSOURI

Proxy Property (SAML Class)

A set of properties related to proxy access.

Syntax

CloudSSOProxy* GetProxy();
int SetProxy(CloudSSOProxy* val);
int cloudsso_saml_getproxyauthscheme(void* lpObj);
int cloudsso_saml_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int cloudsso_saml_getproxyautodetect(void* lpObj);
int cloudsso_saml_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
char* cloudsso_saml_getproxypassword(void* lpObj);
int cloudsso_saml_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int cloudsso_saml_getproxyport(void* lpObj);
int cloudsso_saml_setproxyport(void* lpObj, int iProxyPort);
char* cloudsso_saml_getproxyserver(void* lpObj);
int cloudsso_saml_setproxyserver(void* lpObj, const char* lpszProxyServer);
int cloudsso_saml_getproxyssl(void* lpObj);
int cloudsso_saml_setproxyssl(void* lpObj, int iProxySSL);
char* cloudsso_saml_getproxyuser(void* lpObj);
int cloudsso_saml_setproxyuser(void* lpObj, const char* lpszProxyUser);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); QString GetProxyServer();
int SetProxyServer(QString qsProxyServer); int GetProxySSL();
int SetProxySSL(int iProxySSL); QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

CloudSSOProxy

RelayState Property (SAML Class)

The RelayState for a SAMLRequest or SAMLResponse.

Syntax

ANSI (Cross Platform)
char* GetRelayState();
int SetRelayState(const char* lpszRelayState); Unicode (Windows) LPWSTR GetRelayState();
INT SetRelayState(LPCWSTR lpszRelayState);
char* cloudsso_saml_getrelaystate(void* lpObj);
int cloudsso_saml_setrelaystate(void* lpObj, const char* lpszRelayState);
QString GetRelayState();
int SetRelayState(QString qsRelayState);

Default Value

""

Remarks

When set before building a request using the BuildAuthnRequest and BuildLogoutRequest methods, this property will set the RelayState parameter. Any value may be specified here and it will be returned exactly as it was sent. This can be used to maintain state within the application, and also may be used for security purposes. The contents of this property are treated as an opaque value.

Data Type

String

SAMLRequestBody Property (SAML Class)

The HTTP body for a SAMLRequest.

Syntax

ANSI (Cross Platform)
int GetSAMLRequestBody(char* &lpSAMLRequestBody, int &lenSAMLRequestBody);

Unicode (Windows)
INT GetSAMLRequestBody(LPSTR &lpSAMLRequestBody, INT &lenSAMLRequestBody);
int cloudsso_saml_getsamlrequestbody(void* lpObj, char** lpSAMLRequestBody, int* lenSAMLRequestBody);
QByteArray GetSAMLRequestBody();

Default Value

""

Remarks

This property contains the generated HTTP body for the request that should be provided to the SAMLRequestURL if required by the selected binding. It is generated alongside the SAMLRequestURL property when calling BuildAuthnRequest or BuildLogoutRequest.

This property is read-only.

Data Type

Binary String

SAMLRequestSettings Property (SAML Class)

The settings for a SAMLRequest.

Syntax

CloudSSOSAMLRequestSettings* GetSAMLRequestSettings();
int SetSAMLRequestSettings(CloudSSOSAMLRequestSettings* val);
int cloudsso_saml_getsamlrequestallowcreate(void* lpObj);
int cloudsso_saml_setsamlrequestallowcreate(void* lpObj, int bSAMLRequestAllowCreate);
int cloudsso_saml_getsamlrequestconsent(void* lpObj);
int cloudsso_saml_setsamlrequestconsent(void* lpObj, int iSAMLRequestConsent);
char* cloudsso_saml_getsamlrequestdestination(void* lpObj);
int cloudsso_saml_setsamlrequestdestination(void* lpObj, const char* lpszSAMLRequestDestination);
char* cloudsso_saml_getsamlrequestid(void* lpObj);
int cloudsso_saml_setsamlrequestid(void* lpObj, const char* lpszSAMLRequestId);
char* cloudsso_saml_getsamlrequestissuedtime(void* lpObj);
int cloudsso_saml_setsamlrequestissuedtime(void* lpObj, const char* lpszSAMLRequestIssuedTime);
char* cloudsso_saml_getsamlrequestissuer(void* lpObj);
int cloudsso_saml_setsamlrequestissuer(void* lpObj, const char* lpszSAMLRequestIssuer);
int cloudsso_saml_getsamlrequestnameidformat(void* lpObj);
int cloudsso_saml_setsamlrequestnameidformat(void* lpObj, int iSAMLRequestNameIdFormat);
int cloudsso_saml_getsamlrequestrequestbinding(void* lpObj);
int cloudsso_saml_setsamlrequestrequestbinding(void* lpObj, int iSAMLRequestRequestBinding);
int cloudsso_saml_getsamlrequestselectedendpoint(void* lpObj);
int cloudsso_saml_setsamlrequestselectedendpoint(void* lpObj, int iSAMLRequestSelectedEndpoint);
int cloudsso_saml_getsamlrequestsignrequest(void* lpObj);
int cloudsso_saml_setsamlrequestsignrequest(void* lpObj, int bSAMLRequestSignRequest);
int cloudsso_saml_getsamlrequestusedefaultendpoint(void* lpObj);
int cloudsso_saml_setsamlrequestusedefaultendpoint(void* lpObj, int bSAMLRequestUseDefaultEndpoint);
bool GetSAMLRequestAllowCreate();
int SetSAMLRequestAllowCreate(bool bSAMLRequestAllowCreate); int GetSAMLRequestConsent();
int SetSAMLRequestConsent(int iSAMLRequestConsent); QString GetSAMLRequestDestination();
int SetSAMLRequestDestination(QString qsSAMLRequestDestination); QString GetSAMLRequestId();
int SetSAMLRequestId(QString qsSAMLRequestId); QString GetSAMLRequestIssuedTime();
int SetSAMLRequestIssuedTime(QString qsSAMLRequestIssuedTime); QString GetSAMLRequestIssuer();
int SetSAMLRequestIssuer(QString qsSAMLRequestIssuer); int GetSAMLRequestNameIdFormat();
int SetSAMLRequestNameIdFormat(int iSAMLRequestNameIdFormat); int GetSAMLRequestRequestBinding();
int SetSAMLRequestRequestBinding(int iSAMLRequestRequestBinding); int GetSAMLRequestSelectedEndpoint();
int SetSAMLRequestSelectedEndpoint(int iSAMLRequestSelectedEndpoint); bool GetSAMLRequestSignRequest();
int SetSAMLRequestSignRequest(bool bSAMLRequestSignRequest); bool GetSAMLRequestUseDefaultEndpoint();
int SetSAMLRequestUseDefaultEndpoint(bool bSAMLRequestUseDefaultEndpoint);

Remarks

This property is used to configure the SAMLRequest built by the BuildAuthnRequest or BuildLogoutRequest methods.

Data Type

CloudSSOSAMLRequestSettings

SAMLRequestURL Property (SAML Class)

The URL for SAMLRequests.

Syntax

ANSI (Cross Platform)
char* GetSAMLRequestURL();

Unicode (Windows)
LPWSTR GetSAMLRequestURL();
char* cloudsso_saml_getsamlrequesturl(void* lpObj);
QString GetSAMLRequestURL();

Default Value

""

Remarks

This property contains the generated URL to an identity provider for a sign-on or logoff service. Depending on the binding used, the URL may contain the SAMLRequest, or the SAMLRequestBody property will be populated to be sent along with the request. It is generated using the BuildAuthnRequest or BuildLogoutRequest methods.

This property is read-only.

Data Type

String

SAMLResponseBody Property (SAML Class)

The HTTP body for the current SAMLResponse.

Syntax

ANSI (Cross Platform)
int GetSAMLResponseBody(char* &lpSAMLResponseBody, int &lenSAMLResponseBody);
int SetSAMLResponseBody(const char* lpSAMLResponseBody, int lenSAMLResponseBody); Unicode (Windows) INT GetSAMLResponseBody(LPSTR &lpSAMLResponseBody, INT &lenSAMLResponseBody);
INT SetSAMLResponseBody(LPCSTR lpSAMLResponseBody, INT lenSAMLResponseBody);
int cloudsso_saml_getsamlresponsebody(void* lpObj, char** lpSAMLResponseBody, int* lenSAMLResponseBody);
int cloudsso_saml_setsamlresponsebody(void* lpObj, const char* lpSAMLResponseBody, int lenSAMLResponseBody);
QByteArray GetSAMLResponseBody();
int SetSAMLResponseBody(QByteArray qbaSAMLResponseBody);

Default Value

""

Remarks

This property can be set before calling the ParseSAMLResponse or ProcessSAMLResponse methods to directly provide the HTTP body of the SAMLResponse that should be parsed. If using the HTTP context, this property is populated with the HTTP body containing the SAMLResponse that was parsed from the HTTP context after calling ParseSAMLResponse or ProcessSAMLResponse.

Data Type

Binary String

SAMLResponseHeaders Property (SAML Class)

The HTTP headers for the current SAMLResponse.

Syntax

ANSI (Cross Platform)
char* GetSAMLResponseHeaders();
int SetSAMLResponseHeaders(const char* lpszSAMLResponseHeaders); Unicode (Windows) LPWSTR GetSAMLResponseHeaders();
INT SetSAMLResponseHeaders(LPCWSTR lpszSAMLResponseHeaders);
char* cloudsso_saml_getsamlresponseheaders(void* lpObj);
int cloudsso_saml_setsamlresponseheaders(void* lpObj, const char* lpszSAMLResponseHeaders);
QString GetSAMLResponseHeaders();
int SetSAMLResponseHeaders(QString qsSAMLResponseHeaders);

Default Value

""

Remarks

This property can be set before calling the ParseSAMLResponse or ProcessSAMLResponse methods to directly provide the HTTP headers that contain the SAMLResponse from the Identity Provider. If using the HTTP context, this property is populated with the HTTP headers that were parsed from the HTTP context after calling ParseSAMLResponse or ProcessSAMLResponse.

Data Type

String

SAMLResponseInfo Property (SAML Class)

Information about a SAMLResponse.

Syntax

CloudSSOSAMLResponseInfo* GetSAMLResponseInfo();
int SetSAMLResponseInfo(CloudSSOSAMLResponseInfo* val);
char* cloudsso_saml_getsamlresponseconsent(void* lpObj);
char* cloudsso_saml_getsamlresponsedestination(void* lpObj);
char* cloudsso_saml_getsamlresponseinresponseto(void* lpObj);
char* cloudsso_saml_getsamlresponseissuedtime(void* lpObj);
char* cloudsso_saml_getsamlresponseissuer(void* lpObj);
int cloudsso_saml_getsamlresponseresponsecontent(void* lpObj, char** lpSAMLResponseResponseContent, int* lenSAMLResponseResponseContent);
int cloudsso_saml_setsamlresponseresponsecontent(void* lpObj, const char* lpSAMLResponseResponseContent, int lenSAMLResponseResponseContent);
char* cloudsso_saml_getsamlresponseresponseid(void* lpObj);
int cloudsso_saml_getsamlresponseresponsetype(void* lpObj);
int cloudsso_saml_getsamlresponsesigned(void* lpObj);
char* cloudsso_saml_getsamlresponsestatuscodes(void* lpObj);
char* cloudsso_saml_getsamlresponsestatusmessage(void* lpObj);
QString GetSAMLResponseConsent();

QString GetSAMLResponseDestination();

QString GetSAMLResponseInResponseTo();

QString GetSAMLResponseIssuedTime();

QString GetSAMLResponseIssuer();

QByteArray GetSAMLResponseResponseContent();
int SetSAMLResponseResponseContent(QByteArray qbaSAMLResponseResponseContent); QString GetSAMLResponseResponseId(); int GetSAMLResponseResponseType(); bool GetSAMLResponseSigned(); QString GetSAMLResponseStatusCodes(); QString GetSAMLResponseStatusMessage();

Remarks

This property provides information about the recently parsed SAMLResponse. It can be set when calling the ProcessSAMLResponse or ParseSAMLResponse methods. It can also be used to provide a stored SAMLResponse manually to the class.

Data Type

CloudSSOSAMLResponseInfo

ServiceProviderMetadata Property (SAML Class)

Information about a service provider's SAML metadata document.

Syntax

CloudSSOServiceProviderMetadata* GetServiceProviderMetadata();
int SetServiceProviderMetadata(CloudSSOServiceProviderMetadata* val);
int cloudsso_saml_getserviceprovidermetadataauthnrequestsigned(void* lpObj);
int cloudsso_saml_setserviceprovidermetadataauthnrequestsigned(void* lpObj, int bServiceProviderMetadataAuthnRequestSigned);
char* cloudsso_saml_getserviceprovidermetadataentityid(void* lpObj);
int cloudsso_saml_setserviceprovidermetadataentityid(void* lpObj, const char* lpszServiceProviderMetadataEntityId);
int cloudsso_saml_getserviceprovidermetadatametadatacontent(void* lpObj, char** lpServiceProviderMetadataMetadataContent, int* lenServiceProviderMetadataMetadataContent);
int cloudsso_saml_setserviceprovidermetadatametadatacontent(void* lpObj, const char* lpServiceProviderMetadataMetadataContent, int lenServiceProviderMetadataMetadataContent);
int cloudsso_saml_getserviceprovidermetadatasignedmetadata(void* lpObj);
int cloudsso_saml_setserviceprovidermetadatasignedmetadata(void* lpObj, int bServiceProviderMetadataSignedMetadata);
char* cloudsso_saml_getserviceprovidermetadatasupportednameidformats(void* lpObj);
int cloudsso_saml_setserviceprovidermetadatasupportednameidformats(void* lpObj, const char* lpszServiceProviderMetadataSupportedNameIdFormats);
int cloudsso_saml_getserviceprovidermetadatawantassertionssigned(void* lpObj);
int cloudsso_saml_setserviceprovidermetadatawantassertionssigned(void* lpObj, int bServiceProviderMetadataWantAssertionsSigned);
bool GetServiceProviderMetadataAuthnRequestSigned();
int SetServiceProviderMetadataAuthnRequestSigned(bool bServiceProviderMetadataAuthnRequestSigned); QString GetServiceProviderMetadataEntityId();
int SetServiceProviderMetadataEntityId(QString qsServiceProviderMetadataEntityId); QByteArray GetServiceProviderMetadataMetadataContent();
int SetServiceProviderMetadataMetadataContent(QByteArray qbaServiceProviderMetadataMetadataContent); bool GetServiceProviderMetadataSignedMetadata();
int SetServiceProviderMetadataSignedMetadata(bool bServiceProviderMetadataSignedMetadata); QString GetServiceProviderMetadataSupportedNameIdFormats();
int SetServiceProviderMetadataSupportedNameIdFormats(QString qsServiceProviderMetadataSupportedNameIdFormats); bool GetServiceProviderMetadataWantAssertionsSigned();
int SetServiceProviderMetadataWantAssertionsSigned(bool bServiceProviderMetadataWantAssertionsSigned);

Remarks

This property contains the settings needed to generate the service provider's (this application) SAML metadata document to be given to the identity provider.

Data Type

CloudSSOServiceProviderMetadata

ServiceProviderSigningCert Property (SAML Class)

The certificate used by the service provider when signing a SAMLRequest or SAML metadata document.

Syntax

CloudSSOCertificate* GetServiceProviderSigningCert();
int SetServiceProviderSigningCert(CloudSSOCertificate* val);
int cloudsso_saml_getserviceprovidersigningcertstore(void* lpObj, char** lpServiceProviderSigningCertStore, int* lenServiceProviderSigningCertStore);
int cloudsso_saml_setserviceprovidersigningcertstore(void* lpObj, const char* lpServiceProviderSigningCertStore, int lenServiceProviderSigningCertStore);
char* cloudsso_saml_getserviceprovidersigningcertstorepassword(void* lpObj);
int cloudsso_saml_setserviceprovidersigningcertstorepassword(void* lpObj, const char* lpszServiceProviderSigningCertStorePassword);
int cloudsso_saml_getserviceprovidersigningcertstoretype(void* lpObj);
int cloudsso_saml_setserviceprovidersigningcertstoretype(void* lpObj, int iServiceProviderSigningCertStoreType);
char* cloudsso_saml_getserviceprovidersigningcertsubject(void* lpObj);
int cloudsso_saml_setserviceprovidersigningcertsubject(void* lpObj, const char* lpszServiceProviderSigningCertSubject);
int cloudsso_saml_getserviceprovidersigningcertencoded(void* lpObj, char** lpServiceProviderSigningCertEncoded, int* lenServiceProviderSigningCertEncoded);
int cloudsso_saml_setserviceprovidersigningcertencoded(void* lpObj, const char* lpServiceProviderSigningCertEncoded, int lenServiceProviderSigningCertEncoded);
QByteArray GetServiceProviderSigningCertStore();
int SetServiceProviderSigningCertStore(QByteArray qbaServiceProviderSigningCertStore); QString GetServiceProviderSigningCertStorePassword();
int SetServiceProviderSigningCertStorePassword(QString qsServiceProviderSigningCertStorePassword); int GetServiceProviderSigningCertStoreType();
int SetServiceProviderSigningCertStoreType(int iServiceProviderSigningCertStoreType); QString GetServiceProviderSigningCertSubject();
int SetServiceProviderSigningCertSubject(QString qsServiceProviderSigningCertSubject); QByteArray GetServiceProviderSigningCertEncoded();
int SetServiceProviderSigningCertEncoded(QByteArray qbaServiceProviderSigningCertEncoded);

Remarks

This property contains the certificate that should be used if the SAMLRequest (Authn and Logout) needs to be signed when calling BuildAuthnRequest or BuildLogoutRequest. Additionally, if required, this certificate is used to sign a SAML metadata document when calling the BuildServiceMetadata method.

This property is not available at design time.

Data Type

CloudSSOCertificate

ServiceProviderURIs Property (SAML Class)

Information about the URIs for a service provider.

Syntax

CloudSSOList<CloudSSOURI>* GetServiceProviderURIs();
int SetServiceProviderURIs(CloudSSOList<CloudSSOURI>* val);
int cloudsso_saml_getserviceprovideruricount(void* lpObj);
int cloudsso_saml_setserviceprovideruricount(void* lpObj, int iServiceProviderURICount);
char* cloudsso_saml_getserviceprovideruribindingref(void* lpObj, int serviceprovideruriidx);
int cloudsso_saml_setserviceprovideruribindingref(void* lpObj, int serviceprovideruriidx, const char* lpszServiceProviderURIBindingRef);
int cloudsso_saml_getserviceprovideruribindingtype(void* lpObj, int serviceprovideruriidx);
int cloudsso_saml_setserviceprovideruribindingtype(void* lpObj, int serviceprovideruriidx, int iServiceProviderURIBindingType);
int cloudsso_saml_getserviceprovideruriisdefault(void* lpObj, int serviceprovideruriidx);
int cloudsso_saml_setserviceprovideruriisdefault(void* lpObj, int serviceprovideruriidx, int bServiceProviderURIIsDefault);
char* cloudsso_saml_getserviceproviderurilocation(void* lpObj, int serviceprovideruriidx);
int cloudsso_saml_setserviceproviderurilocation(void* lpObj, int serviceprovideruriidx, const char* lpszServiceProviderURILocation);
int cloudsso_saml_getserviceprovideruriindex(void* lpObj, int serviceprovideruriidx);
int cloudsso_saml_setserviceprovideruriindex(void* lpObj, int serviceprovideruriidx, int iServiceProviderURIIndex);
int cloudsso_saml_getserviceprovideruritype(void* lpObj, int serviceprovideruriidx);
int cloudsso_saml_setserviceprovideruritype(void* lpObj, int serviceprovideruriidx, int iServiceProviderURIType);
int GetServiceProviderURICount();
int SetServiceProviderURICount(int iServiceProviderURICount); QString GetServiceProviderURIBindingRef(int iServiceProviderURIIdx);
int SetServiceProviderURIBindingRef(int iServiceProviderURIIdx, QString qsServiceProviderURIBindingRef); int GetServiceProviderURIBindingType(int iServiceProviderURIIdx);
int SetServiceProviderURIBindingType(int iServiceProviderURIIdx, int iServiceProviderURIBindingType); bool GetServiceProviderURIIsDefault(int iServiceProviderURIIdx);
int SetServiceProviderURIIsDefault(int iServiceProviderURIIdx, bool bServiceProviderURIIsDefault); QString GetServiceProviderURILocation(int iServiceProviderURIIdx);
int SetServiceProviderURILocation(int iServiceProviderURIIdx, QString qsServiceProviderURILocation); int GetServiceProviderURIIndex(int iServiceProviderURIIdx);
int SetServiceProviderURIIndex(int iServiceProviderURIIdx, int iServiceProviderURIIndex); int GetServiceProviderURIType(int iServiceProviderURIIdx);
int SetServiceProviderURIType(int iServiceProviderURIIdx, int iServiceProviderURIType);

Remarks

This properties contains a list of URIs that are used by the service provider (this application) and should be provided to the identity provider. This is used when building the service provider's SAML metadata document during the BuildServiceMetadata method. When building an authentication request using the BuildAuthnRequest method, the class will use the fisrt URI from this properties if UseDefaultEndpoint and SelectedEndpoint are not set. When validating a SAMLResponse or assertion, these URIs are used to validate the destination or recipient attributes respectively. See ValidateSAMLResponse and ValidateAssertion for more information.

Data Type

CloudSSOURI

SSLAcceptServerCert Property (SAML Class)

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

Syntax

CloudSSOCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudSSOCertificate* val);
char* cloudsso_saml_getsslacceptservercerteffectivedate(void* lpObj);
char* cloudsso_saml_getsslacceptservercertexpirationdate(void* lpObj);
char* cloudsso_saml_getsslacceptservercertextendedkeyusage(void* lpObj);
char* cloudsso_saml_getsslacceptservercertfingerprint(void* lpObj);
char* cloudsso_saml_getsslacceptservercertfingerprintsha1(void* lpObj);
char* cloudsso_saml_getsslacceptservercertfingerprintsha256(void* lpObj);
char* cloudsso_saml_getsslacceptservercertissuer(void* lpObj);
char* cloudsso_saml_getsslacceptservercertprivatekey(void* lpObj);
int cloudsso_saml_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* cloudsso_saml_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* cloudsso_saml_getsslacceptservercertpublickey(void* lpObj);
char* cloudsso_saml_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int cloudsso_saml_getsslacceptservercertpublickeylength(void* lpObj);
char* cloudsso_saml_getsslacceptservercertserialnumber(void* lpObj);
char* cloudsso_saml_getsslacceptservercertsignaturealgorithm(void* lpObj);
int cloudsso_saml_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudsso_saml_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* cloudsso_saml_getsslacceptservercertstorepassword(void* lpObj);
int cloudsso_saml_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int cloudsso_saml_getsslacceptservercertstoretype(void* lpObj);
int cloudsso_saml_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* cloudsso_saml_getsslacceptservercertsubjectaltnames(void* lpObj);
char* cloudsso_saml_getsslacceptservercertthumbprintmd5(void* lpObj);
char* cloudsso_saml_getsslacceptservercertthumbprintsha1(void* lpObj);
char* cloudsso_saml_getsslacceptservercertthumbprintsha256(void* lpObj);
char* cloudsso_saml_getsslacceptservercertusage(void* lpObj);
int cloudsso_saml_getsslacceptservercertusageflags(void* lpObj);
char* cloudsso_saml_getsslacceptservercertversion(void* lpObj);
char* cloudsso_saml_getsslacceptservercertsubject(void* lpObj);
int cloudsso_saml_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int cloudsso_saml_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudsso_saml_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore); QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword); int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType); QString GetSSLAcceptServerCertSubjectAltNames(); QString GetSSLAcceptServerCertThumbprintMD5(); QString GetSSLAcceptServerCertThumbprintSHA1(); QString GetSSLAcceptServerCertThumbprintSHA256(); QString GetSSLAcceptServerCertUsage(); int GetSSLAcceptServerCertUsageFlags(); QString GetSSLAcceptServerCertVersion(); QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject); QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

CloudSSOCertificate

SSLCert Property (SAML Class)

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

Syntax

CloudSSOCertificate* GetSSLCert();
int SetSSLCert(CloudSSOCertificate* val);
char* cloudsso_saml_getsslcerteffectivedate(void* lpObj);
char* cloudsso_saml_getsslcertexpirationdate(void* lpObj);
char* cloudsso_saml_getsslcertextendedkeyusage(void* lpObj);
char* cloudsso_saml_getsslcertfingerprint(void* lpObj);
char* cloudsso_saml_getsslcertfingerprintsha1(void* lpObj);
char* cloudsso_saml_getsslcertfingerprintsha256(void* lpObj);
char* cloudsso_saml_getsslcertissuer(void* lpObj);
char* cloudsso_saml_getsslcertprivatekey(void* lpObj);
int cloudsso_saml_getsslcertprivatekeyavailable(void* lpObj);
char* cloudsso_saml_getsslcertprivatekeycontainer(void* lpObj);
char* cloudsso_saml_getsslcertpublickey(void* lpObj);
char* cloudsso_saml_getsslcertpublickeyalgorithm(void* lpObj);
int cloudsso_saml_getsslcertpublickeylength(void* lpObj);
char* cloudsso_saml_getsslcertserialnumber(void* lpObj);
char* cloudsso_saml_getsslcertsignaturealgorithm(void* lpObj);
int cloudsso_saml_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudsso_saml_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* cloudsso_saml_getsslcertstorepassword(void* lpObj);
int cloudsso_saml_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int cloudsso_saml_getsslcertstoretype(void* lpObj);
int cloudsso_saml_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* cloudsso_saml_getsslcertsubjectaltnames(void* lpObj);
char* cloudsso_saml_getsslcertthumbprintmd5(void* lpObj);
char* cloudsso_saml_getsslcertthumbprintsha1(void* lpObj);
char* cloudsso_saml_getsslcertthumbprintsha256(void* lpObj);
char* cloudsso_saml_getsslcertusage(void* lpObj);
int cloudsso_saml_getsslcertusageflags(void* lpObj);
char* cloudsso_saml_getsslcertversion(void* lpObj);
char* cloudsso_saml_getsslcertsubject(void* lpObj);
int cloudsso_saml_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int cloudsso_saml_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudsso_saml_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore); QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword); int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); QString GetSSLCertSubjectAltNames(); QString GetSSLCertThumbprintMD5(); QString GetSSLCertThumbprintSHA1(); QString GetSSLCertThumbprintSHA256(); QString GetSSLCertUsage(); int GetSSLCertUsageFlags(); QString GetSSLCertVersion(); QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject); QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

CloudSSOCertificate

SSLProvider Property (SAML Class)

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

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int cloudsso_saml_getsslprovider(void* lpObj);
int cloudsso_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 as follows:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
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

SSLServerCert Property (SAML Class)

The server certificate for the last established connection.

Syntax

CloudSSOCertificate* GetSSLServerCert();

char* cloudsso_saml_getsslservercerteffectivedate(void* lpObj);
char* cloudsso_saml_getsslservercertexpirationdate(void* lpObj);
char* cloudsso_saml_getsslservercertextendedkeyusage(void* lpObj);
char* cloudsso_saml_getsslservercertfingerprint(void* lpObj);
char* cloudsso_saml_getsslservercertfingerprintsha1(void* lpObj);
char* cloudsso_saml_getsslservercertfingerprintsha256(void* lpObj);
char* cloudsso_saml_getsslservercertissuer(void* lpObj);
char* cloudsso_saml_getsslservercertprivatekey(void* lpObj);
int cloudsso_saml_getsslservercertprivatekeyavailable(void* lpObj);
char* cloudsso_saml_getsslservercertprivatekeycontainer(void* lpObj);
char* cloudsso_saml_getsslservercertpublickey(void* lpObj);
char* cloudsso_saml_getsslservercertpublickeyalgorithm(void* lpObj);
int cloudsso_saml_getsslservercertpublickeylength(void* lpObj);
char* cloudsso_saml_getsslservercertserialnumber(void* lpObj);
char* cloudsso_saml_getsslservercertsignaturealgorithm(void* lpObj);
int cloudsso_saml_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* cloudsso_saml_getsslservercertstorepassword(void* lpObj);
int cloudsso_saml_getsslservercertstoretype(void* lpObj);
char* cloudsso_saml_getsslservercertsubjectaltnames(void* lpObj);
char* cloudsso_saml_getsslservercertthumbprintmd5(void* lpObj);
char* cloudsso_saml_getsslservercertthumbprintsha1(void* lpObj);
char* cloudsso_saml_getsslservercertthumbprintsha256(void* lpObj);
char* cloudsso_saml_getsslservercertusage(void* lpObj);
int cloudsso_saml_getsslservercertusageflags(void* lpObj);
char* cloudsso_saml_getsslservercertversion(void* lpObj);
char* cloudsso_saml_getsslservercertsubject(void* lpObj);
int cloudsso_saml_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

CloudSSOCertificate

BuildAuthnRequest Method (SAML Class)

Builds an Authentication Request.

Syntax

ANSI (Cross Platform)
int BuildAuthnRequest();

Unicode (Windows)
INT BuildAuthnRequest();
int cloudsso_saml_buildauthnrequest(void* lpObj);
int BuildAuthnRequest();

Remarks

Using the SAMLRequestSettings, this method will build a SAMLRequest meant for authenticating the current user. To help keep track of a user's state in your application, the RelayState property can be set to add a RelayState to the request. The value set in the RelayState property will then be present in the response from the Identity Provider. After the request is built, the following properties are set depending on how the RequestBinding field is set.

The Assertion Consumer Service that should handle the response specified in the request depends on how SAMLRequestSettings is configured. If UseDefaultEndpoint is set, the request will specify that the Identity Provider should use the URI that is configured as the default. If SelectedEndpoint is set, the class will use that index in the request. Otherwise, the class will select the first URI set in the ServiceProviderURIs 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.)

BuildLogoutRequest Method (SAML Class)

Builds a Single Logout request.

Syntax

ANSI (Cross Platform)
int BuildLogoutRequest(const char* lpszNameIdentifier);

Unicode (Windows)
INT BuildLogoutRequest(LPCWSTR lpszNameIdentifier);
int cloudsso_saml_buildlogoutrequest(void* lpObj, const char* lpszNameIdentifier);
int BuildLogoutRequest(const QString& qsNameIdentifier);

Remarks

This method uses the SAMLRequestSettings property to build a SAMLRequest that is meant for logging out the user identified by the NameIdentifier parameter. To help keep track of a user's state in your application, the RelayState property can be set to add a RelayState to the request. The value set in the RelayState property will then be present in the response from the Identity Provider. Typically, if supported, the identity provider will also issue logout requests for all other sessions that are active for the user. After the request is built, the following properties are set depending on how the RequestBinding field is set.

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

BuildServiceMetadata Method (SAML Class)

Builds a metadata document for a service provider.

Syntax

ANSI (Cross Platform)
int BuildServiceMetadata();

Unicode (Windows)
INT BuildServiceMetadata();
int cloudsso_saml_buildservicemetadata(void* lpObj);
int BuildServiceMetadata();

Remarks

This method uses the ServiceProviderMetadata property to create a new federation metadata document that describes the service provider. This is typically used to provide information about the service provider to the identity provider. The following fields and properties are used:

Error Handling (C++)

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

Config Method (SAML Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* cloudsso_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.

DoEvents Method (SAML Class)

This method processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
int cloudsso_saml_doevents(void* lpObj);
int DoEvents();

Remarks

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

Error Handling (C++)

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

GetAssertionAttribute Method (SAML Class)

Searches for a specific assertion attribute.

Syntax

ANSI (Cross Platform)
char* GetAssertionAttribute(const char* lpszattrName);

Unicode (Windows)
LPWSTR GetAssertionAttribute(LPCWSTR lpszattrName);
char* cloudsso_saml_getassertionattribute(void* lpObj, const char* lpszattrName);
QString GetAssertionAttribute(const QString& qsattrName);

Remarks

This method will search the current AssertionAttributeInfo properties for a specific attribute. The attrName parameter should be set to the attribute name. The method will then return the value of the attribute with the matching name. If there is more than one value, it will return the values in a semicolon-separated list.

Error Handling (C++)

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

Interrupt Method (SAML Class)

This method interrupts the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
int cloudsso_saml_interrupt(void* lpObj);
int Interrupt();

Remarks

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

Error Handling (C++)

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

LoadIdentityMetadata Method (SAML Class)

Loads an identity provider's metadata document.

Syntax

ANSI (Cross Platform)
int LoadIdentityMetadata(const char* lpszmetadataDocument, int bvalidate);

Unicode (Windows)
INT LoadIdentityMetadata(LPCWSTR lpszmetadataDocument, BOOL bvalidate);
int cloudsso_saml_loadidentitymetadata(void* lpObj, const char* lpszmetadataDocument, int bvalidate);
int LoadIdentityMetadata(const QString& qsmetadataDocument, bool bvalidate);

Remarks

This method loads in the identity provider's metadata document that is provided through the metadataDocument parameter. After the document has been loaded, the IdentityProviderEncryptingCert, IdentityProviderMetadata, IdentityProviderSigningCert and IdentityProviderURIs properties will be set with the information that is available in the document. If the metadata document is signed and the validate parameter is true, the method will also validate the metadata document's signature.

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 an assertion.

Syntax

ANSI (Cross Platform)
int ParseAssertion();

Unicode (Windows)
INT ParseAssertion();
int cloudsso_saml_parseassertion(void* lpObj);
int ParseAssertion();

Remarks

This method parses the assertion found in the AssertionInfo property. The assertion can either be manually set by setting the AssertionContent field or by first calling ParseSAMLResponse on a SAMLResponse that contains an assertion. If the method is able to successfully parse the assertion, the AssertionInfo property is populated along with the AssertionAttributeInfo and AssertionAuthnInfo collections, once for each type of statement found in the assertion.

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

ParseSAMLResponse Method (SAML Class)

Parses a SAMLResponse.

Syntax

ANSI (Cross Platform)
int ParseSAMLResponse();

Unicode (Windows)
INT ParseSAMLResponse();
int cloudsso_saml_parsesamlresponse(void* lpObj);
int ParseSAMLResponse();

Remarks

This method parses the SAMLResponse found in the SAMLResponseInfo property or from the current HTTP request. The HTTP request can be found through the SAMLResponseBody and SAMLResponseHeaders properties or from the current HTTP Context if accessible. The SAMLResponse can also be manually set by setting the ResponseContent field. If the method is able to successfully parse the SAMLResponse, the information fields in the SAMLResponseInfo property are populated.

To validate a SAMLResponse, see ValidateSAMLResponse.

Additionally, if the ResponseType is srtAuthn, the AssertionContent field will be populated. See ValidateAssertion and ParseAssertion for more information on validating and parsing the assertion.

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

ProcessSAMLResponse Method (SAML Class)

Processes the SAMLResponse from the current HTTP request.

Syntax

ANSI (Cross Platform)
int ProcessSAMLResponse();

Unicode (Windows)
INT ProcessSAMLResponse();
int cloudsso_saml_processsamlresponse(void* lpObj);
int ProcessSAMLResponse();

Remarks

This method processes the SAMLResponse found in the current HTTP request and, if applicable, parses and validates the SAMLResponse and optional assertion from the request. The method is equivalent to calling the following methods. See the specific methods for more information.

The HTTP request is taken directly from the SAMLResponseHeaders and SAMLResponseBody properties if set; otherwise, it will try to read the HTTP context.

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

RequestIdentityMetadata Method (SAML Class)

Requests an identity provider's SAML metadata document.

Syntax

ANSI (Cross Platform)
int RequestIdentityMetadata(const char* lpszURL);

Unicode (Windows)
INT RequestIdentityMetadata(LPCWSTR lpszURL);
int cloudsso_saml_requestidentitymetadata(void* lpObj, const char* lpszURL);
int RequestIdentityMetadata(const QString& qsURL);

Remarks

This method makes an HTTP GET request to get the Identity Provider metadata document from the URL location. Once the document has been retrieved, the method will parse and validate the metadata document. After the document has been parsed, the IdentityProviderEncryptingCert, IdentityProviderMetadata, IdentityProviderSigningCert, and IdentityProviderURIs properties will be populated with the information that is available in the document.

Error Handling (C++)

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

Reset Method (SAML Class)

This method will reset the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int cloudsso_saml_reset(void* lpObj);
int Reset();

Remarks

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

Error Handling (C++)

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

ValidateAssertion Method (SAML Class)

Validates an assertion.

Syntax

ANSI (Cross Platform)
int ValidateAssertion();

Unicode (Windows)
INT ValidateAssertion();
int cloudsso_saml_validateassertion(void* lpObj);
int ValidateAssertion();

Remarks

This method validates the assertion found in the AssertionInfo property. The assertion can either be manually set via the AssertionContent field or by first calling ParseSAMLResponse on a SAMLResponse that contains an assertion. Before attempting this validation, the Assertion event provides an opportunity to configure the class to successfully validate the assertion. If the validation fails at any point, the method will throw an exception with the error code corresponding to the reason. The following checks are performed on the assertion:

Validation Check Required Property or Field
Signature IdentityProviderSigningCert
Issuer Element EntityId
InResponseTo Attribute Id
Recipient Attribute ServiceProviderURIs (ACS URI)
NotBefore Attribute N/A
NotOnOrAfter Attribute (Expiration Date) N/A
SessionNotOnOrAfter Attribute (Expiration Date) N/A

To skip certain checks, see AssertionValidationFlags.

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

ValidateSAMLResponse Method (SAML Class)

Validates a SAMLResponse.

Syntax

ANSI (Cross Platform)
int ValidateSAMLResponse();

Unicode (Windows)
INT ValidateSAMLResponse();
int cloudsso_saml_validatesamlresponse(void* lpObj);
int ValidateSAMLResponse();

Remarks

This method validates a SAMLResponse. The SAMLResponse can either be manually set via the ResponseContent field or by first calling ParseSAMLResponse on an HTTP request with a SAMLResponse. Before attempting validation, the SAMLResponse event provides an opportunity to configure the class to successfully validate the SAMLResponse. The following checks are performed on the SAMLResponse:

Validation Check Required Property or Field
Signature (if found) IdentityProviderSigningCert
Issuer Element EntityId
InResponseTo Attribute Id
Destination Attribute ServiceProviderURIs (ACS URI)
Status Element N/A

To skip certain checks, see SAMLResponseValidationFlags. Note that this method does not validate the assertion if one is found within the SAMLResponse. See ValidateAssertion and ParseAssertion for more information on validating and parsing the assertion.

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

Assertion Event (SAML Class)

Fired when an assertion is validated.

Syntax

ANSI (Cross Platform)
virtual int FireAssertion(SAMLAssertionEventParams *e);
typedef struct {
const char *Issuer;
const char *InResponseTo; int reserved; } SAMLAssertionEventParams;
Unicode (Windows) virtual INT FireAssertion(SAMLAssertionEventParams *e);
typedef struct {
LPCWSTR Issuer;
LPCWSTR InResponseTo; INT reserved; } SAMLAssertionEventParams;
#define EID_SAML_ASSERTION 1

virtual INT CLOUDSSO_CALL FireAssertion(LPSTR &lpszIssuer, LPSTR &lpszInResponseTo);
class SAMLAssertionEventParams {
public:
  const QString &Issuer();

  const QString &InResponseTo();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Assertion(SAMLAssertionEventParams *e);
// Or, subclass SAML and override this emitter function. virtual int FireAssertion(SAMLAssertionEventParams *e) {...}

Remarks

This event is fired before an assertion is validated. The Issuer parameter is the Id of the entity that issued the assertion. The InResponseTo parameter is the Id of the SAMLRequest that requested the assertion. Note that these two parameters are found in the assertion and are not set in the EntityId and Id fields respectively. This event allows certain settings to be configured before the validation checks happen to ensure the assertion is validated correctly. See ValidateAssertion for more information about the validation process.

Error Event (SAML Class)

Fired when information is available about errors during data delivery.

Syntax

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 2

virtual INT CLOUDSSO_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.

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

Log Event (SAML Class)

Fired once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(SAMLLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } SAMLLogEventParams;
Unicode (Windows) virtual INT FireLog(SAMLLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } SAMLLogEventParams;
#define EID_SAML_LOG 3

virtual INT CLOUDSSO_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class SAMLLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Log(SAMLLogEventParams *e);
// Or, subclass SAML and override this emitter function. virtual int FireLog(SAMLLogEventParams *e) {...}

Remarks

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

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

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

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

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

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

Message is the log entry.

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

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

Redirect Event (SAML Class)

Fired when a redirection is received from the server.

Syntax

ANSI (Cross Platform)
virtual int FireRedirect(SAMLRedirectEventParams *e);
typedef struct {
const char *Location;
int Accept; int reserved; } SAMLRedirectEventParams;
Unicode (Windows) virtual INT FireRedirect(SAMLRedirectEventParams *e);
typedef struct {
LPCWSTR Location;
BOOL Accept; INT reserved; } SAMLRedirectEventParams;
#define EID_SAML_REDIRECT 4

virtual INT CLOUDSSO_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);
class SAMLRedirectEventParams {
public:
  const QString &Location();

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

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Redirect(SAMLRedirectEventParams *e);
// Or, subclass SAML and override this emitter function. virtual int FireRedirect(SAMLRedirectEventParams *e) {...}

Remarks

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

SAMLResponse Event (SAML Class)

Fired when a SAMLResponse is validated.

Syntax

ANSI (Cross Platform)
virtual int FireSAMLResponse(SAMLSAMLResponseEventParams *e);
typedef struct {
const char *Issuer;
const char *InResponseTo; int reserved; } SAMLSAMLResponseEventParams;
Unicode (Windows) virtual INT FireSAMLResponse(SAMLSAMLResponseEventParams *e);
typedef struct {
LPCWSTR Issuer;
LPCWSTR InResponseTo; INT reserved; } SAMLSAMLResponseEventParams;
#define EID_SAML_SAMLRESPONSE 5

virtual INT CLOUDSSO_CALL FireSAMLResponse(LPSTR &lpszIssuer, LPSTR &lpszInResponseTo);
class SAMLSAMLResponseEventParams {
public:
  const QString &Issuer();

  const QString &InResponseTo();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SAMLResponse(SAMLSAMLResponseEventParams *e);
// Or, subclass SAML and override this emitter function. virtual int FireSAMLResponse(SAMLSAMLResponseEventParams *e) {...}

Remarks

This event is fired before is SAMLResponse validated . The Issuer parameter is the Id of the entity that issued the SAMLResponse. The InResponseTo parameter is the Id of the SAMLRequest that requested the SAMLResponse. Note that these two parameters are found in the SAMLResponse and are not set in the EntityId and Id fields respectively. This event allows certain settings to be configured before the validation checks happen to ensure the SAMLResponse is validated correctly. See ValidateSAMLResponse for more information about the validation process.

SSLServerAuthentication Event (SAML Class)

Fired after the server presents its certificate to the client.

Syntax

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 CLOUDSSO_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

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

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

SSLStatus Event (SAML Class)

Fired when secure connection progress messages are available.

Syntax

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 CLOUDSSO_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. This event tracks the progress of the connection.

AssertionAttribute Type

Holds information about an attribute.

Syntax

CloudSSOAssertionAttribute (declared in cloudsso.h)

Remarks

The fields of this type describe one of the attributes found in an assertion's attribute statement.

The following fields are available:

Fields

AttributeContent
char* (read-only)

Default Value: ""

The raw XML of the attribute. In cases where the content of the attribute is complex, this field can be used to do additional XML parsing.

AttributeValueCount
int (read-only)

Default Value: 0

In cases where there are multiple values for a single attribute, this count will be updated to reflect the size of the list. If the value of the attribute is not a list, the count will be set to 1. See AttributeValueIndex for more information.

AttributeValueData
char* (read-only)

Default Value: ""

The content of the attribute value selected by AttributeValueIndex.

AttributeValueIndex
int

Default Value: 0

The index of the attribute value that should be populated in the AttributeValueData field. Valid ranges for this field are from 0 to AttributeValueCount - 1. By default, this field is set to 0. In cases where there is only a singular value, that value will be at index 0. For example:

Multi-value attribute

<Attribute Name="ValueName" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified"> <AttributeValue>Value1</AttributeValue> <AttributeValue>Value2</AttributeValue> </Attribute>

Iterating through each value in an attribute

for (int i = 0; i < saml.AssertionAttributeInfo[0].AttributeValueCount; i++) { saml.AssertionAttributeInfo[0].AttributeValueIndex = i; string attribute_value = saml.AssertionAttributeInfo[0].AttributeValueData; //... the rest of the processing }

FriendlyName
char* (read-only)

Default Value: ""

A human-readable version of the attribute name, if provided. This value is intended to be used for informational and logging purposes only.

Name
char* (read-only)

Default Value: ""

The name of the attribute. The format of the name (if provided) can be found in the NameFormat field.

NameFormat
char* (read-only)

Default Value: ""

A URI reference to how the Name of the attribute is formatted. If not set, Unspecified is used. Some common values are:

urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified Unspecified
urn:oasis:names:tc:SAML:2.0:attrname-format:uri URI Reference
urn:oasis:names:tc:SAML:2.0:attrname-format:basic Basic

Constructors

AssertionAttribute()

AssertionInfo Type

Holds information about an assertion.

Syntax

CloudSSOAssertionInfo (declared in cloudsso.h)

Remarks

The fields of this type describe an assertion that has been parsed or processed by the class.

The following fields are available:

Fields

AssertionContent
char*

Default Value: ""

The raw XML of the assertion. This field can be set to provide the assertion to the class for the ParseAssertion method to parse the assertion without the SAML response.

ExpirationDate
char* (read-only)

Default Value: ""

When the assertion expires. This represents the NotOnOrAfter attribute of the Conditions element if the attribute is present in the assertion.

Time-based values are specified by the SAML specification to be in UTC in the following format: YYYY-MM-DDTHH:mm:ss.sssZ

Id
char* (read-only)

Default Value: ""

The unique Id of the assertion generated by the identity provider. This is not an Id that is tied to a user but rather to the assertion itself.

IsSigned
int (read-only)

Default Value: FALSE

Whether the assertion has been signed by the identity provider. This is set to true when the Signature element is present in the assertion.

IssuedTime
char* (read-only)

Default Value: ""

The time at which the assertion was issued by the Issuer (typically the identity provider). This field represents the IssueInstant attribute of the Assertion element.

Time-based values are specified by the SAML specification to be in UTC in the following format: YYYY-MM-DDTHH:mm:ss.sssZ

Issuer
char* (read-only)

Default Value: ""

The issuer of the assertion. Typically, this is the same as the identity provider that provided the SAML response. This field represents the Issuer element in the Assertion element.

NotBeforeDate
char* (read-only)

Default Value: ""

The time at which the assertion becomes valid. If the current time is before this field, then the assertion is not considered valid yet. This represents the NotBefore attribute of the Conditions element if the attribute is present in the assertion.

Time-based values are specified by the SAML specification to be in UTC in the following format: YYYY-MM-DDTHH:mm:ss.sssZ

OneTimeUse
int (read-only)

Default Value: FALSE

Whether the issuer only considers this information valid for this single instance. The information saved here typically should not be cached or saved for future use. This represents the OneTimeUse element of the Conditions element if the element is present in the assertion.

SubjectNameId
char* (read-only)

Default Value: ""

The NameId for the subject of the assertion. Typically, the subject is the user that is being authenticated. The format of this name Id can be found in the SubjectNameIdFormat field. This represents the NameId element of the Subject element if the element is present in the assertion.

SubjectNameIdFormat
char* (read-only)

Default Value: ""

A URI reference to how the SubjectNameId of the element is formatted. If not set, Unspecified is used. This represents the Format attribute of the NameID element if the attribute is present in the assertion. Some common values are:

urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified Unspecified
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress Email Address
urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName Windows Domain Qualified Name

UserInfoAddress
char* (read-only)

Default Value: ""

The address for the user if one could be parsed from the assertion. The attribute names used to set this and other fields can be configured using the AttributeNameProfile configuration setting.

UserInfoEmail
char* (read-only)

Default Value: ""

The email for the user if one could be parsed from the assertion. The attribute names used to set this and other fields can be configured using the AttributeNameProfile configuration setting.

UserInfoName
char* (read-only)

Default Value: ""

The address for the user if one could be parsed from the assertion. The attribute names used to set this and other fields can be configured using the AttributeNameProfile configuration setting.

Constructors

AssertionInfo()

AuthnStatement Type

An Authn statement from an assertion.

Syntax

CloudSSOAuthnStatement (declared in cloudsso.h)

Remarks

The fields of this type describe an authentication (Authn) statement from an assertion in response to an authentication request.

The following fields are available:

Fields

AuthenticatingAuthorites
char* (read-only)

Default Value: ""

A semicolon-separated list of authorities involved with the current authentication context. Typically, this list includes other parties involved with the authentication of the subject besides the issuer that issued the assertion.

AuthnInstant
char* (read-only)

Default Value: ""

The time at which the authentication took place.

Time-based values are specified by the SAML specification to be in UTC in the following format: YYYY-MM-DDTHH:mm:ss.sssZ

ContextClassReference
char* (read-only)

Default Value: ""

A per-defined URI reference identifying an authentication context class that describes how authentication was provided. For example, if the user used a password to perform authentication, this will be set to urn:oasis:names:tc:SAML:2.0:ac:classes:Password.

ContextDeclaration
char* (read-only)

Default Value: ""

A description or URI that describes additional information about the authentication context past the ContextClassReference. This provides more detail about the authentication process when provided by the Identity Provider.

SessionExpiration
char* (read-only)

Default Value: ""

The time at which the session between the principal and Identity Provider must be considered ended.

Time-based values are specified by the SAML specification to be in UTC in the following format: YYYY-MM-DDTHH:mm:ss.sssZ

SessionIndex
char* (read-only)

Default Value: ""

The unique identifier for a particular session established between the user (principal) and the Service Provider (SP), as provided by the Identity Provider (IdP). It is common (but not required) to use this value as the session identifier between the user and the Service Provider (your application).

StatementContent
char* (read-only)

Default Value: ""

The raw XML of the Authn statement. Typically, this is used in cases to get additional information from the Authn statement that is not provided by the class.

Constructors

AuthnStatement()

Certificate Type

This is the digital certificate being used.

Syntax

CloudSSOCertificate (declared in cloudsso.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:

Fields

EffectiveDate
char* (read-only)

Default Value: ""

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

23-Jan-2000 15:00:00.

ExpirationDate
char* (read-only)

Default Value: ""

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

23-Jan-2001 15:00:00.

ExtendedKeyUsage
char* (read-only)

Default Value: ""

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

Fingerprint
char* (read-only)

Default Value: ""

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

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

FingerprintSHA1
char* (read-only)

Default Value: ""

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

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

FingerprintSHA256
char* (read-only)

Default Value: ""

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

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

Issuer
char* (read-only)

Default Value: ""

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

PrivateKey
char* (read-only)

Default Value: ""

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

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

PrivateKeyAvailable
int (read-only)

Default Value: FALSE

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

PrivateKeyContainer
char* (read-only)

Default Value: ""

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

PublicKey
char* (read-only)

Default Value: ""

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

PublicKeyAlgorithm
char* (read-only)

Default Value: ""

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

PublicKeyLength
int (read-only)

Default Value: 0

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

SerialNumber
char* (read-only)

Default Value: ""

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

SignatureAlgorithm
char* (read-only)

Default Value: ""

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

Store
char*

Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

StorePassword
char*

Default Value: ""

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

StoreType
int

Default Value: 0

The type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: This store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CERTMGR class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
char* (read-only)

Default Value: ""

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

ThumbprintMD5
char* (read-only)

Default Value: ""

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

ThumbprintSHA1
char* (read-only)

Default Value: ""

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

ThumbprintSHA256
char* (read-only)

Default Value: ""

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

Usage
char* (read-only)

Default Value: ""

The text description of UsageFlags.

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

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

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

UsageFlags
int (read-only)

Default Value: 0

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

0x80Digital Signature
0x40Non-Repudiation
0x20Key Encipherment
0x10Data Encipherment
0x08Key Agreement
0x04Certificate Signing
0x02CRL Signing
0x01Encipher Only

Please see the Usage field for a text representation of UsageFlags.

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

Version
char* (read-only)

Default Value: ""

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

Subject
char*

Default Value: ""

The subject of the certificate used for client authentication.

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Encoded
char*

Default Value: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

Constructors

Certificate()

Creates a instance whose properties can be set. This is useful for use with when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X.509 public key.

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

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

Firewall Type

The firewall the component will connect through.

Syntax

CloudSSOFirewall (declared in cloudsso.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

The following fields are available:

Fields

AutoDetect
int

Default Value: FALSE

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

FirewallType
int

Default Value: 0

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

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
char*

Default Value: ""

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

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

Password
char*

Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Port
int

Default Value: 0

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

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

User
char*

Default Value: ""

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

Constructors

Firewall()

IdentityProviderMetadata Type

The metadata for the Identity Provider.

Syntax

CloudSSOIdentityProviderMetadata (declared in cloudsso.h)

Remarks

This type represents the metadata for a specific Identity Provider.

The following fields are available:

Fields

EntityId
char*

Default Value: ""

The unique Id for the identity provider that is being described. This is used for verification purposes when verifying the issuer of an assertion or SAMLResponse.

ExpirationDate
char* (read-only)

Default Value: ""

The expiration date of the Identity Provider description provided by the metadata document. This represents the valid attribute of the IDPSSODescriptor element if the attribute is present in the document.

MetadataContent
char*

Default Value: ""

The raw metadata for the identity provider. To avoid repeated requests to the Identity Provider, this value can be saved for later to be used with the LoadIdentityMetadata method.

RequestsSignedAuthnRequests
int

Default Value: FALSE

Whether the identity provider requests that authentication (Authn) requests are signed.

SignedMetadata
int (read-only)

Default Value: FALSE

Whether the identity provider's parsed metadata is signed.

SupportedAttributeProfiles
char* (read-only)

Default Value: ""

A semicolon-separated list of attribute profiles supported by the identity provider. Some common attribute profiles are:

  • urn:oasis:names:tc:SAML:2.0:profiles:attribute:basic
  • urn:oasis:names:tc:SAML:2.0:profiles:attribute:X500
  • urn:oasis:names:tc:SAML:2.0:profiles:attribute:UUID
  • urn:oasis:names:tc:SAML:2.0:profiles:attribute:DCE
  • urn:oasis:names:tc:SAML:2.0:profiles:attribute:XACML

SupportedAttributes
char* (read-only)

Default Value: ""

A semicolon-separated list of attributes supported by the identity provider as presented by the Identity Provider's metadata document. This is a list of attributes that are explicitly supported by the Identity Provider but is not a full list of all the supported attributes. The list will contain the Name of each attribute found in the IDPSSODescriptor element.

SupportedNameIdFormats
char* (read-only)

Default Value: ""

The name identifier formats supported by the identity provider if provided by the metadata document. Some common values are:

  • Unspecified - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
  • Email Address - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
  • Windows Domain Qualified Name - urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName

Constructors

IdentityProviderMetadata()

Proxy Type

The proxy the component will connect to.

Syntax

CloudSSOProxy (declared in cloudsso.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

The following fields are available:

Fields

AuthScheme
int

Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the class will attempt basic authentication.

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

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

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

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
int

Default Value: FALSE

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

Password
char*

Default Value: ""

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

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int

Default Value: 80

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

Server
char*

Default Value: ""

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

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

SSL
int

Default Value: 0

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

psAutomatic (0)Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL-enabled.
psNever (2)The connection is not SSL-enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

User
char*

Default Value: ""

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

If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

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

SAMLRequestSettings Type

Settings used when building a SAMLRequest.

Syntax

CloudSSOSAMLRequestSettings (declared in cloudsso.h)

Remarks

The fields of this type are the settings used when building a SAMLRequest for an Authentication (Authn) or Logout request.

The following fields are available:

Fields

AllowCreate
int

Default Value: FALSE

Whether the class will set the AllowCreate attribute in the NameIDPolicy element that is specific to the AuthnRequest element. When set to true, this will inform the Identity Provider that it is allowed to create a new identifier to represent the principal. When set to false (default), the Identity Provider should only issue an assertion if an acceptable identifier is already created.

Consent
int

Default Value: 0

Whether consent from a principal was provided when this request was sent. This typically is set to some URI reference that was used by the application to obtain consent from the principal (user). This setting specifically sets the Consent attribute in the AuthnRequest or LogoutRequest elements in a SAMLRequest.

By default, the scidUnspecified value is used. If a format needs to be used that is not listed here, the snidCustom value can be used instead. When set, the SAMLRequestCustomConsent configuration setting will be used instead.

Value Consent Id Name Identifier URI
00 (scidUnspecified - default) Unspecified urn:oasis:names:tc:SAML:2.0:consent:unspecified
01 (scidObtained) Obtained urn:oasis:names:tc:SAML:2.0:consent:obtained
02 (scidPrior) Prior urn:oasis:names:tc:SAML:2.0:consent:prior
03 (scidImplicit) Implicit urn:oasis:names:tc:SAML:2.0:consent:current-implicit
04 (scidExplicit) Explicit urn:oasis:names:tc:SAML:2.0:consent:current-explicit
05 (scidUnavailable) Unavailable urn:oasis:names:tc:SAML:2.0:consent:unavailable
06 (scidInapplicable) Inapplicable urn:oasis:names:tc:SAML:2.0:consent:inapplicable
99 (scidCustom) Custom Format N/A

Destination
char*

Default Value: ""

A URI reference for the intended destination for the SAMLRequest. This is useful to prevent malicious forwarding of responses to unintended recipients.

Id
char*

Default Value: ""

A unique Id of the SAMLRequest. If left empty before calling BuildAuthnRequest or BuildLogoutRequest, the class will automatically generate an Id. This Id should match the Id of the InResponseTo attribute of the matching SAMLResponse (see InResponseTo for more information). Due to this, after BuildAuthnRequest or BuildLogoutRequest is used to create a request, this setting (along with the Issuer field) should be cached for verification purposes.

IssuedTime
char*

Default Value: ""

The time at which the SAMLRequest was issued. If not set, the class will use the current time.

Time-based values are specified by the SAML specification to be in UTC in the following format: YYYY-MM-DDTHH:mm:ss.sssZ

Issuer
char*

Default Value: ""

The issuer for the SAML Request. Typically, this should be set to the Entity Id configured for the Identity Provider.

NameIdFormat
int

Default Value: 0

If supported by the Identity Provider, this setting can be used to tailor the name identifier for the subject in the response to an Authn Request. This field is not used for Logout Requests.

By default, the snidUnspecified format will be used, which informs the Identity Provider to use whatever name identifier format they prefer. This setting specifically sets the Format attribute in the NameIDPolicy element in an AuthnRequest. If a format needs to be used that is not listed here, the snidCustom value can be used instead. When set, the SAMLRequestCustomNameIdFormat configuration setting will be used instead.

Value Format Name Format URI
00 (snidUnspecified - default) Unspecified urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified
01 (snidEmail) Email Address urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress
02 (snidX509) X.509 Subject Name urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName
03 (snidWindowsDQ) Windows Domain Qualified Name urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName
04 (snidKerberos) Kerberos Principal Name urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos
05 (snidEntity) Entity Identifier urn:oasis:names:tc:SAML:2.0:nameid-format:entity
06 (snidPersistent) Persistent Identifier urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
07 (snidTransitent) Transient Identifier urn:oasis:names:tc:SAML:2.0:nameid-format:transient
99 (snidCustom) Custom Format N/A

RequestBinding
int

Default Value: 0

The binding that will be used to make the request.

By default, the class will use the srbHTTPRedirect binding which provides the SAMLRequest through a query parameter. The srbHTTPRedirect binding will set just the SAMLRequestURL property.

If set to the srbHTTPPost binding, the SAMLResponse is provided in an HTML body that should be used to make a form post request. This will set both the SAMLRequestURL and SAMLRequestBody properties.

Value BindingName Binding URI
0 (srbHTTPRedirect - default) HTTP Redirect Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
1 (srbHTTPPost) HTTP Post Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST

Note: This setting does not control the binding of the response, just how the request will be made.

SelectedEndpoint
int

Default Value: -1

This setting only applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider. When building an Authn Request, the class will select the the ACS endpoint depending on how SAMLRequestSettings is configured. If UseDefaultEndpoint is set to true, the request will specify that the Identity Provider should use the URI that is configured as the default. If SelectedEndpoint is set, the class will use that index in the request. Otherwise, the class will select the first URI available in the ServiceProviderURIs properties.

SignRequest
int

Default Value: FALSE

Whether the SAMLRequest should be signed when building the SAMLRequest using the BuildAuthnRequest or BuildLogoutRequest methods. The class will use the certificate set in the ServiceProviderSigningCert property to sign the request.

UseDefaultEndpoint
int

Default Value: FALSE

This setting only applies to Authn Requests since there can be multiple Assertion Consumer Service (ACS) endpoints per service provider. When multiple ACS endpoints are available, a single endpoint can be selected as the default endpoint. When building an Authn Request, the class will select the the ACS endpoint depending on how SAMLRequestSettings is configured. If UseDefaultEndpoint is set to true, the request will specify that the Identity Provider should use the URI that is configured as the default. If SelectedEndpoint is set, then the class will use that index in the request. Otherwise, the class will select the first URI available in the ServiceProviderURIs properties.

Constructors

SAMLRequestSettings()

SAMLResponseInfo Type

Holds information about a SAMLResponse.

Syntax

CloudSSOSAMLResponseInfo (declared in cloudsso.h)

Remarks

The fields of this type describe a SAMLResponse that has been parsed or processed by the class.

The following fields are available:

Fields

Consent
char* (read-only)

Default Value: ""

Whether consent from a principal was provided when this response was sent. This typically is set to some URI reference that was used by the application to obtain consent from the principal (user). Some common URI values are:

  • Unspecified - urn:oasis:names:tc:SAML:2.0:consent:unspecified
  • Obtained - urn:oasis:names:tc:SAML:2.0:consent:obtained
  • Prior - urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName
  • Implicit - urn:oasis:names:tc:SAML:2.0:consent:current-implicit
  • Explicit - urn:oasis:names:tc:SAML:2.0:consent:current-explicit
  • Unavailable - urn:oasis:names:tc:SAML:2.0:consent:unavailable
  • Inapplicable - urn:oasis:names:tc:SAML:2.0:consent:inapplicable

Destination
char* (read-only)

Default Value: ""

A URI reference for the intended destination for the SAMLResponse. This is useful to prevent malicious forwarding of responses to unintended recipients.

InResponseTo
char* (read-only)

Default Value: ""

The Id of the SAMLRequest that requested the Identity Provider to issue this SAMLResponse. It can be checked with the original Id of the SAMLRequest (see Id for more information).

IssuedTime
char* (read-only)

Default Value: ""

The time at which the SAMLResponse was issued by the Issuer.

Time-based values are specified by the SAML specification to be in UTC in the following format: YYYY-MM-DDTHH:mm:ss.sssZ

Issuer
char* (read-only)

Default Value: ""

The Entity Id of the issuer of the SAMLResponse. Typically, this will be the EntityId of the Identity Provider.

ResponseContent
char*

Default Value: ""

The full XML of the SAMLResponse after being parsed or processed by the class after calling ParseHTTPRequest or ProcessHTTPRequest. Optionally, this setting can be set to provide a SAMLResponse directly to the class to be used with the ParseSAMLResponse method.

ResponseId
char* (read-only)

Default Value: ""

The unique Id for the SAMLResponse that was created by the Issuer.

ResponseType
int (read-only)

Default Value: 0

The type of SAMLResponse that was processed when calling ProcessHTTPRequest or manually parsed using the ParseSAMLResponse method.

0 (srtUnknown - default) The class was unable to determine the type of response contained in the SAMLResponse.
1 (srtAuthn) The class found a Response in the SAMLResponse.
2 (srtLogout) The class found an LogoutResponse in the SAMLResponse.

Signed
int (read-only)

Default Value: FALSE

Whether the SAMLResponse is signed. If the SAMLResponse contains no signatures, or only the assertion is signed, then this field will be set to false.

StatusCodes
char* (read-only)

Default Value: ""

A semicolon-separated list of status codes found in the SAMLResponse. A compliant SAMLResponse will always contain a top-level response with one of the following values.

urn:oasis:names:tc:SAML:2.0:status:Success Success
urn:oasis:names:tc:SAML:2.0:status:Requester The original request could not be performed due to an issue from the requester.
urn:oasis:names:tc:SAML:2.0:status:Responder The original request could not be performed due to an issue from the issuer.
urn:oasis:names:tc:SAML:2.0:status:VersionMismatch The original request could not be processed due to a SAML version mismatch in the request..
After the top-level status code, second-level codes can also be included to provide additional information about the top-level status code. These second-level codes are also typically a URI reference like the top-level codes. For example, if the Identity Provider was unable to authenticate the user, this setting could be set to:

urn:oasis:names:tc:SAML:2.0:status:Responder;urn:oasis:names:tc:SAML:2.0:status:AuthnFailed

Sometimes, a message is also provided with the Status. See StatusMessage for more information.

StatusMessage
char* (read-only)

Default Value: ""

The message that was provided in the status of the SAMLResponse. This field is set alongside the StatusCodes and can be used to provide more information about the status.

Constructors

SAMLResponseInfo()

ServiceProviderMetadata Type

The metadata settings for a service provider.

Syntax

CloudSSOServiceProviderMetadata (declared in cloudsso.h)

Remarks

The metadata settings for a service provider. This is typically used when configuring an Identity Provider with the information about your application.

The following fields are available:

Fields

AuthnRequestSigned
int

Default Value: FALSE

Whether the generated metadata document will inform the identity provider that this service provider will be sending signed requests.

EntityId
char*

Default Value: ""

The Entity Id for this service provider. This is the unique Id that will be used by the Identity Provider and should be unique to this service provider.

MetadataContent
char*

Default Value: ""

The raw XML document that represents the metadata document for the configured service provider. This field is populated when the BuildServiceMetadata method is used to generate a new document.

SignedMetadata
int

Default Value: FALSE

Whether the class will sign the metadata document when it is being generated. When the BuildServiceMetadata method is used to generate the metadata document, the class will use the ServiceProviderSigningCert property to sign the document.

SupportedNameIdFormats
char*

Default Value: ""

A semicolon-separated list of NameId formats that are supported by this service provider. Some common values are:

urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified Unspecified
urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress Email Address
urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName Windows Domain Qualified Name

To support both email addresses and Windows domain qualified name, this field would be set to:

urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress;urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName

WantAssertionsSigned
int

Default Value: FALSE

Whether the metadata document will inform the identity provider that this service provider wants issued assertions to be signed.

Constructors

ServiceProviderMetadata()

URI Type

A URI endpoint that is used in the SAML protocol.

Syntax

CloudSSOURI (declared in cloudsso.h)

Remarks

A URI endpoint that is used in the SAML protocol. Service providers and identity providers provide information about the URI that should be used when making specific requests.

The following fields are available:

Fields

BindingRef
char*

Default Value: ""

The URI reference for the set BindingType. When the BindingType is set, this field will be updated to match. The exception is the subCustom value, which allows for any value to be placed in this field.

If this field is set instead, the class will attempt to set the BindingType field to match. If it can't, subCustom will also be used.

When parsing a metadata document, the class will also use the subCustom value for any binding types that are not recognized by the class.

BindingType
int

Default Value: 0

The type of binding that is supported for this URI. The class only supports using the HTTP Redirect and HTTP Post bindings. The HTTP Artifact and other bindings are informational, and support for them must be implemented directly.

When setting this field, the BindingRef field will also be updated with the matching URI. The exception is the subCustom value, which allows for any value to be placed in the BindingRef field.

If the BindingRef field is set, during the processing of a metadata document the class will attempt to set this field as well with the matching value. If it can't, subCustom will be used instead.

Value Binding Name Identifier URI
00 (subRedirect - default) HTTP Redirect urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect
01 (subPost) HTTP POST urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
02 (subArtifact - unsupported) HTTP Artifact urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact
99 (subCustom) Custom Format N/A

IsDefault
int

Default Value: FALSE

Whether this URI is the default URI that should be used for the specific URIType and BindingType combination.

Location
char*

Default Value: ""

The address of the URI.

URIIndex
int

Default Value: 0

The index for the URI that can be optionally used if multiple URIs of the same URIType and BindingType are provided.

URIType
int

Default Value: 0

The purpose of the URI. Possible values are:

0 (sutSignon - default) Identity Provider Single Sign-on URI
1 (sutLogout) Both Logout URI
2 (sutACS) Service Provider Assertion Consumer Service

Constructors

URI()

CloudSSOList Type

Syntax

CloudSSOList<T> (declared in cloudsso.h)

Remarks

CloudSSOList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SAML class.

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.

int SetCount(int count) {}

Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.

T* Get(int index) {}

Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.

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

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

AssertionValidationFlags:   The checks that are ignored when validating an assertion.

This setting informs the class to skip certain checks when validating a parsed assertion. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore the SubjectConfirmation element.
0x00000002Ignore the AuthnStatement element.
0x00000004Ignore the Issuer element.
0x00000008Ignore the assertion's signature (does not apply to the SAMLResponse).
0x00000010Ignores a mismatch between the certificates set in the class and the one found in the signature of the assertion.
0x00000020Ignores the Conditions element.
AttributeNameProfile:   The set of names that are used for common attributes.

This setting takes a semicolon-separated list of supported attribute names when setting the UserInfo* fields in the AssertionInfo property. For example, microsoft;basic would be a list that enables just the Azure and Basic profiles. The class will check in the order of each enabled profile. By default, all the profiles below are enabled.

basicThe basic names for the attributes.
microsoftThe scheme used by Microsoft Entra.
SAMLRequestCustomConsent:   The URI reference of a custom consent type.

When the Consent field is set to scidCustom - 99, this configuration setting can be used to the custom URI reference to the consent type.

SAMLRequestCustomNameIdFormat:   The URI reference of a custom NameID format type.

When the NameIdFormats field is set to snidCustom - 99, this configuration setting can be used to the custom URI reference to the NameID format type.

SAMLResponseDetachedSignature:   The SAMLResponse's detached signature.

This configuration setting can be set to a detached signature of a SAMLResponse so that it can be validated. This value should be URL decoded before providing it to the component. To set the signing algorithm, see SAMLResponseDetachedSignatureAlg for more information.

Particularly, when the ResponseContent field is used to provide a SAMLResponse directly to the class, this configuration setting can be used to provide a detached signature. Typically this would be seen if the HTTP-Redirect binding was used to transmit the SAMLResponse.

SAMLResponseDetachedSignatureAlg:   The algorithm of a SAMLResponse's detached signature.

This configuration setting can be set to the signing algorithm used to created the detached signature of a SAMLResponse. This value should be URL decoded before providing it to the component. To set the signature value, see SAMLResponseDetachedSignature for more information.

SAMLResponseValidationFlags:   The checks that are ignored when validating a SAMLResponse.

This setting informs the class to skip certain checks when validating a parsed SAMLResponse. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore the InResponseTo attribute.
0x00000002Ignore the destination attribute.
0x00000004Ignore the Issuer element.
0x00000008Ignore the SAMLResponse's signature (does not apply to the assertion).
0x00000010Ignores a mismatch between the certificates set in the class and the one found in the signature of the SAMLResponse.
0x00000020Ignores a status that is not set to a success.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

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

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

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

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

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

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

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

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

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

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

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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

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

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

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

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

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and AutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

Possible values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

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

In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are as follows:

0 IPv4 only
1 IPv6 only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

SSLClientCACerts:   A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internalinclude the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include the following:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default - Client and Server)
TLS1.1768 (Hex 300) (Default - Client)
TLS1 192 (Hex C0) (Default - Client)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

  • The platform provider is available only on Windows 11/Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown certificate authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown certificate authority revocation status.
0x00000800Ignore unknown root revocation status.
0x00008000Allow test root certificate.
0x00004000Trust test root certificate.
0x80000000Ignore non-matching CN (certificate CN non-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method that does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for User Datagram Protocol (UDP) ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitiveData:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (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

500   Unable to request SAML Metadata Document. Invalid URI provided.
550   Unable to parse or process SAMLResponse. Provided SAMLResponse contained invalid HTTP headers.
600   Unable to parse or process SAMLResponse. Missing SAMLResponse.
650   Unable to parse or process HTTP Request. Invalid HTTP-POST binding request.
680   Unable to build SAMLRequest. Missing Id for request.
681   Unable to build SAMLRequest. Missing issue time instant for when SAMLRequest is issued.
700   SAMLResponse verification failed. Missing Id in a SAMLResponse.
701   SAMLResponse verification failed. Missing or invalid Version in a SAMLResponse.
702   SAMLResponse verification failed. Missing issued time instant in SAMLResponse.
703   SAMLResponse verification failed. Missing authentication time instant in SAMLResponse.
704   SAMLResponse verification failed. Invalid signature in SAMLResponse.
705   SAMLResponse verification failed. Certificate found in SAMLResponse's signature does not match the provided certificate.
706   SAMLResponse verification failed. The SAMLResponse is in response to a different request than the one configured.
707   SAMLResponse verification failed. The Entity Id of the issuer of the SAMLResponse is different than the one configured.
708   SAMLResponse verification failed. The SAMLResponse is meant for a different location (URI) than the ones configured.
708   SAMLResponse verification failed. The SAMLResponse needs to be parsed before ValidateSAMLResponse can be called.
750   Assertion verification failed. Invalid method used for the subject confirmation in Assertion.
751   Assertion verification failed. The Assertion is meant for future use (current time is before NotBefore element).
752   Assertion verification failed. The Assertion has expired.
753   Assertion verification failed. The Assertion is for a recipient different that the configured URIs.
754   Assertion verification failed. The Assertion is in response to a different request that the one configured.
755   Assertion verification failed. The Entity Id of the issuer of the Assertion is different than the one configured.
756   Assertion verification failed. The authentication session the Assertion is linked to has expired.
757   Assertion verification failed. Invalid signature in Assertion.
758   Assertion verification failed. Certificate found in Assertion's signature does not match the provided certificate.
759   Assertion verification failed. The recipient of the assertion (this Service Provider) does not match one of the URIs provided to the class.
760   Assertion verification failed. The Assertion is missing a Subject.
761   Assertion verification failed. The Assertion needs to be parsed before ValidateAssertion can be called.

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

HTTP Errors

118   Firewall error. The error description contains the 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   Cannot 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.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

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