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");

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.

Method List

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

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.

Config Settings

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

Active Property (SAMLSPServer Component)

Tells whether the server is active and ready to process requests.

Syntax

• C#
• VB.NET

public bool Active { get; }

Public ReadOnly Property Active As Boolean

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

• C#
• VB.NET

public string BaseDir { get; set; }

Public Property BaseDir As String

Default Value

""

Remarks

Use this property to specify the base directory for the SP server.

DecryptionCertificate Property (SAMLSPServer Component)

The certificate to be used to decrypt assertions.

Syntax

• C#
• VB.NET

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.

ExternalCrypto Property (SAMLSPServer Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

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 OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).

This property is read-only.

FIPSMode Property (SAMLSPServer Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

Host Property (SAMLSPServer Component)

Specifies the host address of the SP server.

Syntax

• C#
• VB.NET

public string Host { get; set; }

Public Property Host As String

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

• C#
• VB.NET

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.

IdPSettings Property (SAMLSPServer Component)

Populates a list of SAML IdP entity settings.

Syntax

• C#
• VB.NET

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.

Issuer Property (SAMLSPServer Component)

Name identifier of the issuer of the SP's requests.

Syntax

• C#
• VB.NET

public string Issuer { get; set; }

Public Property Issuer As String

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

• C#
• VB.NET

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 certificates to be added to this collection is roughly equivalent to that of 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.

LogoutPage Property (SAMLSPServer Component)

Specifies the location of the logout page.

Syntax

• C#
• VB.NET

public string LogoutPage { get; set; }

Public Property LogoutPage As String

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

• C#
• VB.NET

public string MetadataURL { get; set; }

Public Property MetadataURL As String

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

• C#
• VB.NET

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.

OfflineMode Property (SAMLSPServer Component)

Enables the Offline mode.

Syntax

• C#
• VB.NET

public bool OfflineMode { get; set; }

Public Property OfflineMode As Boolean

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.

Port Property (SAMLSPServer Component)

Specifies the listening port number.

Syntax

• C#
• VB.NET

public int Port { get; set; }

Public Property Port As Integer

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.

PreferredIDPToSPBinding Property (SAMLSPServer Component)

Specifies the preferred IdP to SP binding.

Syntax

• C#
• VB.NET

public SAMLSPServerPreferredIDPToSPBindings PreferredIDPToSPBinding { get; set; }

enum SAMLSPServerPreferredIDPToSPBindings {
  csbtNone,
  csbtSOAP,
  csbtPAOS,
  csbtRedirect,
  csbtPOST,
  csbtArtifact
}

Public Property PreferredIDPToSPBinding As SamlspserverPreferredIDPToSPBindings

Enum SAMLSPServerPreferredIDPToSPBindings
  csbtNone
  csbtSOAP
  csbtPAOS
  csbtRedirect
  csbtPOST
  csbtArtifact
End Enum

Default Value

4

Remarks

Specifies the preferred binding (message exchange mechanism) used for communication with Identity Provider (IdP).

ProtectedResources Property (SAMLSPServer Component)

Specifies the list of protected resources.

Syntax

• C#
• VB.NET

public string ProtectedResources { get; set; }

Public Property ProtectedResources As String

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

• C#
• VB.NET

public string RedirectOnLogoutPage { get; set; }

Public Property RedirectOnLogoutPage As String

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

• C#
• VB.NET

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.

SenderChain Property (SAMLSPServer Component)

Contains the certificate chain of the message sender.

Syntax

• C#
• VB.NET

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.

SigningCertificate Property (SAMLSPServer Component)

The certificate for signing the SP requests.

Syntax

• C#
• VB.NET

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.

SigningChain Property (SAMLSPServer Component)

The signing certificate chain.

Syntax

• C#
• VB.NET

public CertificateList SigningChain { get; }

Public Property SigningChain As CertificateList

Remarks

Use this property to provide the chain for the signing certificate. Use SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

SigningFlags Property (SAMLSPServer Component)

Adjusts signing behaviour.

Syntax

• C#
• VB.NET

public int SigningFlags { get; set; }

Public Property SigningFlags As Integer

Default Value

0

Remarks

Use this bit mask property to adjust what entities are going to be signed by the server. The following flags are supported:

• 1 - ssfSignAuthnRequests - sign authentication requests
• 2 - ssfSignArtifactResolveRequests - sign artifact resolve requests
• 4 - ssfSignLogoutRequests - sign logout requests

SocketSettings Property (SAMLSPServer Component)

Manages network connection settings.

Syntax

• C#
• VB.NET

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.

SPServices Property (SAMLSPServer Component)

Populates a list of services supported by the SP.

Syntax

• C#
• VB.NET

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.

SPSettings Property (SAMLSPServer Component)

Populates a list of SAML SP entity settings.

Syntax

• C#
• VB.NET

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.

SPToIDPBinding Property (SAMLSPServer Component)

Specifies the IdP to SP binding to use.

Syntax

• C#
• VB.NET

public SAMLSPServerSPToIDPBindings SPToIDPBinding { get; set; }

enum SAMLSPServerSPToIDPBindings {
  csbtNone,
  csbtSOAP,
  csbtPAOS,
  csbtRedirect,
  csbtPOST,
  csbtArtifact
}

Public Property SPToIDPBinding As SamlspserverSPToIDPBindings

Enum SAMLSPServerSPToIDPBindings
  csbtNone
  csbtSOAP
  csbtPAOS
  csbtRedirect
  csbtPOST
  csbtArtifact
End Enum

Default Value

3

Remarks

Specifies the binding (message exchange mechanism) used for communication with Identity Provider (IdP) that is actually used during the session.

To specify the preferred binding, use PreferredIDPToSPBinding.

TLSServerChain Property (SAMLSPServer Component)

The server's TLS certificates.

Syntax

• C#
• VB.NET

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.

TLSSettings Property (SAMLSPServer Component)

Manages TLS layer settings.

Syntax

• C#
• VB.NET

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.

URL Property (SAMLSPServer Component)

Specifies the base URL of this SP server.

Syntax

• C#
• VB.NET

public string URL { get; set; }

Public Property URL As String

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

• C#
• VB.NET

public void AddIdPService(int service, int bindingType, string location, int priority, int index);

Public Sub AddIdPService(ByVal Service As Integer, ByVal BindingType As Integer, ByVal Location As String, ByVal Priority As Integer, ByVal Index As Integer)

Remarks

Use this method to add an entry to the list of services and their locations provided by the IdP. TBD

AddSPService Method (SAMLSPServer Component)

Registers an SP service in the SPServices list.

Syntax

• C#
• VB.NET

public void AddSPService(int service, int bindingType, string location, int priority, int index);

Public Sub AddSPService(ByVal Service As Integer, ByVal BindingType As Integer, ByVal Location As String, ByVal Priority As Integer, ByVal Index As Integer)

Remarks

Use this method to add an entry to the list of services and their locations provided by the SP. TBD

Config Method (SAMLSPServer Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

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

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

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

DoAction Method (SAMLSPServer Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

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

ExportSettings Method (SAMLSPServer Component)

Saves the SP or IdP configuration to an XML metadata file.

Syntax

• C#
• VB.NET

public string ExportSettings(bool SP);

Public Function ExportSettings(ByVal SP As Boolean) As String

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)

Obtains a pending connection buffer.

Syntax

• C#
• VB.NET

public byte[] GetClientBuffer(long connectionID);

Public Function GetClientBuffer(ByVal ConnectionID As Long) As Byte()

Remarks

Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

GetProviderProperty Method (SAMLSPServer Component)

Returns the value of a custom provider property.

Syntax

• C#
• VB.NET

public string GetProviderProperty(string name);

Public Function GetProviderProperty(ByVal Name As String) As String

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

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

• C#
• VB.NET

public void ImportSettings(string metadata, bool SP);

Public Sub ImportSettings(ByVal Metadata As String, ByVal SP As Boolean)

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)

TBD

Syntax

• C#
• VB.NET

public int InitiateArtifactResolve(long connectionID, string sessionID, int idPServiceIndex, string artifact);

Public Function InitiateArtifactResolve(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal IdPServiceIndex As Integer, ByVal Artifact As String) As Integer

Remarks

You can use this method with or without the OfflineMode.

InitiateAttributeQuery Method (SAMLSPServer Component)

TBD

Syntax

• C#
• VB.NET

public int InitiateAttributeQuery(long connectionID, string sessionID, int idPServiceIndex, string attributes);

Public Function InitiateAttributeQuery(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal IdPServiceIndex As Integer, ByVal Attributes As String) As Integer

Remarks

TBD: we may need another event (some "ClarifyAttributes") to request more details about attributes.

You can use this method with or without the OfflineMode.

InitiateAuth Method (SAMLSPServer Component)

Starts SP-initiated SAML authentication flow.

Syntax

• C#
• VB.NET

public int InitiateAuth(long connectionID, string sessionID, int idPServiceIndex, string relayState);

Public Function InitiateAuth(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal IdPServiceIndex As Integer, ByVal RelayState As String) As Integer

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.

You can use this method with or without the OfflineMode.

InitiateLogout Method (SAMLSPServer Component)

Starts SP-initiated SAML logout flow.

Syntax

• C#
• VB.NET

public int InitiateLogout(long connectionID, string sessionID, int idPServiceIndex, string relayState);

Public Function InitiateLogout(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal IdPServiceIndex As Integer, ByVal RelayState As String) As Integer

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.

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.

You can use this method with or without the OfflineMode. TBD

ProcessArtifactResolveRequest Method (SAMLSPServer Component)

Processes an artifact request received from the SP service at one of the ARS endpoints.

Syntax

• C#
• VB.NET

public int ProcessArtifactResolveRequest(long connectionID, string sessionID, string request);

Public Function ProcessArtifactResolveRequest(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal Request As String) As Integer

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.

You can use this method with or without the OfflineMode.

ProcessAssertion Method (SAMLSPServer Component)

Processes assertion received from the IdP service at one of the ACS endpoints.

Syntax

• C#
• VB.NET

public int ProcessAssertion(long connectionID, string sessionID, string request);

Public Function ProcessAssertion(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal Request As String) As Integer

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.

You can use this method with or without the OfflineMode.

ProcessGenericRequest Method (SAMLSPServer Component)

Processes a generic HTTP SAML request.

Syntax

• C#
• VB.NET

public int ProcessGenericRequest(long connectionID, string sessionID, string request);

Public Function ProcessGenericRequest(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal Request As String) As Integer

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

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.

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

• C#
• VB.NET

public int ProcessLogoutRequest(long connectionID, string sessionID, string request);

Public Function ProcessLogoutRequest(ByVal ConnectionID As Long, ByVal SessionID As String, ByVal Request As String) As Integer

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.

You can use this method with or without the OfflineMode.

SetClientBuffer Method (SAMLSPServer Component)

Commits a data buffer to the connection.

Syntax

• C#
• VB.NET

public void SetClientBuffer(long connectionID, byte[] value);

Public Sub SetClientBuffer(ByVal ConnectionID As Long, ByVal Value As Byte())

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

• C#
• VB.NET

public void SetProviderProperty(string name, string value);

Public Sub SetProviderProperty(ByVal Name As String, ByVal Value As String)

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

Start Method (SAMLSPServer Component)

Starts the SP server.

Syntax

• C#
• VB.NET

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

• C#
• VB.NET

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

• C#
• VB.NET

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.

ArtifactResolveRequestPrepared Event (SAMLSPServer Component)

This event is fired when a new authentication request message has been prepared.

Syntax

• C#
• VB.NET

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 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 Artifact As String
End Class

Remarks

TBD

ArtifactResolveRequestReceived Event (SAMLSPServer Component)

TBD

Syntax

• C#
• VB.NET

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 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 IsEncrypted As Boolean
  Public ReadOnly Property IsSigned As Boolean
  Public ReadOnly Property Artifact As String
  Public Property Action As Integer
End Class

Remarks

AssertionReceived Event (SAMLSPServer Component)

This event is fired when a new assertion has been received.

Syntax

• C#
• VB.NET

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 bool IsEncrypted { get; }
  public bool IsSigned { get; }
  public string NameID { get; }
  public string SessionIndex { 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 IsEncrypted As Boolean
  Public ReadOnly Property IsSigned As Boolean
  Public ReadOnly Property NameID As String
  Public ReadOnly Property SessionIndex 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.

AttributeQueryPrepared Event (SAMLSPServer Component)

This event is fired when a new attribute query message has been prepared.

Syntax

• C#
• VB.NET

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 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 Attributes As String
End Class

Remarks

TBD

AuthnRequestPrepared Event (SAMLSPServer Component)

This event is fired when a new authentication request message has been prepared.

Syntax

• C#
• VB.NET

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 bool ForceAuthn { get; }
  public bool NonInteractive { get; }
}

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 ForceAuthn As Boolean
  Public ReadOnly Property NonInteractive As Boolean
End Class

Remarks

TBD

Connect Event (SAMLSPServer Component)

Reports an accepted connection.

Syntax

• C#
• VB.NET

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

• C#
• VB.NET

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

• C#
• VB.NET

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

• C#
• VB.NET

public event OnErrorHandler OnError;

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

public class SAMLSPServerErrorEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int ErrorCode { 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 ErrorCode As Integer
  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

• C#
• VB.NET

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 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 contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for 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 a .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

• C#
• VB.NET

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 NameID { get; }
}

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 NameID As String
End Class

Remarks

TBD

LogoutRequestReceived Event (SAMLSPServer Component)

TBD

Syntax

• C#
• VB.NET

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 bool IsEncrypted { get; }
  public bool IsSigned { get; }
  public string NameID { 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 IsEncrypted As Boolean
  Public ReadOnly Property IsSigned As Boolean
  Public ReadOnly Property NameID As String
  Public Property Action As Integer
End Class

Remarks

MetadataPrepared Event (SAMLSPServer Component)

Passes a prepared metadata object to the application.

Syntax

• C#
• VB.NET

public event OnMetadataPreparedHandler OnMetadataPrepared;

public delegate void OnMetadataPreparedHandler(object sender, SAMLSPServerMetadataPreparedEventArgs e);

public class SAMLSPServerMetadataPreparedEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Metadata { get; set; }
}

Public Event OnMetadataPrepared As OnMetadataPreparedHandler

Public Delegate Sub OnMetadataPreparedHandler(sender As Object, e As SAMLSPServerMetadataPreparedEventArgs)

Public Class SAMLSPServerMetadataPreparedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Metadata As String
End Class

Remarks

The component uses this event to notify the application about the prepared metadata object and let the user code adjust it if needed. This event may fire from within an ExportSettings call, or in response to the incoming metadata request if the server is operating in standalone mode.

The suggested metadata object is provided through the Metadata parameter. The application can adjust it as required if it needs to.

Notification Event (SAMLSPServer Component)

This event notifies the application about an underlying control flow event.

Syntax

• C#
• VB.NET

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

ProcessingCompleted Event (SAMLSPServer Component)

This event notifies the application of the completion of request or response processing.

Syntax

• C#
• VB.NET

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

ResourceClose Event (SAMLSPServer Component)

Tells the application that it can close the opened resource.

Syntax

• C#
• VB.NET

public event OnResourceCloseHandler OnResourceClose;

public delegate void OnResourceCloseHandler(object sender, SAMLSPServerResourceCloseEventArgs e);

public class SAMLSPServerResourceCloseEventArgs : EventArgs {
  public long ConnectionID { 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
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.

After closing the resource, set the OperationStatus according to the outcome of the operation.

ResourceOpen Event (SAMLSPServer Component)

Requests the application to open the requested resource.

Syntax

• C#
• VB.NET

public event OnResourceOpenHandler OnResourceOpen;

public delegate void OnResourceOpenHandler(object sender, SAMLSPServerResourceOpenEventArgs e);

public class SAMLSPServerResourceOpenEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URL { get; }
  public int OperationStatus { 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 URL As String
  Public Property OperationStatus As Integer
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:

ResourceRead Event (SAMLSPServer Component)

Requests the application to read from an opened resource.

Syntax

• C#
• VB.NET

public event OnResourceReadHandler OnResourceRead;

public delegate void OnResourceReadHandler(object sender, SAMLSPServerResourceReadEventArgs e);

public class SAMLSPServerResourceReadEventArgs : EventArgs {
  public long ConnectionID { 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 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:

ResourceRequest Event (SAMLSPServer Component)

Notifies the application that a server resource is requested.

Syntax

• C#
• VB.NET

public event OnResourceRequestHandler OnResourceRequest;

public delegate void OnResourceRequestHandler(object sender, SAMLSPServerResourceRequestEventArgs e);

public class SAMLSPServerResourceRequestEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string URL { get; }
  public bool ResProtected { get; set; }
  public bool ResSpecial { 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 URL As String
  Public Property ResProtected As Boolean
  Public Property ResSpecial 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:

SAMLMessagePrepared Event (SAMLSPServer Component)

The server fires this event when it is ready to submit a SAML response body.

Syntax

• C#
• VB.NET

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 InResponseTo { get; }
  public string RequestBody { get; }
  public string MessageType { get; }
  public string MessageBody { 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 InResponseTo As String
  Public ReadOnly Property RequestBody As String
  Public ReadOnly Property MessageType As String
  Public Property MessageBody As String
  Public Property Success As Boolean
End Class

Remarks

Subscribe to this event to be notified about authentication requests being received. The component can fire this event from ProcessSignOnRequest and ProcessGenericRequest calls in OfflineMode, or asynchronously in online mode.

Set Action property in accordance with desired handling option. TBD TODO: we may need to include the Destination parameter

SAMLMessageReceived Event (SAMLSPServer Component)

The server fires this event upon receiving a valid SAML message.

Syntax

• C#
• VB.NET

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 MessageType { get; }
  public string MessageID { get; }
  public string Issuer { get; }
  public string IssueInstant { get; }
  public string MessageBody { 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 MessageType As String
  Public ReadOnly Property MessageID As String
  Public ReadOnly Property Issuer As String
  Public ReadOnly Property IssueInstant As String
  Public ReadOnly Property MessageBody As String
  Public ReadOnly Property RelayState As String
  Public Property Action As Integer
End Class

Remarks

Subscribe to this event to be notified about SAML messages received. The component can fire this event from ProcessAssertion and ProcessGenericRequest calls in OfflineMode, or asynchronously in online mode.

Set Action property in accordance with desired handling option. TBD

SessionCreated Event (SAMLSPServer Component)

This event is fired when a new session has been established.

Syntax

• C#
• VB.NET

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

• C#
• VB.NET

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 the change of SAML session stage.

Syntax

• C#
• VB.NET

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 method to notify your code about changed SAML session stage. The Session parameter specifies the session ID. The Stage parameter can take one of the following values:

• Start
• AuthnRequestSent
• ResponseReceived
• ResourceSupplied
• LogoutRequestSent
• LogoutResponseReceived
• LogoutRequestRecv
• LogoutResponseSent
• ArtifactResolveRecv
• ArtifactResponseSent
• Finish

SessionInfoNeeded Event (SAMLSPServer Component)

This event is fired in OfflineMode to request the session ID for the current flow.

Syntax

• C#
• VB.NET

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

TBD

SessionStateRetrieve Event (SAMLSPServer Component)

TBD

Syntax

• C#
• VB.NET

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

TBD

SessionStateSave Event (SAMLSPServer Component)

TBD

Syntax

• C#
• VB.NET

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

TBD

SignatureFound Event (SAMLSPServer Component)

Signifies the start of signature validation.

Syntax

• C#
• VB.NET

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 string RequestID { get; }
  public int Scope { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { 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 RequestID As String
  Public ReadOnly Property Scope As Integer
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  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.

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

• C#
• VB.NET

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 string RequestID { get; }
  public int Scope { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { 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 RequestID As String
  Public ReadOnly Property Scope As Integer
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  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.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields