SAMLSPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLSPServer class represents a SAML service provider.

Syntax

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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

Active Property (SAMLSPServer Class)

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

Syntax

public boolean isActive();

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

Base directory on the server.

Syntax

public String getBaseDir();


public void setBaseDir(String baseDir);

Default Value

""

Remarks

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

BindingKey Property (SAMLSPServer Class)

Contains a private key to sign the redirect binding requests.

Syntax

public CryptoKey getBindingKey();


public void setBindingKey(CryptoKey bindingKey);

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.

DecryptionCertificate Property (SAMLSPServer Class)

The certificate to be used to decrypt assertions.

Syntax

public Certificate getDecryptionCertificate();


public void setDecryptionCertificate(Certificate decryptionCertificate);

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

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

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.

FIPSMode Property (SAMLSPServer Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (SAMLSPServer Class)

Specifies the handshake timeout in milliseconds.

Syntax

public int getHandshakeTimeout();


public void setHandshakeTimeout(int handshakeTimeout);

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (SAMLSPServer Class)

Specifies the host address of the SP server.

Syntax

public String getHost();


public void setHost(String host);

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

Populates a list of services supported by the IdP.

Syntax

public SAMLServiceInfoList getIdPServices();

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

Populates a list of SAML IdP entity settings.

Syntax

public SAMLEntity getIdPSettings();

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

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

Syntax

public String getIssuer();


public void setIssuer(String issuer);

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

Additional certificates for chain validation.

Syntax

public CertificateList getKnownCertificates();


public void setKnownCertificates(CertificateList knownCertificates);

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

KnownKeys Property (SAMLSPServer Class)

Public keys for low-level signature validation.

Syntax

public CryptoKeyList getKnownKeys();


public void setKnownKeys(CryptoKeyList knownKeys);

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.

LogoutPage Property (SAMLSPServer Class)

Specifies the location of the logout page.

Syntax

public String getLogoutPage();


public void setLogoutPage(String logoutPage);

Default Value

"/sp/logout"

Remarks

Use this property to specify the relative URL of the logout page.

MetadataURL Property (SAMLSPServer Class)

The SP's metadata location.

Syntax

public String getMetadataURL();


public void setMetadataURL(String metadataURL);

Default Value

"/sp/metadata"

Remarks

This property specifies the metadata URL of this Service Provider (SP).

MetaSigningCertificate Property (SAMLSPServer Class)

Specifies the metadata signing certificate.

Syntax

public Certificate getMetaSigningCertificate();


public void setMetaSigningCertificate(Certificate metaSigningCertificate);

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

Enables the Offline mode.

Syntax

public boolean isOfflineMode();


public void setOfflineMode(boolean offlineMode);

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

Populates the pinned client details.

Syntax

public TLSConnectionInfo getPinnedClient();

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.

PinnedClientChain Property (SAMLSPServer Class)

Contains the certificate chain of the pinned client.

Syntax

public CertificateList getPinnedClientChain();

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.

Port Property (SAMLSPServer Class)

Specifies the listening port number.

Syntax

public int getPort();


public void setPort(int port);

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

Specifies the list of protected resources.

Syntax

public String getProtectedResources();


public void setProtectedResources(String protectedResources);

Default Value

""

Remarks

This property contains a set of relative URLs of the protected resources offered by this Service Provider (SP).

RedirectOnLogoutPage Property (SAMLSPServer Class)

Specifies the location to redirect the user on logout.

Syntax

public String getRedirectOnLogoutPage();


public void setRedirectOnLogoutPage(String redirectOnLogoutPage);

Default Value

"https://nsoftware.com"

Remarks

Use this property to specify the page where to redirect the user on logout.

Security Property (SAMLSPServer Class)

Provides access to the SAML security properties.

Syntax

public SAMLSecuritySettings getSecurity();

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

Contains the certificate chain of the message sender.

Syntax

public CertificateList getSenderChain();

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

The certificate for signing the SP requests.

Syntax

public Certificate getSigningCertificate();


public void setSigningCertificate(Certificate signingCertificate);

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

The signing certificate chain.

Syntax

public CertificateList getSigningChain();


public void setSigningChain(CertificateList signingChain);

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.

SocketSettings Property (SAMLSPServer Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

SPServices Property (SAMLSPServer Class)

Populates a list of services supported by the SP.

Syntax

public SAMLServiceInfoList getSPServices();

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

Populates a list of SAML SP entity settings.

Syntax

public SAMLEntity getSPSettings();

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.

TLSServerChain Property (SAMLSPServer Class)

The server's TLS certificates.

Syntax

public CertificateList getTLSServerChain();


public void setTLSServerChain(CertificateList TLSServerChain);

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

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

URL Property (SAMLSPServer Class)

Specifies the base URL of this SP server.

Syntax

public String getURL();


public void setURL(String URL);

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

Registers an IdP service in the IdPServices list.

Syntax

public void addIdPService(int service, int bindingType, String location, int priority, int index);

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:

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.

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

Registers an SP service in the SPServices list.

Syntax

public void addSPService(int service, int bindingType, String location, int priority, int index);

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:

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.

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

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

public void 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 Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

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

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

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

DoAction Method (SAMLSPServer Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. 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 Class)

Terminates a client connection.

Syntax

public void dropClient(long connectionId, boolean forced);

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

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

Syntax

public String exportSettings(boolean SP);

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

Acquires a piece of operation data.

Syntax

public byte[] getClientBuffer(long connectionID, String handle);

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

Returns the value of a custom provider property.

Syntax

public String getProviderProperty(String name);

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

Returns the contents of the connected client's HTTP request.

Syntax

public byte[] getRequestBytes(long connectionID, String requestFilter);

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

Returns a request header value.

Syntax

public String getRequestHeader(long connectionId, String headerName);

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

Returns a response header value.

Syntax

public String getResponseHeader(long connectionId, String headerName);

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

Returns the value of a custom session property.

Syntax

public String getSessionProperty(String sessionID, String name);

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

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

public void importSettings(String metadata, boolean SP);

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

Initiates the artifact resolution protocol.

Syntax

public int initiateArtifactResolve(long connectionID, String sessionID, int idPServiceIndex, String artifact, String tag);

Remarks

Use this event to initiate the artifact resolution protocol for Artifact. Specify the desired SP service endpoint via the IdPServiceIndex parameter.

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

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

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.

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

Starts SP-initiated SAML authentication flow.

Syntax

public int initiateAuth(long connectionID, String sessionID, int idPServiceIndex, String nameIDFormat, String relayState, String tag);

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

Starts SP-initiated SAML logout flow.

Syntax

public int initiateLogout(long connectionID, String sessionID, int idPServiceIndex, String nameID, String sessionIndex, String relayState, String tag);

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.

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

Enumerates the connected clients.

Syntax

public String listClients();

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

Takes a snapshot of the connection's properties.

Syntax

public void pinClient(long connectionId);

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

Processes an artifact request received from the IdP service at one of artifact receiver endpoints.

Syntax

public int processArtifact(long connectionID, String sessionID, String request, String tag);

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.

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

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

Syntax

public int processArtifactResolveRequest(long connectionID, String sessionID, String request, String tag);

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.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

ProcessAssertion Method (SAMLSPServer Class)

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

Syntax

public int processAssertion(long connectionID, String sessionID, String request, String tag);

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

Processes a generic HTTP SAML request.

Syntax

public byte[] processGenericRequest(long connectionID, byte[] request);

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

Processes logout request received from the IdP service at one of the SLS endpoints.

Syntax

public int processLogoutRequest(long connectionID, String sessionID, String request, String tag);

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.

Reset Method (SAMLSPServer Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (SAMLSPServer Class)

Commits a data buffer to the connection.

Syntax

public void setClientBuffer(long connectionID, String handle, byte[] value);

Remarks

Use this method from your ReadFile event handler to commit a chunk of file data to the server component.

SetProviderProperty Method (SAMLSPServer Class)

Sets the value of a custom provider property.

Syntax

public void setProviderProperty(String name, String value);

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

Sets a response header.

Syntax

public void setResponseHeader(long connectionId, String headerName, String value);

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

Sets the value of a custom provider session property.

Syntax

public void setSessionProperty(String sessionID, String name, String value);

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

Starts the SP server.

Syntax

public void start();

Remarks

Use this method to start listening for incoming connections.

Stop Method (SAMLSPServer Class)

Stops the IdP server.

Syntax

public void stop();

Remarks

Call this method to stop listening for incoming connections.

Accept Event (SAMLSPServer Class)

Reports an incoming connection.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void accept(SAMLSPServerAcceptEvent e) {}
  ...
}

public class SAMLSPServerAcceptEvent {
  public String remoteAddress;
  public int remotePort;
  public boolean accept; //read-write
}

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

The server fires this event upon receiving an Artifact message from the other side.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void artifactReceived(SAMLSPServerArtifactReceivedEvent e) {}
  ...
}

public class SAMLSPServerArtifactReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String issuer;
  public String artifact;
  public int action; //read-write
}

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

This event is fired when a new artifact resolution request message has been prepared by the class.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void artifactResolveRequestPrepared(SAMLSPServerArtifactResolveRequestPreparedEvent e) {}
  ...
}

public class SAMLSPServerArtifactResolveRequestPreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String destination;
  public String artifact;
}

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

Reports receipt of ArtifactResolveRequest message.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void artifactResolveRequestReceived(SAMLSPServerArtifactResolveRequestReceivedEvent e) {}
  ...
}

public class SAMLSPServerArtifactResolveRequestReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String issuer;
  public boolean isEncrypted;
  public boolean isSigned;
  public String artifact;
  public int action; //read-write
}

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:

AssertionReceived Event (SAMLSPServer Class)

This event is fired when an assertion is received from the IdP.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void assertionReceived(SAMLSPServerAssertionReceivedEvent e) {}
  ...
}

public class SAMLSPServerAssertionReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String issuer;
  public String body;
  public boolean isEncrypted;
  public boolean isSigned;
  public String auth;
  public String nameID;
  public String nameIDFormat;
  public String sessionIndex;
  public String attributes;
  public String validFrom;
  public String validTo;
  public String relayState;
  public int action; //read-write
}

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:

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

Notifies the application of the preparation of an AttributeQuery.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void attributeQueryPrepared(SAMLSPServerAttributeQueryPreparedEvent e) {}
  ...
}

public class SAMLSPServerAttributeQueryPreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String destination;
  public String nameID;
  public String nameIDFormat;
  public String attributes;
}

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

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

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void authnRequestPrepared(SAMLSPServerAuthnRequestPreparedEvent e) {}
  ...
}

public class SAMLSPServerAuthnRequestPreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String destination;
  public String nameIDFormat;
  public boolean forceAuthn;
  public boolean nonInteractive;
  public String relayState; //read-write
}

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

Reports an accepted connection.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void connect(SAMLSPServerConnectEvent e) {}
  ...
}

public class SAMLSPServerConnectEvent {
  public long connectionId;
  public String remoteAddress;
  public int remotePort;
}

Remarks

The class 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 Class)

Fires to report a disconnected client.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void disconnect(SAMLSPServerDisconnectEvent e) {}
  ...
}

public class SAMLSPServerDisconnectEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client disconnects.

Encrypted Event (SAMLSPServer Class)

Notifies the application that the assertion is encrypted and provides recipient certificate details.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void encrypted(SAMLSPServerEncryptedEvent e) {}
  ...
}

public class SAMLSPServerEncryptedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public boolean needCredential;
  public boolean skipThis; //read-write
}

Remarks

The class 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 class 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 Class)

Information about errors during data delivery.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void error(SAMLSPServerErrorEvent e) {}
  ...
}

public class SAMLSPServerErrorEvent {
  public long connectionID;
  public String sessionID;
  public int errorCode;
  public boolean fatal;
  public boolean remote;
  public String description;
}

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

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void externalSign(SAMLSPServerExternalSignEvent e) {}
  ...
}

public class SAMLSPServerExternalSignEvent {
  public long connectionID;
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData; //read-write
}

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 class via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The class 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 Class)

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

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void logoutRequestPrepared(SAMLSPServerLogoutRequestPreparedEvent e) {}
  ...
}

public class SAMLSPServerLogoutRequestPreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String destination;
  public String nameID;
  public String nameIDFormat;
  public String sessionIndex;
  public String relayState; //read-write
}

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

The class uses this event to notify the application about an incoming SAML Logout Request message.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void logoutRequestReceived(SAMLSPServerLogoutRequestReceivedEvent e) {}
  ...
}

public class SAMLSPServerLogoutRequestReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String issuer;
  public boolean isEncrypted;
  public boolean isSigned;
  public String nameID;
  public String nameIDFormat;
  public String sessionIndex;
  public int action; //read-write
}

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:

LogoutResponsePrepared Event (SAMLSPServer Class)

The class uses this event to notify the application about the Logout Response message being ready to be sent.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void logoutResponsePrepared(SAMLSPServerLogoutResponsePreparedEvent e) {}
  ...
}

public class SAMLSPServerLogoutResponsePreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String destination;
  public String body;
  public String nameID;
  public String nameIDFormat;
  public String sessionIndex;
}

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

The class uses this event to notify the application about an incoming SAML LogoutResponse message.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void logoutResponseReceived(SAMLSPServerLogoutResponseReceivedEvent e) {}
  ...
}

public class SAMLSPServerLogoutResponseReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String issuer;
  public boolean isEncrypted;
  public boolean isSigned;
  public String nameID;
  public String nameIDFormat;
  public String sessionIndex;
  public String relayState;
  public int action; //read-write
}

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:

Notification Event (SAMLSPServer Class)

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

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void notification(SAMLSPServerNotificationEvent e) {}
  ...
}

public class SAMLSPServerNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

ProcessingCompleted Event (SAMLSPServer Class)

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

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void processingCompleted(SAMLSPServerProcessingCompletedEvent e) {}
  ...
}

public class SAMLSPServerProcessingCompletedEvent {
  public long connectionID;
  public String sessionID;
  public String tag;
  public int processingResult;
  public String response;
  public boolean redirect;
}

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.

ReadArtifact Event (SAMLSPServer Class)

Requests content identified by an artifact from the application.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void readArtifact(SAMLSPServerReadArtifactEvent e) {}
  ...
}

public class SAMLSPServerReadArtifactEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String issuer;
  public String artifact;
  public String value; //read-write
  public boolean skip; //read-write
}

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

Tells the application that it can close the opened resource.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void resourceClose(SAMLSPServerResourceCloseEvent e) {}
  ...
}

public class SAMLSPServerResourceCloseEvent {
  public long connectionID;
  public String sessionID;
  public String handle;
}

Remarks

The class uses this event to notify the application that it can now close the resource opened earlier in its ResourceOpen handler.

ResourceOpen Event (SAMLSPServer Class)

Requests the application to open the requested resource.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void resourceOpen(SAMLSPServerResourceOpenEvent e) {}
  ...
}

public class SAMLSPServerResourceOpenEvent {
  public long connectionID;
  public String sessionID;
  public String URL;
  public String httpMethod;
  public int operationStatus; //read-write
  public String handle; //read-write
}

Remarks

The class 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 Class)

Requests the application to read from an opened resource.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void resourceRead(SAMLSPServerResourceReadEvent e) {}
  ...
}

public class SAMLSPServerResourceReadEvent {
  public long connectionID;
  public String sessionID;
  public String handle;
  public int size;
  public int operationStatus; //read-write
}

Remarks

The class 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 Class)

Notifies the application that a server resource is requested.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void resourceRequest(SAMLSPServerResourceRequestEvent e) {}
  ...
}

public class SAMLSPServerResourceRequestEvent {
  public long connectionID;
  public String sessionID;
  public String URL;
  public String httpMethod;
  public boolean resProtected; //read-write
  public boolean resSpecial; //read-write
  public boolean allowWriting; //read-write
  public int action; //read-write
}

Remarks

The class 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:

ResourceWrite Event (SAMLSPServer Class)

Requests the application to write to an opened resource.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void resourceWrite(SAMLSPServerResourceWriteEvent e) {}
  ...
}

public class SAMLSPServerResourceWriteEvent {
  public long connectionID;
  public String sessionID;
  public String handle;
  public int operationStatus; //read-write
}

Remarks

The class 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:

SAMLMessagePrepared Event (SAMLSPServer Class)

This event is fired when a SAML message has been prepared and is ready to be dispatched.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void SAMLMessagePrepared(SAMLSPServerSAMLMessagePreparedEvent e) {}
  ...
}

public class SAMLSPServerSAMLMessagePreparedEvent {
  public long connectionID;
  public String sessionID;
  public String messageID;
  public String destination;
  public String issueInstant;
  public String inResponseTo;
  public String requestBody;
  public String messageType;
  public String messageBody; //read-write
  public String relayState; //read-write
  public boolean success; //read-write
}

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

The server fires this event for every SAML message it receives.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void SAMLMessageReceived(SAMLSPServerSAMLMessageReceivedEvent e) {}
  ...
}

public class SAMLSPServerSAMLMessageReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String messageID;
  public String issuer;
  public String issueInstant;
  public String inResponseTo;
  public String requestBody;
  public String messageType;
  public String messageBody;
  public boolean isSigned;
  public String relayState;
  public int action; //read-write
}

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.

SessionCreated Event (SAMLSPServer Class)

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

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void sessionCreated(SAMLSPServerSessionCreatedEvent e) {}
  ...
}

public class SAMLSPServerSessionCreatedEvent {
  public long connectionID;
  public String sessionID;
}

Remarks

ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.

SessionDestroyed Event (SAMLSPServer Class)

This event is fired when the SP server has closed a session.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void sessionDestroyed(SAMLSPServerSessionDestroyedEvent e) {}
  ...
}

public class SAMLSPServerSessionDestroyedEvent {
  public long connectionID;
  public String sessionID;
}

Remarks

ConnectionID contains the identifier of the closed session.

SessionEvent Event (SAMLSPServer Class)

Notifies the application about SAML session events.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void sessionEvent(SAMLSPServerSessionEventEvent e) {}
  ...
}

public class SAMLSPServerSessionEventEvent {
  public long connectionID;
  public String sessionID;
  public String eventText;
}

Remarks

class 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 Class)

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

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void sessionInfoNeeded(SAMLSPServerSessionInfoNeededEvent e) {}
  ...
}

public class SAMLSPServerSessionInfoNeededEvent {
  public long connectionID;
  public String sessionID; //read-write
}

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

This event fires to retrieve session state information from the application.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void sessionStateRetrieve(SAMLSPServerSessionStateRetrieveEvent e) {}
  ...
}

public class SAMLSPServerSessionStateRetrieveEvent {
  public long connectionID;
  public String sessionID;
  public String sessionState; //read-write
}

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

This event passes a session state object to the application for safekeeping.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void sessionStateSave(SAMLSPServerSessionStateSaveEvent e) {}
  ...
}

public class SAMLSPServerSessionStateSaveEvent {
  public long connectionID;
  public String sessionID;
  public String sessionState;
}

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

Signifies the start of signature validation.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void signatureFound(SAMLSPServerSignatureFoundEvent e) {}
  ...
}

public class SAMLSPServerSignatureFoundEvent {
  public long connectionID;
  public String sessionID;
  public int scope;
  public String signer;
  public String targetID;
  public String targetType;
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public String sigMethod;
  public String digestMethod;
  public boolean certFound;
  public boolean validate; //read-write
}

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 class 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 Class)

Reports the signature validation result.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void signatureValidated(SAMLSPServerSignatureValidatedEvent e) {}
  ...
}

public class SAMLSPServerSignatureValidatedEvent {
  public long connectionID;
  public String sessionID;
  public int scope;
  public String signer;
  public String targetID;
  public String targetType;
  public String issuerRDN;
  public byte[] serialNumber;
  public byte[] subjectKeyID;
  public String sigMethod;
  public String digestMethod;
  public int validationResult; //read-write
}

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.

TLSCertValidate Event (SAMLSPServer Class)

Fires when a client certificate needs to be validated.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void TLSCertValidate(SAMLSPServerTLSCertValidateEvent e) {}
  ...
}

public class SAMLSPServerTLSCertValidateEvent {
  public long connectionID;
  public boolean accept; //read-write
}

Remarks

The class 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 Class)

Reports the setup of a TLS session.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void TLSEstablished(SAMLSPServerTLSEstablishedEvent e) {}
  ...
}

public class SAMLSPServerTLSEstablishedEvent {
  public long connectionID;
}

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (SAMLSPServer Class)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void TLSHandshake(SAMLSPServerTLSHandshakeEvent e) {}
  ...
}

public class SAMLSPServerTLSHandshakeEvent {
  public long connectionID;
  public String serverName;
  public boolean abort; //read-write
}

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

Requests a pre-shared key for TLS-PSK.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void TLSPSK(SAMLSPServerTLSPSKEvent e) {}
  ...
}

public class SAMLSPServerTLSPSKEvent {
  public long connectionID;
  public String identity;
  public String PSK; //read-write
  public String ciphersuite; //read-write
}

Remarks

The class 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 Class)

Reports closure of a TLS session.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void TLSShutdown(SAMLSPServerTLSShutdownEvent e) {}
  ...
}

public class SAMLSPServerTLSShutdownEvent {
  public long connectionID;
}

Remarks

The class 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 Class)

Notifies the application about the success of user authentication flow.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void userAuthCompleted(SAMLSPServerUserAuthCompletedEvent e) {}
  ...
}

public class SAMLSPServerUserAuthCompletedEvent {
  public long connectionID;
  public String sessionID;
  public String assertionBody;
  public String auth;
  public String nameID;
  public String nameIDFormat;
  public String sessionIndex;
  public String validFrom;
  public String validTo;
  public String relayState;
}

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

Notifies the application about failure of user authentication flow.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void userAuthFailed(SAMLSPServerUserAuthFailedEvent e) {}
  ...
}

public class SAMLSPServerUserAuthFailedEvent {
  public long connectionID;
  public String sessionID;
  public String relayState;
}

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

Notifies the application about the start of user authentication flow.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void userAuthStart(SAMLSPServerUserAuthStartEvent e) {}
  ...
}

public class SAMLSPServerUserAuthStartEvent {
  public long connectionID;
  public String sessionID;
  public int idPServiceIndex;
  public String relayState; //read-write
}

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

Notifies the application about the completion of user logout flow.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void userLogoutCompleted(SAMLSPServerUserLogoutCompletedEvent e) {}
  ...
}

public class SAMLSPServerUserLogoutCompletedEvent {
  public long connectionID;
  public String sessionID;
  public String nameID;
  public String sessionIndex;
  public String relayState;
}

Remarks

Subscribe to this event to be notified about the completion of the logout flow.

UserLogoutStart Event (SAMLSPServer Class)

Notifies the application about the start of user logout flow.

Syntax

public class DefaultSAMLSPServerEventListener implements SAMLSPServerEventListener {
  ...
  public void userLogoutStart(SAMLSPServerUserLogoutStartEvent e) {}
  ...
}

public class SAMLSPServerUserLogoutStartEvent {
  public long connectionID;
  public String sessionID;
  public int idPServiceIndex;
  public String nameID;
  public String sessionIndex;
  public boolean secondary;
  public String relayState; //read-write
}

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

Constructors

public Certificate( bytes,  startIndex,  count,  password);

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

public Certificate( bytes,  startIndex,  count);

public Certificate( path,  password);

public Certificate( certPath,  keyPath,  password);

public Certificate( path);

public Certificate( stream);

public Certificate( stream,  password);

public Certificate( certStream,  keyStream,  password);

public Certificate();

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

public CryptoKey();

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

Constructors

public ExternalCrypto();

SAMLEntity Type

Represents SAML entity details.

Remarks

This type is a container for SAML SP or IdP entity parameters. These are often referred to as service metadata.

Fields

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=other

Company=My Company;EmailAddress=info@company.com;TelephoneNumber=+012345678;Type=technical;Extension.https://spid.gov.it/saml-extensions.VATNumber=IT122345678