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 AddIdPSSOLink method to add sign-on URLs.

ArtifactResolutionService Property (SAMLIdPServer Class)

The location of the artifact resolution service.

Syntax

public String getArtifactResolutionService();


public void setArtifactResolutionService(String artifactResolutionService);

Default Value

"/idp/ArtifactResolutionService"

Remarks

Use this property to specify the location of the artifact resolution service of this Identity Provider (IdP).

AttributeQueryService Property (SAMLIdPServer Class)

The location of the AttributeQuery service.

Syntax

public String getAttributeQueryService();


public void setAttributeQueryService(String attributeQueryService);

Default Value

"/idp/AttributeQueryService"

Remarks

Use this property to specify the relative URL of the AttributeQuery service provided by this Identity Provider (IdP).

AuthFormTemplate Property (SAMLIdPServer Class)

Defines the default authentication template (login page).

Syntax

public String getAuthFormTemplate();


public void setAuthFormTemplate(String authFormTemplate);

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.

ClientAuth Property (SAMLIdPServer Class)

Enables or disables certificate-based client authentication.

Syntax

public int getClientAuth();


public void setClientAuth(int clientAuth);


Enumerated values:
  public final static int ccatNoAuth = 0;
  public final static int ccatRequestCert = 1;
  public final static int ccatRequireCert = 2;

Default Value

0

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

EncryptAssertions Property (SAMLIdPServer Class)

Specifies whether to encrypt assertions included into the IdP response.

Syntax

public boolean isEncryptAssertions();


public void setEncryptAssertions(boolean encryptAssertions);

Default Value

False

Remarks

Set this property to True to force the class to encrypt the assertions included into the server's response.

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 EncryptAssertions is True.

This property is not available at design time.

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

ErrorOrigin Property (SAMLIdPServer Class)

Indicates the endpoint where the error originates from.

Syntax

public int getErrorOrigin();


public void setErrorOrigin(int errorOrigin);


Enumerated values:
  public final static int eoLocal = 0;
  public final static int eoRemote = 1;

Default Value

0

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

This property is not available at design time.

ErrorSeverity Property (SAMLIdPServer Class)

The severity of the error that happened.

Syntax

public int getErrorSeverity();


public void setErrorSeverity(int errorSeverity);


Enumerated values:
  public final static int esInfo = 0;
  public final static int esWarning = 1;
  public final static int esFatal = 2;

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

This property is not available at design time.

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.

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.

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

IDPSSOPageContent Property (SAMLIdPServer Class)

The content of the IdP-initiated SSO page.

Syntax

public String getIDPSSOPageContent();


public void setIDPSSOPageContent(String IDPSSOPageContent);

Default Value

""

Remarks

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

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

False

Remarks

In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be provided via the ProcessGenericRequest calls.

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.

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.

PreferredSingleLogoutResponseBinding Property (SAMLIdPServer Class)

Specifies the preferred single logout response binding.

Syntax

public int getPreferredSingleLogoutResponseBinding();


public void setPreferredSingleLogoutResponseBinding(int preferredSingleLogoutResponseBinding);


Enumerated values:
  public final static int csbtNone = 0;
  public final static int csbtSOAP = 1;
  public final static int csbtPAOS = 2;
  public final static int csbtRedirect = 3;
  public final static int csbtPOST = 4;
  public final static int csbtArtifact = 5;

Default Value

3

Remarks

This value is used by the Identity Provider (IdP) when the default binding is not specified in Service Provider's (SP) metadata file.

The binding is the mechanism of message exchange used by SAML requestors and responders.

PreferredSingleSignOnResponseBinding Property (SAMLIdPServer Class)

Specifies preferred SSO response binding.

Syntax

public int getPreferredSingleSignOnResponseBinding();


public void setPreferredSingleSignOnResponseBinding(int preferredSingleSignOnResponseBinding);


