SAMLIdPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLIdPServer class represents a SAML identity provider.

Syntax

secureblackbox.SAMLIdPServer

Remarks

The identity provider in the SAML (Security Assertion Markup Language) exchange flow represents the server that issues authentication assertions for single sign-on (SSO).

Requests received by the IdP server from known service providers (SP) are processed automatically, in accordance with known SP metadata and IdP options. If the request is correct, the client is redirected to the IdP for authentication. The authentication algorithm depends on the IdP options and may be reduced to a simple IP check, X.509 certificate authentication, or login credentials check.

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

AllowIDPSSO Property (SAMLIdPServer Class)

Specifies if IdP-initiated Single Sign-On (SSO) is allowed.

Syntax

public boolean isAllowIDPSSO();
public void setAllowIDPSSO(boolean allowIDPSSO);

Default Value

False

Remarks

Set this property to true to allow IdP-initiated Single Sign-Ons. Use the IdPSSOLink parameter of AddSP method to add sign-on URLs.

BaseDir Property (SAMLIdPServer 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 (SAMLIdPServer 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.

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

EncryptionCertificate Property (SAMLIdPServer Class)

The certificate used to encrypt the assertions.

Syntax

public Certificate getEncryptionCertificate();
public void setEncryptionCertificate(Certificate encryptionCertificate);

Remarks

Use this property to provide the certificate to be used for encrypting the assertions included into the IdP responses.

The class encrypts assertions automatically if the certificate is set.

This property is not available at design time.

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

ExternalCrypto Property (SAMLIdPServer 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.

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

FIPSMode Property (SAMLIdPServer Class)

Reserved.

Syntax

public boolean isFIPSMode();
public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (SAMLIdPServer 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 (SAMLIdPServer Class)

Specifies the host address of the IdP 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 (SAMLIdPServer 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.

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

IdPSettings Property (SAMLIdPServer 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.

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

IdPSSOPage Property (SAMLIdPServer Class)

Specifies the relative URL of the IdP-initiated SSO page.

Syntax

public String getIdPSSOPage();
public void setIdPSSOPage(String idPSSOPage);

Default Value

"/idpsso"

Remarks

Use this property to specify the address of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP).

IdPSSOPageTemplate Property (SAMLIdPServer Class)

The content of the IdP-initiated SSO page.

Syntax

public String getIdPSSOPageTemplate();
public void setIdPSSOPageTemplate(String idPSSOPageTemplate);

Default Value

""

Remarks

Use this property to specify the content of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP).

KnownCertificates Property (SAMLIdPServer 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.

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

KnownKeys Property (SAMLIdPServer 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.

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

LoginAttemptsLimit Property (SAMLIdPServer Class)

The maximum number of login attempts.

Syntax

public int getLoginAttemptsLimit();
public void setLoginAttemptsLimit(int loginAttemptsLimit);

Default Value

3

Remarks

Use this property to set the maximum number of login attempts.

MetadataURL Property (SAMLIdPServer Class)

The IdP's metadata location.

Syntax

public String getMetadataURL();
public void setMetadataURL(String metadataURL);

Default Value

"/idp/metadata"

Remarks

This property specifies the metadata URL of this Identity Provider (IdP).

MetaSigningCertificate Property (SAMLIdPServer 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 IdP's metadata.

This property is not available at design time.

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

OfflineMode Property (SAMLIdPServer 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 incoming requests to be routed by the application via calls to ProcessSignOnRequest, ProcessLogoutRequest, ProcessSignOnResponse, 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 requests.

PinnedClient Property (SAMLIdPServer 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.

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

PinnedClientChain Property (SAMLIdPServer 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.

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

Port Property (SAMLIdPServer Class)

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 IdP server should listen for incoming connections. To specify server's IP address use Host.

Security Property (SAMLIdPServer 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.

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

SenderChain Property (SAMLIdPServer 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.

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

SigningCertificate Property (SAMLIdPServer Class)

The certificate to be used by the IdP's for signing.

Syntax

public Certificate getSigningCertificate();
public void setSigningCertificate(Certificate signingCertificate);

Remarks

Use this property to specify the certificate that shall be used for signing the assertions. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

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

SigningChain Property (SAMLIdPServer 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.

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

SignOnPageTemplate Property (SAMLIdPServer Class)

Defines the default authentication template (login page).

Syntax

public String getSignOnPageTemplate();
public void setSignOnPageTemplate(String signOnPageTemplate);

Default Value

""

Remarks

This property contains the HTML code of the authentication form. You can use it to control the appearance of the login page.

SocketSettings Property (SAMLIdPServer Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

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

SPServices Property (SAMLIdPServer 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.

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

SPSettings Property (SAMLIdPServer Class)

Populates a list of SAML SP entity settings.

Syntax

public SAMLEntityList 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 using ImportSettings method.

This property is read-only and not available at design time.

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

TLSServerChain Property (SAMLIdPServer 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.

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

TLSSettings Property (SAMLIdPServer 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.

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

URL Property (SAMLIdPServer Class)

Specifies the base URL of this IdP server.

Syntax

public String getURL();
public void setURL(String URL);

Default Value

""

Remarks

Use this property to set the base URL for this Identity Provider (IdP) server.

Users Property (SAMLIdPServer Class)

A collection of known users.

Syntax

public UserAccountList getUsers();
public void setUsers(UserAccountList users);

Remarks

This property provides access to registered user database.

This property is not available at design time.

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

AddIdPService Method (SAMLIdPServer 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 services and their locations provided by the IdP.

An identity provider can provide a variety of identity services through a selection of endpoints, each supporting one or more transports (or bindings). Typical examples are a single sign-on 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 AddIdPService 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:

idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); idp.AddIdPService(spsSingleSignOnService, csbtPOST, "/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 SLO services to support POST and Redirect bindings.

The Location parameter specifies an absolute or relative path to the service within the SAML web service:

idp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1); // absolute path idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); // relative path

The Priority parameter is nominal as it only specifies the relative priority of the transport in the IdP metadata. The actual transport used, among those supported, depends on the choice of the external service provider / application. 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 identity provider's own service - something that the identity provider provides. This is different to AddSPService method, which registers a foreign service provider's service - something that the identity provider should be aware of.

AddSP Method (SAMLIdPServer Class)

Registers an SP entity in SPSettings list.

Syntax

public void addSP(String entityID, String idPSSOLink);

Remarks

This method adds an empty entry to the SPSettings list of known service providers. When registering a service provider manually (v.s. importing it from its metadata with a ImportSettings call), make sure to register all the individual SP service endpoints (assertion consumer services, single logout services, and so on) manually using the AddSPService method.

Once you have added the SP entry to the list, you can edit it using the SPSettings property.

AddSPService Method (SAMLIdPServer Class)

Registers an SP service in the SPServices list.

Syntax

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

Remarks

Use this method to add an entry to the list of known external SAML services and their locations.

The identity provider needs to be knowledgeable of external SP services (applications) that it provides services to. 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 SP service is available through several different transports (bindings), you will need to register each (service, transport) pair individually:

idp.AddSPService(spsAssertionConsumerService, csbtPOST, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata"); idp.AddSPService(spsAssertionConsumerService, csbtRedirect, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata");

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. This information is typically provided by the service 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.

The EntityID parameter provides a unique identifier of the service provider. It is common to use the URL of the provider's metadata file as the Entity ID, although that is not a requirement.

Note that this method registers a known service - something that the identity provider should be aware of. This is different to the purpose of the AddIdPService method, which registers the identity provider's own service.

Cleanup Method (SAMLIdPServer 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.

CompleteAuth Method (SAMLIdPServer Class)

Initiates transfer of the authentication fact (assertion) to the SP.

Syntax

public int completeAuth(long connectionID, String sessionID, int SPServiceIndex, String relayState, String tag);

Remarks

Use this method to pass a SAML assertion to a chosen SP after completion of the IdP-initiated SSO process.

Calling this method is equivalent to navigating to the SP-specific IdP link on the web server running the SAML IdP service.

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.

Config Method (SAMLIdPServer 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 (SAMLIdPServer 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;....

Common ActionIDs:

DropClient Method (SAMLIdPServer 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 (SAMLIdPServer Class)

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

Syntax

public String exportSettings(boolean idP, int index);

Remarks

Use this method to save the Identity Provider (IdP) or Service Provider (SP) configuration in the form of XML metadata. The IdP metadata file may then be transferred to identity providers (SP) to let them know about the IdP configuration.

When exporting IdP settings, adjust the identity provider configuration as required in IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.

When exporting SP settings, provide the index of the service provider in the SPSettings list.

GetClientBuffer Method (SAMLIdPServer 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 (SAMLIdPServer 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 Identity 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 (SAMLIdPServer Class)

Returns the contents of the received HTTP request.

Syntax

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

Remarks

Use this method to get the body of the received HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

GetRequestHeader Method (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 Identity 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 IdP sessions and can be passed to the Name parameter of this method:

• AuthnContextClassRef: the authentication context Auth class.
• AuthnRequestID: the AuthnRequest ID.
• Binding: the binding type used.
• Certificate: the certificate that signed the request (in base16 DER-encoded format).
• CustomAuthFlow: whether the session uses a custom authentication flow.
• Expires: the web session expiration time.
• LoggedIn: whether the user associated with this session has successfully undergone the authentication procedures.
• Login: the login name used by the user to authenticate themselves.
• LoginAttempts: the number of login attempts available for the user.
• 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.
• NameIDPolicyFormat: the name ID policy format.
• NameIDPolicyIdentifier: the name ID policy identifier.
• RelayState: the current (last) relay state entry.
• ResponseLocation: the location where the response should be sent.
• Session: the session ID (the same as you pass as parameter).
• SessionIndex: the cross-network session index assigned to this session.
• SP: the entity ID of the service provider.
• 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 (SAMLIdPServer Class)

Loads the metadata required for information exchange with the identity provider. Both local (IdP-side) and remote (SP-side) metadata can be loaded with this call.

Syntax

public void importSettings(String metadata, boolean idP);

Remarks

The Service provider (SP) may have a lot of different options and requirements for interactions with the Identity provider (IdP). 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 such file generated by the service provider.

The Metadata parameter contains metadata in the form of byte array. Set IdP parameter to true to indicate that it is the Identity Provider's own settings that are being loaded.

The loaded metadata is populated in the IdPSettings or SPSettings object (depending on the value of the IdP parameter).

InitiateArtifactResolve Method (SAMLIdPServer Class)

Initiates the artifact resolution protocol.

Syntax

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

Remarks

Use this event to initiate the artifact resolution protocol for Artifact. Specify the desired SP service endpoint via the SPServiceIndex 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 (SAMLIdPServer Class)

Starts IdP-initiated SAML authentication flow.

Syntax

public int initiateAuth(long connectionID, String sessionID, int SPServiceIndex, String tag);

Remarks

Use this method to initiate SAML authentication flow on the IdP side.

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.

Once the user has been authenticated, you can use ProcessSignOnRequest to generate SAML assertions for specific SPs.

InitiateLogout Method (SAMLIdPServer Class)

Starts IdP-initiated SAML logout flow.

Syntax

public int initiateLogout(long connectionID, String sessionID, int SPServiceIndex, String tag);

Remarks

Use this method to initiate SAML logout flow on the IdP side. Pass the index of the logout endpoint that you want to use to the SPServiceIndex 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.

ListClients Method (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Class)

Processes an artifact request received from the SP 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 AuthnRequestReceived.

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

ProcessAttributeQuery Method (SAMLIdPServer Class)

Processes an attribute request received from the SP service at one of the AQS endpoints.

Syntax

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

Remarks

Use this method to pass a SAML attribute request received at one of the AttributeQueryService 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.

ProcessGenericRequest Method (SAMLIdPServer 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.

You can use this method with or without the OfflineMode.

ProcessLogoutRequest Method (SAMLIdPServer Class)

Processes logout request received from the SP 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 returned 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.

ProcessSignOnRequest Method (SAMLIdPServer Class)

Processes a single sign-on request received from the SP service at one of the SSO endpoints.

Syntax

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

Remarks

Use this method to pass a SAML Single Sign-On request received at one of the SingleSignOnService 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.

ProcessSignOnResponse Method (SAMLIdPServer Class)

Processes the submission of the login form previously generated by the IdP server.

Syntax

public int processSignOnResponse(long connectionID, String sessionID, String response, String tag);

Remarks

Use this method to pass the login form data that was received from the user in response to the presented login form, to the IdP server. If the provided data matches the form, the credentials are passed to the application via the UserAuthVerifyCredentials event.

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.

RemoveSP Method (SAMLIdPServer Class)

Removes an SP from the list of known service providers.

Syntax

public void removeSP(int index);

Remarks

Use this method to remove information about a service provider from the SPSettings list. The IdP server will be unable to process any further requests from this provider once it is removed.

Reset Method (SAMLIdPServer Class)

Resets the class settings.

Syntax

public void reset();

Remarks

Reset is a generic method available in every class.

SetClientBuffer Method (SAMLIdPServer Class)

Commits a data buffer to the connection.

Syntax

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

Remarks

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

SetProviderProperty Method (SAMLIdPServer 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 Identity 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 (SAMLIdPServer 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 (SAMLIdPServer 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 Identity 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:

• AuthnContextClassRef: the authentication context Auth class.
• AuthnRequestID: the AuthnRequest ID.
• Certificate: the certificate that signed the request (in base16 DER-encoded format).
• CustomAuthFlow: whether the session uses a custom authentication flow.
• Login: the login name used by the user to authenticate themselves.
• LoginAttempts: the number of login attempts available for the user.
• LogoutRequestID: the LogoutRequest ID.
• NameID: the NameID of the user.
• NameIDPolicyFormat: the name ID policy format.
• NameIDPolicyIdentifier: the name ID policy identifier.
• RelayState: the current (last) relay state entry.
• ResponseLocation: the location where the response should be sent.
• Session: the session ID (the same as you pass as parameter).
• SessionIndex: the cross-network session index 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 it will contain a now-unmatching In-Response-To entry.

Start Method (SAMLIdPServer Class)

Starts the IdP server.

Syntax

public void start();

Remarks

Use this method to start listening for incoming connections.

Stop Method (SAMLIdPServer Class)

Stops the IdP server.

Syntax

public void stop();

Remarks

Call this method to stop listening for incoming connections.

Accept Event (SAMLIdPServer Class)

Reports an incoming connection.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void accept(SAMLIdPServerAcceptEvent e) {}
  ...
}

public class SAMLIdPServerAcceptEvent {
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void artifactReceived(SAMLIdPServerArtifactReceivedEvent e) {}
  ...
}

public class SAMLIdPServerArtifactReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void artifactResolveRequestPrepared(SAMLIdPServerArtifactResolveRequestPreparedEvent e) {}
  ...
}

public class SAMLIdPServerArtifactResolveRequestPreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  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 service provider.

ArtifactResolveRequestReceived Event (SAMLIdPServer Class)

Reports receipt of ArtifactResolveRequest message.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void artifactResolveRequestReceived(SAMLIdPServerArtifactResolveRequestReceivedEvent e) {}
  ...
}

public class SAMLIdPServerArtifactResolveRequestReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  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:

AssertionPrepared Event (SAMLIdPServer Class)

This event fires when a new assertion has been prepared by the IdP server.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void assertionPrepared(SAMLIdPServerAssertionPreparedEvent e) {}
  ...
}

public class SAMLIdPServerAssertionPreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  public String body;
  public String auth;
  public String nameID;
  public String nameIDFormat;
  public String sessionIndex;
  public String attributes;
  public String validFrom;
  public String validTo;
}

Remarks

The component fires this event when it has prepared an assertion to be sent to the SP as part of the authentication process. This event may fire from within ProcessSignOnRequest and ProcessSignOnResponse calls when working in OfflineMode, and at any time otherwise.

The RequestID parameter contains the request ID, in response to which the assertion was created. The SP parameter contains the identifier of the service provider where the assertion will be sent to. The Body parameter contains the assertion itself in XML format. The NameID parameter contains the name identifier of the authenticated user, and SessionIndex the unique session index of the new session. The ValidFrom and ValidTo parameters specify the validity period of the assertion.

AttributeQueryReceived Event (SAMLIdPServer Class)

Notifies the application about receipt of an AttributeQuery.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void attributeQueryReceived(SAMLIdPServerAttributeQueryReceivedEvent e) {}
  ...
}

public class SAMLIdPServerAttributeQueryReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  public boolean isEncrypted;
  public boolean isSigned;
  public String nameID;
  public String nameIDFormat;
  public String attributes;
  public int action; //read-write
}

Remarks

The component fires this event to notify the application of receipt of an AttributeQuery message. The parameters of the event detail the properties included in the request. The NameID and NameIDFormat specify the subject, and the Attributes string contains a list of attributes being requested.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

If the application chooses to process the request manually, the component will go ahead to fire ReadAttribute event repeatedly for each attribute in the list. The application must subscribe to the event and return the attribute parameters and values from there.

AuthnRequestReceived Event (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void authnRequestReceived(SAMLIdPServerAuthnRequestReceivedEvent e) {}
  ...
}

public class SAMLIdPServerAuthnRequestReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  public boolean isEncrypted;
  public boolean isSigned;
  public String nameIDFormat; //read-write
  public boolean forceAuthn; //read-write
  public boolean nonInteractive; //read-write
  public boolean authenticated; //read-write
  public int action; //read-write
}

Remarks

The event reports the details of the received AuthnRequest message. The ForceAuthn and NonInteractive parameters contain optional suggestions included in the request. The Authenticated parameter specifies whether the user has already been authenticated within this session. All the three parameters can be adjusted in the event handler to direct the authentication logic in the required direction.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

In OfflineMode this event would typically be fired from ProcessSignOnRequest call.

Connect Event (SAMLIdPServer Class)

Reports an accepted connection.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void connect(SAMLIdPServerConnectEvent e) {}
  ...
}

public class SAMLIdPServerConnectEvent {
  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 (SAMLIdPServer Class)

Fires to report a disconnected client.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void disconnect(SAMLIdPServerDisconnectEvent e) {}
  ...
}

public class SAMLIdPServerDisconnectEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client disconnects.

Error Event (SAMLIdPServer Class)

Information about errors during data delivery.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void error(SAMLIdPServerErrorEvent e) {}
  ...
}

public class SAMLIdPServerErrorEvent {
  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 (SAMLIdPServer Class)

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void externalSign(SAMLIdPServerExternalSignEvent e) {}
  ...
}

public class SAMLIdPServerExternalSignEvent {
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void logoutRequestPrepared(SAMLIdPServerLogoutRequestPreparedEvent e) {}
  ...
}

public class SAMLIdPServerLogoutRequestPreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void logoutRequestReceived(SAMLIdPServerLogoutRequestReceivedEvent e) {}
  ...
}

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

Remarks

The SAML IdP 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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void logoutResponsePrepared(SAMLIdPServerLogoutResponsePreparedEvent e) {}
  ...
}

public class SAMLIdPServerLogoutResponsePreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void logoutResponseReceived(SAMLIdPServerLogoutResponseReceivedEvent e) {}
  ...
}

public class SAMLIdPServerLogoutResponseReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  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 IdP 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:

NewAssertion Event (SAMLIdPServer Class)

This event reports a new assertion initiated by the IdP server.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void newAssertion(SAMLIdPServerNewAssertionEvent e) {}
  ...
}

public class SAMLIdPServerNewAssertionEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  public int reason;
  public String authInstant; //read-write
  public String authContext; //read-write
  public String nameID; //read-write
  public String nameIDFormat; //read-write
  public String sessionIndex; //read-write
  public String attributes; //read-write
  public String validFrom; //read-write
  public String validTo; //read-write
  public boolean sign; //read-write
  public boolean encrypt; //read-write
}

Remarks

The component fires this event when it is about to preapre an assertion to be sent to the SP as part of the authentication or attribute request process. This event may fire from within the ProcessSignOnRequest and ProcessSignOnResponse calls when working in OfflineMode, and at any time otherwise.

The RequestID parameter contains the request ID, in response to which the assertion is being created. The SP parameter contains the identifier of the service provider where the assertion will be sent to.

The Reason parameter contains the reason for the assertion to be generated. This can be an authentication request or an attribute request being received. The AuthInstant, AuthContext, NameID, SessionIndex, Attributes, ValidFrom, and ValidTo parameters indicate the initial parameters of the new assertion. Further events, such as ReadAttribute or AssertionPrepared will be fired later on to clarify the contents of the assertion.

Notification Event (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void notification(SAMLIdPServerNotificationEvent e) {}
  ...
}

public class SAMLIdPServerNotificationEvent {
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void processingCompleted(SAMLIdPServerProcessingCompletedEvent e) {}
  ...
}

public class SAMLIdPServerProcessingCompletedEvent {
  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 ProcessSignOnRequest, ProcessSignOnResponse, 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 web page containing a login form.
• 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 (SAMLIdPServer Class)

Requests content identified by an artifact from the application.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void readArtifact(SAMLIdPServerReadArtifactEvent e) {}
  ...
}

public class SAMLIdPServerReadArtifactEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  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 an 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.

ReadAttribute Event (SAMLIdPServer Class)

Requests an attribute from the application.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void readAttribute(SAMLIdPServerReadAttributeEvent e) {}
  ...
}

public class SAMLIdPServerReadAttributeEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  public String nameID;
  public String nameIDFormat;
  public String attrName; //read-write
  public String attrNameFormat; //read-write
  public String attrFriendlyName; //read-write
  public String value; //read-write
  public boolean skip; //read-write
}

Remarks

The component fires this event to request an attribute from the application. This event can be invoked multiple times after the AttributeQueryReceived event has fired, to collect every attribute requested.

The application is expected to set the Value and, optionally, AttrNameFormat and AttrFriendlyName for every attribute requested. The AttrName mathes the name requested by the remote party, but the event handler can change it too if required.

If the application has no knowledge of or does not support the AttrName attribute, it can set Skip to true to avoid sending it.

ResourceClose Event (SAMLIdPServer Class)

Tells the application that it can close the opened resource.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void resourceClose(SAMLIdPServerResourceCloseEvent e) {}
  ...
}

public class SAMLIdPServerResourceCloseEvent {
  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 (SAMLIdPServer Class)

Requests the application to open the requested resource.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void resourceOpen(SAMLIdPServerResourceOpenEvent e) {}
  ...
}

public class SAMLIdPServerResourceOpenEvent {
  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 (SAMLIdPServer Class)

Requests the application to read from an opened resource.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void resourceRead(SAMLIdPServerResourceReadEvent e) {}
  ...
}

public class SAMLIdPServerResourceReadEvent {
  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 (SAMLIdPServer Class)

Notifies the application that a server resource is requested.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void resourceRequest(SAMLIdPServerResourceRequestEvent e) {}
  ...
}

public class SAMLIdPServerResourceRequestEvent {
  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).

This event may fire more than once for one resource if the client is forced to re-submit the request with a session cookie.

Choose Action as one of the following values:

ResourceWrite Event (SAMLIdPServer Class)

Requests the application to write to an opened resource.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void resourceWrite(SAMLIdPServerResourceWriteEvent e) {}
  ...
}

public class SAMLIdPServerResourceWriteEvent {
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void SAMLMessagePrepared(SAMLIdPServerSAMLMessagePreparedEvent e) {}
  ...
}

public class SAMLIdPServerSAMLMessagePreparedEvent {
  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 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, LogoutRequest, or IdP metadata). 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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void SAMLMessageReceived(SAMLIdPServerSAMLMessageReceivedEvent e) {}
  ...
}

public class SAMLIdPServerSAMLMessageReceivedEvent {
  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 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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void sessionCreated(SAMLIdPServerSessionCreatedEvent e) {}
  ...
}

public class SAMLIdPServerSessionCreatedEvent {
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void sessionDestroyed(SAMLIdPServerSessionDestroyedEvent e) {}
  ...
}

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

Remarks

ConnectionID contains the identifier of the closed session.

SessionEvent Event (SAMLIdPServer Class)

Notifies the application about SAML session events.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void sessionEvent(SAMLIdPServerSessionEventEvent e) {}
  ...
}

public class SAMLIdPServerSessionEventEvent {
  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
• IdPSSOReceived
• AuthnRequestReceived
• ChallengePrepared
• CredentialsReceived
• ResponsePrepared
• LoggedIn
• LogoutRequestReceived
• LogoutResponsePrepared
• ArtifactResolveReceived
• ArtifactResponsePrepared
• AttributeQueryReceived
• AttributeResponsePrepared
• Finish

SessionInfoNeeded Event (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void sessionInfoNeeded(SAMLIdPServerSessionInfoNeededEvent e) {}
  ...
}

public class SAMLIdPServerSessionInfoNeededEvent {
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void sessionStateRetrieve(SAMLIdPServerSessionStateRetrieveEvent e) {}
  ...
}

public class SAMLIdPServerSessionStateRetrieveEvent {
  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 (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void sessionStateSave(SAMLIdPServerSessionStateSaveEvent e) {}
  ...
}

public class SAMLIdPServerSessionStateSaveEvent {
  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 (SAMLIdPServer Class)

Notifies the application about the start of signature validation.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void signatureFound(SAMLIdPServerSignatureFoundEvent e) {}
  ...
}

public class SAMLIdPServerSignatureFoundEvent {
  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 TargetID and TargetType provide additional details.

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

Reports the signature validation result.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void signatureValidated(SAMLIdPServerSignatureValidatedEvent e) {}
  ...
}

public class SAMLIdPServerSignatureValidatedEvent {
  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 signature validation process is completed.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion. The TargetID and TargetType parameters provide the details.

Signing certificates are typically identified either by an (IssuerRDN, SerialNumber) pair, or via their unique SubjectKeyID. Use these parameters to look for the signing certificate if it is not available in the signature. The ValidationResult parameter specifies whether the signature is established to be valid or not. You can alter it in the event handler to override the built-in validation outcome.

SignOnPagePrepared Event (SAMLIdPServer Class)

The server fires this event upon preparing the sign-on page.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void signOnPagePrepared(SAMLIdPServerSignOnPagePreparedEvent e) {}
  ...
}

public class SAMLIdPServerSignOnPagePreparedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String SP;
  public String request;
  public String pageData; //read-write
  public boolean redirect; //read-write
}

Remarks

The IdP server fires this event to notify the application that the sign-on page (login form) has been formed and is ready to be flushed. Use SignOnPageTemplate to assign the sign-on page template.

The form body is returned via the PageData parameter. You can adjust it in the event handler as required. The Redirect parameter advises whether the form should be returned as a Location header of the HTTP response with the 302 status, or as an HTTP body of text/html type.

SignOnResponseReceived Event (SAMLIdPServer Class)

Notifies the application about the received response to the sign-on page.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void signOnResponseReceived(SAMLIdPServerSignOnResponseReceivedEvent e) {}
  ...
}

public class SAMLIdPServerSignOnResponseReceivedEvent {
  public long connectionID;
  public String sessionID;
  public String requestID;
  public String responseData; //read-write
  public int action; //read-write
}

Remarks

The component uses this event to report that the login form previously generated by the component has been filled in and returned by the user. ResponseData contains the content submitted by the user (the URL-encoded form fields, or any authentication data if the custom authentication flow is used). The application that chose to use custom authentication process can use this data to authenticate the user.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

TLSCertValidate Event (SAMLIdPServer Class)

Fires when a client certificate needs to be validated.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void TLSCertValidate(SAMLIdPServerTLSCertValidateEvent e) {}
  ...
}

public class SAMLIdPServerTLSCertValidateEvent {
  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 (SAMLIdPServer Class)

Reports the setup of a TLS session.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void TLSEstablished(SAMLIdPServerTLSEstablishedEvent e) {}
  ...
}

public class SAMLIdPServerTLSEstablishedEvent {
  public long connectionID;
}

Remarks

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

TLSHandshake Event (SAMLIdPServer Class)

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

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void TLSHandshake(SAMLIdPServerTLSHandshakeEvent e) {}
  ...
}

public class SAMLIdPServerTLSHandshakeEvent {
  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 (SAMLIdPServer Class)

Requests a pre-shared key for TLS-PSK.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void TLSPSK(SAMLIdPServerTLSPSKEvent e) {}
  ...
}

public class SAMLIdPServerTLSPSKEvent {
  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 (SAMLIdPServer Class)

Reports closure of a TLS session.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void TLSShutdown(SAMLIdPServerTLSShutdownEvent e) {}
  ...
}

public class SAMLIdPServerTLSShutdownEvent {
  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 (SAMLIdPServer Class)

Notifies the application about the success of user authentication flow.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void userAuthCompleted(SAMLIdPServerUserAuthCompletedEvent e) {}
  ...
}

public class SAMLIdPServerUserAuthCompletedEvent {
  public long connectionID;
  public String sessionID;
  public String SP;
  public String auth;
  public String username;
  public String nameID; //read-write
  public String nameIDFormat; //read-write
  public String sessionIndex; //read-write
  public int assertionTTL; //read-write
}

Remarks

Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, and AssertionTTL parameters contain the proposed session parameters. You can alter them in your event handler as required.

UserAuthFailed Event (SAMLIdPServer Class)

Notifies the application about failure of user authentication flow.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void userAuthFailed(SAMLIdPServerUserAuthFailedEvent e) {}
  ...
}

public class SAMLIdPServerUserAuthFailedEvent {
  public long connectionID;
  public String sessionID;
  public String SP;
  public String auth;
  public String username;
  public boolean canRetry;
  public boolean tryAgain; //read-write
}

Remarks

The component fires this event to notify the application about failed user authentication step - for example, if a wrong password was supplied.

The CanRetry parameter indicates whether another attempt of the same type can be performed. If you would like to use that opportunity, set TryAgain to true to restart the process.

UserAuthStart Event (SAMLIdPServer Class)

Notifies the application about the start of user authentication flow.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void userAuthStart(SAMLIdPServerUserAuthStartEvent e) {}
  ...
}

public class SAMLIdPServerUserAuthStartEvent {
  public long connectionID;
  public String sessionID;
  public String SP;
  public String supportedAuths;
  public String selectedAuth; //read-write
  public int action; //read-write
}

Remarks

Set Action to Auto to proceed with the default sign on page based on SignOnPageTemplate, or to Custom to supply (or redirect to) your own authentication landing. The SupportedAuths parameter contains the list of authentication methods supported by the server. If you are looking to use a particular authentication method, return it to the server via SelectedAuth parameter.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

UserAuthVerifyCredentials Event (SAMLIdPServer Class)

Passes user credentials to the application for verification.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void userAuthVerifyCredentials(SAMLIdPServerUserAuthVerifyCredentialsEvent e) {}
  ...
}

public class SAMLIdPServerUserAuthVerifyCredentialsEvent {
  public long connectionID;
  public String sessionID;
  public String SP;
  public String claimedUsername;
  public String claimedPassword;
  public String claimedBody;
  public boolean accept; //read-write
  public String username; //read-write
}

Remarks

Subscribe to this event to be notified about authentication attempts and adjust the acceptance result as required. This event fires after the user credentials have been validated against the configured database, and the value of the Accept parameter reflects the outcome of the validation.

The Username and Password parameters contain the provided credentials, and the Body parameter contains the unparsed form data.

UserLogoutCompleted Event (SAMLIdPServer Class)

Notifies the application about the completion of user logout flow.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void userLogoutCompleted(SAMLIdPServerUserLogoutCompletedEvent e) {}
  ...
}

public class SAMLIdPServerUserLogoutCompletedEvent {
  public long connectionID;
  public String sessionID;
  public String SP;
  public String username;
  public String nameID;
  public String sessionIndex;
  public boolean partial;
}

Remarks

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

UserLogoutStart Event (SAMLIdPServer Class)

Notifies the application about the start of user logout flow.

Syntax

public class DefaultSAMLIdPServerEventListener implements SAMLIdPServerEventListener {
  ...
  public void userLogoutStart(SAMLIdPServerUserLogoutStartEvent e) {}
  ...
}

public class SAMLIdPServerUserLogoutStartEvent {
  public long connectionID;
  public String sessionID;
  public String SP;
  public String username;
  public String nameID;
  public String sessionIndex;
  public boolean secondary;
  public int action; //read-write
}

Remarks

The component uses this event to notify the application about the start of user logout flow. The Secondary parameter indicates that the logout is initiated in response to request received from a remote party.

The application can choose to accept or reject the request, or process it manually, using the Action parameter:

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

Constructors

public SAMLEntity();

SAMLSecuritySettings Type

Represents SAML security settings for the message being viewed/edited.

Remarks

This type is a container for SAML security parameters.

Fields

Constructors

public SAMLSecuritySettings();

SAMLServiceInfo Type

Represents SAML service details.

Remarks

This type is a container for SAML SP or IdP endpoint service parameters.

Fields

Constructors

public SAMLServiceInfo();

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

TLSConnectionInfo Type

Contains information about a network connection.

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

Fields

Constructors

public TLSConnectionInfo();

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

public TLSSettings();

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

Constructors

public UserAccount();

Config Settings (SAMLIdPServer Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SAMLIdPServer Config Settings

Base Config Settings

Trappable Errors (SAMLIdPServer Class)

SAMLIdPServer Errors