SAMLSPServer Component
Properties Methods Events Config Settings Errors
The SAMLSPServer component represents a SAML service provider
Syntax
nsoftware.SecureBlackbox.SAMLSPServer
Remarks
The Service Provider in the SAML exchange flow represents the web server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO). Most commonly, an SP server is part of the application responsible for communicating with an Identity Provider to establish the authenticity of application users.
SAMLSPServer provides easy means of integrating the SAML Service Provider functionality into your application. It presents a fully-features SP endpoint with its own HTTP(S) and assertion validation engines.
Please find below a step-by-step guide on setting up your own SAML SP endpoint.
- Register the IdP metadata using the ImportSettings method.
Most IDPs let you download their metadata in XML format. The metadata file contains general
parameters of the IdP endpoint, such as its web address and algorithm requirements.
server.ImportSettings(metadataBytes, false); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>";
- Configure the main server capabilities:
// public server endpoint (use "https://" and/or port 443 if required) server.URL = "http://sp.myapp.com"; server.Port = 80; // IdP triggers this URL to pull metadata server.MetadataURL = '/sp/metadata'; // ACS is th "main" SP endpoint that receives assertions from the IdP server.AssertionConsumerService = '/sp/AssertionConsumerService'; server.SPToIDPBinding = csbtRedirect; // the SP will use HTTP redirect to forward the browser to the IdP when required server.AssertionConsumerServiceBindings = 'POST'; // and we want the IdP to use POST to submit its assertions server.PreferredIDPToSPBinding = csbtPOST; // Single logout service setup server.SingleLogoutService = '/sp/SingleLogoutService'; server.SingleLogoutServiceBindings = 'Redirect,POST,Artifact'; server.LogoutPage = '/sp/logout'; server.RedirectOnLogoutPage = 'https://www.nsoftware.com'; // The document root of the server on the local system server.BaseDir = "D:\\Inetpub\\SAMLSP"; // Security parameters: indicating that we want to sign both // the metadata and the requests server.SignAuthnRequests = true; server.SignMetadata = true; // We need to attach certificates to be able to sign. // Assume we have loaded our signing certificate into // a CertificateManager object. server.SigningCertificate = mgr.Certificate; server.MetaSigningCertificate = mgr.Certificate;
- Personalize the server:
server.Config("OrganizationName=My Organization Ltd"); server.Config("OrganizationDisplayName=My Organization Pet Supplies"); server.Config("OrganizationURL=http://myorg.com"); server.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); server.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); server.Config("WantAssertionsSigned=true");
- Optionally, save metadata to an XML file. This will let you send/upload it to the IdP,
so they could set your SP up. Some IdPs can download the metadata right from your SP
using the MetadataURL that you've provided above, in which case saving it to a file
is not necessary.
server.SaveMetadata("my_metadata.xml");
server.Start();
The server should now be running on the local system, listening to incoming connections on the port that you
have specified above (80). Use your browser to check if the server is responding by navigating
to the metadata URL (http://127.0.0.1:80/sp/metadata). If the server has been set up right,
you should see something like this:
Now let us actually try to use the SAML functionality. Copy an arbitrary file - for example, a recent photo of your cat - to the directory you provided earlier via the BaseDir property (D:\Inetpub\SAMLSP). Having copied the file (suppose it is called clifford.jpg), try to access it in your browser by navigating to http://127.0.0.1:80/clifford.jpg.
This is where SAML kicks in. Since you are not authenticated for the SP server yet (we have just launched it, so no one is), the server redirects your browser to the IdP endpoint for authentication. The address of the IdP is taken from the their_metadata.xml file that you have loaded at the very beginning.
Note: you can configure which resources to restrict access to using the ProtectedResources property. If ProtectedResources is empty, the server considers all the files in BaseDir and its subfolders to be protected.
It is now the IdP services turn to authenticate you. Most IdPs on this stage will present you with a login form. Yet, if you have signed in recently, the IdP may still remember you, in which case it will skip the form and proceed directly to the next step. After establishing and proving your identity, the IdP will generate an assertion, a signed proof that effectively states that the IdP knows who you are and have verified your identity rigorously. Think of the assertion as your unique pass to the resources protected by the SP. The IdP will then submit that assertion back to the SP at its AssertionConsumerService endpoint, again using your browser.
Note that the SP service knows nothing about how IdP authenticates you. All the SP is interested in is an assertion.
If the assertion is well-formed and its signature is valid, the SAML exchange completes. At this point the SP accepts the assertion and creates a session for you. You can now access the resources protected by the SP for as long as the session lasts. If this step succeeds, you should see the photo of your cat in your browser.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Active | Tells whether the server is active and ready to process requests. |
BaseDir | Base directory on the server. |
BindingKey | Contains a private key to sign the redirect binding requests. |
DecryptionCertificate | The certificate to be used to decrypt assertions. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
Host | Specifies the host address of the SP server. |
IdPServices | Populates a list of services supported by the IdP. |
IdPSettings | Populates a list of SAML IdP entity settings. |
Issuer | Name identifier of the issuer of the SP's requests. |
KnownCertificates | Additional certificates for chain validation. |
KnownKeys | Public keys for low-level signature validation. |
LogoutPage | Specifies the location of the logout page. |
MetadataURL | The SP's metadata location. |
MetaSigningCertificate | Specifies the metadata signing certificate. |
OfflineMode | Enables the Offline mode. |
PinnedClient | Populates the pinned client details. |
PinnedClientChain | Contains the certificate chain of the pinned client. |
Port | Specifies the listening port number. |
ProtectedResources | Specifies the list of protected resources. |
RedirectOnLogoutPage | Specifies the location to redirect the user on logout. |
Security | Provides access to the SAML security properties. |
SenderChain | Contains the certificate chain of the message sender. |
SigningCertificate | The certificate for signing the SP requests. |
SigningChain | The signing certificate chain. |
SocketSettings | Manages network connection settings. |
SPServices | Populates a list of services supported by the SP. |
SPSettings | Populates a list of SAML SP entity settings. |
TLSServerChain | The server's TLS certificates. |
TLSSettings | Manages TLS layer settings. |
URL | Specifies the base URL of this SP server. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddIdPService | Registers an IdP service in the IdPServices list. |
AddSPService | Registers an SP service in the SPServices list. |
Cleanup | Cleans up the server environment by purging expired sessions and cleaning caches. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
DropClient | Terminates a client connection. |
ExportSettings | Saves the SP or IdP configuration to an XML metadata file. |
GetClientBuffer | Acquires a piece of operation data. |
GetProviderProperty | Returns the value of a custom provider property. |
GetRequestBytes | Returns the contents of the connected client's HTTP request. |
GetRequestHeader | Returns a request header value. |
GetResponseHeader | Returns a response header value. |
GetSessionProperty | Returns the value of a custom session property. |
ImportSettings | Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call. |
InitiateArtifactResolve | Initiates the artifact resolution protocol. |
InitiateAttributeQuery | Initiates the attribute query. |
InitiateAuth | Starts SP-initiated SAML authentication flow. |
InitiateLogout | Starts SP-initiated SAML logout flow. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
ProcessArtifact | Processes an artifact request received from the IdP service at one of artifact receiver endpoints. |
ProcessArtifactResolveRequest | Processes an artifact request received from the SP service at one of the ARS endpoints. |
ProcessAssertion | Processes assertion received from the IdP service at one of the ACS endpoints. |
ProcessGenericRequest | Processes a generic HTTP SAML request. |
ProcessLogoutRequest | Processes logout request received from the IdP service at one of the SLS endpoints. |
Reset | Resets the component settings. |
SetClientBuffer | Commits a data buffer to the connection. |
SetProviderProperty | Sets the value of a custom provider property. |
SetResponseHeader | Sets a response header. |
SetSessionProperty | Sets the value of a custom provider session property. |
Start | Starts the SP server. |
Stop | Stops the IdP server. |
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.
Accept | Reports an incoming connection. |
ArtifactReceived | The server fires this event upon receiving an Artifact message from the other side. |
ArtifactResolveRequestPrepared | This event is fired when a new artifact resolution request message has been prepared by the component. |
ArtifactResolveRequestReceived | Reports receipt of ArtifactResolveRequest message. |
AssertionReceived | This event is fired when an assertion is received from the IdP. |
AttributeQueryPrepared | Notifies the application of the preparation of an AttributeQuery. |
AuthnRequestPrepared | This event is fired when a new authentication request message has been prepared. |
Connect | Reports an accepted connection. |
Disconnect | Fires to report a disconnected client. |
Encrypted | Notifies the application that the assertion is encrypted and provides recipient certificate details. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
LogoutRequestPrepared | This event is fired when a new logout request has been prepared. |
LogoutRequestReceived | The component uses this event to notify the application about an incoming SAML Logout Request message. |
LogoutResponsePrepared | The component uses this event to notify the application about the Logout Response message being ready to be sent. |
LogoutResponseReceived | The component uses this event to notify the application about an incoming SAML LogoutResponse message. |
Notification | This event notifies the application about an underlying control flow event. |
ProcessingCompleted | This event notifies the application of the completion of request or response processing. |
ReadArtifact | Requests content identified by an artifact from the application. |
ResourceClose | Tells the application that it can close the opened resource. |
ResourceOpen | Requests the application to open the requested resource. |
ResourceRead | Requests the application to read from an opened resource. |
ResourceRequest | Notifies the application that a server resource is requested. |
ResourceWrite | Requests the application to write to an opened resource. |
SAMLMessagePrepared | This event is fired when a SAML message has been prepared and is ready to be dispatched. |
SAMLMessageReceived | The server fires this event for every SAML message it receives. |
SessionCreated | This event is fired when a new session has been established. |
SessionDestroyed | This event is fired when the SP server has closed a session. |
SessionEvent | Notifies the application about SAML session events. |
SessionInfoNeeded | This event is fired in OfflineMode to request the session ID for the current flow. |
SessionStateRetrieve | This event fires to retrieve session state information from the application. |
SessionStateSave | This event passes a session state object to the application for safekeeping. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Reports the signature validation result. |
TLSCertValidate | Fires when a client certificate needs to be validated. |
TLSEstablished | Reports the setup of a TLS session. |
TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
TLSPSK | Requests a pre-shared key for TLS-PSK. |
TLSShutdown | Reports closure of a TLS session. |
UserAuthCompleted | Notifies the application about the success of user authentication flow. |
UserAuthFailed | Notifies the application about failure of user authentication flow. |
UserAuthStart | Notifies the application about the start of user authentication flow. |
UserLogoutCompleted | Notifies the application about the completion of user logout flow. |
UserLogoutStart | Notifies the application about the start of user logout flow. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
AttributeConsumingService | TBD. |
AuthDigestExpire | Specifies digest expiration time for digest authentication. |
BoundPort | The port that was bound by the server. |
ContactPerson | The ContactPerson entry of the provider metadata. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
HandshakeTimeout | The HTTPS handshake timeout. |
HomePage | Specifies the home page resource name. |
IDPAQS | TBD. |
IDPARS | TBD. |
IDPSLS | TBD. |
IDPSSO | TBD. |
MaxIssueInstantTimeDiff | The maximum issue-instant time delta. |
OrganizationDisplayName | The OrganizationDisplayName entry of the provider metadata. |
OrganizationLang | The OrganizationLang key of the provider metadata. |
OrganizationName | The OrganizationName element of the provider metadata. |
OrganizationURL | The OrganizationURL element of the provider metadata. |
PortRangeFrom | The lower bound of allowed port scope to listen on. |
PortRangeTo | The higher bound of allowed port scope to listen on. |
RequestFilter | The request string modifier. |
SAMLAction | TBD. |
SAMLBuffer | TBD. |
SAMLResourceProtected | TBD. |
SAMLResourceSpecial | TBD. |
SAMLString | TBD. |
SendBufferSize | The network send buffer size. |
ServerName | Specifies the server name for the created responses. |
SessionTimeout | The HTTP session timeout. |
SessionTTL | The SAML session time-to-live value. |
SignatureAlgorithm | TBD. |
TempPath | Path for storing temporary files. |
UseZeroIndexForDefaultServices | TBD. |
WantAssertionsSigned | TBD. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the component. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client components created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
Active Property (SAMLSPServer Component)
Tells whether the server is active and ready to process requests.
Syntax
Default Value
False
Remarks
This property indicates whether the IdP server is in an active state.
This property is read-only and not available at design time.
BaseDir Property (SAMLSPServer Component)
Base directory on the server.
Syntax
Default Value
""
Remarks
Use this property to specify the base directory for the SP server.
BindingKey Property (SAMLSPServer Component)
Contains a private key to sign the redirect binding requests.
Syntax
Remarks
Use this property to set the signing key for the redirect binding object. This is used to sign the content of the redirect binding.
Note that when using the redirect binding, the outgoing SAML message must not be signed in parallel with a certificate. Any assertions may still be signed.
This property is not available at design time.
Please refer to the CryptoKey type for a complete list of fields.DecryptionCertificate Property (SAMLSPServer Component)
The certificate to be used to decrypt assertions.
Syntax
public Certificate DecryptionCertificate { get; set; }
Public Property DecryptionCertificate As Certificate
Remarks
Use this property to provide the certificate to be used for decrypting assertions included in IdP (Identity Provider) responses. This certificate should have a private key associated with it.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.ExternalCrypto Property (SAMLSPServer Component)
Provides access to external signing and DC parameters.
Syntax
public ExternalCrypto ExternalCrypto { get; }
Public ReadOnly Property ExternalCrypto As ExternalCrypto
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).
This property is read-only.
Please refer to the ExternalCrypto type for a complete list of fields.FIPSMode Property (SAMLSPServer Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
HandshakeTimeout Property (SAMLSPServer Component)
Specifies the handshake timeout in milliseconds.
Syntax
Default Value
20000
Remarks
Use this property to set the TLS handshake timeout.
Host Property (SAMLSPServer Component)
Specifies the host address of the SP server.
Syntax
Default Value
""
Remarks
Use this property to specify the IP address on which to listen to incoming connections. To specify the listening port number, use Port.
IdPServices Property (SAMLSPServer Component)
Populates a list of services supported by the IdP.
Syntax
public SAMLServiceInfoList IdPServices { get; }
Public ReadOnly Property IdPServices As SAMLServiceInfoList
Remarks
Use this property to access the list of services supported by the IdP. In the SAMLIdPServer, this is the list of services supported by the IdP. In the SAMLSPServer, this is the list of services advertised by the remote IdP server. These can be loaded from the respective IdP's metadata or set manually via AddIdPService method.
This property is read-only and not available at design time.
Please refer to the SAMLServiceInfo type for a complete list of fields.IdPSettings Property (SAMLSPServer Component)
Populates a list of SAML IdP entity settings.
Syntax
public SAMLEntity IdPSettings { get; }
Public ReadOnly Property IdPSettings As SAMLEntity
Remarks
Use this property to get or set properties of a SAML IdP entity. These properties can be adjusted manually or loaded from the respective metadata file.
This property is read-only and not available at design time.
Please refer to the SAMLEntity type for a complete list of fields.Issuer Property (SAMLSPServer Component)
Name identifier of the issuer of the SP's requests.
Syntax
Default Value
""
Remarks
Use this property to set the name identifier of this Service Provider (SP) to be used in its requests.
KnownCertificates Property (SAMLSPServer Component)
Additional certificates for chain validation.
Syntax
public CertificateList KnownCertificates { get; }
Public Property KnownCertificates As CertificateList
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.KnownKeys Property (SAMLSPServer Component)
Public keys for low-level signature validation.
Syntax
public CryptoKeyList KnownKeys { get; }
Public Property KnownKeys As CryptoKeyList
Remarks
Use this property to supply a list of public keys that might be needed for redirect binding signature validation.
This property is not available at design time.
Please refer to the CryptoKey type for a complete list of fields.LogoutPage Property (SAMLSPServer Component)
Specifies the location of the logout page.
Syntax
Default Value
"/sp/logout"
Remarks
Use this property to specify the relative URL of the logout page.
MetadataURL Property (SAMLSPServer Component)
The SP's metadata location.
Syntax
Default Value
"/sp/metadata"
Remarks
This property specifies the metadata URL of this Service Provider (SP).
MetaSigningCertificate Property (SAMLSPServer Component)
Specifies the metadata signing certificate.
Syntax
public Certificate MetaSigningCertificate { get; set; }
Public Property MetaSigningCertificate As Certificate
Remarks
Use this property to specify the certificate to be used to sign the SP's metadata. This certificate should have a private key associated with it.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.OfflineMode Property (SAMLSPServer Component)
Enables the Offline mode.
Syntax
Default Value
True
Remarks
In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be relayed by the application via calls to ProcessAssertion, ProcessLogoutRequest ProcessArtifactResolveRequest, and other similar methods.
The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML traffic.
PinnedClient Property (SAMLSPServer Component)
Populates the pinned client details.
Syntax
public TLSConnectionInfo PinnedClient { get; }
Public ReadOnly Property PinnedClient As TLSConnectionInfo
Remarks
Use this property to access the details of the client connection previously pinned with PinClient method.
This property is read-only and not available at design time.
Please refer to the TLSConnectionInfo type for a complete list of fields.PinnedClientChain Property (SAMLSPServer Component)
Contains the certificate chain of the pinned client.
Syntax
public CertificateList PinnedClientChain { get; }
Public ReadOnly Property PinnedClientChain As CertificateList
Remarks
Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.
This property is read-only and not available at design time.
Please refer to the Certificate type for a complete list of fields.Port Property (SAMLSPServer Component)
Specifies the listening port number.
Syntax
Default Value
80
Remarks
Use this property to specify the port number on which the SP server should listen for incoming connections. To specify the server's IP address use Host.
ProtectedResources Property (SAMLSPServer Component)
Specifies the list of protected resources.
Syntax
Default Value
""
Remarks
This property contains a set of relative URLs of the protected resources offered by this Service Provider (SP).
RedirectOnLogoutPage Property (SAMLSPServer Component)
Specifies the location to redirect the user on logout.
Syntax
Default Value
"https://nsoftware.com"
Remarks
Use this property to specify the page where to redirect the user on logout.
Security Property (SAMLSPServer Component)
Provides access to the SAML security properties.
Syntax
public SAMLSecuritySettings Security { get; }
Public ReadOnly Property Security As SAMLSecuritySettings
Remarks
Use this property to access the security parameters of the server.
This property is read-only and not available at design time.
Please refer to the SAMLSecuritySettings type for a complete list of fields.SenderChain Property (SAMLSPServer Component)
Contains the certificate chain of the message sender.
Syntax
public CertificateList SenderChain { get; }
Public ReadOnly Property SenderChain As CertificateList
Remarks
Use this property to access the certificate chain of the creator of the signed message or entity that is currently being processed. This property is only available from SignatureFound and SignatureValidated events.
This property is read-only and not available at design time.
Please refer to the Certificate type for a complete list of fields.SigningCertificate Property (SAMLSPServer Component)
The certificate for signing the SP requests.
Syntax
public Certificate SigningCertificate { get; set; }
Public Property SigningCertificate As Certificate
Remarks
Use this property to designate a certificate for signing the SP requests. The provided certificate must have a private key associated with it.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.SigningChain Property (SAMLSPServer Component)
The signing certificate chain.
Syntax
public CertificateList SigningChain { get; }
Public Property SigningChain As CertificateList
Remarks
Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.SocketSettings Property (SAMLSPServer Component)
Manages network connection settings.
Syntax
public SocketSettings SocketSettings { get; }
Public ReadOnly Property SocketSettings As SocketSettings
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Please refer to the SocketSettings type for a complete list of fields.SPServices Property (SAMLSPServer Component)
Populates a list of services supported by the SP.
Syntax
public SAMLServiceInfoList SPServices { get; }
Public ReadOnly Property SPServices As SAMLServiceInfoList
Remarks
Use this property to access the list of services supported by the SP. In the SAMLSPServer, this is the list of services supported by the SP. In the SAMLIdPServer, this is the list of services advertised by the remote SP server. These can be loaded from the respective SP's metadata or set manually via AddSPService method.
This property is read-only and not available at design time.
Please refer to the SAMLServiceInfo type for a complete list of fields.SPSettings Property (SAMLSPServer Component)
Populates a list of SAML SP entity settings.
Syntax
public SAMLEntity SPSettings { get; }
Public ReadOnly Property SPSettings As SAMLEntity
Remarks
Use this property to get or set properties of a SAML SP entity. These properties can be adjusted manually or loaded from the respective metadata file.
This property is read-only and not available at design time.
Please refer to the SAMLEntity type for a complete list of fields.TLSServerChain Property (SAMLSPServer Component)
The server's TLS certificates.
Syntax
public CertificateList TLSServerChain { get; }
Public Property TLSServerChain As CertificateList
Remarks
Use this property to provide a list of TLS certificates for the server endpoint.
A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.
The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.
This property is not available at design time.
Please refer to the Certificate type for a complete list of fields.TLSSettings Property (SAMLSPServer Component)
Manages TLS layer settings.
Syntax
public TLSSettings TLSSettings { get; }
Public ReadOnly Property TLSSettings As TLSSettings
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Please refer to the TLSSettings type for a complete list of fields.URL Property (SAMLSPServer Component)
Specifies the base URL of this SP server.
Syntax
Default Value
""
Remarks
Use this property to set the base URL for this Service Provider (SP) server.
Please make sure the URL you provide here aligns well with the relative endpoint resource paths, such as AssertionConsumerService or ArtifactResolutionService. The two parts (the URL and the endpoint paths) are concatenated to produce full endpoint URLs. Please double check that only one of the parts includes the slash character in it: either the endpoint paths at the beginning (the default configuration), or the base URL at the end.
AddIdPService Method (SAMLSPServer Component)
Registers an IdP service in the IdPServices list.
Syntax
Remarks
Use this method to add an entry to the list of known external SAML services and their locations.
The service provider needs to be knowledgeable of the external IdP services that it needs to use. That information can either be provided in the form of a metadata file (see ImportSettings), or registered manually using this method.
When using this method, make sure to register all the services you expect to work with. Note that if the same IdP service is available through several different transports (bindings), you will need to register each (service, transport) pair individually:
sp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1);
sp.AddIdPService(spsSingleSignOnService, csbtRedirect, "https://idp.identityserver/saml/sso", -1, -1);
Use the Service parameter to specify the service to register:
spsUnknown | 0 | The service is of unknown or unsupported type |
spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for SSO and SLS services to use POST or Redirect bindings. This information is typically provided by the identity provider.
csbtNone | 0 | TBD |
csbtSOAP | 1 | TBD |
csbtPAOS | 2 | TBD |
csbtRedirect | 3 | TBD |
csbtPOST | 4 | TBD |
csbtArtifact | 5 | TBD |
The Location parameter specifies the absolute URL of the respective SAML web endpoint.
The Priority parameter specifies the relative priority of the transport among several identical services. The actual transport used may be different to the specified priority, as the request received from the SP (such as AuthnRequest) may explicitly request a specific transport to use.
The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.
Note that this method registers a known service - something that the service provider should be aware of. This is different to the purpose of the AddSPService method, which registers the service provider's own service.
AddSPService Method (SAMLSPServer Component)
Registers an SP service in the SPServices list.
Syntax
Remarks
Use this method to add an entry to the list of SAML services and their locations provided by the SP.
A service provider can provide a variety of SAML services through a selection of endpoints, each supporting one or more transports (or bindings). Typical examples are an assertion consumer service or a single logout service, each of which can be served independently on the same or different endpoints, via a POST or Redirect transports (or both).
Each AddSPService call registers a single service offered via a single transport. If you would like to have the same service to be available using several different transports, you need to register each combination individually, even if the service runs at the same web endpoint:
sp.AddSPService(spsAssertionConsumerService, csbtPOST, '/saml/acs', -1, 1);
sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2);
Use the Service parameter to specify the service to register:
spsUnknown | 0 | The service is of unknown or unsupported type |
spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for ACS service to use POST binding (due to the size of assertions), and SLS to either use POST or Redirect.
csbtNone | 0 | TBD |
csbtSOAP | 1 | TBD |
csbtPAOS | 2 | TBD |
csbtRedirect | 3 | TBD |
csbtPOST | 4 | TBD |
csbtArtifact | 5 | TBD |
The Location parameter specifies an absolute or relative path to the service within the SAML web service:
sp.AddSPService(spsAssertionConsumerService, csbtPOST, 'https://app.com/saml/acs', -1, 1); // absolute path
sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2); // relative path
The Priority parameter is nominal as it only specifies the relative priority of the transport in the SP metadata. The actual transport used, among those supported, depends on the choice of the external identity provider. Pass -1 to stick with the default priority.
The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.
Note that this method registers the service provider's own service - something that the service provider provides. This is different to AddIdPService method, which registers a foreign identity provider's service - something that the service provider should be aware of.
Cleanup Method (SAMLSPServer Component)
Cleans up the server environment by purging expired sessions and cleaning caches.
Syntax
public void Cleanup();
Public Sub Cleanup()
Remarks
Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.
Config Method (SAMLSPServer Component)
Sets or retrieves a configuration setting.
Syntax
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.
DoAction Method (SAMLSPServer Component)
Performs an additional action.
Syntax
Remarks
DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
DropClient Method (SAMLSPServer Component)
Terminates a client connection.
Syntax
Remarks
Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.
ExportSettings Method (SAMLSPServer Component)
Saves the SP or IdP configuration to an XML metadata file.
Syntax
Remarks
Use this method to save the Service Provider (SP) or Identity Provider (IdP) configuration in the form of XML metadata. The SP metadata file may then be transferred to identity providers (IdP) to let them know about the SP configuration.
Adjust the provider configuration as required in SPSettings or IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.
GetClientBuffer Method (SAMLSPServer Component)
Acquires a piece of operation data.
Syntax
Remarks
Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.
A typical place to call this method is inside the ResourceWrite event handler, when implementing customized file transfers.
GetProviderProperty Method (SAMLSPServer Component)
Returns the value of a custom provider property.
Syntax
Remarks
This method, together with SetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
GetRequestBytes Method (SAMLSPServer Component)
Returns the contents of the connected client's HTTP request.
Syntax
Remarks
Use this method to get the body of the client's HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.
GetRequestHeader Method (SAMLSPServer Component)
Returns a request header value.
Syntax
Remarks
Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.
GetResponseHeader Method (SAMLSPServer Component)
Returns a response header value.
Syntax
Remarks
Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.
GetSessionProperty Method (SAMLSPServer Component)
Returns the value of a custom session property.
Syntax
Remarks
This method, together with SetSessionProperty, provides an extensible way of managing the Service Provider's session properties that are not available through the primary properties and events of the component. These methods can be called on any active browser session. Use SessionCreated and SessionDestroyed events to get notifications about session creation and disposal.
The following properties are supported for SP sessions and can be passed to the Name parameter of this method:
- AuthnRequestID: the AuthnRequest ID.
- Expires: the web session expiration time.
- LogoutRequestID: the LogoutRequest ID.
- NameID: the NameID of the user.
- NameIDFormat: the format of the NameID of the user.
- FormattedNameID: the formatted version of the NameID.
- RelayState: the current (last) relay state entry.
- Session: the session ID (the same as you pass as parameter).
- SessionIndex: a list of cross-network session indexes assigned to this session.
- URL: the current request's URL.
- UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.
ImportSettings Method (SAMLSPServer Component)
Loads the metadata required for information exchange with the identity provider. Both local (SP-side) and remote (IdP-side) metadata can be loaded with this call.
Syntax
Remarks
The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.
The Metadata parameter contains metadata in the form of byte array. Set SP parameter to true to indicate that it is the Service Provider's own settings that are being loaded.
The loaded metadata is populated in the SPSettings or IdPSettings object (depending on the value of the SP parameter).
InitiateArtifactResolve Method (SAMLSPServer Component)
Initiates the artifact resolution protocol.
Syntax
Remarks
Use this event to initiate the artifact resolution protocol for Artifact. Specify the desired SP service endpoint via the IdPServiceIndex parameter.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
InitiateAttributeQuery Method (SAMLSPServer Component)
Initiates the attribute query.
Syntax
public int InitiateAttributeQuery(long connectionID, string sessionID, int idPServiceIndex, string nameID, string nameIDFormat, string attributes, string attrNameFormats, string attrFriendlyNames, string tag);
Public Function InitiateAttributeQuery(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal IdPServiceIndex As Integer, ByVal NameID As String, ByVal NameIDFormat As String, ByVal Attributes As String, ByVal AttrNameFormats As String, ByVal AttrFriendlyNames As String, ByVal Tag As String) As Integer
Remarks
Use this event to initiate the attribute query for user NameID. Specify the desired Attributes as a list of CRLF-separated attribute names. AttrNameFormats and AttrFriendlyNames can also be provided in the same way.
Specify the IdP AQS endpoint via the IdPServiceIndex parameter.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
InitiateAuth Method (SAMLSPServer Component)
Starts SP-initiated SAML authentication flow.
Syntax
Remarks
Use this method to initiate SAML authentication flow on the SP side. Pass the index of the single sign-on service that you want to use to the IdPServiceIndex parameter. Leave it empty to let the component pick up the best one automatically. Use RelayState to pass the callback URL to the IdP service. This will be mirrored back by the IDP in its response.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
InitiateLogout Method (SAMLSPServer Component)
Starts SP-initiated SAML logout flow.
Syntax
Remarks
Use this method to initiate SAML logout flow on the SP side. Pass the index of the single logout service that you want to use to the IdPServiceIndex parameter.
Use IdPServiceIndex to specify the identity provider's service that you want to use for signing out. Provide the existing SAML session details in one of the following ways:
- as an HTTP SessionID: in this case the component will try to pick the matching SAML session from its session cache.
- as a known NameID.
- as a known SAML SessionIndex.
You can use a combination of the above.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
Use RelayState to pass a value to the IdP that you want to be mirrored back in the IdP's response. The Tag value will be similarly mirrored, but in the component's events, such as ProcessingCompleted.
You can use this method with or without the OfflineMode.
ListClients Method (SAMLSPServer Component)
Enumerates the connected clients.
Syntax
Remarks
This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.
PinClient Method (SAMLSPServer Component)
Takes a snapshot of the connection's properties.
Syntax
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.
ProcessArtifact Method (SAMLSPServer Component)
Processes an artifact request received from the IdP service at one of artifact receiver endpoints.
Syntax
Remarks
Use this method to pass a SAML artifact received at one of the artifact endpoints.
Artifact messages are typically very simple:
https://idp.server.com/sso/artifact?SAMLart=artifact
In response to the artifact received, the server initiates an artifact resolution protocol to retrieve the SAML message identified by the artifact. This will typically expose itself via an invocation of the ArtifactResolveRequestPrepared event, and, later on, of an event matching the type of the actual message received - such as AssertionReceived.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
ProcessArtifactResolveRequest Method (SAMLSPServer Component)
Processes an artifact request received from the SP service at one of the ARS endpoints.
Syntax
Remarks
Use this method to pass a SAML artifact request received at one of the ArtifactResolutionService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Note: this method is currently in development and will be available in later SecureBlackbox updates.
ProcessAssertion Method (SAMLSPServer Component)
Processes assertion received from the IdP service at one of the ACS endpoints.
Syntax
Remarks
Use this method to pass a SAML assertion received at one of the AssertionConsumerService endpoints.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
ProcessGenericRequest Method (SAMLSPServer Component)
Processes a generic HTTP SAML request.
Syntax
Remarks
Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine.
The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. The generated response contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers).
You can use this method with or without the OfflineMode.
ProcessLogoutRequest Method (SAMLSPServer Component)
Processes logout request received from the IdP service at one of the SLS endpoints.
Syntax
Remarks
Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints.
An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If Request contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If Request contains a LogoutResponse, the generated content is empty.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
You can use this method with or without the OfflineMode.
Reset Method (SAMLSPServer Component)
Resets the component settings.
Syntax
public void Reset();
Public Sub Reset()
Remarks
Reset is a generic method available in every component.
SetClientBuffer Method (SAMLSPServer Component)
Commits a data buffer to the connection.
Syntax
Remarks
Use this method from your ReadFile event handler to commit a chunk of file data to the server component.
SetProviderProperty Method (SAMLSPServer Component)
Sets the value of a custom provider property.
Syntax
Remarks
This method, together with GetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
SetResponseHeader Method (SAMLSPServer Component)
Sets a response header.
Syntax
Remarks
Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.
SetSessionProperty Method (SAMLSPServer Component)
Sets the value of a custom provider session property.
Syntax
Remarks
This method, together with GetSessionProperty, provides an extensible way of managing the Service Provider's session settings that are not available through the primary properties and events of the component.
The following properties can be adjusted for each individual session:
- AuthnRequestID: the AuthnRequest ID.
- LogoutRequestID: the LogoutRequest ID.
- NameID: the NameID of the user.
- RelayState: the current (last) relay state entry.
- Session: the session ID (the same as you pass as parameter).
- SessionIndex: a collection of cross-network session indexes assigned to this session.
- URL: the current request's URL.
- UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.
Note: setting a session property invokes a call to SessionStateSave. The component does that to update the session state kept externally.
Note: changing session properties mindlessly may break the protocol flow. For example, changing AuthnRequestID to a different value may cause the Service Provider to reject the subsequent assertion message, as the incoming assertion will contain a now-unmatching In-Response-To entry.
Start Method (SAMLSPServer Component)
Starts the SP server.
Syntax
public void Start();
Public Sub Start()
Remarks
Use this method to start listening for incoming connections.
Stop Method (SAMLSPServer Component)
Stops the IdP server.
Syntax
public void Stop();
Public Sub Stop()
Remarks
Call this method to stop listening for incoming connections.
Accept Event (SAMLSPServer Component)
Reports an incoming connection.
Syntax
public event OnAcceptHandler OnAccept; public delegate void OnAcceptHandler(object sender, SAMLSPServerAcceptEventArgs e); public class SAMLSPServerAcceptEventArgs : EventArgs { public string RemoteAddress { get; } public int RemotePort { get; } public bool Accept { get; set; } }
Public Event OnAccept As OnAcceptHandler Public Delegate Sub OnAcceptHandler(sender As Object, e As SAMLSPServerAcceptEventArgs) Public Class SAMLSPServerAcceptEventArgs Inherits EventArgs Public ReadOnly Property RemoteAddress As String Public ReadOnly Property RemotePort As Integer Public Property Accept As Boolean End Class
Remarks
This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.
Subscribe to Connect event to be notified of every connection that has been set up.
ArtifactReceived Event (SAMLSPServer Component)
The server fires this event upon receiving an Artifact message from the other side.
Syntax
public event OnArtifactReceivedHandler OnArtifactReceived; public delegate void OnArtifactReceivedHandler(object sender, SAMLSPServerArtifactReceivedEventArgs e); public class SAMLSPServerArtifactReceivedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Issuer { get; } public string Artifact { get; } public int Action { get; set; } }
Public Event OnArtifactReceived As OnArtifactReceivedHandler Public Delegate Sub OnArtifactReceivedHandler(sender As Object, e As SAMLSPServerArtifactReceivedEventArgs) Public Class SAMLSPServerArtifactReceivedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Issuer As String Public ReadOnly Property Artifact As String Public Property Action As Integer End Class
Remarks
The Artifact message is very simple and only contains the actual artifact (an opaque string). Depending on the choice of the Action parameter, the further flow may go as following:
- fraAuto: the server will prepare an ArtifactResolve request and sent it to the other side to retrieve the artifact.
- fraCustom: the server will acknowledge the receipt of the artifact, but it is the task of your code to request the message and pass it on to the server via ProcessGenericRequest method.
- fraReject: the server will discard the artifact.
Note that you still can choose fraAuto to let the server proceed, but alter the flow as required in further events, such as ArtifactResolveRequestPrepared.
In OfflineMode this event would typically be fired from ProcessArtifact call.
ArtifactResolveRequestPrepared Event (SAMLSPServer Component)
This event is fired when a new artifact resolution request message has been prepared by the component.
Syntax
public event OnArtifactResolveRequestPreparedHandler OnArtifactResolveRequestPrepared; public delegate void OnArtifactResolveRequestPreparedHandler(object sender, SAMLSPServerArtifactResolveRequestPreparedEventArgs e); public class SAMLSPServerArtifactResolveRequestPreparedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Destination { get; } public string Artifact { get; } }
Public Event OnArtifactResolveRequestPrepared As OnArtifactResolveRequestPreparedHandler Public Delegate Sub OnArtifactResolveRequestPreparedHandler(sender As Object, e As SAMLSPServerArtifactResolveRequestPreparedEventArgs) Public Class SAMLSPServerArtifactResolveRequestPreparedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Destination As String Public ReadOnly Property Artifact As String End Class
Remarks
Subscribe to this event to be notified about preparation of artifact resolution requests. This is fired right after the resolution request has been prepared, and just before the component sends it out to the identity provider.
ArtifactResolveRequestReceived Event (SAMLSPServer Component)
Reports receipt of ArtifactResolveRequest message.
Syntax
public event OnArtifactResolveRequestReceivedHandler OnArtifactResolveRequestReceived; public delegate void OnArtifactResolveRequestReceivedHandler(object sender, SAMLSPServerArtifactResolveRequestReceivedEventArgs e); public class SAMLSPServerArtifactResolveRequestReceivedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Issuer { get; } public bool IsEncrypted { get; } public bool IsSigned { get; } public string Artifact { get; } public int Action { get; set; } }
Public Event OnArtifactResolveRequestReceived As OnArtifactResolveRequestReceivedHandler Public Delegate Sub OnArtifactResolveRequestReceivedHandler(sender As Object, e As SAMLSPServerArtifactResolveRequestReceivedEventArgs) Public Class SAMLSPServerArtifactResolveRequestReceivedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Issuer As String Public ReadOnly Property IsEncrypted As Boolean Public ReadOnly Property IsSigned As Boolean Public ReadOnly Property Artifact As String Public Property Action As Integer End Class
Remarks
The component fires this event to report receipt of incoming artifact resolution request. The Artifact parameter contains the artifact identifier received.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
AssertionReceived Event (SAMLSPServer Component)
This event is fired when an assertion is received from the IdP.
Syntax
public event OnAssertionReceivedHandler OnAssertionReceived; public delegate void OnAssertionReceivedHandler(object sender, SAMLSPServerAssertionReceivedEventArgs e); public class SAMLSPServerAssertionReceivedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Issuer { get; } public string Body { get; } public bool IsEncrypted { get; } public bool IsSigned { get; } public string Auth { get; } public string NameID { get; } public string NameIDFormat { get; } public string SessionIndex { get; } public string Attributes { get; } public string ValidFrom { get; } public string ValidTo { get; } public string RelayState { get; } public int Action { get; set; } }
Public Event OnAssertionReceived As OnAssertionReceivedHandler Public Delegate Sub OnAssertionReceivedHandler(sender As Object, e As SAMLSPServerAssertionReceivedEventArgs) Public Class SAMLSPServerAssertionReceivedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Issuer As String Public ReadOnly Property Body As String Public ReadOnly Property IsEncrypted As Boolean Public ReadOnly Property IsSigned As Boolean Public ReadOnly Property Auth As String Public ReadOnly Property NameID As String Public ReadOnly Property NameIDFormat As String Public ReadOnly Property SessionIndex As String Public ReadOnly Property Attributes As String Public ReadOnly Property ValidFrom As String Public ReadOnly Property ValidTo As String Public ReadOnly Property RelayState As String Public Property Action As Integer End Class
Remarks
The AssertionReceived event notifies the application that an assertion has been received at the ACS endpoint. In OfflineMode this event may fire in response to a ProcessAssertion call. In online mode it can fire at any time while the server is active.
The ConnectionID and SessionID specify the IDs of the current client connection and HTTP session. The RequestID contains the ID of the original AuthnRequest message, if it was sent by the service provider. The IsEncrypted and IsSigned parameters indicate the security properties of the assertion. The NameID parameter contains the unique name identifier of the authenticated principal, and the SessionIndex contains the SAML session identifier. In rare cases SessionIndex may contain multiple indices, if the SP has more than one session at the IdP.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
If the assertion is returned in response to this SP's AuthnRequest message, the RelayState parameter will contain the original relay state passed to the earlier InitiateAuth call.
AttributeQueryPrepared Event (SAMLSPServer Component)
Notifies the application of the preparation of an AttributeQuery.
Syntax
public event OnAttributeQueryPreparedHandler OnAttributeQueryPrepared; public delegate void OnAttributeQueryPreparedHandler(object sender, SAMLSPServerAttributeQueryPreparedEventArgs e); public class SAMLSPServerAttributeQueryPreparedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Destination { get; } public string NameID { get; } public string NameIDFormat { get; } public string Attributes { get; } }
Public Event OnAttributeQueryPrepared As OnAttributeQueryPreparedHandler Public Delegate Sub OnAttributeQueryPreparedHandler(sender As Object, e As SAMLSPServerAttributeQueryPreparedEventArgs) Public Class SAMLSPServerAttributeQueryPreparedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Destination As String Public ReadOnly Property NameID As String Public ReadOnly Property NameIDFormat As String Public ReadOnly Property Attributes As String End Class
Remarks
The component uses this event to notify the application of the completion of the preparation of the AttributeQuery message. The NameID and NameIDFormat parameters indicate the attribute subject, and the Attributes parameter contains a list of attributes being requested.
This event may be fired in response to a InitiateAttributeQuery call (in offline mode), or intermittently in online mode.
AuthnRequestPrepared Event (SAMLSPServer Component)
This event is fired when a new authentication request message has been prepared.
Syntax
public event OnAuthnRequestPreparedHandler OnAuthnRequestPrepared; public delegate void OnAuthnRequestPreparedHandler(object sender, SAMLSPServerAuthnRequestPreparedEventArgs e); public class SAMLSPServerAuthnRequestPreparedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Destination { get; } public string NameIDFormat { get; } public bool ForceAuthn { get; } public bool NonInteractive { get; } public string RelayState { get; set; } }
Public Event OnAuthnRequestPrepared As OnAuthnRequestPreparedHandler Public Delegate Sub OnAuthnRequestPreparedHandler(sender As Object, e As SAMLSPServerAuthnRequestPreparedEventArgs) Public Class SAMLSPServerAuthnRequestPreparedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Destination As String Public ReadOnly Property NameIDFormat As String Public ReadOnly Property ForceAuthn As Boolean Public ReadOnly Property NonInteractive As Boolean Public Property RelayState As String End Class
Remarks
Subscribe to this event to get notified about assertion requests prepared by the service provider. This event may fire from InitiateAuth method when working in OfflineMode, or at any time when working as a standalone live web server.
You can adjust the RelayState as required in the event handler to pass on a state to the IdP. The IdP will return this state back to you together with its authentication assertion.
Connect Event (SAMLSPServer Component)
Reports an accepted connection.
Syntax
public event OnConnectHandler OnConnect; public delegate void OnConnectHandler(object sender, SAMLSPServerConnectEventArgs e); public class SAMLSPServerConnectEventArgs : EventArgs { public long ConnectionId { get; } public string RemoteAddress { get; } public int RemotePort { get; } }
Public Event OnConnect As OnConnectHandler Public Delegate Sub OnConnectHandler(sender As Object, e As SAMLSPServerConnectEventArgs) Public Class SAMLSPServerConnectEventArgs Inherits EventArgs Public ReadOnly Property ConnectionId As Long Public ReadOnly Property RemoteAddress As String Public ReadOnly Property RemotePort As Integer End Class
Remarks
The component fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as SessionClosed or SessionEstablished.
Disconnect Event (SAMLSPServer Component)
Fires to report a disconnected client.
Syntax
public event OnDisconnectHandler OnDisconnect; public delegate void OnDisconnectHandler(object sender, SAMLSPServerDisconnectEventArgs e); public class SAMLSPServerDisconnectEventArgs : EventArgs { public long ConnectionID { get; } }
Public Event OnDisconnect As OnDisconnectHandler Public Delegate Sub OnDisconnectHandler(sender As Object, e As SAMLSPServerDisconnectEventArgs) Public Class SAMLSPServerDisconnectEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long End Class
Remarks
The component fires this event when a connected client disconnects.
Encrypted Event (SAMLSPServer Component)
Notifies the application that the assertion is encrypted and provides recipient certificate details.
Syntax
public event OnEncryptedHandler OnEncrypted; public delegate void OnEncryptedHandler(object sender, SAMLSPServerEncryptedEventArgs e); public class SAMLSPServerEncryptedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public bool NeedCredential { get; } public bool SkipThis { get; set; } }
Public Event OnEncrypted As OnEncryptedHandler Public Delegate Sub OnEncryptedHandler(sender As Object, e As SAMLSPServerEncryptedEventArgs) Public Class SAMLSPServerEncryptedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property IssuerRDN As String Public ReadOnly Property SerialNumber As Byte() Public ReadOnly Property SubjectKeyID As Byte() Public ReadOnly Property NeedCredential As Boolean Public Property SkipThis As Boolean End Class
Remarks
The component fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.
This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate property (depending on encryption method used), or sets SkipThis to true.
The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.
The NeedCredential parameter specifies whether the correct credential is already available to the component or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the DecryptionCertificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.
Error Event (SAMLSPServer Component)
Information about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, SAMLSPServerErrorEventArgs e); public class SAMLSPServerErrorEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public int ErrorCode { get; } public bool Fatal { get; } public bool Remote { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As SAMLSPServerErrorEventArgs) Public Class SAMLSPServerErrorEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Fatal As Boolean Public ReadOnly Property Remote As Boolean Public ReadOnly Property Description As String End Class
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.
ExternalSign Event (SAMLSPServer Component)
Handles remote or external signing initiated by the server protocol.
Syntax
public event OnExternalSignHandler OnExternalSign; public delegate void OnExternalSignHandler(object sender, SAMLSPServerExternalSignEventArgs e); public class SAMLSPServerExternalSignEventArgs : EventArgs { public long ConnectionID { get; } public string OperationId { get; } public string HashAlgorithm { get; } public string Pars { get; } public string Data { get; } public string SignedData { get; set; } }
Public Event OnExternalSign As OnExternalSignHandler Public Delegate Sub OnExternalSignHandler(sender As Object, e As SAMLSPServerExternalSignEventArgs) Public Class SAMLSPServerExternalSignEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property OperationId As String Public ReadOnly Property HashAlgorithm As String Public ReadOnly Property Pars As String Public ReadOnly Property Data As String Public Property SignedData As String End Class
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The component uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
LogoutRequestPrepared Event (SAMLSPServer Component)
This event is fired when a new logout request has been prepared.
Syntax
public event OnLogoutRequestPreparedHandler OnLogoutRequestPrepared; public delegate void OnLogoutRequestPreparedHandler(object sender, SAMLSPServerLogoutRequestPreparedEventArgs e); public class SAMLSPServerLogoutRequestPreparedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Destination { get; } public string NameID { get; } public string NameIDFormat { get; } public string SessionIndex { get; } public string RelayState { get; set; } }
Public Event OnLogoutRequestPrepared As OnLogoutRequestPreparedHandler Public Delegate Sub OnLogoutRequestPreparedHandler(sender As Object, e As SAMLSPServerLogoutRequestPreparedEventArgs) Public Class SAMLSPServerLogoutRequestPreparedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Destination As String Public ReadOnly Property NameID As String Public ReadOnly Property NameIDFormat As String Public ReadOnly Property SessionIndex As String Public Property RelayState As String End Class
Remarks
The component uses this event to report completion of the LogoutRequest preparation. The NameID, NameIDFormat, and SessionIndex parameters indicate the subject that is being logged out. The SP parameter references the service provider involved.
The RelayState contains the relay state value that is going to be passed with the LogoutRequest to the remote party and mirrored back (if the protocol supports it).
LogoutRequestReceived Event (SAMLSPServer Component)
The component uses this event to notify the application about an incoming SAML Logout Request message.
Syntax
public event OnLogoutRequestReceivedHandler OnLogoutRequestReceived; public delegate void OnLogoutRequestReceivedHandler(object sender, SAMLSPServerLogoutRequestReceivedEventArgs e); public class SAMLSPServerLogoutRequestReceivedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Issuer { get; } public bool IsEncrypted { get; } public bool IsSigned { get; } public string NameID { get; } public string NameIDFormat { get; } public string SessionIndex { get; } public int Action { get; set; } }
Public Event OnLogoutRequestReceived As OnLogoutRequestReceivedHandler Public Delegate Sub OnLogoutRequestReceivedHandler(sender As Object, e As SAMLSPServerLogoutRequestReceivedEventArgs) Public Class SAMLSPServerLogoutRequestReceivedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Issuer As String Public ReadOnly Property IsEncrypted As Boolean Public ReadOnly Property IsSigned As Boolean Public ReadOnly Property NameID As String Public ReadOnly Property NameIDFormat As String Public ReadOnly Property SessionIndex As String Public Property Action As Integer End Class
Remarks
The SAML SP server fires this event when a SAML logout request is received at a single logout service endpoint. The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
LogoutResponsePrepared Event (SAMLSPServer Component)
The component uses this event to notify the application about the Logout Response message being ready to be sent.
Syntax
public event OnLogoutResponsePreparedHandler OnLogoutResponsePrepared; public delegate void OnLogoutResponsePreparedHandler(object sender, SAMLSPServerLogoutResponsePreparedEventArgs e); public class SAMLSPServerLogoutResponsePreparedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Destination { get; } public string Body { get; } public string NameID { get; } public string NameIDFormat { get; } public string SessionIndex { get; } }
Public Event OnLogoutResponsePrepared As OnLogoutResponsePreparedHandler Public Delegate Sub OnLogoutResponsePreparedHandler(sender As Object, e As SAMLSPServerLogoutResponsePreparedEventArgs) Public Class SAMLSPServerLogoutResponsePreparedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Destination As String Public ReadOnly Property Body As String Public ReadOnly Property NameID As String Public ReadOnly Property NameIDFormat As String Public ReadOnly Property SessionIndex As String End Class
Remarks
The IdP server fires this event when it has prepared a Logout Response message and is ready to send it out to the SP.
LogoutResponseReceived Event (SAMLSPServer Component)
The component uses this event to notify the application about an incoming SAML LogoutResponse message.
Syntax
public event OnLogoutResponseReceivedHandler OnLogoutResponseReceived; public delegate void OnLogoutResponseReceivedHandler(object sender, SAMLSPServerLogoutResponseReceivedEventArgs e); public class SAMLSPServerLogoutResponseReceivedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Issuer { get; } public bool IsEncrypted { get; } public bool IsSigned { get; } public string NameID { get; } public string NameIDFormat { get; } public string SessionIndex { get; } public string RelayState { get; } public int Action { get; set; } }
Public Event OnLogoutResponseReceived As OnLogoutResponseReceivedHandler Public Delegate Sub OnLogoutResponseReceivedHandler(sender As Object, e As SAMLSPServerLogoutResponseReceivedEventArgs) Public Class SAMLSPServerLogoutResponseReceivedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Issuer As String Public ReadOnly Property IsEncrypted As Boolean Public ReadOnly Property IsSigned As Boolean Public ReadOnly Property NameID As String Public ReadOnly Property NameIDFormat As String Public ReadOnly Property SessionIndex As String Public ReadOnly Property RelayState As String Public Property Action As Integer End Class
Remarks
The SAML SP server fires this event when a SAML logout response is received at a single logout service endpoint following the LogoutRequest sent earlier. The RelayState is a mirrored back value included in the request.
The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.
The application can choose to accept or reject the request, or process it manually, using the Action parameter:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
Notification Event (SAMLSPServer Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, SAMLSPServerNotificationEventArgs e); public class SAMLSPServerNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As SAMLSPServerNotificationEventArgs) Public Class SAMLSPServerNotificationEventArgs Inherits EventArgs Public ReadOnly Property EventID As String Public ReadOnly Property EventParam As String End Class
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
This component can fire this event with the following EventID values:
SAMLResponderError | TBD |
SAMLSessionLogout | TBD |
ListeningStarted | Notifies the application that the server has started listening for incoming connections. |
ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. |
ProcessingCompleted Event (SAMLSPServer Component)
This event notifies the application of the completion of request or response processing.
Syntax
public event OnProcessingCompletedHandler OnProcessingCompleted; public delegate void OnProcessingCompletedHandler(object sender, SAMLSPServerProcessingCompletedEventArgs e); public class SAMLSPServerProcessingCompletedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string Tag { get; } public int ProcessingResult { get; } public string Response { get; } public bool Redirect { get; } }
Public Event OnProcessingCompleted As OnProcessingCompletedHandler Public Delegate Sub OnProcessingCompletedHandler(sender As Object, e As SAMLSPServerProcessingCompletedEventArgs) Public Class SAMLSPServerProcessingCompletedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property Tag As String Public ReadOnly Property ProcessingResult As Integer Public ReadOnly Property Response As String Public ReadOnly Property Redirect As Boolean End Class
Remarks
The component fires ProcessingCompleted to notify the application about completion of an earlier initiated processing operation. It is only fired in OfflineMode in response to calls such as ProcessAssertion, ProcessLogoutRequest, or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser.
This event is fired strictly once for each Process* call, with the ConnectionID matching the value passed to the Process* method.
The SessionID parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the SessionInfoNeeded event. The ProcessingResult indicates the type of deliverable that was created during the processing (see below for possible values). The Response parameter contains the body of the deliverable. This can take one of the forms:
- a self-submitting form containing a SAML message.
- a redirect URL.
- a SOAP XML response.
- an empty string if ProcessingResult is set to sprSuccess.
The Redirect parameter indicates whether the value of Response should be passed to the browser within the 302 Location header, or as a document body.
sprUnknown | 0 | Unknown or undefined processing result |
sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). |
sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. |
sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. |
sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. |
sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. |
ReadArtifact Event (SAMLSPServer Component)
Requests content identified by an artifact from the application.
Syntax
public event OnReadArtifactHandler OnReadArtifact; public delegate void OnReadArtifactHandler(object sender, SAMLSPServerReadArtifactEventArgs e); public class SAMLSPServerReadArtifactEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RequestID { get; } public string Issuer { get; } public string Artifact { get; } public string Value { get; set; } public bool Skip { get; set; } }
Public Event OnReadArtifact As OnReadArtifactHandler Public Delegate Sub OnReadArtifactHandler(sender As Object, e As SAMLSPServerReadArtifactEventArgs) Public Class SAMLSPServerReadArtifactEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RequestID As String Public ReadOnly Property Issuer As String Public ReadOnly Property Artifact As String Public Property Value As String Public Property Skip As Boolean End Class
Remarks
The component fires this event to request the content matching Artifact from the application. This is normally happens within the artifact resolution protocol between the SP and the IdP server.
The application must provide the requested artifact content via the Value parameter. The application can choose not to provide the artifact content (for example, if it doesn't have it) by setting Skip to true.
ResourceClose Event (SAMLSPServer Component)
Tells the application that it can close the opened resource.
Syntax
public event OnResourceCloseHandler OnResourceClose; public delegate void OnResourceCloseHandler(object sender, SAMLSPServerResourceCloseEventArgs e); public class SAMLSPServerResourceCloseEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string Handle { get; } }
Public Event OnResourceClose As OnResourceCloseHandler Public Delegate Sub OnResourceCloseHandler(sender As Object, e As SAMLSPServerResourceCloseEventArgs) Public Class SAMLSPServerResourceCloseEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property Handle As String End Class
Remarks
The component uses this event to notify the application that it can now close the resource opened earlier in its ResourceOpen handler.
ResourceOpen Event (SAMLSPServer Component)
Requests the application to open the requested resource.
Syntax
public event OnResourceOpenHandler OnResourceOpen; public delegate void OnResourceOpenHandler(object sender, SAMLSPServerResourceOpenEventArgs e); public class SAMLSPServerResourceOpenEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string URL { get; } public string HttpMethod { get; } public int OperationStatus { get; set; } public string Handle { get; set; } }
Public Event OnResourceOpen As OnResourceOpenHandler Public Delegate Sub OnResourceOpenHandler(sender As Object, e As SAMLSPServerResourceOpenEventArgs) Public Class SAMLSPServerResourceOpenEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property URL As String Public ReadOnly Property HttpMethod As String Public Property OperationStatus As Integer Public Property Handle As String End Class
Remarks
The component fires this event in virtualized mode if the application had returned the fraCustom modifier from the earlier ResourceRequest event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent ResourceRead event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRead Event (SAMLSPServer Component)
Requests the application to read from an opened resource.
Syntax
public event OnResourceReadHandler OnResourceRead; public delegate void OnResourceReadHandler(object sender, SAMLSPServerResourceReadEventArgs e); public class SAMLSPServerResourceReadEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string Handle { get; } public int Size { get; } public int OperationStatus { get; set; } }
Public Event OnResourceRead As OnResourceReadHandler Public Delegate Sub OnResourceReadHandler(sender As Object, e As SAMLSPServerResourceReadEventArgs) Public Class SAMLSPServerResourceReadEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property Handle As String Public ReadOnly Property Size As Integer Public Property OperationStatus As Integer End Class
Remarks
The component fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to Size bytes from the object, and pass them to the component with a SetClientBuffer call.
Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ResourceRead calls are needed.
Set OperationStatus to one of the following values:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRequest Event (SAMLSPServer Component)
Notifies the application that a server resource is requested.
Syntax
public event OnResourceRequestHandler OnResourceRequest; public delegate void OnResourceRequestHandler(object sender, SAMLSPServerResourceRequestEventArgs e); public class SAMLSPServerResourceRequestEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string URL { get; } public string HttpMethod { get; } public bool ResProtected { get; set; } public bool ResSpecial { get; set; } public bool AllowWriting { get; set; } public int Action { get; set; } }
Public Event OnResourceRequest As OnResourceRequestHandler Public Delegate Sub OnResourceRequestHandler(sender As Object, e As SAMLSPServerResourceRequestEventArgs) Public Class SAMLSPServerResourceRequestEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property URL As String Public ReadOnly Property HttpMethod As String Public Property ResProtected As Boolean Public Property ResSpecial As Boolean Public Property AllowWriting As Boolean Public Property Action As Integer End Class
Remarks
The component uses this event to notify the application that the connection has requested a server resource.
The URL parameter specifies the resource requested. ResProtected is set to true if the resource is protected by SAML. ResSpecial is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. ConnectionID identifies the connected client.
Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request).
Choose Action as one of the following values:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
ResourceWrite Event (SAMLSPServer Component)
Requests the application to write to an opened resource.
Syntax
public event OnResourceWriteHandler OnResourceWrite; public delegate void OnResourceWriteHandler(object sender, SAMLSPServerResourceWriteEventArgs e); public class SAMLSPServerResourceWriteEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string Handle { get; } public int OperationStatus { get; set; } }
Public Event OnResourceWrite As OnResourceWriteHandler Public Delegate Sub OnResourceWriteHandler(sender As Object, e As SAMLSPServerResourceWriteEventArgs) Public Class SAMLSPServerResourceWriteEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property Handle As String Public Property OperationStatus As Integer End Class
Remarks
The component fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the GetClientBuffer method and write them to the opened file descriptor.
Use the OperationStatus parameter to return the operation result back to the server:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
SAMLMessagePrepared Event (SAMLSPServer Component)
This event is fired when a SAML message has been prepared and is ready to be dispatched.
Syntax
public event OnSAMLMessagePreparedHandler OnSAMLMessagePrepared; public delegate void OnSAMLMessagePreparedHandler(object sender, SAMLSPServerSAMLMessagePreparedEventArgs e); public class SAMLSPServerSAMLMessagePreparedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string MessageID { get; } public string Destination { get; } public string IssueInstant { get; } public string InResponseTo { get; } public string RequestBody { get; } public string MessageType { get; } public string MessageBody { get; set; } public string RelayState { get; set; } public bool Success { get; set; } }
Public Event OnSAMLMessagePrepared As OnSAMLMessagePreparedHandler Public Delegate Sub OnSAMLMessagePreparedHandler(sender As Object, e As SAMLSPServerSAMLMessagePreparedEventArgs) Public Class SAMLSPServerSAMLMessagePreparedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property MessageID As String Public ReadOnly Property Destination As String Public ReadOnly Property IssueInstant As String Public ReadOnly Property InResponseTo As String Public ReadOnly Property RequestBody As String Public ReadOnly Property MessageType As String Public Property MessageBody As String Public Property RelayState As String Public Property Success As Boolean End Class
Remarks
Subscribe to this event to be notified about every SAML message that has been prepared by the server. This event is fired for every type of the outgoing message (e.g. SAMLResponse or LogoutRequest). The InResponseTo contains the ID of the message in response to which the current message is sent (if applicable). The RequestBody parameter contains the body of such request.
The MessageType parameter indicates the type of the message that has been prepared, such as SAMLResponse. The MessageBody contains the XML body of the message. The Success parameter indicates whether the message contains a positive statement or an error. Both the MessageBody and Success parameters are adjustable.
SAMLMessageReceived Event (SAMLSPServer Component)
The server fires this event for every SAML message it receives.
Syntax
public event OnSAMLMessageReceivedHandler OnSAMLMessageReceived; public delegate void OnSAMLMessageReceivedHandler(object sender, SAMLSPServerSAMLMessageReceivedEventArgs e); public class SAMLSPServerSAMLMessageReceivedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string MessageID { get; } public string Issuer { get; } public string IssueInstant { get; } public string InResponseTo { get; } public string RequestBody { get; } public string MessageType { get; } public string MessageBody { get; } public bool IsSigned { get; } public string RelayState { get; } public int Action { get; set; } }
Public Event OnSAMLMessageReceived As OnSAMLMessageReceivedHandler Public Delegate Sub OnSAMLMessageReceivedHandler(sender As Object, e As SAMLSPServerSAMLMessageReceivedEventArgs) Public Class SAMLSPServerSAMLMessageReceivedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property MessageID As String Public ReadOnly Property Issuer As String Public ReadOnly Property IssueInstant As String Public ReadOnly Property InResponseTo As String Public ReadOnly Property RequestBody As String Public ReadOnly Property MessageType As String Public ReadOnly Property MessageBody As String Public ReadOnly Property IsSigned As Boolean Public ReadOnly Property RelayState As String Public Property Action As Integer End Class
Remarks
Subscribe to this event to be notified about incoming SAML messages.
The MessageType, MessageID, Issuer, and MessageBody parameters provide the details of the message received. The RequestBody and InResponseTo contain a reference to the request that this message is a response to (if any).
Set Action property as required to let the component know how to proceed.
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
SessionCreated Event (SAMLSPServer Component)
This event is fired when a new session has been established.
Syntax
public event OnSessionCreatedHandler OnSessionCreated; public delegate void OnSessionCreatedHandler(object sender, SAMLSPServerSessionCreatedEventArgs e); public class SAMLSPServerSessionCreatedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } }
Public Event OnSessionCreated As OnSessionCreatedHandler Public Delegate Sub OnSessionCreatedHandler(sender As Object, e As SAMLSPServerSessionCreatedEventArgs) Public Class SAMLSPServerSessionCreatedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String End Class
Remarks
ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.
SessionDestroyed Event (SAMLSPServer Component)
This event is fired when the SP server has closed a session.
Syntax
public event OnSessionDestroyedHandler OnSessionDestroyed; public delegate void OnSessionDestroyedHandler(object sender, SAMLSPServerSessionDestroyedEventArgs e); public class SAMLSPServerSessionDestroyedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } }
Public Event OnSessionDestroyed As OnSessionDestroyedHandler Public Delegate Sub OnSessionDestroyedHandler(sender As Object, e As SAMLSPServerSessionDestroyedEventArgs) Public Class SAMLSPServerSessionDestroyedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String End Class
Remarks
ConnectionID contains the identifier of the closed session.
SessionEvent Event (SAMLSPServer Component)
Notifies the application about SAML session events.
Syntax
public event OnSessionEventHandler OnSessionEvent; public delegate void OnSessionEventHandler(object sender, SAMLSPServerSessionEventEventArgs e); public class SAMLSPServerSessionEventEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string EventText { get; } }
Public Event OnSessionEvent As OnSessionEventHandler Public Delegate Sub OnSessionEventHandler(sender As Object, e As SAMLSPServerSessionEventEventArgs) Public Class SAMLSPServerSessionEventEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property EventText As String End Class
Remarks
component uses this event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes.
The SessionID parameter specifies the session ID, and the EventText parameter describes the event that happened. Below are a few typical examples of what EventText you can expect to get:
- Start
- AuthnRequestPrepared
- ResponseReceived
- ResourceSupplied
- LogoutRequestPrepared
- LogoutResponseReceived
- LogoutRequestReceived
- LogoutResponsePrepared
- ArtifactResolveRequestReceived
- ArtifactResponsePrepared
- Finish
SessionInfoNeeded Event (SAMLSPServer Component)
This event is fired in OfflineMode to request the session ID for the current flow.
Syntax
public event OnSessionInfoNeededHandler OnSessionInfoNeeded; public delegate void OnSessionInfoNeededHandler(object sender, SAMLSPServerSessionInfoNeededEventArgs e); public class SAMLSPServerSessionInfoNeededEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; set; } }
Public Event OnSessionInfoNeeded As OnSessionInfoNeededHandler Public Delegate Sub OnSessionInfoNeededHandler(sender As Object, e As SAMLSPServerSessionInfoNeededEventArgs) Public Class SAMLSPServerSessionInfoNeededEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public Property SessionID As String End Class
Remarks
SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them.
The components use a collection of Session* events to exchange session information with the application:
- SessionCreated is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie.
- SessionStateSave : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire SessionStateSave multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data.
- SessionStateRetrieve : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again.
- SessionInfoNeeded (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls ProcessLogoutRequest but passes an empty SessionID as a parameter.
- SessionDestroyed is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event.
SessionStateRetrieve Event (SAMLSPServer Component)
This event fires to retrieve session state information from the application.
Syntax
public event OnSessionStateRetrieveHandler OnSessionStateRetrieve; public delegate void OnSessionStateRetrieveHandler(object sender, SAMLSPServerSessionStateRetrieveEventArgs e); public class SAMLSPServerSessionStateRetrieveEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string SessionState { get; set; } }
Public Event OnSessionStateRetrieve As OnSessionStateRetrieveHandler Public Delegate Sub OnSessionStateRetrieveHandler(sender As Object, e As SAMLSPServerSessionStateRetrieveEventArgs) Public Class SAMLSPServerSessionStateRetrieveEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public Property SessionState As String End Class
Remarks
The component fires this event to request a session state that was previously provided to the application via the SessionStateSave call.
See the SessionInfoNeeded topic for more details about session management in offline mode.
SessionStateSave Event (SAMLSPServer Component)
This event passes a session state object to the application for safekeeping.
Syntax
public event OnSessionStateSaveHandler OnSessionStateSave; public delegate void OnSessionStateSaveHandler(object sender, SAMLSPServerSessionStateSaveEventArgs e); public class SAMLSPServerSessionStateSaveEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string SessionState { get; } }
Public Event OnSessionStateSave As OnSessionStateSaveHandler Public Delegate Sub OnSessionStateSaveHandler(sender As Object, e As SAMLSPServerSessionStateSaveEventArgs) Public Class SAMLSPServerSessionStateSaveEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property SessionState As String End Class
Remarks
The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a SessionStateRetrieve call.
See the SessionInfoNeeded topic for more details about session management in offline mode.
SignatureFound Event (SAMLSPServer Component)
Signifies the start of signature validation.
Syntax
public event OnSignatureFoundHandler OnSignatureFound; public delegate void OnSignatureFoundHandler(object sender, SAMLSPServerSignatureFoundEventArgs e); public class SAMLSPServerSignatureFoundEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public int Scope { get; } public string Signer { get; } public string TargetID { get; } public string TargetType { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public string SigMethod { get; } public string DigestMethod { get; } public bool CertFound { get; } public bool Validate { get; set; } }
Public Event OnSignatureFound As OnSignatureFoundHandler Public Delegate Sub OnSignatureFoundHandler(sender As Object, e As SAMLSPServerSignatureFoundEventArgs) Public Class SAMLSPServerSignatureFoundEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property Scope As Integer Public ReadOnly Property Signer As String Public ReadOnly Property TargetID As String Public ReadOnly Property TargetType As String Public ReadOnly Property IssuerRDN As String Public ReadOnly Property SerialNumber As Byte() Public ReadOnly Property SubjectKeyID As Byte() Public ReadOnly Property SigMethod As String Public ReadOnly Property DigestMethod As String Public ReadOnly Property CertFound As Boolean Public Property Validate As Boolean End Class
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.
The CertFound is set to True if the component has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.
Use the Validate parameter to tell the reader whether it should validate the signature.
SignatureValidated Event (SAMLSPServer Component)
Reports the signature validation result.
Syntax
public event OnSignatureValidatedHandler OnSignatureValidated; public delegate void OnSignatureValidatedHandler(object sender, SAMLSPServerSignatureValidatedEventArgs e); public class SAMLSPServerSignatureValidatedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public int Scope { get; } public string Signer { get; } public string TargetID { get; } public string TargetType { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public string SigMethod { get; } public string DigestMethod { get; } public int ValidationResult { get; set; } }
Public Event OnSignatureValidated As OnSignatureValidatedHandler Public Delegate Sub OnSignatureValidatedHandler(sender As Object, e As SAMLSPServerSignatureValidatedEventArgs) Public Class SAMLSPServerSignatureValidatedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property Scope As Integer Public ReadOnly Property Signer As String Public ReadOnly Property TargetID As String Public ReadOnly Property TargetType As String Public ReadOnly Property IssuerRDN As String Public ReadOnly Property SerialNumber As Byte() Public ReadOnly Property SubjectKeyID As Byte() Public ReadOnly Property SigMethod As String Public ReadOnly Property DigestMethod As String Public Property ValidationResult As Integer End Class
Remarks
This event is fired when the complete XML signature validation process is finished.
The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
TLSCertValidate Event (SAMLSPServer Component)
Fires when a client certificate needs to be validated.
Syntax
public event OnTLSCertValidateHandler OnTLSCertValidate; public delegate void OnTLSCertValidateHandler(object sender, SAMLSPServerTLSCertValidateEventArgs e); public class SAMLSPServerTLSCertValidateEventArgs : EventArgs { public long ConnectionID { get; } public bool Accept { get; set; } }
Public Event OnTLSCertValidate As OnTLSCertValidateHandler Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As SAMLSPServerTLSCertValidateEventArgs) Public Class SAMLSPServerTLSCertValidateEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public Property Accept As Boolean End Class
Remarks
The component fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.
TLSEstablished Event (SAMLSPServer Component)
Reports the setup of a TLS session.
Syntax
public event OnTLSEstablishedHandler OnTLSEstablished; public delegate void OnTLSEstablishedHandler(object sender, SAMLSPServerTLSEstablishedEventArgs e); public class SAMLSPServerTLSEstablishedEventArgs : EventArgs { public long ConnectionID { get; } }
Public Event OnTLSEstablished As OnTLSEstablishedHandler Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As SAMLSPServerTLSEstablishedEventArgs) Public Class SAMLSPServerTLSEstablishedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long End Class
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (SAMLSPServer Component)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
public event OnTLSHandshakeHandler OnTLSHandshake; public delegate void OnTLSHandshakeHandler(object sender, SAMLSPServerTLSHandshakeEventArgs e); public class SAMLSPServerTLSHandshakeEventArgs : EventArgs { public long ConnectionID { get; } public string ServerName { get; } public bool Abort { get; set; } }
Public Event OnTLSHandshake As OnTLSHandshakeHandler Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As SAMLSPServerTLSHandshakeEventArgs) Public Class SAMLSPServerTLSHandshakeEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property ServerName As String Public Property Abort As Boolean End Class
Remarks
Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.
TLSPSK Event (SAMLSPServer Component)
Requests a pre-shared key for TLS-PSK.
Syntax
public event OnTLSPSKHandler OnTLSPSK; public delegate void OnTLSPSKHandler(object sender, SAMLSPServerTLSPSKEventArgs e); public class SAMLSPServerTLSPSKEventArgs : EventArgs { public long ConnectionID { get; } public string Identity { get; } public string PSK { get; set; } public string Ciphersuite { get; set; } }
Public Event OnTLSPSK As OnTLSPSKHandler Public Delegate Sub OnTLSPSKHandler(sender As Object, e As SAMLSPServerTLSPSKEventArgs) Public Class SAMLSPServerTLSPSKEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property Identity As String Public Property PSK As String Public Property Ciphersuite As String End Class
Remarks
The component fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.
Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.
TLSShutdown Event (SAMLSPServer Component)
Reports closure of a TLS session.
Syntax
public event OnTLSShutdownHandler OnTLSShutdown; public delegate void OnTLSShutdownHandler(object sender, SAMLSPServerTLSShutdownEventArgs e); public class SAMLSPServerTLSShutdownEventArgs : EventArgs { public long ConnectionID { get; } }
Public Event OnTLSShutdown As OnTLSShutdownHandler Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As SAMLSPServerTLSShutdownEventArgs) Public Class SAMLSPServerTLSShutdownEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long End Class
Remarks
The component fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.
UserAuthCompleted Event (SAMLSPServer Component)
Notifies the application about the success of user authentication flow.
Syntax
public event OnUserAuthCompletedHandler OnUserAuthCompleted; public delegate void OnUserAuthCompletedHandler(object sender, SAMLSPServerUserAuthCompletedEventArgs e); public class SAMLSPServerUserAuthCompletedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string AssertionBody { get; } public string Auth { get; } public string NameID { get; } public string NameIDFormat { get; } public string SessionIndex { get; } public string ValidFrom { get; } public string ValidTo { get; } public string RelayState { get; } }
Public Event OnUserAuthCompleted As OnUserAuthCompletedHandler Public Delegate Sub OnUserAuthCompletedHandler(sender As Object, e As SAMLSPServerUserAuthCompletedEventArgs) Public Class SAMLSPServerUserAuthCompletedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property AssertionBody As String Public ReadOnly Property Auth As String Public ReadOnly Property NameID As String Public ReadOnly Property NameIDFormat As String Public ReadOnly Property SessionIndex As String Public ReadOnly Property ValidFrom As String Public ReadOnly Property ValidTo As String Public ReadOnly Property RelayState As String End Class
Remarks
Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, ValidFrom, and ValidTo parameters contain the session parameters as stated in the assertion, which is provided via the AssertionBody parameter. The Auth parameter contain the authentication mechanism used.
The RelayState matches the original relay state that was used on the initiation stage of the authentication.
UserAuthFailed Event (SAMLSPServer Component)
Notifies the application about failure of user authentication flow.
Syntax
public event OnUserAuthFailedHandler OnUserAuthFailed; public delegate void OnUserAuthFailedHandler(object sender, SAMLSPServerUserAuthFailedEventArgs e); public class SAMLSPServerUserAuthFailedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string RelayState { get; } }
Public Event OnUserAuthFailed As OnUserAuthFailedHandler Public Delegate Sub OnUserAuthFailedHandler(sender As Object, e As SAMLSPServerUserAuthFailedEventArgs) Public Class SAMLSPServerUserAuthFailedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property RelayState As String End Class
Remarks
The component fires this event to notify the application about failed user authentication flow. The RelayState parameter matches the one included with the AuthnRequest message.
UserAuthStart Event (SAMLSPServer Component)
Notifies the application about the start of user authentication flow.
Syntax
public event OnUserAuthStartHandler OnUserAuthStart; public delegate void OnUserAuthStartHandler(object sender, SAMLSPServerUserAuthStartEventArgs e); public class SAMLSPServerUserAuthStartEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public int IdPServiceIndex { get; } public string RelayState { get; set; } }
Public Event OnUserAuthStart As OnUserAuthStartHandler Public Delegate Sub OnUserAuthStartHandler(sender As Object, e As SAMLSPServerUserAuthStartEventArgs) Public Class SAMLSPServerUserAuthStartEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property IdPServiceIndex As Integer Public Property RelayState As String End Class
Remarks
The component invokes this event to signal the start of the user authentication flow. This happens shortly before the component proceeds to generation of AuthnRequest message.
The RelayState is an arbitrary string that will be passed to the IdP and mirrored back with the assertion. It is typically used to remember the URL of the resource or page that kicked in the SAML authentication flow.
UserLogoutCompleted Event (SAMLSPServer Component)
Notifies the application about the completion of user logout flow.
Syntax
public event OnUserLogoutCompletedHandler OnUserLogoutCompleted; public delegate void OnUserLogoutCompletedHandler(object sender, SAMLSPServerUserLogoutCompletedEventArgs e); public class SAMLSPServerUserLogoutCompletedEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public string NameID { get; } public string SessionIndex { get; } public string RelayState { get; } }
Public Event OnUserLogoutCompleted As OnUserLogoutCompletedHandler Public Delegate Sub OnUserLogoutCompletedHandler(sender As Object, e As SAMLSPServerUserLogoutCompletedEventArgs) Public Class SAMLSPServerUserLogoutCompletedEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property NameID As String Public ReadOnly Property SessionIndex As String Public ReadOnly Property RelayState As String End Class
Remarks
Subscribe to this event to be notified about the completion of the logout flow.
UserLogoutStart Event (SAMLSPServer Component)
Notifies the application about the start of user logout flow.
Syntax
public event OnUserLogoutStartHandler OnUserLogoutStart; public delegate void OnUserLogoutStartHandler(object sender, SAMLSPServerUserLogoutStartEventArgs e); public class SAMLSPServerUserLogoutStartEventArgs : EventArgs { public long ConnectionID { get; } public string SessionID { get; } public int IdPServiceIndex { get; } public string NameID { get; } public string SessionIndex { get; } public bool Secondary { get; } public string RelayState { get; set; } }
Public Event OnUserLogoutStart As OnUserLogoutStartHandler Public Delegate Sub OnUserLogoutStartHandler(sender As Object, e As SAMLSPServerUserLogoutStartEventArgs) Public Class SAMLSPServerUserLogoutStartEventArgs Inherits EventArgs Public ReadOnly Property ConnectionID As Long Public ReadOnly Property SessionID As String Public ReadOnly Property IdPServiceIndex As Integer Public ReadOnly Property NameID As String Public ReadOnly Property SessionIndex As String Public ReadOnly Property Secondary As Boolean Public Property RelayState As String End Class
Remarks
Subscribe to this event to get notified about the start of the user logout flow.
The logout process can be initiated on either the SP or IdP side. This event is fired at the earliest opportunity that this fact becomes known to the service provider: from within the InitiateLogout method, ProcessLogoutRequest method, or upon receiving a logout request at the SLS endpoint.
Independently of the timing and the stage of this event, the subsequent flow is the same: the logout protocol is initiated. The application will be notified of the completion of the protocol using the UserLogoutCompleted event. Note that the UserLogoutCompleted event may not fire if the connectivity to the IdP is lost prematurely or the IdP chooses not to respond. Due to that, it is reasonable to consider the user as logged out immediately after the current event fires.
The IdPServiceIndex parameter contains the index of the IdP service in the IdPServices collection. NameID indicates the name identifier of the user that is being logged out, and SessionIndex contain the unique SAML session identifier. The Secondary flag indicates whether the the SP is responding to IdP-initiated logout request.
The RelayState parameter is an optional SP-generated token that the IdP will return back in its LogoutResponse message. This is often set to the destination page where the browser should be redirected upon completion of the signout process.
Certificate Type
Encapsulates an individual X.509 certificate.
Remarks
This type keeps and provides access to X.509 certificate details.
Fields
Bytes
byte[] (read-only)
Default: ""
Returns the raw certificate data in DER format.
CA
bool
Default: False
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.
CAKeyID
byte[] (read-only)
Default: ""
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
CertTypes (read-only)
Default: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager component to load or create new certificate and certificate requests objects.
CRLDistributionPoints
string
Default: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
Curve
string
Default: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
Fingerprint
string (read-only)
Default: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
FriendlyName
string (read-only)
Default: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
HashAlgorithm
string
Default: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
string (read-only)
Default: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
string
Default: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
KeyAlgorithm
string
Default: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.
KeyBits
int (read-only)
Default: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
string (read-only)
Default: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
int
Default: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this field before generating the certificate to propagate the key usage flags to the new certificate.
KeyValid
bool (read-only)
Default: False
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
string
Default: ""
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
OCSPNoCheck
bool
Default: False
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default: 0
Returns the location that the certificate was taken or loaded from.
PolicyIDs
string
Default: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this field when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
PrivateKeyBytes
byte[] (read-only)
Default: ""
Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
PrivateKeyExists
bool (read-only)
Default: False
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
PrivateKeyExtractable
bool (read-only)
Default: False
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
byte[] (read-only)
Default: ""
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
Qualified
bool (read-only)
Default: False
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
QualifiedStatements
QualifiedStatementsTypes
Default: 0
Returns a simplified qualified status of the certificate.
Qualifiers
string (read-only)
Default: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
bool (read-only)
Default: False
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
byte[]
Default: ""
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
SigAlgorithm
string (read-only)
Default: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
Source
PKISources (read-only)
Default: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Subject
string (read-only)
Default: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.