Enumerated values:
  public final static int csbtNone = 0;
  public final static int csbtSOAP = 1;
  public final static int csbtPAOS = 2;
  public final static int csbtRedirect = 3;
  public final static int csbtPOST = 4;
  public final static int csbtArtifact = 5;

Default Value

4

Remarks

This value is used by the Identity Provider (IdP) when the default binding is not specified in Service Provider's (SP) metadata file.

The binding is the mechanism of message exchange used by SAML requestors and responders.

ServerCertificates Property (SAMLIdPServer Class)

The server's TLS certificates.

Syntax

public CertificateList getServerCertificates();


public void setServerCertificates(CertificateList serverCertificates);

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.

SigCanonicalizationMethod Property (SAMLIdPServer Class)

The canonicalization method to use in the signature.

Syntax

public String getSigCanonicalizationMethod();


public void setSigCanonicalizationMethod(String sigCanonicalizationMethod);

Default Value

""

Remarks

The URI of the canonicalization method to use in the signature (e.g. http://www.w3.org/TR/xml-exc-c14n/)

SigDigestMethod Property (SAMLIdPServer Class)

The digest method to use.

Syntax

public String getSigDigestMethod();


public void setSigDigestMethod(String sigDigestMethod);

Default Value

""

Remarks

The URI of the digest method to use for signing, as defined in XMLDSIG or XMLENC: http://www.w3.org/2000/09/xmldsig#sha256.

SigMethod Property (SAMLIdPServer Class)

The signature method to use.

Syntax

public String getSigMethod();


public void setSigMethod(String sigMethod);

Default Value

""

Remarks

The URI specifying the signature method to use for signing, for example http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

SignAssertions Property (SAMLIdPServer Class)

Specifies whether the assertions included in IdP responses should be signed.

Syntax

public boolean isSignAssertions();


public void setSignAssertions(boolean signAssertions);

Default Value

False

Remarks

Set this property to True to automatically sign the assertions included into the Identity Provider (IdP) responses.

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.

SignMetadata Property (SAMLIdPServer Class)

Specifies whether the IdP's metadata should be signed.

Syntax

public boolean isSignMetadata();


public void setSignMetadata(boolean signMetadata);

Default Value

False

Remarks

Set this property to True to sign the Identity Provider's (IdP) metadata before saving it. Do not forget to assign the signing certificate to the MetaSigningCertificate property.

SignResponse Property (SAMLIdPServer Class)

Specifies whether the IdP responses should be signed.

Syntax

public boolean isSignResponse();


public void setSignResponse(boolean signResponse);

Default Value

False

Remarks

Set this property to True to automatically sign the responses sent by this IdP server.

SingleLogoutService Property (SAMLIdPServer Class)

The URL of the single logout service.

Syntax

public String getSingleLogoutService();


public void setSingleLogoutService(String singleLogoutService);

Default Value

"/idp/SingleLogoutService"

Remarks

This property specifies the relative URL of the single logout service.

SingleLogoutServiceBindings Property (SAMLIdPServer Class)

Defines single logout service bindings.

Syntax

public String getSingleLogoutServiceBindings();


public void setSingleLogoutServiceBindings(String singleLogoutServiceBindings);

Default Value

"+Artifact,+POST,+Redirect"

Remarks

Use this property to specify the single logout service bindings.

The binding is the mechanism of message exchange used by SAML requestors and responders.

SingleSignOnService Property (SAMLIdPServer Class)

The URL of the single logout service.

Syntax

public String getSingleSignOnService();


public void setSingleSignOnService(String singleSignOnService);

Default Value

"/idp/SingleSignOnService"

Remarks

This property specifies the relative URL of the single logout (SSO) service.

SingleSignOnServiceBindings Property (SAMLIdPServer Class)

Defines single sign-on service bindings.

Syntax

public String getSingleSignOnServiceBindings();


public void setSingleSignOnServiceBindings(String singleSignOnServiceBindings);

Default Value

"+Artifact,+POST,+Redirect"

Remarks

Use this property to specify the single sign-on service bindings.

The binding is the mechanism of message exchange used by SAML requestors and responders.

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.

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.

AddIdPSSOLink Method (Samlidpserver Class)

Adds an SSO URL to the list.

Syntax

public int addIdPSSOLink(int SPIndex, String URL, String relayState);

Remarks

Use this method to add a new single sign-on (SSO) link. The method returns the index of the new link in the internal list of SSO links.

SPIndex specifies the index of the service provider configuration, URL contains the relative URL for the SSO, and RelayState contains the value of the corresponding SAML parameter.

According to SAML 2.0 specification, the RelayState parameter may be used by the SAML binding in order to convey and preserve state information. If this parameter is present in a SAML request message, the responding party must include the same exact parameter into the response to this request.

In many applications, when using IdP-initiated single sign-on, the IdP uses RelayState to indicate to the SP the URL to which it should redirect after the successful sign-on.

AddUser Method (Samlidpserver Class)

Registers known user credentials.

Syntax

public void addUser(String login, String password);

Remarks

Call this method to register a pair of known user's credentials with the server.

AddUserWithEmail Method (Samlidpserver Class)

Registers known user credentials.

Syntax

public void addUserWithEmail(String login, String email, String password);

Remarks

Call this method to register known user's credentials with the server. In addition to Login and Password this method also associates an Email address with this user.

ClearUsers Method (Samlidpserver Class)

Clears the database of registered users.

Syntax

public void clearUsers();

Remarks

Use this method to remove all stored user credential details.

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

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

LoadSPMetadata Method (Samlidpserver Class)

Loads the metadata required for information exchange with the service provider.

Syntax

public int loadSPMetadata(String fileName);

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.

FileName specifies the metadata file name.

ProcessGenericRequest Method (Samlidpserver Class)

Processes a generic HTTP SAML request.

Syntax

public byte[] processGenericRequest(byte[] request);

Remarks

Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine.

The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. The returned value contains a full HTTP response that should be supplied back to the requestor. You can edit some parts of the response (for example, by adding some custom HTTP headers).

You can use this method with or without the OfflineMode.

RemoveIdPSSOLink Method (Samlidpserver Class)

Removes the specified SSO link.

Syntax

public void removeIdPSSOLink(int index);

Remarks

Multiple URLs may be used on an IdP to initiate the single sign-on (SSO) session. You can add new links using AddIdPSSOLink, and remove ones that are no longer needed with RemoveIdPSSOLink.

RemoveSP Method (Samlidpserver Class)

Removes an SP from the list of trusted service providers.

Syntax

public void removeSP(int index);

Remarks

Use this method to remove information about a service provider from the server.

RemoveUser Method (Samlidpserver Class)

Unregister user credentials.

Syntax

public void removeUser(String login);

Remarks

Use this method to 'forget' the credentials of the user specified by the Login.

SaveMetadata Method (Samlidpserver Class)

Saves the IdP configuration to a metadata file.

Syntax

public void saveMetadata(String fileName);

Remarks

Use this method to save the Identity Provider (IdP) configuration in the form of XML metadata in the file specified by FileName. This file may be transferred to service providers (SP) to adjust their interaction processes.

SaveMetadataToStream Method (Samlidpserver Class)

Saves the IdP configuration to a metadata file.

Syntax

public void saveMetadataToStream(java.io.OutputStream stream);

Remarks

Use this method to save the Identity Provider (IdP) configuration in the form of XML metadata into the Stream. This metadata may be transferred to service providers (SP) to adjust their interaction processes.

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

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

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.

AssertionCreated Event (Samlidpserver Class)

Notifies the application about the creation of a new assertion.

Syntax

public class DefaultSamlidpserverEventListener implements SamlidpserverEventListener {
  ...
  public void assertionCreated(SamlidpserverAssertionCreatedEvent e) {}
  ...
}

public class SamlidpserverAssertionCreatedEvent {
  public long connectionID;
  public int assertionOrigin;
  public String assertionType;
  public String content;
}

Remarks

Use this event to track the creation of a new SAML assertion (upon request from the browser or the SP).

The ConnectionID identifies the connection that requested the assertion. AssertionOrigin and AssertionType specify the type of assertion that was prepared and its disposition, and Content contains the body of the assertion. You can alter the body if required, but please keep in mind that changes may invalidate signed assertions.

AssertionReceived Event (Samlidpserver Class)

Notifies the application about the receipt of an assertion.

Syntax

public class DefaultSamlidpserverEventListener implements SamlidpserverEventListener {
  ...
  public void assertionReceived(SamlidpserverAssertionReceivedEvent e) {}
  ...
}

public class SamlidpserverAssertionReceivedEvent {
  public long connectionID;
  public int assertionOrigin;
  public String content;
}

Remarks

Use this event to track the receipt of a SAML assertion from the remote party.

The ConnectionID identifies the connection that requested the assertion. AssertionOrigin specifies the disposition of the assertion, and Content contains its body. You can alter the body if required, but please keep in mind that changes may invalidate signed assertions.

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 int errorCode;
  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;
}

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

MetadataRequest Event (Samlidpserver Class)

Notifies the application about the metadata request.

Syntax

public class DefaultSamlidpserverEventListener implements SamlidpserverEventListener {
  ...
  public void metadataRequest(SamlidpserverMetadataRequestEvent e) {}
  ...
}

public class SamlidpserverMetadataRequestEvent {
  public long connectionID;
  public String metadata;
}

Remarks

The class uses this event to notify the application about an incoming metadata request. The suggested metadata text is provided through the Metadata parameter. The application can adjust it as required if it needs to.

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.

SessionClosed Event (Samlidpserver Class)

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

Syntax

public class DefaultSamlidpserverEventListener implements SamlidpserverEventListener {
  ...
  public void sessionClosed(SamlidpserverSessionClosedEvent e) {}
  ...
}

public class SamlidpserverSessionClosedEvent {
  public long connectionID;
}

Remarks

ConnectionID contains the identifier of the closed session.

SessionEstablished Event (Samlidpserver Class)

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

Syntax

public class DefaultSamlidpserverEventListener implements SamlidpserverEventListener {
  ...
  public void sessionEstablished(SamlidpserverSessionEstablishedEvent e) {}
  ...
}

public class SamlidpserverSessionEstablishedEvent {
  public long connectionID;
  public String username;
}

