SAML Component

Properties Methods Events Config Settings Errors

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

Syntax

nsoftware.CloudSSO.SAML

Remarks

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

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

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

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

Setup

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

Usage: Requesting and Reloading Identity Provider Metadata Document

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

Additionally, the component needs to be configured with the information about the Service Provider (ie. your application). The ServiceProviderMetadata, ServiceProviderSigningCert, and ServiceProviderURIs properties can be used to provide information about the Service Provider. This is used by the component to build SAML requests and to verify SAML responses and assertions. Additionally, to easily supply this information to an Identity Provider, the BuildServiceMetadata method can be used to create a SAML Metadata Document.

Usage: Configuring Service Provider Metadata

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

Authentication Request

Once configured, the BuildAuthnRequest method can be used to build a SAMLRequest that has been configured by the SAMLRequestSettings. Additionally, to provide state information between the request and the response, the RelayState property can be set. When provided by the Service Provider, the Identity Provider will return the same value with the SAMLResponse. For example, this can be used to return the user back to the page that they were on when they initiated the authentication flow.

Usage: Building an Authn Request

saml.SAMLRequestSettings.RequestBinding = SAMLRequestBindings.srbHTTPRedirect; saml.SAMLRequestSettings.SignRequest = true; saml.RelayState = "https://service_provider.com/landing"; saml.BuildAuthnRequest();

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

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

Authentication Response

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

To handle an incoming HTTP request, the ProcessHTTPRequest and ParseHTTPRequest methods should be used. By default these methods will attempt to read the HTTP request headers and body from the current HttpContext. To provide HTTP headers and body directly to the componentthe HTTPRequestHeaders and HTTPRequest properties can be set before calling ParseHTTPRequest or ProcessHTTPRequest.

To start processing the HTTP Request call the ProcessHTTPRequest method. While the ProcessHTTPRequest method is processing the HTTP Request, the component fires the SAMLResponse and Assertion events. These events can be used to provide information about the original request or the Identity Provider. If the SAMLResponse and Assertion are valid, then the method will return without any errors. Additionally the SAMLResponseInfo, AssertionInfo, AssertionAttributeInfo, and AssertionAuthnInfo properties and collection will be populated.

The ProcessHTTPRequest performs multiple steps automatically making it a simple method to handle incoming requests. If needed, the ParseHTTPRequest, ParseSAMLResponse, and ParseAssertion methods can be used to perform each operation individually instead of relying on the ProcessHTTPRequest method.

Property List

The following is the full list of the properties of the component 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	This property determines what happens when the server issues a redirect.
HTTPRequest	The HTTP body for the current HTTP Request.
HTTPRequestHeaders	The HTTP headers for the current HTTP Request.
IdentityProviderEncryptingCert	Certificate used to decrypt responses from an identity provider.
IdentityProviderMetadata	Information about the identity provider.
IdentityProviderSigningCert	Certificate used to verify signatures in responses from an identity provider.
IdentityProviderURIs	URIs for an identity provider.
Idle	This property specifies the current status of the component.
Proxy	A set of properties related to proxy access.
RelayState	The RelayState for a SAMLRequest or SAMLResponse.
SAMLRequestBody	The HTTP body for a SAMLRequest.
SAMLRequestSettings	Settings for a SAMLRequest.
SAMLRequestURL	URL for SAMLRequests.
SAMLResponseInfo	Information about a SAMLResponse.
ServiceProviderMetadata	Information about a service provider's SAML metadata document.
ServiceProviderSigningCert	Certificate used by the service provider when signing a SAMLRequest or SAML metadata document.
ServiceProviderURIs	Information about the URIs for a service provider.
SSLAcceptServerCert	This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	This property includes the server certificate for the last established connection.

Method List

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


BuildAuthnRequest	Build an Authentication Request.
BuildLogoutRequest	Build a Single Logout request.
BuildServiceMetadata	Build 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	Search for a specific assertion attribute.
Interrupt	This method interrupts the current method.
LoadIdentityMetadata	Load an identity provider's metadata document.
ParseAssertion	Parse and validate an assertion.
ParseHTTPRequest	Parse the current HTTP request.
ParseSAMLResponse	Parse and validate a SAMLResponse.
ProcessHTTPRequest	Process the current HTTP Request.
RequestIdentityMetadata	Request an identity provider's SAML metadata document.
Reset	This method will reset the component.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


Assertion	Fired when an assertion is parsed.
EndTransfer	This event is fired when a document finishes transferring.
Error	Fired when information is available about errors during data delivery.
Header	This event is fired every time a header line comes in.
Log	This event fires once for each log message.
Redirect	This event is fired when a redirection is received from the server.
SAMLResponse	Fired when a SAMLResponse is parsed.
SetCookie	This event is fired for every cookie set by the server.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.
StartTransfer	This event is fired when a document starts transferring (after the headers).
Transfer	This event is fired while a document transfers (delivers document).

Config Settings

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


AssertionValidationFlags	The checks that are ignored when validating an Assertion.
AttributeNameProfile	The set of names that are used for common attributes.
SAMLRequestCustomConsent	TBD.
SAMLRequestCustomNameIdFormat	TBD.
SAMLRequestSPNameQualifier	TBD.
SAMLResponseValidationFlags	The checks that are ignored when validating a SAMLResponse.
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.
AllowNTLMFallback	Whether to allow fallback from Negotiate to NTLM when authenticating.
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 component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the component 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 component.
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.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
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 component.
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.
UsePlatformDeflate	Whether to use the platform implementation to decompress compressed responses.
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).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (TCPClient only).
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.
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 component 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.
CACertFilePaths	The paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
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.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

AssertionAttributeInfo Property (SAML Component)

Information about the attributes found in an assertion.

public AssertionAttributeList AssertionAttributeInfo { get; }

Public Property AssertionAttributeInfo As AssertionAttributeList

Remarks

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

Please refer to the AssertionAttribute type for a complete list of fields.

AssertionAuthnInfo Property (SAML Component)

Information about the AuthnStatement in an assertion.

Syntax

C#
VB.NET

public AuthnStatementList AssertionAuthnInfo { get; }

Public Property AssertionAuthnInfo As AuthnStatementList

Remarks

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

Please refer to the AuthnStatement type for a complete list of fields.

AssertionInfo Property (SAML Component)

Information about a parsed assertion.

Syntax

C#
VB.NET

public AssertionInfo AssertionInfo { get; set; }

Public Property AssertionInfo As AssertionInfo

Remarks

Information about the recently parsed assertion. Can also be used to provide a cached assertion manually to the component.

Please refer to the AssertionInfo type for a complete list of fields.

Firewall Property (SAML Component)

A set of properties related to firewall access.

Syntax

C#
VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

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

Please refer to the Firewall type for a complete list of fields.

FollowRedirects Property (SAML Component)

This property determines what happens when the server issues a redirect.

Syntax

C#
VB.NET

public SAMLFollowRedirects FollowRedirects { get; set; }

enum SAMLFollowRedirects {
  frNever,
  frAlways,
  frSameScheme
}

Public Property FollowRedirects As SamlFollowRedirects

Enum SAMLFollowRedirects
  frNever
  frAlways
  frSameScheme
End Enum

Default Value

Remarks

This property determines what happens when the server issues a redirect. Normally, the component 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 component throws an exception.

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 component throws an exception instead.

HTTPRequest Property (SAML Component)

The HTTP body for the current HTTP Request.

Syntax

C#
VB.NET

public string HTTPRequest { get; set; }
public byte[] HTTPRequestB { get; set; }

Public Property HTTPRequest As String
Public Property HTTPRequestB As Byte()

Default Value

Remarks

This property can be set before calling the ParseHTTPRequest or ProcessHTTPRequest methods to directly provide the HTTP body to be parsed. If using the HTTP Context, this property is set with the HTTP body that was parsed from the HTTP context after calling ParseHTTPRequest or ProcessHTTPRequest.

HTTPRequestHeaders Property (SAML Component)

The HTTP headers for the current HTTP Request.

Syntax

C#
VB.NET

public string HTTPRequestHeaders { get; set; }

Public Property HTTPRequestHeaders As String

Default Value

Remarks

This property can be set before calling the ParseHTTPRequest or ProcessHTTPRequest methods to directly provide the HTTP headers to be parsed. If using the HTTP Context, this property is set with the HTTP headers that was parsed from the HTTP context after calling ParseHTTPRequest or ProcessHTTPRequest.

IdentityProviderEncryptingCert Property (SAML Component)

Certificate used to decrypt responses from an identity provider.

Syntax

C#
VB.NET

public Certificate IdentityProviderEncryptingCert { get; set; }

Public Property IdentityProviderEncryptingCert As Certificate

Remarks

The certificate that is used to decrypt if encryption is found while parsing. This certificate will need to have access to it's private key to be able to successfully decrypt.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

IdentityProviderMetadata Property (SAML Component)

Information about the identity provider.

Syntax

C#
VB.NET

public IdentityProviderMetadata IdentityProviderMetadata { get; set; }

Public Property IdentityProviderMetadata As IdentityProviderMetadata

Remarks

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

Please refer to the IdentityProviderMetadata type for a complete list of fields.

IdentityProviderSigningCert Property (SAML Component)

Certificate used to verify signatures in responses from an identity provider.

Syntax

C#
VB.NET

public Certificate IdentityProviderSigningCert { get; set; }

Public Property IdentityProviderSigningCert As Certificate

Remarks

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.

Please refer to the Certificate type for a complete list of fields.

IdentityProviderURIs Property (SAML Component)

URIs for an identity provider.

Syntax

C#
VB.NET

public URIList IdentityProviderURIs { get; }

Public Property IdentityProviderURIs As URIList

Remarks

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.

Please refer to the URI type for a complete list of fields.

Idle Property (SAML Component)

This property specifies the current status of the component.

Syntax

C#
VB.NET

public bool Idle { get; }

Public ReadOnly Property Idle As Boolean

Default Value

True

Remarks

Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Proxy Property (SAML Component)

A set of properties related to proxy access.

Syntax

C#
VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

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

Please refer to the Proxy type for a complete list of fields.

RelayState Property (SAML Component)

The RelayState for a SAMLRequest or SAMLResponse.

Syntax

C#
VB.NET

public string RelayState { get; set; }

Public Property RelayState As String

Default Value

Remarks

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

SAMLRequestBody Property (SAML Component)

The HTTP body for a SAMLRequest.

Syntax

C#
VB.NET

public string SAMLRequestBody { get; }
public byte[] SAMLRequestBodyB { get; }

Public ReadOnly Property SAMLRequestBody As String
Public ReadOnly Property SAMLRequestBodyB As Byte()

Default Value

Remarks

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

This property is read-only.

SAMLRequestSettings Property (SAML Component)

Settings for a SAMLRequest.

Syntax

C#
VB.NET

public SAMLRequestSettings SAMLRequestSettings { get; set; }

Public Property SAMLRequestSettings As SAMLRequestSettings

Remarks

The settings to configure the SAMLRequest that is built by the BuildAuthnRequest or BuildLogoutRequest methods.

Please refer to the SAMLRequestSettings type for a complete list of fields.

SAMLRequestURL Property (SAML Component)

URL for SAMLRequests.

Syntax

C#
VB.NET

public string SAMLRequestURL { get; }

Public ReadOnly Property SAMLRequestURL As String

Default Value

Remarks

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

This property is read-only.

SAMLResponseInfo Property (SAML Component)

Information about a SAMLResponse.

Syntax

C#
VB.NET

public SAMLResponseInfo SAMLResponseInfo { get; set; }

Public Property SAMLResponseInfo As SAMLResponseInfo

Remarks

Information about the recently parsed SAMLResponse. Can be set when calling the ProcessHTTPRequest or ParseSAMLResponse methods. Can also be used to provide a stored SAMLResponse manually to the component.

Please refer to the SAMLResponseInfo type for a complete list of fields.

ServiceProviderMetadata Property (SAML Component)

Information about a service provider's SAML metadata document.

Syntax

C#
VB.NET

public ServiceProviderMetadata ServiceProviderMetadata { get; set; }

Public Property ServiceProviderMetadata As ServiceProviderMetadata

Remarks

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

Please refer to the ServiceProviderMetadata type for a complete list of fields.

ServiceProviderSigningCert Property (SAML Component)

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

Syntax

C#
VB.NET

public Certificate ServiceProviderSigningCert { get; set; }

Public Property ServiceProviderSigningCert As Certificate

Remarks

The certificate that should be used if signing of the SAMLRequest (Authn and Logout) is needed when calling BuildAuthnRequest or BuildLogoutRequest. Additionally, if required, this certificate is used to sign a SAML metadata document when calling the BuildServiceMetadata method.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

ServiceProviderURIs Property (SAML Component)

Information about the URIs for a service provider.

Syntax

C#
VB.NET

public URIList ServiceProviderURIs { get; }

Public Property ServiceProviderURIs As URIList

Remarks

A list of URIs that are used by the service provider (this application) that should be provided to the identity provider. This is used when build the service provider's SAML metadata document when calling the BuildServiceMetadata method. When validating a SAMLResponse or assertion, these URIs are used to validate the destination or recipient attributes respectively. See ParseSAMLResponse and ParseAssertion for more information.

Please refer to the URI type for a complete list of fields.

SSLAcceptServerCert Property (SAML Component)

This property instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

C#
VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component 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.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (SAML Component)

This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

C#
VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component 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.

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (SAML Component)

This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

C#
VB.NET

public SAMLSSLProviders SSLProvider { get; set; }

enum SAMLSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As SamlSSLProviders

Enum SAMLSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

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

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (SAML Component)

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

Syntax

C#
VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

BuildAuthnRequest Method (SAML Component)

Build an Authentication Request.

Syntax

C#
VB.NET

public void BuildAuthnRequest();

Async Version
public async Task BuildAuthnRequest();
public async Task BuildAuthnRequest(CancellationToken cancellationToken);

Public Sub BuildAuthnRequest()

Async Version
Public Sub BuildAuthnRequest() As Task
Public Sub BuildAuthnRequest(cancellationToken As CancellationToken) As Task

Remarks

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

HTTP Redirect - SAMLRequestURL
HTTP Post - SAMLRequestURL, SAMLRequestBody

BuildLogoutRequest Method (SAML Component)

Build a Single Logout request.

Syntax

C#
VB.NET

public void BuildLogoutRequest(string nameIdentifier);

Async Version
public async Task BuildLogoutRequest(string nameIdentifier);
public async Task BuildLogoutRequest(string nameIdentifier, CancellationToken cancellationToken);

Public Sub BuildLogoutRequest(ByVal NameIdentifier As String)

Async Version
Public Sub BuildLogoutRequest(ByVal NameIdentifier As String) As Task
Public Sub BuildLogoutRequest(ByVal NameIdentifier As String, cancellationToken As CancellationToken) As Task

Remarks

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

HTTP Redirect - SAMLRequestURL
HTTP Post - SAMLRequestURL, SAMLRequestBody

BuildServiceMetadata Method (SAML Component)

Build a metadata document for a service provider.

Syntax

C#
VB.NET

public void BuildServiceMetadata();

Async Version
public async Task BuildServiceMetadata();
public async Task BuildServiceMetadata(CancellationToken cancellationToken);

Public Sub BuildServiceMetadata()

Async Version
Public Sub BuildServiceMetadata() As Task
Public Sub BuildServiceMetadata(cancellationToken As CancellationToken) As Task

Remarks

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

AuthnRequestSigned
EntityId
SignedMetadata
SupportedNameIdFormats
WantAssertionsSigned
ServiceProviderSigningCert
ServiceProviderURIs

Config Method (SAML Component)

Sets or retrieves a configuration setting.

Syntax

C#
VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

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

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

DoEvents Method (SAML Component)

This method processes events from the internal message queue.

Syntax

C#
VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

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

GetAssertionAttribute Method (SAML Component)

Search for a specific assertion attribute.

Syntax

C#
VB.NET

public string GetAssertionAttribute(string attrName);

Async Version
public async Task<string> GetAssertionAttribute(string attrName);
public async Task<string> GetAssertionAttribute(string attrName, CancellationToken cancellationToken);

Public Function GetAssertionAttribute(ByVal attrName As String) As String

Async Version
Public Function GetAssertionAttribute(ByVal attrName As String) As Task(Of String)
Public Function GetAssertionAttribute(ByVal attrName As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

This method will search the current AssertionAttributeInfo collection 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, then it will return the values in a semi-colon separated list.

Interrupt Method (SAML Component)

This method interrupts the current method.

Syntax

C#
VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

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

LoadIdentityMetadata Method (SAML Component)

Load an identity provider's metadata document.

Syntax

C#
VB.NET

public void LoadIdentityMetadata(string metadataDocument, bool validate);

Async Version
public async Task LoadIdentityMetadata(string metadataDocument, bool validate);
public async Task LoadIdentityMetadata(string metadataDocument, bool validate, CancellationToken cancellationToken);

Public Sub LoadIdentityMetadata(ByVal metadataDocument As String, ByVal validate As Boolean)

Async Version
Public Sub LoadIdentityMetadata(ByVal metadataDocument As String, ByVal validate As Boolean) As Task
Public Sub LoadIdentityMetadata(ByVal metadataDocument As String, ByVal validate As Boolean, cancellationToken As CancellationToken) As Task

Remarks

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

ParseAssertion Method (SAML Component)

Parse and validate an assertion.

Syntax

C#
VB.NET

public void ParseAssertion(bool validate);

Async Version
public async Task ParseAssertion(bool validate);
public async Task ParseAssertion(bool validate, CancellationToken cancellationToken);

Public Sub ParseAssertion(ByVal validate As Boolean)

Async Version
Public Sub ParseAssertion(ByVal validate As Boolean) As Task
Public Sub ParseAssertion(ByVal validate As Boolean, cancellationToken As CancellationToken) As Task

Remarks

Parses and optionally validates the assertion found in the AssertionInfo property. The assertion can either be manually set by setting the AssertionContent field or by first calling ParseSAMLResponse on a SAMLResponse that contains an assertion. If the method is able to successful 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. Additionally, the method will fire the Assertion event before attempting validation (see below).

Validation:

If the validate parameter is set to true, then the method will attempt to validate the assertion. Before attempting this validation, theAssertion event provides an opportunity to configure the component to successfully validate the assertion. The following checks are performed on the assertion:


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

To skip certain checks, see AssertionValidationFlags.

ParseHTTPRequest Method (SAML Component)

Parse the current HTTP request.

Syntax

C#
VB.NET

public void ParseHTTPRequest();

Async Version
public async Task ParseHTTPRequest();
public async Task ParseHTTPRequest(CancellationToken cancellationToken);

Public Sub ParseHTTPRequest()

Async Version
Public Sub ParseHTTPRequest() As Task
Public Sub ParseHTTPRequest(cancellationToken As CancellationToken) As Task

Remarks

This method parses the current HTTP request and if found sets the ResponseContent field with the SAMLResponse. If a RelayState parameter is found in the request, it will be set to the RelayState property. The HTTP Request is taken directly from the HTTPRequestHeaders and HTTPRequest properties if set, otherwise it will try to read the HTTP context.

This method does not parse or validate the SAMLResponse. See the ParseSAMLResponse method for more information. To automatically parse and validate the SAMLResponse, see the ProcessHTTPRequest method.

ParseSAMLResponse Method (SAML Component)

Parse and validate a SAMLResponse.

Syntax

C#
VB.NET

public void ParseSAMLResponse(bool validate);

Async Version
public async Task ParseSAMLResponse(bool validate);
public async Task ParseSAMLResponse(bool validate, CancellationToken cancellationToken);

Public Sub ParseSAMLResponse(ByVal validate As Boolean)

Async Version
Public Sub ParseSAMLResponse(ByVal validate As Boolean) As Task
Public Sub ParseSAMLResponse(ByVal validate As Boolean, cancellationToken As CancellationToken) As Task

Remarks

Parses and optionally validates the SAMLResponse found in the SAMLResponseInfo property. The SAMLResponse can either be manually set by setting the ResponseContent field or by first calling ParseHTTPRequest on an HTTP request with a SAMLResponse. If the method is able to successful parse the SAMLResponse, the information fields in the SAMLResponseInfo property is populated. Additionally, if the ResponseType is srtAuthn then the AssertionContent field is set. See ParseAssertion for more info on parsing and validating the assertion. Additionally, the method will fire the SAMLResponse event before attempting validation (see below).

Validation:

If the validate parameter is set to true, then the method will attempt to validate the SAMLResponse. Before attempting this validation, the SAMLResponse event provides an opportunity to configure the component to successfully validate the SAMLResponse. The following checks are performed on the SAMLResponse:


Validation Check	Property or Field
Signature (If Found)	IdentityProviderSigningCert
Issuer Element	EntityId
InResponseTo Attribute	Id
Destination Attribute	ServiceProviderURIs (ACS URI)
Status Element	NA

To skip certain checks, see SAMLResponseValidationFlags.

ProcessHTTPRequest Method (SAML Component)

Process the current HTTP Request.

Syntax

C#
VB.NET

public void ProcessHTTPRequest();

Async Version
public async Task ProcessHTTPRequest();
public async Task ProcessHTTPRequest(CancellationToken cancellationToken);

Public Sub ProcessHTTPRequest()

Async Version
Public Sub ProcessHTTPRequest() As Task
Public Sub ProcessHTTPRequest(cancellationToken As CancellationToken) As Task

Remarks

Parses the current HTTP request and if applicable parses and validates the SAMLResponse and optional Assertion from the request. The method is the equivalent to calling the following methods. See the specific methods for more information.

ParseHTTPRequest
ParseSAMLResponse (validate = true)
ParseAssertion (validate = true)

The HTTP Request is taken directly from the HTTPRequestHeaders and HTTPRequest properties if set, otherwise it will try to read the HTTP context.

RequestIdentityMetadata Method (SAML Component)

Request an identity provider's SAML metadata document.

Syntax

C#
VB.NET

public void RequestIdentityMetadata(string URL);

Async Version
public async Task RequestIdentityMetadata(string URL);
public async Task RequestIdentityMetadata(string URL, CancellationToken cancellationToken);

Public Sub RequestIdentityMetadata(ByVal URL As String)

Async Version
Public Sub RequestIdentityMetadata(ByVal URL As String) As Task
Public Sub RequestIdentityMetadata(ByVal URL As String, cancellationToken As CancellationToken) As Task

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 set with the information that is available in the document.

Reset Method (SAML Component)

This method will reset the component.

Syntax

C#
VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

Assertion Event (SAML Component)

Fired when an assertion is parsed.

Syntax

C#
VB.NET

public event OnAssertionHandler OnAssertion;

public delegate void OnAssertionHandler(object sender, SAMLAssertionEventArgs e);

public class SAMLAssertionEventArgs : EventArgs {
  public string Issuer { get; }
  public string InResponseTo { get; }
}

Public Event OnAssertion As OnAssertionHandler

Public Delegate Sub OnAssertionHandler(sender As Object, e As SAMLAssertionEventArgs)

Public Class SAMLAssertionEventArgs Inherits EventArgs
  Public ReadOnly Property Issuer As String
  Public ReadOnly Property InResponseTo As String
End Class

Remarks

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

EndTransfer Event (SAML Component)

This event is fired when a document finishes transferring.

Syntax

C#
VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, SAMLEndTransferEventArgs e);

public class SAMLEndTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As SAMLEndTransferEventArgs)

Public Class SAMLEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The EndTransfer event is fired first when the client finishes sending data to the server (in a POST or PUT request) and then when the document text finishes transferring from the server to the local host.

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

Error Event (SAML Component)

Fired when information is available about errors during data delivery.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SAMLErrorEventArgs e);

public class SAMLErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SAMLErrorEventArgs)

Public Class SAMLErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

Header Event (SAML Component)

This event is fired every time a header line comes in.

Syntax

C#
VB.NET

public event OnHeaderHandler OnHeader;

public delegate void OnHeaderHandler(object sender, SAMLHeaderEventArgs e);

public class SAMLHeaderEventArgs : EventArgs {
  public string Field { get; }
  public string Value { get; }
}

Public Event OnHeader As OnHeaderHandler

Public Delegate Sub OnHeaderHandler(sender As Object, e As SAMLHeaderEventArgs)

Public Class SAMLHeaderEventArgs Inherits EventArgs
  Public ReadOnly Property Field As String
  Public ReadOnly Property Value As String
End Class

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (SAML Component)

This event fires once for each log message.

Syntax

C#
VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, SAMLLogEventArgs e);

public class SAMLLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As SAMLLogEventArgs)

Public Class SAMLLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

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


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

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

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

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

Message is the log entry.

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

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

Redirect Event (SAML Component)

This event is fired when a redirection is received from the server.

Syntax

C#
VB.NET

public event OnRedirectHandler OnRedirect;

public delegate void OnRedirectHandler(object sender, SAMLRedirectEventArgs e);

public class SAMLRedirectEventArgs : EventArgs {
  public string Location { get; }
  public bool Accept { get; set; }
}

Public Event OnRedirect As OnRedirectHandler

Public Delegate Sub OnRedirectHandler(sender As Object, e As SAMLRedirectEventArgs)

Public Class SAMLRedirectEventArgs Inherits EventArgs
  Public ReadOnly Property Location As String
  Public Property Accept As Boolean
End Class

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 component throws an exception. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SAMLResponse Event (SAML Component)

Fired when a SAMLResponse is parsed.

Syntax

C#
VB.NET

public event OnSAMLResponseHandler OnSAMLResponse;

public delegate void OnSAMLResponseHandler(object sender, SAMLSAMLResponseEventArgs e);

public class SAMLSAMLResponseEventArgs : EventArgs {
  public string Issuer { get; }
  public string InResponseTo { get; }
}

Public Event OnSAMLResponse As OnSAMLResponseHandler

Public Delegate Sub OnSAMLResponseHandler(sender As Object, e As SAMLSAMLResponseEventArgs)

Public Class SAMLSAMLResponseEventArgs Inherits EventArgs
  Public ReadOnly Property Issuer As String
  Public ReadOnly Property InResponseTo As String
End Class

Remarks

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

SetCookie Event (SAML Component)

This event is fired for every cookie set by the server.

Syntax

C#
VB.NET

public event OnSetCookieHandler OnSetCookie;

public delegate void OnSetCookieHandler(object sender, SAMLSetCookieEventArgs e);

public class SAMLSetCookieEventArgs : EventArgs {
  public string Name { get; }
  public string Value { get; }
  public string Expires { get; }
  public string Domain { get; }
  public string Path { get; }
  public bool Secure { get; }
}

Public Event OnSetCookie As OnSetCookieHandler

Public Delegate Sub OnSetCookieHandler(sender As Object, e As SAMLSetCookieEventArgs)

Public Class SAMLSetCookieEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public ReadOnly Property Value As String
  Public ReadOnly Property Expires As String
  Public ReadOnly Property Domain As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property Secure As Boolean
End Class

Remarks

The SetCookie event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

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

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

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

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (SAML Component)

Fired after the server presents its certificate to the client.

Syntax

C#
VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, SAMLSSLServerAuthenticationEventArgs e);

public class SAMLSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As SAMLSSLServerAuthenticationEventArgs)

Public Class SAMLSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

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

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

SSLStatus Event (SAML Component)

Fired when secure connection progress messages are available.

Syntax

C#
VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, SAMLSSLStatusEventArgs e);

public class SAMLSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As SAMLSSLStatusEventArgs)

Public Class SAMLSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

StartTransfer Event (SAML Component)

This event is fired when a document starts transferring (after the headers).

Syntax

C#
VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, SAMLStartTransferEventArgs e);

public class SAMLStartTransferEventArgs : EventArgs {
  public int Direction { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As SAMLStartTransferEventArgs)

Public Class SAMLStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
End Class

Remarks

The StartTransfer event is fired first when the client starts sending data to the server (in a POST or PUT request) and then when the document text starts transferring from the server to the local host.

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

Transfer Event (SAML Component)

This event is fired while a document transfers (delivers document).

Syntax

C#
VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, SAMLTransferEventArgs e);

public class SAMLTransferEventArgs : EventArgs {
  public int Direction { get; }
  public long BytesTransferred { get; }
  public int PercentDone { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As SAMLTransferEventArgs)

Public Class SAMLTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property PercentDone As Integer
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

Remarks

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

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

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

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

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

AssertionAttribute Type

Holds information about an attribute.

Remarks

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

The following fields are available:

Fields

AttributeContent
string (read-only)
Default: ""

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

AttributeValueCount
int (read-only)
Default: 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, then the count will be set to 1. See AttributeValueIndex for more information.

AttributeValueData
string (read-only)
Default: ""

The content of the attribute value selected by AttributeValueIndex.

AttributeValueIndex
int
Default: 0

Selects the index of the attribute value that should be populated in the AttributeValueData field. Valid ranges for this field are from 0 to (AttributeValueCount - 1). By default this field is set to 0. In cases where there is only a singular value, then 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(i = 0; i < saml.AttributeAttributeInfo[0].AttributeValueCount; i++){ saml.AttributeAttributeInfo[0].AttributeValueIndex = i; string attribute_value = saml.AttributeAttributeInfo[0].AttributeValueData; //... the rest of the processing }

FriendlyName
string (read-only)
Default: ""

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

Name
string (read-only)
Default: ""

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

NameFormat
string (read-only)
Default: ""

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


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

Constructors

C#
VB.NET

public AssertionAttribute();

Public AssertionAttribute()

AssertionInfo Type

Holds information about an assertion.

Remarks

The fields of the type describes an assertion that has been parsed or processed by the component.

The following fields are available:

Fields

AssertionContent
string
Default: ""

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

AssertionContentB
byte []
Default: ""

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

ExpirationDate
string (read-only)
Default: ""

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

Time based values are specified by the SAML specification to be a UTC encoded value in the following format.

YYYY-MM-DDTHH:mm:ss.sssZ

Id
string (read-only)
Default: ""

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

IsSigned
bool (read-only)
Default: False

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

IssuedTime
string (read-only)
Default: ""

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 a UTC encoded value in the following format.

YYYY-MM-DDTHH:mm:ss.sssZ

Issuer
string (read-only)
Default: ""

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

NotBeforeDate
string (read-only)
Default: ""

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 a UTC encoded value in the following format.

YYYY-MM-DDTHH:mm:ss.sssZ

OneTimeUse
bool (read-only)
Default: False

If true, this means that 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
string (read-only)
Default: ""

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

SubjectNameIdFormat
string (read-only)
Default: ""

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


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

UserInfoAddress
string (read-only)
Default: ""

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

UserInfoEmail
string (read-only)
Default: ""

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

UserInfoName
string (read-only)
Default: ""

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

Constructors

C#
VB.NET

public AssertionInfo();

Public AssertionInfo()

AuthnStatement Type

An Authn statement from an assertion.

Remarks

An authentication (Authn) statement from an assertion in response to an authentication request.

The following fields are available:

AuthenticatingAuthorites

AuthnInstant

ContextClassReference

Fields

AuthenticatingAuthorites
string (read-only)
Default: ""

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

AuthnInstant
string (read-only)
Default: ""

The time at which the authentication took place.

Time based values are specified by the SAML specification to be a UTC encoded value in the following format.

YYYY-MM-DDTHH:mm:ss.sssZ

ContextClassReference
string (read-only)
Default: ""

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

ContextDeclaration
string (read-only)
Default: ""

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

SessionExpiration
string (read-only)
Default: ""

The time at which the session between the principle and IdP must be considered ended.

Time based values are specified by the SAML specification to be a UTC encoded value in the following format.

YYYY-MM-DDTHH:mm:ss.sssZ

SessionIndex
string (read-only)
Default: ""

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

StatementContent
string (read-only)
Default: ""

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

Constructors

C#
VB.NET

public AuthnStatement();

Public AuthnStatement()

Certificate Type

This is the digital certificate being used.

Remarks

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

The following fields are available:

Fields

EffectiveDate
string (read-only)
Default: ""

This is 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
string (read-only)
Default: ""

This is the date 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
string (read-only)
Default: ""

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

Fingerprint
string (read-only)
Default: ""

This is 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
string (read-only)
Default: ""

This is 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
string (read-only)
Default: ""

This is 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
string (read-only)
Default: ""

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

PrivateKey
string (read-only)
Default: ""

This is 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
bool (read-only)
Default: False

This field shows 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
string (read-only)
Default: ""

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

PublicKey
string (read-only)
Default: ""

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

PublicKeyAlgorithm
string (read-only)
Default: ""

This field contains 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: 0

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

SerialNumber
string (read-only)
Default: ""

This is 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
string (read-only)
Default: ""

The field contains 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
string
Default: "MY"

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

StoreB
byte []
Default: "MY"

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

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.

StorePassword
string
Default: ""

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

StoreType
CertStoreTypes
Default: 0

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component 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 component. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SubjectAltNames
string (read-only)
Default: ""

This field contains comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)
Default: ""

This field contains 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
string (read-only)
Default: ""

This field contains 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
string (read-only)
Default: ""

This field contains 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
string (read-only)
Default: ""

This field contains the text description of UsageFlags.

This value will be of 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: 0

This field contains 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
string (read-only)
Default: ""

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

Subject
string
Default: ""

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

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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

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

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

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


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
string
Default: ""

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

EncodedB
byte []
Default: ""

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

Constructors

C#
VB.NET

public Certificate();

Public Certificate()

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

C#
VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

C#
VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

Parses Encoded as an X.509 public key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. 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.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

C#
VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

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.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component will connect through.

Remarks

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

The following fields are available:

Fields

AutoDetect
bool
Default: False

This field tells the component whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes
Default: 0

This field determines 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
string
Default: ""

This field contains 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 component throws an exception.

Password
string
Default: ""

This field contains 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 component throws an exception.

Port
int
Default: 0

This field contains 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
string
Default: ""

This field contains 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 component throws an exception.

Constructors

C#
VB.NET

public Firewall();

Public Firewall()

IdentityProviderMetadata Type

The metadata for the Identity Provider.

Remarks

This type represents that metadata for a specific Identity Provider.

The following fields are available:

EntityId

ExpirationDate

MetadataContent

RequestsSignedAuthnRequests

SignedMetadata

SupportedAttributeProfiles

SupportedAttributes

SupportedNameIdFormats

Fields

EntityId
string
Default: ""

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

ExpirationDate
string (read-only)
Default: ""

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

MetadataContent
string
Default: ""

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

MetadataContentB
byte []
Default: ""

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

RequestsSignedAuthnRequests
bool
Default: False

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

SignedMetadata
bool (read-only)
Default: False

If the identity provider's parsed metadata is signed.

SupportedAttributeProfiles
string (read-only)
Default: ""

This field provides a semi-colon 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
string (read-only)
Default: ""

A semi-colon separated list of supported attributes 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 attributes supported. The list will contain the Name of each attribute found in the IDPSSODescriptor element.

SupportedNameIdFormats
string (read-only)
Default: ""

The name identifier formats that are 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

C#
VB.NET

public IdentityProviderMetadata();

Public IdentityProviderMetadata()

Proxy Type

The proxy the component will connect to.

Remarks

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

The following fields are available:

Fields

AuthScheme
ProxyAuthSchemes
Default: 0

This field is used to tell the component which 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 component 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 component. Look at the configuration file for the component 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
bool
Default: False

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

Password
string
Default: ""

This field contains 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: 80

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

Server
string
Default: ""

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
ProxySSLTypes
Default: 0

This field determines 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 component will use the `psTunnel` option. If the URL is an `http` URL, the component 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
string
Default: ""

This field contains 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

C#
VB.NET

public Proxy();

Public Proxy()

C#
VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

C#
VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

SAMLRequestSettings Type

Settings used when building a SAMLRequest.

Remarks

The settings used when building a SAMLRequest for an Authentication (Authn) or Logout request.

The following fields are available:

Fields

AllowCreate
bool
Default: False

This setting 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 they are allowed to created a new identifier to represent the principal. When set to false (default) the Identity Provider should only issue an assertion if an acceptable identifier is already created.

Consent
ConsentIdentifiers
Default: 0

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

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


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

Destination
string
Default: ""

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

Id
string
Default: ""

This field is a unique Id of the SAMLRequest. If left empty before calling BuildAuthnRequest or BuildLogoutRequest, the component will automatically generate an Id. This Id should match the Id of the InResponseTo attribute the matching SAMLResponse (see InResponseTo for more information).

IssuedTime
string
Default: ""

This field is the time that the SAMLRequest was issued. If not set, the component will use the current time.

Time based values are specified by the SAML specification to be a UTC encoded value in the following format.

YYYY-MM-DDTHH:mm:ss.sssZ

Issuer
string
Default: ""

This field is the issuer of the SAMLRequest. If left blank, the component will use the value EntityId field.

NameIdFormat
NameIdFormats
Default: 0

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

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


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

RequestBinding
SAMLRequestBindings
Default: 0

The binding that will be used to make the request.

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

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


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

SelectedEndpoint
int
Default: -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, by default, the component will select the first ACS endpoint available in the ServiceProviderURIs collection. If set to a positive integer, then the component will search the ServiceProviderURIs collection for a URI with the appropriate BindingType and Index settings.

If the component cannot find an endpoint with a matching Index, then it will select the URI with the IsDefault field set. If no URIs are set with the IsDefault field, then the component will select the first URI with the correct BindingType.

If UseDefaultEndpoint is set to true, then this field will not do anything.

SignRequest
bool
Default: False

This setting should be set to true if the SAMLRequest should be signed when building the SAMLRequest using the BuildAuthnRequest or BuildLogoutRequest methods. The component will use the certificate set in the ServiceProviderSigningCert property to sign the request.

UseDefaultEndpoint
bool
Default: 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 this setting is set to true, the component will select the first URI with the correct BindingType that also has the IsDefault field set when building an Authn Request.

Constructors

C#
VB.NET

public SAMLRequestSettings();

Public SAMLRequestSettings()

SAMLResponseInfo Type

Holds information about a SAMLResponse.

Remarks

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

The following fields are available:

Fields

Consent
string (read-only)
Default: ""

If consent from a principle was provided in the sending of this response. This typically is set to some URI reference that was used by the application to obtain consent from the principal (user). Some common URI values are:

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

Destination
string (read-only)
Default: ""

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

InResponseTo
string (read-only)
Default: ""

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

IssuedTime
string (read-only)
Default: ""

This field is the time that the SAMLResponse was issued by the Issuer

Time based values are specified by the SAML specification to be a UTC encoded value in the following format.

YYYY-MM-DDTHH:mm:ss.sssZ

Issuer
string (read-only)
Default: ""

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

ResponseContent
string
Default: ""

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

ResponseContentB
byte []
Default: ""

ResponseId
string (read-only)
Default: ""

This setting is the unique Id for the SAMLResponse that was created by the Issuer.

ResponseType
SamlResponseTypes (read-only)
Default: 0

This setting is set to type of SAMLResponse that was processed when calling ProcessHTTPRequest or manually parsed using the ParseSAMLResponse method.


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

Signed
bool (read-only)
Default: False

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

StatusCodes
string (read-only)
Default: ""

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


`urn:oasis:names:tc:SAML:2.0:status:Success`	Success
`urn:oasis:names:tc:SAML:2.0:status:Requester`	The original request could not be performed due to an issue from the requester.
`urn:oasis:names:tc:SAML:2.0:status:Responder`	The original request could not be performed due to an issue from the issuer.
`urn:oasis:names:tc:SAML:2.0:status:VersionMismatch`	The original request could not be processed due to a SAML version mismatch in the request..

After the top-level status code, second-level codes can also be included to provide additional information about the top-level status code. These second level codes are also typically a URI reference like the top-level codes. For example, if the Identity Provider was unable to authenticate the user, this setting could be set to:

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

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

StatusMessage
string (read-only)
Default: ""

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

Constructors

C#
VB.NET

public SAMLResponseInfo();

Public SAMLResponseInfo()

ServiceProviderMetadata Type

The metadata settings for a service provider.

Remarks

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

The following fields are available:

SupportedNameIdFormats

WantAssertionsSigned

Fields

AuthnRequestSigned
bool
Default: False

When this field is set to true, the generated metadata document will inform the identity provider that this service provider will be sending signed requests.

EntityId
string
Default: ""

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

MetadataContent
string
Default: ""

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.

MetadataContentB
byte []
Default: ""

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

SignedMetadata
bool
Default: False

If this field is set to true, then the component will sign the metadata document when it is being generated. The component when the BuildServiceMetadata method is used to generate the metadata document, it will use the ServiceProviderSigningCert property to sign the document.

SupportedNameIdFormats
string
Default: ""

A semi-colon 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 then be set to:

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

WantAssertionsSigned
bool
Default: False

If this field is set to true, the metadata document inform the identity provider that this service provider wants issued assertions to be signed.

Constructors

C#
VB.NET

public ServiceProviderMetadata();

Public ServiceProviderMetadata()

URI Type

A URI endpoint that is used in the SAML protocol.

Remarks

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

The following fields are available:

Fields

BindingRef
string
Default: ""

This field holds 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 instead this field is set, then the component will attempt to set the BindingType field to match. If it can't, then the subCustom will also be used.

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

BindingType
URIBindings
Default: 0

This field represents the type of binding that is supported for this URI. The component 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 or during the processing of a metadata document, the component will attempt to set this field as well with the matching value. If it can't then 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	NA

Index
int
Default: 0

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

IsDefault
bool
Default: False

If this field is set to true, then this URI is the default URI that should be used for the specific URIType and BindingType combination.

Location
string
Default: ""

This field is set to the address of the URI.

URIType
SAMLURITypes
Default: 0

This field is set to 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

C#
VB.NET

public URI();

Public URI()

Config Settings (SAML Component)

The component 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 component, access to these internal properties is provided through the Config method.

SAML Config Settings

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

Informs that component 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).
0x00000010	Ignores a mismatch between the certificates set to the component and the one found in the signature of the Assertion.
0x00000020	Ignores the Conditions element.

AttributeNameProfile: The set of names that are used for common attributes.

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


`basic`	The basic names for the attributes.
`microsoft`	The scheme used by Microsoft Entra.

SAMLRequestCustomConsent: TBD.

TBD.

SAMLRequestCustomNameIdFormat: TBD.

TBD.

SAMLRequestSPNameQualifier: TBD.

TBD.

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

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


0x00000001	Ignore the InResponseTo attribute.
0x00000002	Ignore the destination attribute.
0x00000004	Ignore the Issuer element.
0x00000008	Ignore the SAMLResponse's signature. (Does not apply to the Assertion).
0x00000010	Ignores a mismatch between the certificates set to the component and the one found in the signature of the SAMLResponse.
0x00000020	Ignores a status that is not set to a success.

HTTP Config Settings

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

When AllowHTTPCompression is True, the component 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 component only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

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

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

The default value is True.

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

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

If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component throws an exception if the server does not support HTTP/2.

The default value is True.

AllowNTLMFallback: Whether to allow fallback from Negotiate to NTLM when authenticating.

This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

Append: Whether to append data to LocalFile.

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

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

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

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

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

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

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

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

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

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

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

The default value is False.

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

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

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

This option determines what happens when the server issues a redirect. Normally, the component 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 component throws an exception.

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.

The default value is 0 (Never). In this case, redirects are never followed, and the component throws an exception instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

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

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

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

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

HTTPVersion: The version of HTTP used by the component.

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

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

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

HTTP/2 Notes

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

If the server does not support HTTP/2, the component 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/2 is supported on all versions of Windows. If the Windows version is an earlier version than Windows 8.1/Windows Server 2012 R2, the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later, the system security libraries will be used by default.

HTTP/3 Notes

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

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

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

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

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

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

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

The default value for KeepAlive is false.

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

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

LogLevel: The level of detail that is logged.

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


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

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

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

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

MaxHeaders: Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.

This configuration setting should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

MaxHTTPCookies: Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

This configuration setting should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection.

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

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

NegotiatedHTTPVersion: The negotiated HTTP version.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TransferredRequest: The full request as sent by the client.

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

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

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the component 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 component will not use HTTP-chunked encoding. The default value is False.

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

UseIDNs: Whether to encode hostnames to internationalized domain names.

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

The default value is False and the hostname will always be used exactly as specified.

UsePlatformDeflate: Whether to use the platform implementation to decompress compressed responses.

This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.

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

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

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

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

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

UserAgent: Information about the user agent (browser).

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

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

TCPClient Config Settings

CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.

This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

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

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

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

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

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

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

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

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

FirewallListener: If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

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

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

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

FirewallPort: The TCP port for the FirewallHost;.

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

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

FirewallType: Determines the type of firewall to connect through.

The appropriate 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 components that do not directly expose Firewall properties.

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

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

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

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

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

Note: This value is not applicable in macOS.

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

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

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

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

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

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

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

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

LingerTime: Time in seconds to have the connection linger.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MaxTransferRate: The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

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

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component 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

UseNTLMv2: Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Config Settings

CACertFilePaths: The paths to CA certificate files when using Mono on Unix/Linux.

This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component 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

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

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

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

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

ReuseSSLSession: Determines if the SSL session is reused.

If set to True, the component 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 component is the same.

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

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

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

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component throws an exception.

When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

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

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

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

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

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

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

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

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

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

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

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

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

Multiple cipher suites are separated by semicolons.

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

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include the following:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

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

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

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

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


TLS1.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 component 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 component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

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

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

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

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

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

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

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

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

When set, the component 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 component will only append, it will not overwrite previous values.

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

SSLNegotiatedCipher: Returns the negotiated cipher suite.

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

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

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

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

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

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

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

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

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

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

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

SSLNegotiatedVersion: Returns the negotiated protocol version.

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

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

SSLSecurityFlags: Flags that control certificate verification.

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


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 in Java or when the provider is OpenSSL.

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

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

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

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

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

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

When specified the component 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 component throws an exception.

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

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

TLS12SupportedGroups: The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

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

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

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

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

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

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

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

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

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

Socket Config Settings

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

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

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

FirewallData: Used to send extra data to the firewall.

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

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

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

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

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

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

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

Base Config Settings

BuildInfo: Information about the product's build.

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

GUIAvailable: Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo: Information about the current license.

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

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

MaskSensitiveData: Whether sensitive data is masked in log messages.

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

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

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

When set to false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

Setting this configuration setting to true tells the component 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.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (SAML Component)

SAML Errors

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

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

HTTP Errors

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

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

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