SAMLDesktop Class
Properties Methods Events Config Settings Errors
The SAMLDesktop class provides an easy way to add SAML-based SSO to your desktop application.
Syntax
SAMLDesktop
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.
The SAMLDesktop class is intended for desktop applications that need to add web-based SAML SSO support. The class simplifies the process by building the requests, launching the browser, receiving the response, and validating the assertion for your desktop application with a few simple method calls.
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.Content;
//...
saml.LoadIdentityMetadata(raw_document, true);
Additionally, the class needs to be configured with the information about the Service Provider (i.e., your application). The ServiceProviderSigningCert, WebServerBindings, WebServerPort, and WebServerSSLEnabled properties can be used to provide information about the Service Provider. These are used by the class to build a valid SAML request and to verify the SAML response and its assertions. These settings should typically be considered constant between multiple requests.
Additionally, to easily supply this information to an Identity Provider, the ServiceProviderMetadata property can be used with the BuildServiceMetadata method to create a SAML Metadata Document that describes your application (the Service Provider) to the Identity Provider.
Usage: Configuring Service Provider Metadata Document
saml.ServiceProviderSigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*");
saml.WebServerBindings = WebServerBindings.cwbAutomatic;
saml.WebServerPort = 8888;
saml.WebServerEnabled = false;
saml.ServiceProviderMetadata.EntityId = "ServiceProviderId";
saml.ServiceProviderMetadata.AuthnRequestSigned = true;
saml.ServiceProviderMetadata.WantAssertionsSigned = true;
saml.BuildServiceMetadata();
Authentication
Once the ServiceProviderSigningCert and WebServer* properties are configured, the SAMLRequestSettings property can be configured when the application is ready to make an authentication request by calling AuthenticateUser.
Issuer
The Issuer field is required and be configured to the Entity Id that was provided to the Identity Provider. If the BuildServiceMetadata method was used to create a metadata document that was provided to the Identity Provider, this will match the EntityId field. The Issuer field is also used to validate the SAML response once Identity Provider responds.
Binding
The Binding field is also required and controls how the class communicates the authentication request to the Identity Provider. This does not control how the Identity Provider responds to the request. The class supports two request bindings: HTTP-Redirect and HTTP-POST.
The HTTP-Redirect binding (default) sends the SAML request using an HTTP redirect and provides the parameters through a query string. Typically, this binding requires that UseDetachedSignatures is set to true as the signature causes the request to become to long if held within the actual request.
The HTTP-POST binding sends the SAML request using an HTTP form post to send the parameters through an HTTP POST instead. Internally, this is done by launching the browser to an HTML page that contains an automatic form post.
SignRequest
The SignRequest field can be set to true to have the class sign the SAML request using the ServiceProviderSigningCert certificate. f the BuildServiceMetadata method was used to create a metadata document that was provided to the Identity Provider, the ServiceProviderSigningCert should be the same certificate that was set when the metadata document was built.
RelayState
The RelayState property can be set have the class send the RelayState parameter along with the SAML request. When the Identity Provider returns with the SAML response, it will also return a RelayState parameter with the same value.
Once the authentication request has been configured, call AuthenticateUser to start the authentication process.
Usage: Authenticate User
saml.RequestIdentityMetadata("https://example.com/federationmetadata/federationmetadata.xml");
saml.ServiceProviderSigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*");
saml.WebServerBindings = WebServerBindings.cwbAutomatic;
saml.WebServerPort = 8888;
saml.WebServerEnabled = false;
saml.SAMLRequestSettings.Issuer = "ServiceProviderId";
saml.SAMLRequestSettings.Binding = SAMLBindings.sbHTTPRedirect;
saml.SAMLRequestSettings.SignRequest = true;
saml.RelayState = "Relay_State";
saml.AuthenticateUser;
Assertions
The SAML 2.0 specification gives 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 its 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 properties 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 through the class. First, using the collection, the application can iterate through the collection for the attribute and then iterate through the associated values. 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].ValueCount; j++) {
saml.AssertionAttributeInfo[i].ValueIndex = j;
verified_emails.Add(saml.AssertionAttributeInfo[i].ValueData);
}
}
}
The other option 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 semicolon-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[] verified_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.
AssertionAttributeInfo | Information about the attributes found in an assertion. |
AssertionAuthnInfo | Information about the AuthnStatement in an assertion. |
AssertionInfo | Information about a parsed assertion. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | Determines what happens when the server issues a redirect. |
IdentityProviderEncryptingCert | The certificate used to decrypt responses from an identity provider. |
IdentityProviderMetadata | Information about the identity provider. |
IdentityProviderSigningCert | The certificate used to verify signatures in responses from an identity provider. |
IdentityProviderURIs | The URIs for an identity provider. |
Proxy | A set of properties related to proxy access. |
RelayState | The RelayState for a SAML request or response. |
ReturnURL | The URL where the user (browser) returns after authenticating with the Identity Provider. |
SAMLRequestSettings | The settings for a SAML request. |
SAMLResponseInfo | Information about a SAML response. |
ServiceProviderMetadata | Information about a service provider's SAML metadata document. |
ServiceProviderSigningCert | The certificate used by the service provider when signing a SAMLRequest or SAML metadata document. |
SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | The timeout for the class. |
WebServerBindings | The supported bindings used by the embedded web server. |
WebServerPort | The local port on which the embedded web server listens. |
WebServerSSLCert | The certificate with the private key to use when a Secure Sockets Layer (SSL) is enabled. |
WebServerSSLEnabled | Whether the web server requires Secure Sockets Layer (SSL) connections. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AuthenticateUser | Authenticates a user to the application. |
BuildServiceMetadata | Builds a metadata document for a service provider. |
Config | Sets or retrieves a configuration setting. |
DoEvents | This method processes events from the internal message queue. |
GetAssertionAttribute | Searches for a specific assertion attribute. |
Interrupt | This method interrupts the current method. |
LoadIdentityMetadata | Loads an identity provider's metadata document. |
ParseAssertion | Parses an assertion. |
ParseSAMLResponse | Parses a SAML response. |
RequestIdentityMetadata | Requests an identity provider's SAML metadata document. |
Reset | This method will reset the class. |
StartWebServer | Starts the embedded web server. |
StopWebServer | Stops the embedded web server. |
ValidateAssertion | Validates an assertion. |
ValidateSAMLResponse | Validates a SAML response. |
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.
Error | Fired when information is available about errors during data delivery. |
LaunchBrowser | Fires before launching a browser with the SAML request. |
Log | Fired once for each log message. |
Redirect | Fired when a redirection is received from the server. |
ReturnURL | Fired when the user is redirected to the embedded web server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired 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.
AssertionValidationFlags | The checks that are ignored when validating an assertion. |
CustomConsent | The URI reference of a custom consent type. |
CustomNameIdFormat | The URI reference of a custom NameID format type. |
SAMLResponseDetachedSignature | The SAML response's detached signature. |
SAMLResponseDetachedSignatureAlg | The algorithm of a SAMLResponse's detached signature. |
SAMLResponseValidationFlags | The checks that are ignored when validating a SAMLResponse. |
UseDetachedSignatures | Whether detached signatures are used when building a SAML request. |
BrowserResponseTimeout | Specifies the amount of time to wait for a response from the browser. |
WebServerFailedResponse | The custom response that will be displayed to the user if authentication failed. |
WebServerHost | The hostname used by the embedded web server. |
WebServerResponse | The custom response that is displayed to the user. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AssertionAttributeInfo Property (SAMLDesktop Class)
Information about the attributes found in an assertion.
Syntax
CloudSSOList<CloudSSOAssertionAttribute>* GetAssertionAttributeInfo(); int SetAssertionAttributeInfo(CloudSSOList<CloudSSOAssertionAttribute>* val);
int cloudsso_samldesktop_getassertionattributecount(void* lpObj);
int cloudsso_samldesktop_setassertionattributecount(void* lpObj, int iAssertionAttributeCount);
char* cloudsso_samldesktop_getassertionattributecontent(void* lpObj, int assertionattributeidx);
char* cloudsso_samldesktop_getassertionattributefriendlyname(void* lpObj, int assertionattributeidx);
char* cloudsso_samldesktop_getassertionattributename(void* lpObj, int assertionattributeidx);
char* cloudsso_samldesktop_getassertionattributenameformat(void* lpObj, int assertionattributeidx);
int cloudsso_samldesktop_getassertionattributevaluecount(void* lpObj, int assertionattributeidx);
char* cloudsso_samldesktop_getassertionattributevaluedata(void* lpObj, int assertionattributeidx);
int cloudsso_samldesktop_getassertionattributevalueindex(void* lpObj, int assertionattributeidx);
int cloudsso_samldesktop_setassertionattributevalueindex(void* lpObj, int assertionattributeidx, int iAssertionAttributeValueIndex);
int GetAssertionAttributeCount();
int SetAssertionAttributeCount(int iAssertionAttributeCount); QString GetAssertionAttributeContent(int iAssertionAttributeIdx); QString GetAssertionAttributeFriendlyName(int iAssertionAttributeIdx); QString GetAssertionAttributeName(int iAssertionAttributeIdx); QString GetAssertionAttributeNameFormat(int iAssertionAttributeIdx); int GetAssertionAttributeValueCount(int iAssertionAttributeIdx); QString GetAssertionAttributeValueData(int iAssertionAttributeIdx); int GetAssertionAttributeValueIndex(int iAssertionAttributeIdx);
int SetAssertionAttributeValueIndex(int iAssertionAttributeIdx, int iAssertionAttributeValueIndex);
Remarks
This properties provides the information for each attribute in all of the AttributeStatement elements from the parsed assertion found in the AssertionInfo property. The AuthenticateUser and ParseAssertion methods can set this collection.
Data Type
AssertionAuthnInfo Property (SAMLDesktop Class)
Information about the AuthnStatement in an assertion.
Syntax
CloudSSOList<CloudSSOAuthnStatement>* GetAssertionAuthnInfo(); int SetAssertionAuthnInfo(CloudSSOList<CloudSSOAuthnStatement>* val);
int cloudsso_samldesktop_getassertionauthncount(void* lpObj);
int cloudsso_samldesktop_setassertionauthncount(void* lpObj, int iAssertionAuthnCount);
char* cloudsso_samldesktop_getassertionauthnauthenticatingauthorites(void* lpObj, int assertionauthnindex);
char* cloudsso_samldesktop_getassertionauthncontent(void* lpObj, int assertionauthnindex);
char* cloudsso_samldesktop_getassertionauthncontextclassreference(void* lpObj, int assertionauthnindex);
char* cloudsso_samldesktop_getassertionauthncontextdeclaration(void* lpObj, int assertionauthnindex);
char* cloudsso_samldesktop_getassertionauthninstant(void* lpObj, int assertionauthnindex);
char* cloudsso_samldesktop_getassertionauthnsessionexpiration(void* lpObj, int assertionauthnindex);
char* cloudsso_samldesktop_getassertionauthnsessionindex(void* lpObj, int assertionauthnindex);
int GetAssertionAuthnCount();
int SetAssertionAuthnCount(int iAssertionAuthnCount); QString GetAssertionAuthnAuthenticatingAuthorites(int iAssertionAuthnIndex); QString GetAssertionAuthnContent(int iAssertionAuthnIndex); QString GetAssertionAuthnContextClassReference(int iAssertionAuthnIndex); QString GetAssertionAuthnContextDeclaration(int iAssertionAuthnIndex); QString GetAssertionAuthnInstant(int iAssertionAuthnIndex); QString GetAssertionAuthnSessionExpiration(int iAssertionAuthnIndex); QString GetAssertionAuthnSessionIndex(int iAssertionAuthnIndex);
Remarks
This property provides information about the AuthnStatement from the parsed assertion in the AssertionInfo property. The AuthenticateUser and ParseAssertion methods can set this collection.
Data Type
AssertionInfo Property (SAMLDesktop Class)
Information about a parsed assertion.
Syntax
CloudSSOAssertionInfo* GetAssertionInfo(); int SetAssertionInfo(CloudSSOAssertionInfo* val);
int cloudsso_samldesktop_getassertioncontent(void* lpObj, char** lpAssertionContent, int* lenAssertionContent);
int cloudsso_samldesktop_setassertioncontent(void* lpObj, const char* lpAssertionContent, int lenAssertionContent);
char* cloudsso_samldesktop_getassertionexpirationdate(void* lpObj);
char* cloudsso_samldesktop_getassertionid(void* lpObj);
int cloudsso_samldesktop_getassertionissigned(void* lpObj);
char* cloudsso_samldesktop_getassertionissuedtime(void* lpObj);
char* cloudsso_samldesktop_getassertionissuer(void* lpObj);
char* cloudsso_samldesktop_getassertionnotbeforedate(void* lpObj);
int cloudsso_samldesktop_getassertiononetimeuse(void* lpObj);
char* cloudsso_samldesktop_getassertionsubjectnameid(void* lpObj);
char* cloudsso_samldesktop_getassertionsubjectnameidformat(void* lpObj);
QByteArray GetAssertionContent();
int SetAssertionContent(QByteArray qbaAssertionContent); QString GetAssertionExpirationDate(); QString GetAssertionId(); bool GetAssertionIsSigned(); QString GetAssertionIssuedTime(); QString GetAssertionIssuer(); QString GetAssertionNotBeforeDate(); bool GetAssertionOneTimeUse(); QString GetAssertionSubjectNameId(); QString GetAssertionSubjectNameIdFormat();
Remarks
This property provides information about the recently parsed assertion. It can also be used to provide a cached assertion manually to the class. The AuthenticateUser and ParseAssertion methods can set this collection.
Data Type
Firewall Property (SAMLDesktop Class)
A set of properties related to firewall access.
Syntax
CloudSSOFirewall* GetFirewall(); int SetFirewall(CloudSSOFirewall* val);
int cloudsso_samldesktop_getfirewallautodetect(void* lpObj);
int cloudsso_samldesktop_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);
int cloudsso_samldesktop_getfirewalltype(void* lpObj);
int cloudsso_samldesktop_setfirewalltype(void* lpObj, int iFirewallType);
char* cloudsso_samldesktop_getfirewallhost(void* lpObj);
int cloudsso_samldesktop_setfirewallhost(void* lpObj, const char* lpszFirewallHost);
char* cloudsso_samldesktop_getfirewallpassword(void* lpObj);
int cloudsso_samldesktop_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);
int cloudsso_samldesktop_getfirewallport(void* lpObj);
int cloudsso_samldesktop_setfirewallport(void* lpObj, int iFirewallPort);
char* cloudsso_samldesktop_getfirewalluser(void* lpObj);
int cloudsso_samldesktop_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
FollowRedirects Property (SAMLDesktop 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_samldesktop_getfollowredirects(void* lpObj);
int cloudsso_samldesktop_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 (SAMLDesktop Class)
The certificate used to decrypt responses from an identity provider.
Syntax
CloudSSOCertificate* GetIdentityProviderEncryptingCert(); int SetIdentityProviderEncryptingCert(CloudSSOCertificate* val);
char* cloudsso_samldesktop_getidentityproviderencryptingcerteffectivedate(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertexpirationdate(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertextendedkeyusage(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertfingerprint(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertfingerprintsha1(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertfingerprintsha256(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertissuer(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertprivatekey(void* lpObj);
int cloudsso_samldesktop_getidentityproviderencryptingcertprivatekeyavailable(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertprivatekeycontainer(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertpublickey(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertpublickeyalgorithm(void* lpObj);
int cloudsso_samldesktop_getidentityproviderencryptingcertpublickeylength(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertserialnumber(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertsignaturealgorithm(void* lpObj);
int cloudsso_samldesktop_getidentityproviderencryptingcertstore(void* lpObj, char** lpIdentityProviderEncryptingCertStore, int* lenIdentityProviderEncryptingCertStore);
int cloudsso_samldesktop_setidentityproviderencryptingcertstore(void* lpObj, const char* lpIdentityProviderEncryptingCertStore, int lenIdentityProviderEncryptingCertStore);
char* cloudsso_samldesktop_getidentityproviderencryptingcertstorepassword(void* lpObj);
int cloudsso_samldesktop_setidentityproviderencryptingcertstorepassword(void* lpObj, const char* lpszIdentityProviderEncryptingCertStorePassword);
int cloudsso_samldesktop_getidentityproviderencryptingcertstoretype(void* lpObj);
int cloudsso_samldesktop_setidentityproviderencryptingcertstoretype(void* lpObj, int iIdentityProviderEncryptingCertStoreType);
char* cloudsso_samldesktop_getidentityproviderencryptingcertsubjectaltnames(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertthumbprintmd5(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertthumbprintsha1(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertthumbprintsha256(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertusage(void* lpObj);
int cloudsso_samldesktop_getidentityproviderencryptingcertusageflags(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertversion(void* lpObj);
char* cloudsso_samldesktop_getidentityproviderencryptingcertsubject(void* lpObj);
int cloudsso_samldesktop_setidentityproviderencryptingcertsubject(void* lpObj, const char* lpszIdentityProviderEncryptingCertSubject);
int cloudsso_samldesktop_getidentityproviderencryptingcertencoded(void* lpObj, char** lpIdentityProviderEncryptingCertEncoded, int* lenIdentityProviderEncryptingCertEncoded);
int cloudsso_samldesktop_setidentityproviderencryptingcertencoded(void* lpObj, const char* lpIdentityProviderEncryptingCertEncoded, int lenIdentityProviderEncryptingCertEncoded);
QString GetIdentityProviderEncryptingCertEffectiveDate(); QString GetIdentityProviderEncryptingCertExpirationDate(); QString GetIdentityProviderEncryptingCertExtendedKeyUsage(); QString GetIdentityProviderEncryptingCertFingerprint(); QString GetIdentityProviderEncryptingCertFingerprintSHA1(); QString GetIdentityProviderEncryptingCertFingerprintSHA256(); QString GetIdentityProviderEncryptingCertIssuer(); QString GetIdentityProviderEncryptingCertPrivateKey(); bool GetIdentityProviderEncryptingCertPrivateKeyAvailable(); QString GetIdentityProviderEncryptingCertPrivateKeyContainer(); QString GetIdentityProviderEncryptingCertPublicKey(); QString GetIdentityProviderEncryptingCertPublicKeyAlgorithm(); int GetIdentityProviderEncryptingCertPublicKeyLength(); QString GetIdentityProviderEncryptingCertSerialNumber(); QString GetIdentityProviderEncryptingCertSignatureAlgorithm(); QByteArray GetIdentityProviderEncryptingCertStore();
int SetIdentityProviderEncryptingCertStore(QByteArray qbaIdentityProviderEncryptingCertStore); QString GetIdentityProviderEncryptingCertStorePassword();
int SetIdentityProviderEncryptingCertStorePassword(QString qsIdentityProviderEncryptingCertStorePassword); int GetIdentityProviderEncryptingCertStoreType();
int SetIdentityProviderEncryptingCertStoreType(int iIdentityProviderEncryptingCertStoreType); QString GetIdentityProviderEncryptingCertSubjectAltNames(); QString GetIdentityProviderEncryptingCertThumbprintMD5(); QString GetIdentityProviderEncryptingCertThumbprintSHA1(); QString GetIdentityProviderEncryptingCertThumbprintSHA256(); QString GetIdentityProviderEncryptingCertUsage(); int GetIdentityProviderEncryptingCertUsageFlags(); QString GetIdentityProviderEncryptingCertVersion(); 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
IdentityProviderMetadata Property (SAMLDesktop Class)
Information about the identity provider.
Syntax
CloudSSOIdentityProviderMetadata* GetIdentityProviderMetadata(); int SetIdentityProviderMetadata(CloudSSOIdentityProviderMetadata* val);
int cloudsso_samldesktop_getidentityprovidermetadatacontent(void* lpObj, char** lpIdentityProviderMetadataContent, int* lenIdentityProviderMetadataContent);
int cloudsso_samldesktop_setidentityprovidermetadatacontent(void* lpObj, const char* lpIdentityProviderMetadataContent, int lenIdentityProviderMetadataContent);
char* cloudsso_samldesktop_getidentityprovidermetadataentityid(void* lpObj);
int cloudsso_samldesktop_setidentityprovidermetadataentityid(void* lpObj, const char* lpszIdentityProviderMetadataEntityId);
char* cloudsso_samldesktop_getidentityprovidermetadataexpirationdate(void* lpObj);
int cloudsso_samldesktop_getidentityprovidermetadatarequestssignedauthnrequests(void* lpObj);
int cloudsso_samldesktop_setidentityprovidermetadatarequestssignedauthnrequests(void* lpObj, int bIdentityProviderMetadataRequestsSignedAuthnRequests);
int cloudsso_samldesktop_getidentityprovidermetadatasignedmetadata(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidermetadatasupportedattributeprofiles(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidermetadatasupportedattributes(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidermetadatasupportednameidformats(void* lpObj);
QByteArray GetIdentityProviderMetadataContent();
int SetIdentityProviderMetadataContent(QByteArray qbaIdentityProviderMetadataContent); QString GetIdentityProviderMetadataEntityId();
int SetIdentityProviderMetadataEntityId(QString qsIdentityProviderMetadataEntityId); QString GetIdentityProviderMetadataExpirationDate(); 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 SAML responses 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 (SAMLDesktop Class)
The certificate used to verify signatures in responses from an identity provider.
Syntax
CloudSSOCertificate* GetIdentityProviderSigningCert(); int SetIdentityProviderSigningCert(CloudSSOCertificate* val);
char* cloudsso_samldesktop_getidentityprovidersigningcerteffectivedate(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertexpirationdate(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertextendedkeyusage(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertfingerprint(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertfingerprintsha1(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertfingerprintsha256(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertissuer(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertprivatekey(void* lpObj);
int cloudsso_samldesktop_getidentityprovidersigningcertprivatekeyavailable(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertprivatekeycontainer(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertpublickey(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertpublickeyalgorithm(void* lpObj);
int cloudsso_samldesktop_getidentityprovidersigningcertpublickeylength(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertserialnumber(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertsignaturealgorithm(void* lpObj);
int cloudsso_samldesktop_getidentityprovidersigningcertstore(void* lpObj, char** lpIdentityProviderSigningCertStore, int* lenIdentityProviderSigningCertStore);
int cloudsso_samldesktop_setidentityprovidersigningcertstore(void* lpObj, const char* lpIdentityProviderSigningCertStore, int lenIdentityProviderSigningCertStore);
char* cloudsso_samldesktop_getidentityprovidersigningcertstorepassword(void* lpObj);
int cloudsso_samldesktop_setidentityprovidersigningcertstorepassword(void* lpObj, const char* lpszIdentityProviderSigningCertStorePassword);
int cloudsso_samldesktop_getidentityprovidersigningcertstoretype(void* lpObj);
int cloudsso_samldesktop_setidentityprovidersigningcertstoretype(void* lpObj, int iIdentityProviderSigningCertStoreType);
char* cloudsso_samldesktop_getidentityprovidersigningcertsubjectaltnames(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertthumbprintmd5(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertthumbprintsha1(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertthumbprintsha256(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertusage(void* lpObj);
int cloudsso_samldesktop_getidentityprovidersigningcertusageflags(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertversion(void* lpObj);
char* cloudsso_samldesktop_getidentityprovidersigningcertsubject(void* lpObj);
int cloudsso_samldesktop_setidentityprovidersigningcertsubject(void* lpObj, const char* lpszIdentityProviderSigningCertSubject);
int cloudsso_samldesktop_getidentityprovidersigningcertencoded(void* lpObj, char** lpIdentityProviderSigningCertEncoded, int* lenIdentityProviderSigningCertEncoded);
int cloudsso_samldesktop_setidentityprovidersigningcertencoded(void* lpObj, const char* lpIdentityProviderSigningCertEncoded, int lenIdentityProviderSigningCertEncoded);
QString GetIdentityProviderSigningCertEffectiveDate(); QString GetIdentityProviderSigningCertExpirationDate(); QString GetIdentityProviderSigningCertExtendedKeyUsage(); QString GetIdentityProviderSigningCertFingerprint(); QString GetIdentityProviderSigningCertFingerprintSHA1(); QString GetIdentityProviderSigningCertFingerprintSHA256(); QString GetIdentityProviderSigningCertIssuer(); QString GetIdentityProviderSigningCertPrivateKey(); bool GetIdentityProviderSigningCertPrivateKeyAvailable(); QString GetIdentityProviderSigningCertPrivateKeyContainer(); QString GetIdentityProviderSigningCertPublicKey(); QString GetIdentityProviderSigningCertPublicKeyAlgorithm(); int GetIdentityProviderSigningCertPublicKeyLength(); QString GetIdentityProviderSigningCertSerialNumber(); QString GetIdentityProviderSigningCertSignatureAlgorithm(); QByteArray GetIdentityProviderSigningCertStore();
int SetIdentityProviderSigningCertStore(QByteArray qbaIdentityProviderSigningCertStore); QString GetIdentityProviderSigningCertStorePassword();
int SetIdentityProviderSigningCertStorePassword(QString qsIdentityProviderSigningCertStorePassword); int GetIdentityProviderSigningCertStoreType();
int SetIdentityProviderSigningCertStoreType(int iIdentityProviderSigningCertStoreType); QString GetIdentityProviderSigningCertSubjectAltNames(); QString GetIdentityProviderSigningCertThumbprintMD5(); QString GetIdentityProviderSigningCertThumbprintSHA1(); QString GetIdentityProviderSigningCertThumbprintSHA256(); QString GetIdentityProviderSigningCertUsage(); int GetIdentityProviderSigningCertUsageFlags(); QString GetIdentityProviderSigningCertVersion(); 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
IdentityProviderURIs Property (SAMLDesktop Class)
The URIs for an identity provider.
Syntax
CloudSSOList<CloudSSOURI>* GetIdentityProviderURIs(); int SetIdentityProviderURIs(CloudSSOList<CloudSSOURI>* val);
int cloudsso_samldesktop_getidentityprovideruricount(void* lpObj);
int cloudsso_samldesktop_setidentityprovideruricount(void* lpObj, int iIdentityProviderURICount);
char* cloudsso_samldesktop_getidentityprovideruribindingref(void* lpObj, int identityprovideruriidx);
int cloudsso_samldesktop_setidentityprovideruribindingref(void* lpObj, int identityprovideruriidx, const char* lpszIdentityProviderURIBindingRef);
int cloudsso_samldesktop_getidentityprovideruribindingtype(void* lpObj, int identityprovideruriidx);
int cloudsso_samldesktop_setidentityprovideruribindingtype(void* lpObj, int identityprovideruriidx, int iIdentityProviderURIBindingType);
int cloudsso_samldesktop_getidentityprovideruriisdefault(void* lpObj, int identityprovideruriidx);
int cloudsso_samldesktop_setidentityprovideruriisdefault(void* lpObj, int identityprovideruriidx, int bIdentityProviderURIIsDefault);
char* cloudsso_samldesktop_getidentityproviderurilocation(void* lpObj, int identityprovideruriidx);
int cloudsso_samldesktop_setidentityproviderurilocation(void* lpObj, int identityprovideruriidx, const char* lpszIdentityProviderURILocation);
int cloudsso_samldesktop_getidentityprovideruriindex(void* lpObj, int identityprovideruriidx);
int cloudsso_samldesktop_setidentityprovideruriindex(void* lpObj, int identityprovideruriidx, int iIdentityProviderURIIndex);
int cloudsso_samldesktop_getidentityprovideruritype(void* lpObj, int identityprovideruriidx);
int cloudsso_samldesktop_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
Proxy Property (SAMLDesktop Class)
A set of properties related to proxy access.
Syntax
CloudSSOProxy* GetProxy(); int SetProxy(CloudSSOProxy* val);
int cloudsso_samldesktop_getproxyauthscheme(void* lpObj);
int cloudsso_samldesktop_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int cloudsso_samldesktop_getproxyautodetect(void* lpObj);
int cloudsso_samldesktop_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
char* cloudsso_samldesktop_getproxypassword(void* lpObj);
int cloudsso_samldesktop_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int cloudsso_samldesktop_getproxyport(void* lpObj);
int cloudsso_samldesktop_setproxyport(void* lpObj, int iProxyPort);
char* cloudsso_samldesktop_getproxyserver(void* lpObj);
int cloudsso_samldesktop_setproxyserver(void* lpObj, const char* lpszProxyServer);
int cloudsso_samldesktop_getproxyssl(void* lpObj);
int cloudsso_samldesktop_setproxyssl(void* lpObj, int iProxySSL);
char* cloudsso_samldesktop_getproxyuser(void* lpObj);
int cloudsso_samldesktop_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
RelayState Property (SAMLDesktop Class)
The RelayState for a SAML request or response.
Syntax
ANSI (Cross Platform) char* GetRelayState();
int SetRelayState(const char* lpszRelayState); Unicode (Windows) LPWSTR GetRelayState();
INT SetRelayState(LPCWSTR lpszRelayState);
char* cloudsso_samldesktop_getrelaystate(void* lpObj);
int cloudsso_samldesktop_setrelaystate(void* lpObj, const char* lpszRelayState);
QString GetRelayState();
int SetRelayState(QString qsRelayState);
Default Value
""
Remarks
When set before building a request using the AuthenticateUser method, this property will set the RelayState parameter that is provided with the SAML request. 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.
After receiving the response from the Identity Provider, this setting will then be set to match the RelayState parameter if it was provided by the Identity Provider. This does not work if the SAML response was provided directly to the methods using the SAMLResponseInfo property.
Data Type
String
ReturnURL Property (SAMLDesktop Class)
The URL where the user (browser) returns after authenticating with the Identity Provider.
Syntax
ANSI (Cross Platform) char* GetReturnURL();
int SetReturnURL(const char* lpszReturnURL); Unicode (Windows) LPWSTR GetReturnURL();
INT SetReturnURL(LPCWSTR lpszReturnURL);
char* cloudsso_samldesktop_getreturnurl(void* lpObj);
int cloudsso_samldesktop_setreturnurl(void* lpObj, const char* lpszReturnURL);
QString GetReturnURL();
int SetReturnURL(QString qsReturnURL);
Default Value
""
Remarks
Typically this property will be automatically set by the component when calling AuthenticateUser or BuildServiceMetadata based on how the WebServerBindings, WebServerPort, and WebServerSSLEnabled properties are configured. Additionally, the WebServerHost configuration setting can be specify the domain which is localhost by default. For example, some service prefer the use of 127.0.0.1.
When manually validating a SAML response or assertion, this setting will need to be set for validation to succeeded.
Can be set to override the URL that is provided in the authenticate request or metadata if needed. For example, if using a relay server to pass information from the Identity Provider to the application, ReturnURL should be set to the location of the relay server. The relay server should then pass the information to the embedded web server.
Data Type
String
SAMLRequestSettings Property (SAMLDesktop Class)
The settings for a SAML request.
Syntax
CloudSSOSAMLRequestSettings* GetSAMLRequestSettings(); int SetSAMLRequestSettings(CloudSSOSAMLRequestSettings* val);
int cloudsso_samldesktop_getsamlrequestallowcreate(void* lpObj);
int cloudsso_samldesktop_setsamlrequestallowcreate(void* lpObj, int bSAMLRequestAllowCreate);
int cloudsso_samldesktop_getsamlrequestbinding(void* lpObj);
int cloudsso_samldesktop_setsamlrequestbinding(void* lpObj, int iSAMLRequestBinding);
int cloudsso_samldesktop_getsamlrequestconsent(void* lpObj);
int cloudsso_samldesktop_setsamlrequestconsent(void* lpObj, int iSAMLRequestConsent);
char* cloudsso_samldesktop_getsamlrequestdestination(void* lpObj);
int cloudsso_samldesktop_setsamlrequestdestination(void* lpObj, const char* lpszSAMLRequestDestination);
char* cloudsso_samldesktop_getsamlrequestid(void* lpObj);
int cloudsso_samldesktop_setsamlrequestid(void* lpObj, const char* lpszSAMLRequestId);
char* cloudsso_samldesktop_getsamlrequestissuedtime(void* lpObj);
int cloudsso_samldesktop_setsamlrequestissuedtime(void* lpObj, const char* lpszSAMLRequestIssuedTime);
char* cloudsso_samldesktop_getsamlrequestissuer(void* lpObj);
int cloudsso_samldesktop_setsamlrequestissuer(void* lpObj, const char* lpszSAMLRequestIssuer);
int cloudsso_samldesktop_getsamlrequestnameidformat(void* lpObj);
int cloudsso_samldesktop_setsamlrequestnameidformat(void* lpObj, int iSAMLRequestNameIdFormat);
int cloudsso_samldesktop_getsamlrequestselectedendpoint(void* lpObj);
int cloudsso_samldesktop_setsamlrequestselectedendpoint(void* lpObj, int iSAMLRequestSelectedEndpoint);
char* cloudsso_samldesktop_getsamlrequestsessionindex(void* lpObj);
int cloudsso_samldesktop_setsamlrequestsessionindex(void* lpObj, const char* lpszSAMLRequestSessionIndex);
int cloudsso_samldesktop_getsamlrequestsignrequest(void* lpObj);
int cloudsso_samldesktop_setsamlrequestsignrequest(void* lpObj, int bSAMLRequestSignRequest);
int cloudsso_samldesktop_getsamlrequestusedefaultendpoint(void* lpObj);
int cloudsso_samldesktop_setsamlrequestusedefaultendpoint(void* lpObj, int bSAMLRequestUseDefaultEndpoint);
bool GetSAMLRequestAllowCreate();
int SetSAMLRequestAllowCreate(bool bSAMLRequestAllowCreate); int GetSAMLRequestBinding();
int SetSAMLRequestBinding(int iSAMLRequestBinding); 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 GetSAMLRequestSelectedEndpoint();
int SetSAMLRequestSelectedEndpoint(int iSAMLRequestSelectedEndpoint); QString GetSAMLRequestSessionIndex();
int SetSAMLRequestSessionIndex(QString qsSAMLRequestSessionIndex); bool GetSAMLRequestSignRequest();
int SetSAMLRequestSignRequest(bool bSAMLRequestSignRequest); bool GetSAMLRequestUseDefaultEndpoint();
int SetSAMLRequestUseDefaultEndpoint(bool bSAMLRequestUseDefaultEndpoint);
Remarks
This property is used to configure the SAML request built by the AuthenticateUser method to request authentication.
Data Type
SAMLResponseInfo Property (SAMLDesktop Class)
Information about a SAML response.
Syntax
CloudSSOSAMLResponseInfo* GetSAMLResponseInfo(); int SetSAMLResponseInfo(CloudSSOSAMLResponseInfo* val);
char* cloudsso_samldesktop_getsamlresponseconsent(void* lpObj);
int cloudsso_samldesktop_getsamlresponsecontent(void* lpObj, char** lpSAMLResponseContent, int* lenSAMLResponseContent);
int cloudsso_samldesktop_setsamlresponsecontent(void* lpObj, const char* lpSAMLResponseContent, int lenSAMLResponseContent);
char* cloudsso_samldesktop_getsamlresponsedestination(void* lpObj);
char* cloudsso_samldesktop_getsamlresponseid(void* lpObj);
char* cloudsso_samldesktop_getsamlresponseinresponseto(void* lpObj);
char* cloudsso_samldesktop_getsamlresponseissuedtime(void* lpObj);
char* cloudsso_samldesktop_getsamlresponseissuer(void* lpObj);
int cloudsso_samldesktop_getsamlresponsetype(void* lpObj);
int cloudsso_samldesktop_getsamlresponsesigned(void* lpObj);
char* cloudsso_samldesktop_getsamlresponsestatuscodes(void* lpObj);
char* cloudsso_samldesktop_getsamlresponsestatusmessage(void* lpObj);
QString GetSAMLResponseConsent(); QByteArray GetSAMLResponseContent();
int SetSAMLResponseContent(QByteArray qbaSAMLResponseContent); QString GetSAMLResponseDestination(); QString GetSAMLResponseId(); QString GetSAMLResponseInResponseTo(); QString GetSAMLResponseIssuedTime(); QString GetSAMLResponseIssuer(); int GetSAMLResponseType(); bool GetSAMLResponseSigned(); QString GetSAMLResponseStatusCodes(); QString GetSAMLResponseStatusMessage();
Remarks
This property provides information about the recently parsed SAML response. It can be set when calling the AuthenticateUser or ParseSAMLResponse methods. It is also used to provide a stored SAML response manually to the class.
Data Type
ServiceProviderMetadata Property (SAMLDesktop Class)
Information about a service provider's SAML metadata document.
Syntax
CloudSSOServiceProviderMetadata* GetServiceProviderMetadata(); int SetServiceProviderMetadata(CloudSSOServiceProviderMetadata* val);
int cloudsso_samldesktop_getserviceprovidermetadataauthnrequestsigned(void* lpObj);
int cloudsso_samldesktop_setserviceprovidermetadataauthnrequestsigned(void* lpObj, int bServiceProviderMetadataAuthnRequestSigned);
int cloudsso_samldesktop_getserviceprovidermetadatacontent(void* lpObj, char** lpServiceProviderMetadataContent, int* lenServiceProviderMetadataContent);
int cloudsso_samldesktop_setserviceprovidermetadatacontent(void* lpObj, const char* lpServiceProviderMetadataContent, int lenServiceProviderMetadataContent);
char* cloudsso_samldesktop_getserviceprovidermetadataentityid(void* lpObj);
int cloudsso_samldesktop_setserviceprovidermetadataentityid(void* lpObj, const char* lpszServiceProviderMetadataEntityId);
int cloudsso_samldesktop_getserviceprovidermetadatasignedmetadata(void* lpObj);
int cloudsso_samldesktop_setserviceprovidermetadatasignedmetadata(void* lpObj, int bServiceProviderMetadataSignedMetadata);
char* cloudsso_samldesktop_getserviceprovidermetadatasupportednameidformats(void* lpObj);
int cloudsso_samldesktop_setserviceprovidermetadatasupportednameidformats(void* lpObj, const char* lpszServiceProviderMetadataSupportedNameIdFormats);
int cloudsso_samldesktop_getserviceprovidermetadatawantassertionssigned(void* lpObj);
int cloudsso_samldesktop_setserviceprovidermetadatawantassertionssigned(void* lpObj, int bServiceProviderMetadataWantAssertionsSigned);
bool GetServiceProviderMetadataAuthnRequestSigned();
int SetServiceProviderMetadataAuthnRequestSigned(bool bServiceProviderMetadataAuthnRequestSigned); QByteArray GetServiceProviderMetadataContent();
int SetServiceProviderMetadataContent(QByteArray qbaServiceProviderMetadataContent); QString GetServiceProviderMetadataEntityId();
int SetServiceProviderMetadataEntityId(QString qsServiceProviderMetadataEntityId); 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 (SAMLDesktop Class)
The certificate used by the service provider when signing a SAMLRequest or SAML metadata document.
Syntax
CloudSSOCertificate* GetServiceProviderSigningCert(); int SetServiceProviderSigningCert(CloudSSOCertificate* val);
char* cloudsso_samldesktop_getserviceprovidersigningcerteffectivedate(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertexpirationdate(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertextendedkeyusage(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertfingerprint(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertfingerprintsha1(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertfingerprintsha256(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertissuer(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertprivatekey(void* lpObj);
int cloudsso_samldesktop_getserviceprovidersigningcertprivatekeyavailable(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertprivatekeycontainer(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertpublickey(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertpublickeyalgorithm(void* lpObj);
int cloudsso_samldesktop_getserviceprovidersigningcertpublickeylength(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertserialnumber(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertsignaturealgorithm(void* lpObj);
int cloudsso_samldesktop_getserviceprovidersigningcertstore(void* lpObj, char** lpServiceProviderSigningCertStore, int* lenServiceProviderSigningCertStore);
int cloudsso_samldesktop_setserviceprovidersigningcertstore(void* lpObj, const char* lpServiceProviderSigningCertStore, int lenServiceProviderSigningCertStore);
char* cloudsso_samldesktop_getserviceprovidersigningcertstorepassword(void* lpObj);
int cloudsso_samldesktop_setserviceprovidersigningcertstorepassword(void* lpObj, const char* lpszServiceProviderSigningCertStorePassword);
int cloudsso_samldesktop_getserviceprovidersigningcertstoretype(void* lpObj);
int cloudsso_samldesktop_setserviceprovidersigningcertstoretype(void* lpObj, int iServiceProviderSigningCertStoreType);
char* cloudsso_samldesktop_getserviceprovidersigningcertsubjectaltnames(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertthumbprintmd5(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertthumbprintsha1(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertthumbprintsha256(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertusage(void* lpObj);
int cloudsso_samldesktop_getserviceprovidersigningcertusageflags(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertversion(void* lpObj);
char* cloudsso_samldesktop_getserviceprovidersigningcertsubject(void* lpObj);
int cloudsso_samldesktop_setserviceprovidersigningcertsubject(void* lpObj, const char* lpszServiceProviderSigningCertSubject);
int cloudsso_samldesktop_getserviceprovidersigningcertencoded(void* lpObj, char** lpServiceProviderSigningCertEncoded, int* lenServiceProviderSigningCertEncoded);
int cloudsso_samldesktop_setserviceprovidersigningcertencoded(void* lpObj, const char* lpServiceProviderSigningCertEncoded, int lenServiceProviderSigningCertEncoded);
QString GetServiceProviderSigningCertEffectiveDate(); QString GetServiceProviderSigningCertExpirationDate(); QString GetServiceProviderSigningCertExtendedKeyUsage(); QString GetServiceProviderSigningCertFingerprint(); QString GetServiceProviderSigningCertFingerprintSHA1(); QString GetServiceProviderSigningCertFingerprintSHA256(); QString GetServiceProviderSigningCertIssuer(); QString GetServiceProviderSigningCertPrivateKey(); bool GetServiceProviderSigningCertPrivateKeyAvailable(); QString GetServiceProviderSigningCertPrivateKeyContainer(); QString GetServiceProviderSigningCertPublicKey(); QString GetServiceProviderSigningCertPublicKeyAlgorithm(); int GetServiceProviderSigningCertPublicKeyLength(); QString GetServiceProviderSigningCertSerialNumber(); QString GetServiceProviderSigningCertSignatureAlgorithm(); QByteArray GetServiceProviderSigningCertStore();
int SetServiceProviderSigningCertStore(QByteArray qbaServiceProviderSigningCertStore); QString GetServiceProviderSigningCertStorePassword();
int SetServiceProviderSigningCertStorePassword(QString qsServiceProviderSigningCertStorePassword); int GetServiceProviderSigningCertStoreType();
int SetServiceProviderSigningCertStoreType(int iServiceProviderSigningCertStoreType); QString GetServiceProviderSigningCertSubjectAltNames(); QString GetServiceProviderSigningCertThumbprintMD5(); QString GetServiceProviderSigningCertThumbprintSHA1(); QString GetServiceProviderSigningCertThumbprintSHA256(); QString GetServiceProviderSigningCertUsage(); int GetServiceProviderSigningCertUsageFlags(); QString GetServiceProviderSigningCertVersion(); QString GetServiceProviderSigningCertSubject();
int SetServiceProviderSigningCertSubject(QString qsServiceProviderSigningCertSubject); QByteArray GetServiceProviderSigningCertEncoded();
int SetServiceProviderSigningCertEncoded(QByteArray qbaServiceProviderSigningCertEncoded);
Remarks
This property contains the certificate that should be used if the SAML request (Authn and Logout) needs to be signed when calling AuthenticateUser. 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
SSLAcceptServerCert Property (SAMLDesktop Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
CloudSSOCertificate* GetSSLAcceptServerCert(); int SetSSLAcceptServerCert(CloudSSOCertificate* val);
char* cloudsso_samldesktop_getsslacceptservercerteffectivedate(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertexpirationdate(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertextendedkeyusage(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertfingerprint(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertfingerprintsha1(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertfingerprintsha256(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertissuer(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertprivatekey(void* lpObj);
int cloudsso_samldesktop_getsslacceptservercertprivatekeyavailable(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertprivatekeycontainer(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertpublickey(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertpublickeyalgorithm(void* lpObj);
int cloudsso_samldesktop_getsslacceptservercertpublickeylength(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertserialnumber(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertsignaturealgorithm(void* lpObj);
int cloudsso_samldesktop_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudsso_samldesktop_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);
char* cloudsso_samldesktop_getsslacceptservercertstorepassword(void* lpObj);
int cloudsso_samldesktop_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);
int cloudsso_samldesktop_getsslacceptservercertstoretype(void* lpObj);
int cloudsso_samldesktop_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);
char* cloudsso_samldesktop_getsslacceptservercertsubjectaltnames(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertthumbprintmd5(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertthumbprintsha1(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertthumbprintsha256(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertusage(void* lpObj);
int cloudsso_samldesktop_getsslacceptservercertusageflags(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertversion(void* lpObj);
char* cloudsso_samldesktop_getsslacceptservercertsubject(void* lpObj);
int cloudsso_samldesktop_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);
int cloudsso_samldesktop_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudsso_samldesktop_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
SSLCert Property (SAMLDesktop Class)
The certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
CloudSSOCertificate* GetSSLCert(); int SetSSLCert(CloudSSOCertificate* val);
char* cloudsso_samldesktop_getsslcerteffectivedate(void* lpObj);
char* cloudsso_samldesktop_getsslcertexpirationdate(void* lpObj);
char* cloudsso_samldesktop_getsslcertextendedkeyusage(void* lpObj);
char* cloudsso_samldesktop_getsslcertfingerprint(void* lpObj);
char* cloudsso_samldesktop_getsslcertfingerprintsha1(void* lpObj);
char* cloudsso_samldesktop_getsslcertfingerprintsha256(void* lpObj);
char* cloudsso_samldesktop_getsslcertissuer(void* lpObj);
char* cloudsso_samldesktop_getsslcertprivatekey(void* lpObj);
int cloudsso_samldesktop_getsslcertprivatekeyavailable(void* lpObj);
char* cloudsso_samldesktop_getsslcertprivatekeycontainer(void* lpObj);
char* cloudsso_samldesktop_getsslcertpublickey(void* lpObj);
char* cloudsso_samldesktop_getsslcertpublickeyalgorithm(void* lpObj);
int cloudsso_samldesktop_getsslcertpublickeylength(void* lpObj);
char* cloudsso_samldesktop_getsslcertserialnumber(void* lpObj);
char* cloudsso_samldesktop_getsslcertsignaturealgorithm(void* lpObj);
int cloudsso_samldesktop_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudsso_samldesktop_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
char* cloudsso_samldesktop_getsslcertstorepassword(void* lpObj);
int cloudsso_samldesktop_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
int cloudsso_samldesktop_getsslcertstoretype(void* lpObj);
int cloudsso_samldesktop_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
char* cloudsso_samldesktop_getsslcertsubjectaltnames(void* lpObj);
char* cloudsso_samldesktop_getsslcertthumbprintmd5(void* lpObj);
char* cloudsso_samldesktop_getsslcertthumbprintsha1(void* lpObj);
char* cloudsso_samldesktop_getsslcertthumbprintsha256(void* lpObj);
char* cloudsso_samldesktop_getsslcertusage(void* lpObj);
int cloudsso_samldesktop_getsslcertusageflags(void* lpObj);
char* cloudsso_samldesktop_getsslcertversion(void* lpObj);
char* cloudsso_samldesktop_getsslcertsubject(void* lpObj);
int cloudsso_samldesktop_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
int cloudsso_samldesktop_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudsso_samldesktop_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
SSLProvider Property (SAMLDesktop 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_samldesktop_getsslprovider(void* lpObj);
int cloudsso_samldesktop_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. |
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 (SAMLDesktop Class)
The server certificate for the last established connection.
Syntax
CloudSSOCertificate* GetSSLServerCert();
char* cloudsso_samldesktop_getsslservercerteffectivedate(void* lpObj);
char* cloudsso_samldesktop_getsslservercertexpirationdate(void* lpObj);
char* cloudsso_samldesktop_getsslservercertextendedkeyusage(void* lpObj);
char* cloudsso_samldesktop_getsslservercertfingerprint(void* lpObj);
char* cloudsso_samldesktop_getsslservercertfingerprintsha1(void* lpObj);
char* cloudsso_samldesktop_getsslservercertfingerprintsha256(void* lpObj);
char* cloudsso_samldesktop_getsslservercertissuer(void* lpObj);
char* cloudsso_samldesktop_getsslservercertprivatekey(void* lpObj);
int cloudsso_samldesktop_getsslservercertprivatekeyavailable(void* lpObj);
char* cloudsso_samldesktop_getsslservercertprivatekeycontainer(void* lpObj);
char* cloudsso_samldesktop_getsslservercertpublickey(void* lpObj);
char* cloudsso_samldesktop_getsslservercertpublickeyalgorithm(void* lpObj);
int cloudsso_samldesktop_getsslservercertpublickeylength(void* lpObj);
char* cloudsso_samldesktop_getsslservercertserialnumber(void* lpObj);
char* cloudsso_samldesktop_getsslservercertsignaturealgorithm(void* lpObj);
int cloudsso_samldesktop_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);
char* cloudsso_samldesktop_getsslservercertstorepassword(void* lpObj);
int cloudsso_samldesktop_getsslservercertstoretype(void* lpObj);
char* cloudsso_samldesktop_getsslservercertsubjectaltnames(void* lpObj);
char* cloudsso_samldesktop_getsslservercertthumbprintmd5(void* lpObj);
char* cloudsso_samldesktop_getsslservercertthumbprintsha1(void* lpObj);
char* cloudsso_samldesktop_getsslservercertthumbprintsha256(void* lpObj);
char* cloudsso_samldesktop_getsslservercertusage(void* lpObj);
int cloudsso_samldesktop_getsslservercertusageflags(void* lpObj);
char* cloudsso_samldesktop_getsslservercertversion(void* lpObj);
char* cloudsso_samldesktop_getsslservercertsubject(void* lpObj);
int cloudsso_samldesktop_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
Timeout Property (SAMLDesktop Class)
The timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int cloudsso_samldesktop_gettimeout(void* lpObj);
int cloudsso_samldesktop_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);
Default Value
60
Remarks
If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.
If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.
The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.
If Timeout expires, and the operation is not yet complete, the class fails with an error.
NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
WebServerBindings Property (SAMLDesktop Class)
The supported bindings used by the embedded web server.
Syntax
ANSI (Cross Platform) int GetWebServerBindings();
int SetWebServerBindings(int iWebServerBindings); Unicode (Windows) INT GetWebServerBindings();
INT SetWebServerBindings(INT iWebServerBindings);
Possible Values
CWB_AUTOMATIC(0),
CWB_REDIRECT(1),
CWB_POST(2)
int cloudsso_samldesktop_getwebserverbindings(void* lpObj);
int cloudsso_samldesktop_setwebserverbindings(void* lpObj, int iWebServerBindings);
int GetWebServerBindings();
int SetWebServerBindings(int iWebServerBindings);
Default Value
0
Remarks
This property specifies the supported protocol bindings to handle the SAML response from the Identity Provider. In most cases the default value of 0 (Automatic) is recommended. When set to 0 (Automatic), the class will support both the HTTP-Redirect and HTTP-POST bindings.
Possible values are as follows:
0 (cwbAutomatic - default) | Supports all bindings. |
1 (cwbRedirect) | Supports only the HTTP-Redirect binding. |
2 (cwbPost) | Supports only the HTTP-POST binding. |
Along with controlling the web server that is started by calling AuthenticateUser or StartWebServer, this setting also controls the endpoints added to the Service Provider metadata document when calling BuildServiceMetadata.
Data Type
Integer
WebServerPort Property (SAMLDesktop Class)
The local port on which the embedded web server listens.
Syntax
ANSI (Cross Platform) int GetWebServerPort();
int SetWebServerPort(int iWebServerPort); Unicode (Windows) INT GetWebServerPort();
INT SetWebServerPort(INT iWebServerPort);
int cloudsso_samldesktop_getwebserverport(void* lpObj);
int cloudsso_samldesktop_setwebserverport(void* lpObj, int iWebServerPort);
int GetWebServerPort();
int SetWebServerPort(int iWebServerPort);
Default Value
0
Remarks
This property specifies the port on which the embedded web server listens. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.
Data Type
Integer
WebServerSSLCert Property (SAMLDesktop Class)
The certificate with the private key to use when a Secure Sockets Layer (SSL) is enabled.
Syntax
CloudSSOCertificate* GetWebServerSSLCert(); int SetWebServerSSLCert(CloudSSOCertificate* val);
char* cloudsso_samldesktop_getwebserversslcerteffectivedate(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertexpirationdate(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertextendedkeyusage(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertfingerprint(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertfingerprintsha1(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertfingerprintsha256(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertissuer(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertprivatekey(void* lpObj);
int cloudsso_samldesktop_getwebserversslcertprivatekeyavailable(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertprivatekeycontainer(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertpublickey(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertpublickeyalgorithm(void* lpObj);
int cloudsso_samldesktop_getwebserversslcertpublickeylength(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertserialnumber(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertsignaturealgorithm(void* lpObj);
int cloudsso_samldesktop_getwebserversslcertstore(void* lpObj, char** lpWebServerSSLCertStore, int* lenWebServerSSLCertStore);
int cloudsso_samldesktop_setwebserversslcertstore(void* lpObj, const char* lpWebServerSSLCertStore, int lenWebServerSSLCertStore);
char* cloudsso_samldesktop_getwebserversslcertstorepassword(void* lpObj);
int cloudsso_samldesktop_setwebserversslcertstorepassword(void* lpObj, const char* lpszWebServerSSLCertStorePassword);
int cloudsso_samldesktop_getwebserversslcertstoretype(void* lpObj);
int cloudsso_samldesktop_setwebserversslcertstoretype(void* lpObj, int iWebServerSSLCertStoreType);
char* cloudsso_samldesktop_getwebserversslcertsubjectaltnames(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertthumbprintmd5(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertthumbprintsha1(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertthumbprintsha256(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertusage(void* lpObj);
int cloudsso_samldesktop_getwebserversslcertusageflags(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertversion(void* lpObj);
char* cloudsso_samldesktop_getwebserversslcertsubject(void* lpObj);
int cloudsso_samldesktop_setwebserversslcertsubject(void* lpObj, const char* lpszWebServerSSLCertSubject);
int cloudsso_samldesktop_getwebserversslcertencoded(void* lpObj, char** lpWebServerSSLCertEncoded, int* lenWebServerSSLCertEncoded);
int cloudsso_samldesktop_setwebserversslcertencoded(void* lpObj, const char* lpWebServerSSLCertEncoded, int lenWebServerSSLCertEncoded);
QString GetWebServerSSLCertEffectiveDate(); QString GetWebServerSSLCertExpirationDate(); QString GetWebServerSSLCertExtendedKeyUsage(); QString GetWebServerSSLCertFingerprint(); QString GetWebServerSSLCertFingerprintSHA1(); QString GetWebServerSSLCertFingerprintSHA256(); QString GetWebServerSSLCertIssuer(); QString GetWebServerSSLCertPrivateKey(); bool GetWebServerSSLCertPrivateKeyAvailable(); QString GetWebServerSSLCertPrivateKeyContainer(); QString GetWebServerSSLCertPublicKey(); QString GetWebServerSSLCertPublicKeyAlgorithm(); int GetWebServerSSLCertPublicKeyLength(); QString GetWebServerSSLCertSerialNumber(); QString GetWebServerSSLCertSignatureAlgorithm(); QByteArray GetWebServerSSLCertStore();
int SetWebServerSSLCertStore(QByteArray qbaWebServerSSLCertStore); QString GetWebServerSSLCertStorePassword();
int SetWebServerSSLCertStorePassword(QString qsWebServerSSLCertStorePassword); int GetWebServerSSLCertStoreType();
int SetWebServerSSLCertStoreType(int iWebServerSSLCertStoreType); QString GetWebServerSSLCertSubjectAltNames(); QString GetWebServerSSLCertThumbprintMD5(); QString GetWebServerSSLCertThumbprintSHA1(); QString GetWebServerSSLCertThumbprintSHA256(); QString GetWebServerSSLCertUsage(); int GetWebServerSSLCertUsageFlags(); QString GetWebServerSSLCertVersion(); QString GetWebServerSSLCertSubject();
int SetWebServerSSLCertSubject(QString qsWebServerSSLCertSubject); QByteArray GetWebServerSSLCertEncoded();
int SetWebServerSSLCertEncoded(QByteArray qbaWebServerSSLCertEncoded);
Remarks
This property specifies the certificate with the private key to use when the embedded web server is used. This setting is applicable only when WebServerSSLEnabled is set to True.
Data Type
WebServerSSLEnabled Property (SAMLDesktop Class)
Whether the web server requires Secure Sockets Layer (SSL) connections.
Syntax
ANSI (Cross Platform) int GetWebServerSSLEnabled();
int SetWebServerSSLEnabled(int bWebServerSSLEnabled); Unicode (Windows) BOOL GetWebServerSSLEnabled();
INT SetWebServerSSLEnabled(BOOL bWebServerSSLEnabled);
int cloudsso_samldesktop_getwebserversslenabled(void* lpObj);
int cloudsso_samldesktop_setwebserversslenabled(void* lpObj, int bWebServerSSLEnabled);
bool GetWebServerSSLEnabled();
int SetWebServerSSLEnabled(bool bWebServerSSLEnabled);
Default Value
FALSE
Remarks
This setting specifies whether the embedded web server uses a Secure Sockets Layer (SSL). If set to True, WebServerSSLCert is required and the server will accept only SSL connections. If set to False, only plaintext connects are supported.
Data Type
Boolean
AuthenticateUser Method (SAMLDesktop Class)
Authenticates a user to the application.
Syntax
ANSI (Cross Platform) int AuthenticateUser(); Unicode (Windows) INT AuthenticateUser();
int cloudsso_samldesktop_authenticateuser(void* lpObj);
int AuthenticateUser();
Remarks
This method will attempt to authenticate the current user using the setting from the following properties and fields:
- IdentityProviderMetadata
- IdentityProviderSigningCert
- IdentityProviderURIs
- SAMLRequestSettings
- ServiceProviderSigningCert
- WebServerBindings
- WebServerPort
- WebServerSSLEnabled
The method will first try to launch a web browser window that directs a user to the configured Identity Provider's sign-on page. The user will then go through the authentication process with the Identity Provider, and typically provide consent to allow the service provider (your application) access to their user information. Then, the Identity Provider will return the user back to the application.
At the same time that the user is directed to the sign-on page, the class will also start an internal web server that will be listening for when the user returns. Once the user has returned, the web server will parse the information and validate it.
The method that is used to send the user to the sign-on page and the method that is used to return the user depends on the configuration of the Service Provider and the Identity Provider. The component supports two bindings that define different methods for communicate.
The HTTP-Redirect binding defines communication that happens over HTTP GET requests and provides the recipient with the information for the request or response through the query parameters. Typically, and by default, this is used when directing the user to the sign-on page. The reason it is not often used for the response from the Identity Provider is that the responses are often required which makes them too long for query parameters. If the HTTP-Redirect binding needs to be used with a signed request or response, it will instead use a detached signature.
The HTTP-POST binding defines communication that happens over HTTP POST requests and provides the recipient with the information for the request or response through a form post. Typically, this is used to receive the response from the Identity Provider. Since this binding uses a form post, there are less constraints on how long the response can be. This binding can be used to direct a user to the sign-on page if required. The class will first direct the user to an empty HTML page that will then submit a form post to the sign-on page.
Once the user has finished authetnicating with the Identity Provider, they will be returned to the ReturnURL. Typically, this will be the embedded web server started (if not already running) when AuthenticateUser is called. After the SAML response has been received by the class, it will parse and validate the SAML response. The results are stored in the SAMLResponseInfo property if the SAMLResponse is valid. If the authentication was successful on the Identity Provider's side, it will also parse and validate the assertion. Information about the assertion can be access by accessing the AssertionInfo, AssertionAttributeInfo, and AssertionInfo properties.
This method is the equivalent of using the following methods on an already saved SAML response. See each method for an in-depth review of how each step operates.
If this method completes without any exceptions, then both the SAML response and assertion are valid meaning the user that is described by the SubjectNameId can be considered authenticated to this application.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
BuildServiceMetadata Method (SAMLDesktop Class)
Builds a metadata document for a service provider.
Syntax
ANSI (Cross Platform) int BuildServiceMetadata(); Unicode (Windows) INT BuildServiceMetadata();
int cloudsso_samldesktop_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 when configuring SAML SSO.
The following fields and properties are used:
- AuthnRequestSigned
- EntityId
- SignedMetadata
- SupportedNameIdFormats
- WantAssertionsSigned
- ReturnURL
- ServiceProviderSigningCert
- WebServerBindings
- WebServerPort
- WebServerSSLEnabled
The EntityId field is important to keep static. The Identity Provider uses this to confirm who made the authenticate request and will need to match the configured value. When making an calling AuthenticateUser, the Issuer field should be set to match this value.
The WebServer* settings should be set to allow the class to correctly build the assertion consumer service (ACS) endpoints that are supported by the application. The ACS endpoints are where users are returned from the Identity Provider with the SAML response that needs to be parsed and validated by the class. When this method completes, the ReturnURL property will be set with this location as well. If a specific URI needs to be set instead, set the ReturnURL property directly.
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 (SAMLDesktop Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* cloudsso_samldesktop_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 (SAMLDesktop Class)
This method processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int cloudsso_samldesktop_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 (SAMLDesktop Class)
Searches for a specific assertion attribute.
Syntax
ANSI (Cross Platform) char* GetAssertionAttribute(const char* lpszattrName); Unicode (Windows) LPWSTR GetAssertionAttribute(LPCWSTR lpszattrName);
char* cloudsso_samldesktop_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 (SAMLDesktop Class)
This method interrupts the current method.
Syntax
ANSI (Cross Platform) int Interrupt(); Unicode (Windows) INT Interrupt();
int cloudsso_samldesktop_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 (SAMLDesktop 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_samldesktop_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 (SAMLDesktop Class)
Parses an assertion.
Syntax
ANSI (Cross Platform) int ParseAssertion(); Unicode (Windows) INT ParseAssertion();
int cloudsso_samldesktop_parseassertion(void* lpObj);
int ParseAssertion();
Remarks
This method parses the assertion found in the AssertionInfo property. The raw assertion that is parsed provided to the class by setting the Content field. 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 (SAMLDesktop Class)
Parses a SAML response.
Syntax
ANSI (Cross Platform) int ParseSAMLResponse(); Unicode (Windows) INT ParseSAMLResponse();
int cloudsso_samldesktop_parsesamlresponse(void* lpObj);
int ParseSAMLResponse();
Remarks
This method parses the SAML response found in the SAMLResponseInfo property by setting the Content field. If the method is able to successfully parse the SAML response, the information fields in the SAMLResponseInfo property are populated.
To validate a SAML response, see ValidateSAMLResponse.
Additionally, if the ResponseType is srtAuthn, the Content 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.)
RequestIdentityMetadata Method (SAMLDesktop 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_samldesktop_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 (SAMLDesktop Class)
This method will reset the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int cloudsso_samldesktop_reset(void* lpObj);
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
StartWebServer Method (SAMLDesktop Class)
Starts the embedded web server.
Syntax
ANSI (Cross Platform) int StartWebServer(); Unicode (Windows) INT StartWebServer();
int cloudsso_samldesktop_startwebserver(void* lpObj);
int StartWebServer();
Remarks
This method starts the embedded web server. This method can be used to manually start the embedded web server. Under normal circumstances, this is not needed as the component will automatically start and stop the web server when AuthenticateUser is called. You may decide, however, to start the web server manually before calling AuthenticateUser. When called, this method will also populate ReturnURL with the address of the embedded server if the property is empty.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
StopWebServer Method (SAMLDesktop Class)
Stops the embedded web server.
Syntax
ANSI (Cross Platform) int StopWebServer(); Unicode (Windows) INT StopWebServer();
int cloudsso_samldesktop_stopwebserver(void* lpObj);
int StopWebServer();
Remarks
This method stops the embedded web server. Under normal circumstances, the web server will be stopped automatically during the authentication process when AuthenticateUser is called.
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 (SAMLDesktop Class)
Validates an assertion.
Syntax
ANSI (Cross Platform) int ValidateAssertion(); Unicode (Windows) INT ValidateAssertion();
int cloudsso_samldesktop_validateassertion(void* lpObj);
int ValidateAssertion();
Remarks
This method validates the assertion found in the AssertionInfo property. If an assertion is validated properly, then the user of the application can be authenticated as the subject of the assertion. If the validation fails, then the user should not be authenticated to the application.
The assertion needs to be parsed before it can be validated. You can either be manually set via the Content field or by first calling ParseSAMLResponse on a SAML response 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 | Identity Provider's EntityId |
InResponseTo Attribute | Id |
Recipient Attribute | ReturnURL |
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 (SAMLDesktop Class)
Validates a SAML response.
Syntax
ANSI (Cross Platform) int ValidateSAMLResponse(); Unicode (Windows) INT ValidateSAMLResponse();
int cloudsso_samldesktop_validatesamlresponse(void* lpObj);
int ValidateSAMLResponse();
Remarks
This method validates a SAML response. If a SAML response is successfully validated and in response to an authentication request, then the assertion should be parsed and validated to finish the authentication process. If it is in response to a logout request, then the application should finish it's logout process for the user.
The SAML response must first be parsed by calling the ParseSAMLResponse method. Before attempting validation, the SAMLResponse event provides an opportunity to configure the class to successfully validate the SAML response.
The following checks are performed on the SAML response:
Validation Check | Required Property or Field |
Signature (if found) | IdentityProviderSigningCert |
Issuer Element | Identity Provider's EntityId |
InResponseTo Attribute | Id |
Destination Attribute | ReturnURL |
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 SAML response. 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.)
Error Event (SAMLDesktop Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(SAMLDesktopErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SAMLDesktopErrorEventParams;
Unicode (Windows) virtual INT FireError(SAMLDesktopErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SAMLDesktopErrorEventParams;
#define EID_SAMLDESKTOP_ERROR 1 virtual INT CLOUDSSO_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class SAMLDesktopErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SAMLDesktopErrorEventParams *e);
// Or, subclass SAMLDesktop and override this emitter function. virtual int FireError(SAMLDesktopErrorEventParams *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.
LaunchBrowser Event (SAMLDesktop Class)
Fires before launching a browser with the SAML request.
Syntax
ANSI (Cross Platform) virtual int FireLaunchBrowser(SAMLDesktopLaunchBrowserEventParams *e);
typedef struct {
char *URL;
char *Command; int reserved; } SAMLDesktopLaunchBrowserEventParams;
Unicode (Windows) virtual INT FireLaunchBrowser(SAMLDesktopLaunchBrowserEventParams *e);
typedef struct {
LPWSTR URL;
LPWSTR Command; INT reserved; } SAMLDesktopLaunchBrowserEventParams;
#define EID_SAMLDESKTOP_LAUNCHBROWSER 2 virtual INT CLOUDSSO_CALL FireLaunchBrowser(LPSTR &lpszURL, LPSTR &lpszCommand);
class SAMLDesktopLaunchBrowserEventParams { public: const QString &URL(); void SetURL(const QString &qsURL); const QString &Command(); void SetCommand(const QString &qsCommand); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void LaunchBrowser(SAMLDesktopLaunchBrowserEventParams *e);
// Or, subclass SAMLDesktop and override this emitter function. virtual int FireLaunchBrowser(SAMLDesktopLaunchBrowserEventParams *e) {...}
Remarks
When the AuthenticateUser method is called, the class will fire this event with the Command, which will be executed by the class. The URL parameter will be the URL that the user will be directed to authenticate.
Within this event, you may override the current value of either Command or URL and provide your own value. If Command is set to an empty string, the class will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter.
In Windows, ShellExecute is used to execute Command, which limits the verbs available for use in Command to:
- edit
- explore
- find
- open
Log Event (SAMLDesktop Class)
Fired once for each log message.
Syntax
ANSI (Cross Platform) virtual int FireLog(SAMLDesktopLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } SAMLDesktopLogEventParams;
Unicode (Windows) virtual INT FireLog(SAMLDesktopLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } SAMLDesktopLogEventParams;
#define EID_SAMLDESKTOP_LOG 3 virtual INT CLOUDSSO_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class SAMLDesktopLogEventParams { 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(SAMLDesktopLogEventParams *e);
// Or, subclass SAMLDesktop and override this emitter function. virtual int FireLog(SAMLDesktopLogEventParams *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 (SAMLDesktop Class)
Fired when a redirection is received from the server.
Syntax
ANSI (Cross Platform) virtual int FireRedirect(SAMLDesktopRedirectEventParams *e);
typedef struct {
const char *Location;
int Accept; int reserved; } SAMLDesktopRedirectEventParams;
Unicode (Windows) virtual INT FireRedirect(SAMLDesktopRedirectEventParams *e);
typedef struct {
LPCWSTR Location;
BOOL Accept; INT reserved; } SAMLDesktopRedirectEventParams;
#define EID_SAMLDESKTOP_REDIRECT 4 virtual INT CLOUDSSO_CALL FireRedirect(LPSTR &lpszLocation, BOOL &bAccept);
class SAMLDesktopRedirectEventParams { 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(SAMLDesktopRedirectEventParams *e);
// Or, subclass SAMLDesktop and override this emitter function. virtual int FireRedirect(SAMLDesktopRedirectEventParams *e) {...}
Remarks
This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.
ReturnURL Event (SAMLDesktop Class)
Fired when the user is redirected to the embedded web server.
Syntax
ANSI (Cross Platform) virtual int FireReturnURL(SAMLDesktopReturnURLEventParams *e);
typedef struct {
const char *URLPath;
const char *QueryString;
char *ResponseHeaders;
char *ResponseBody; int reserved; } SAMLDesktopReturnURLEventParams;
Unicode (Windows) virtual INT FireReturnURL(SAMLDesktopReturnURLEventParams *e);
typedef struct {
LPCWSTR URLPath;
LPCWSTR QueryString;
LPWSTR ResponseHeaders;
LPWSTR ResponseBody; INT reserved; } SAMLDesktopReturnURLEventParams;
#define EID_SAMLDESKTOP_RETURNURL 5 virtual INT CLOUDSSO_CALL FireReturnURL(LPSTR &lpszURLPath, LPSTR &lpszQueryString, LPSTR &lpszResponseHeaders, LPSTR &lpszResponseBody);
class SAMLDesktopReturnURLEventParams { public: const QString &URLPath(); const QString &QueryString(); const QString &ResponseHeaders(); void SetResponseHeaders(const QString &qsResponseHeaders); const QString &ResponseBody(); void SetResponseBody(const QString &qsResponseBody); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReturnURL(SAMLDesktopReturnURLEventParams *e);
// Or, subclass SAMLDesktop and override this emitter function. virtual int FireReturnURL(SAMLDesktopReturnURLEventParams *e) {...}
Remarks
When ClientProfile is set to ocpApplication and the embedded web server is used (default), this event will fire when the user is redirected from the authorization server back to the local embedded web server. The event provides an opportunity to set the ResponseHeaders and ResponseBody and to provide a custom response that the user will see in their browser.
URLPath and QueryString are informational parameters that show the values sent by the authorization server.
Additionally, the Params properties will be populated. This allows the GetParam method to be used to get a specific parameter returned from the authorization server when used within this event.
SSLServerAuthentication Event (SAMLDesktop Class)
Fired after the server presents its certificate to the client.
Syntax
ANSI (Cross Platform) virtual int FireSSLServerAuthentication(SAMLDesktopSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } SAMLDesktopSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(SAMLDesktopSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } SAMLDesktopSSLServerAuthenticationEventParams;
#define EID_SAMLDESKTOP_SSLSERVERAUTHENTICATION 6 virtual INT CLOUDSSO_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class SAMLDesktopSSLServerAuthenticationEventParams { 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(SAMLDesktopSSLServerAuthenticationEventParams *e);
// Or, subclass SAMLDesktop and override this emitter function. virtual int FireSSLServerAuthentication(SAMLDesktopSSLServerAuthenticationEventParams *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 (SAMLDesktop Class)
Fired when secure connection progress messages are available.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(SAMLDesktopSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } SAMLDesktopSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(SAMLDesktopSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } SAMLDesktopSSLStatusEventParams;
#define EID_SAMLDESKTOP_SSLSTATUS 7 virtual INT CLOUDSSO_CALL FireSSLStatus(LPSTR &lpszMessage);
class SAMLDesktopSSLStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(SAMLDesktopSSLStatusEventParams *e);
// Or, subclass SAMLDesktop and override this emitter function. virtual int FireSSLStatus(SAMLDesktopSSLStatusEventParams *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.
Fields
Content
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.
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 |
ValueCount
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 ValueIndex for more information.
ValueData
char* (read-only)
Default Value: ""
The content of the attribute value selected by ValueIndex.
ValueIndex
int
Default Value: 0
The index of the attribute value that should be populated in the ValueData field. Valid ranges for this field are from 0 to ValueCount - 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].ValueCount; i++) {
saml.AssertionAttributeInfo[0].ValueIndex = i;
string attribute_value = saml.AssertionAttributeInfo[0].ValueData;
//... the rest of the processing
}
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.
- Content
- ExpirationDate
- Id
- IsSigned
- IssuedTime
- Issuer
- NotBeforeDate
- OneTimeUse
- SubjectNameId
- SubjectNameIdFormat
Fields
Content
char*
Default Value: ""
The raw XML of the assertion. This field can be set to provide the assertion to the class for the ParseAssertion or ValidateAssertion methods to parse or validate the assertion without the SAML response.
ExpirationDate
char* (read-only)
Default Value: ""
When the parsed assertion is expired. If expired, a new assertion should be requested from the Identity Provider for the subject. 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 pf the SAML response, but rather to the assertion itself.
IsSigned
int (read-only)
Default Value: FALSE
Whether the assertion has been signed by the identity provider. The signature is used to verify that the assertion has not been tampered with during transmission. Typically, the assertion is signed along with the SAML response that stores it. 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. The issuer of the SAML response can differ if Identity Provider is an intermediary between the service provider and the final Identity Provider. 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 unique name identifier for the subject of the current assertion. In the SSO SAML profile, the subject is the user that is being authenticated. Since this value is unique to the user (from the Identity Provider) this value is typically used to also identify the user in an application. 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 |
Constructors
AssertionInfo()
AuthnStatement Type
An Authn statement from an assertion.
Syntax
CloudSSOAuthnStatement (declared in cloudsso.h)
Remarks
The fields of this type describe one authentication (Authn) statement from an assertion in response to an authentication request.
- AuthenticatingAuthorites
- Content
- ContextClassReference
- ContextDeclaration
- Instant
- SessionExpiration
- SessionIndex
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.
Content
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.
ContextClassReference
char* (read-only)
Default Value: ""
A predefined 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.
Instant
char* (read-only)
Default Value: ""
The time at which the authentication took place that was used to issue 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
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). Additionally, it is common practice to provide the session index when performing SLO (Single Logout) if supported.
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.
- EffectiveDate
- ExpirationDate
- ExtendedKeyUsage
- Fingerprint
- FingerprintSHA1
- FingerprintSHA256
- Issuer
- PrivateKey
- PrivateKeyAvailable
- PrivateKeyContainer
- PublicKey
- PublicKeyAlgorithm
- PublicKeyLength
- SerialNumber
- SignatureAlgorithm
- Store
- StorePassword
- StoreType
- SubjectAltNames
- ThumbprintMD5
- ThumbprintSHA1
- ThumbprintSHA256
- Usage
- UsageFlags
- Version
- Subject
- Encoded
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root 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:
|
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:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher 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=example@email.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email 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.
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.
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.
- Content
- EntityId
- ExpirationDate
- RequestsSignedAuthnRequests
- SignedMetadata
- SupportedAttributeProfiles
- SupportedAttributes
- SupportedNameIdFormats
Fields
Content
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.
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 SAML response or assertion.
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.
RequestsSignedAuthnRequests
int
Default Value: FALSE
Whether the identity provider requests that authentication (Authn) requests are signed. If true, the SignRequest setting should be set to true before initiating authentication.
SignedMetadata
int (read-only)
Default Value: FALSE
Whether the identity provider's parsed metadata is signed. This signature is used to insure that the metadata was not tampered with during transit.
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.
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 SAML request.
Syntax
CloudSSOSAMLRequestSettings (declared in cloudsso.h)
Remarks
The fields of this type are the settings used when building a SAML request for an Authentication (Authn) or Logout.
- AllowCreate
- Binding
- Consent
- Destination
- Id
- IssuedTime
- Issuer
- NameIdFormat
- SelectedEndpoint
- SessionIndex
- SignRequest
- UseDefaultEndpoint
Fields
AllowCreate
int
Default Value: FALSE
This setting is only used for authentication requests. It controls 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.
Binding
int
Default Value: 0
This setting controls the binding that will be used to make the request.
By default, the class will use the sbHTTPRedirect binding which provides the SAMLRequest value through a query parameter. The sbHTTPRedirect binding will set just the SAMLRequestURL property.
If set to the sbHTTPPost binding, the SAMLRequest value 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 (sbHTTPRedirect - default) | HTTP Redirect Binding | urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect |
1 (sbHTTPPost) | 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.
Consent
int
Default Value: 0
This setting specifies 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 SAML request.
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 CustomConsent 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: ""
This setting specifies a URI reference for the intended destination for the SAML request. This is useful to prevent malicious forwarding of responses to unintended recipients. If left blank the class will set this to match the endpoint selected by the class. See UseDefaultEndpoint and SelectedEndpoint for more information.
Id
char*
Default Value: ""
This setting specifies the unique Id of the SAML request.
When building a SAML request using the BuildAuthnRequest or BuildLogoutRequest methods, the class will use this value for the Id attribute in the request. If left empty before building the request, the class will generate a new one.
When validating a SAML response or assertion, this field is used to provide the Id of the request to the class. The SAML response and assertion both have an InResponseTo attribute that needs to match this field. See InResponseTo for more information. This is important, to check to ensure that the SAML response or assertion was in response to a request that was made by this application.
Due to needing the value for validation purposes this setting, (along with the Issuer field) should be cached in a secure location for later. This Id should match the Id of the InResponseTo attribute of the matching SAMLResponse . Due to this, after BuildAuthnRequest or BuildLogoutRequest is used to create a request, this setting
IssuedTime
char*
Default Value: ""
This setting sets the time at which the SAML request 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
This setting is only used for authentication requests. If supported by the Identity Provider, this setting can be used to tailor the name identifier for the subject in the response to an authentication request.
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 authentication request. If a format needs to be used that is not listed here, the snidCustom value can be used instead. When set, the CustomNameIdFormat 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 |
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.
SessionIndex
char*
Default Value: ""
This setting only applies when building SAML logout requests. SessionIndex identifies the current session of the user that is being ended when the BuildLogoutRequest method is called. When the ProcessSAMLResponse or ParseAssertion methods are called, the SessionIndex field will be set to the session index from the Identity Provider. Providing the session index with the logout request will typically cause the Identity Provider to send logout requests to all participating services that are also part of the session.
SignRequest
int
Default Value: FALSE
This setting controls whether the SAML request should be signed when 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 SAML response.
Syntax
CloudSSOSAMLResponseInfo (declared in cloudsso.h)
Remarks
The fields of this type describe a SAML response that has been parsed or processed by the class.
- Consent
- Content
- Destination
- Id
- InResponseTo
- IssuedTime
- Issuer
- ResponseType
- Signed
- StatusCodes
- StatusMessage
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 matches the method 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:2.0:consent:prior
- 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
Content
char*
Default Value: ""
The full XML of the SAML response after being parsed or processed by the class. Optionally, this setting can be set to provide a SAML response directly to the class to be parsed or processed.
Destination
char* (read-only)
Default Value: ""
A URI reference for the intended destination for the SAML response. This is useful to prevent malicious forwarding of responses to unintended recipients.
Id
char* (read-only)
Default Value: ""
The unique Id for the SAML response that was created by the Issuer.
InResponseTo
char* (read-only)
Default Value: ""
The Id of the SAML request that requested the Identity Provider to issue this SAML response. The class validates this field against the original Id of the SAML request which Id should be set to.
IssuedTime
char* (read-only)
Default Value: ""
The time at which the SAML response 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 SAML response. Typically, this will be the EntityId of the Identity Provider.
ResponseType
int (read-only)
Default Value: 0
The type of SAML response that was parsed or processed.
0 (srtUnknown - default) | The class was unable to determine the type of response contained in the SAML response. |
1 (srtAuthn) | The class found a Response in the SAML response. |
2 (srtLogout) | The class found a LogoutResponse in the SAML response. |
Signed
int (read-only)
Default Value: FALSE
Whether the SAML response is signed. If the SAML response 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 SAML response. A compliant SAML response 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.. |
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 SAML response. 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.
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.
Content
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.
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.
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.
Fields
BindingRef
char*
Default Value: "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
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 SAMLDesktop class.
Config Settings (SAMLDesktop 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.SAMLDesktop Config Settings
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:
0x00000001 | Ignore the SubjectConfirmation element. |
0x00000002 | Ignore the AuthnStatement element. |
0x00000004 | Ignore the Issuer element. |
0x00000008 | Ignore the assertion's signature (does not apply to the SAMLResponse element if that is signed). |
0x00000010 | Ignores a mismatch between the certificates set in the class and the one found in the signature of the assertion. |
0x00000020 | Ignores the Conditions element. |
When the Consent field is set to scidCustom - 99, this configuration setting can be used to set the custom URI reference to the consent type.
When the NameIdFormat field is set to snidCustom - 99, this configuration setting can be used to set the custom URI reference to the NameID format type.
This configuration setting can be set to a detached signature of a SAML response so that it can be validated. This value should be URL decoded before providing it to the class. To set the signing algorithm, see SAMLResponseDetachedSignatureAlg for more information.
Particularly, when the Content field is used to provide a SAMLResponse element 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 SAML response.
This configuration setting can be set to the signing algorithm used to created the detached signature of a SAML response. This value should be URL decoded before providing it to the class. To set the signature value, see SAMLResponseDetachedSignature for more information.
This setting informs the class to skip certain checks when validating a parsed SAMLResponse element. The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:
0x00000001 | Ignore the InResponseTo attribute. |
0x00000002 | Ignore the destination attribute. |
0x00000004 | Ignore the Issuer element. |
0x00000008 | Ignore the SAMLResponse element's signature (does not apply to the Assertion element if signed). |
0x00000010 | Ignores a mismatch between the certificates set in the class and the one found in the signature of the SAMLResponse element. |
0x00000020 | Ignores a status that is not set to a success. |
This configuration setting only applies to request made with the HTTP-Redirect binding. By default, it is set to true. When set to true, the class will sign the SAMLRequest element using a detached signature. When set to false the class will instead include the signature within the request.
WebServer Config Settings
This configuration setting specifies the amount of time (in seconds) the component will wait for a response from the browser in the LaunchBrowser event. The default value is 0, meaning that the component will wait indefinitely.
When AuthenticateUser is called, the user will be redirected to the embedded web server upon completing authentication with the Identity Provider. If authentication fails, the HTML specified here will be sent to the user's browser.
This configuration setting specifies the hostname used by the embedded web server. This specifies the interface on which the embedded web server listens and also the value displayed in the ReturnURL. This should be set to the hostname only, and not to the full URL.
The default value is localhost.
When AuthenticateUser is called, the user will be redirected to the embedded web server upon completing authentication with the Identity Provider. This setting allows you to specify the HTML that will be sent to the user's browser.
HTTP Config Settings
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.
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.
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.
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.
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]".
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.
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.
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.
If set to True, the URL passed to the class will be URL encoded. The default value is False.
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
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.
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.
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") or HTTP/3 ("3.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.
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.
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.
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.
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).
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.
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.
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.
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.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting is provided for use by classs that do not directly expose Proxy properties.
This configuration setting returns the complete set of raw headers as sent by the client.
This configuration setting contains the result code 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].
This configuration setting contains the contents of the last response from the server.
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.
This configuration setting returns the complete set of raw headers as received from the server.
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"));
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.
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.
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.
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.
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
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.
This configuration setting is provided for use by classs that do not directly expose Firewall properties.
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.
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.
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.
Possible values are as follows:
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect 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.
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.
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.
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.
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.
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 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.
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).
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 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.
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.
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.example.com
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.
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.
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 |
When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.
SSL Config Settings
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.
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.
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.
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".
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.
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.
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
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-----
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.
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-----
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
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.
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.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (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.
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.
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.
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.
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]");
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]");
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]");
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]");
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]");
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]");
The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
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-----
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.
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)
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"
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)
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
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.
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).
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.
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
When queried, this setting will return a string containing information about the product's build.
The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
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.
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.
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.
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.
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 (SAMLDesktop 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.
SAMLDesktop Errors
500 | Unable to request SAML metadata document. The URL provided was invalid. |
550 | Unable to parse or process SAML response. The provided SAML response from the Identity Service contained invalid HTTP headers. |
600 | Unable to parse or process SAML response. The SAML response is missing. |
650 | Unable to parse or process SAML response. The HTTP-POST binding request is invalid. |
680 | Unable to build SAML request. The SAML request is missing an Id. |
681 | Unable to build SAML request. The issued time instance of the SAML repsonse is missing. |
700 | SAML response verification failed. The Id of the SAML response is missing. |
701 | SAML response verification failed. The version attribute in the SAML response is missing or invalid. |
702 | SAML response verification failed. The issued time instant in the SAML response is missing. |
703 | SAML response verification failed. The authentication time instant in the SAML response is missing. |
704 | SAML response verification failed. The SAML response's signature is invalid. |
705 | SAML response verification failed. The certificate found in the SAML response's signature does not match the provided certificate. |
706 | SAML response verification failed. The SAML response is in response to a different request than the one configured. |
707 | SAML response verification failed. The entity Id of the SAML response issuer is different than the one configured. |
708 | SAML response verification failed. The SAML response is meant for a different location (URI) than the ones configured. |
708 | SAML response verification failed. The SAML response needs to be parsed before ValidateSAMLResponse can be called. |
750 | Assertion verification failed. The method used for the subject confirmation in the assertion is invalid. |
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 than the configured URIs. |
754 | Assertion verification failed. The assertion is in response to a different request than the one configured. |
755 | Assertion verification failed. The entity Id of the assertion issuer is different than the one configured. |
756 | Assertion verification failed. The linked authentication session of the assertion is expired. |
757 | Assertion verification failed. The signature found in the assertion is expired. |
758 | Assertion verification failed. Certificate found in the 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). |