Remarks

ConnectionID contains the identifier of the new session, Username specifies the client's address and Username.

VerifyCredentials Event (Samlidpserver Class)

Passes user credentials to the application for verification.

Syntax

public class DefaultSamlidpserverEventListener implements SamlidpserverEventListener {
  ...
  public void verifyCredentials(SamlidpserverVerifyCredentialsEvent e) {}
  ...
}

public class SamlidpserverVerifyCredentialsEvent {
  public long connectionID;
  public String username;
  public String password;
  public String body;
  public boolean accept;
}

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.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

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

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

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

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

public Certificate( bytes,  startIndex,  count);

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

public Certificate( path,  password);

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

public Certificate( certPath,  keyPath,  password);

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

public Certificate( path);

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

public Certificate( stream);

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

public Certificate( stream,  password);

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

public Certificate( certStream,  keyStream,  password);

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

public Certificate();

Creates a new object with default field values.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

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

Fields

Constructors

public ExternalCrypto();

Creates a new ExternalCrypto object with default field values.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public SocketSettings();

Creates a new SocketSettings object.

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

Creates a new TLSSettings object.

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

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	30408705   Invalid binging name (SB_ERROR_SAML_INVALID_BINDING_NAME)
	30408706   Invalid binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE)
	30408707   Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET)