SAMLSPServer Class

Properties   Methods   Events   Config Settings   Errors  

The SAMLSPServer class represents a SAML service provider.

Syntax

secureblackbox.Samlspserver

Remarks

The Service Provider in the SAML exchange flow represents the web server that receives and accepts authentication assertions issued by the Identity Provider for single sign-on (SSO). Most commonly, an SP server is part of the application responsible for communicating with an Identity Provider to establish the authenticity of application users.

SAMLSPServer provides easy means of integrating the SAML Service Provider functionality into your application. It presents a fully-features SP endpoint with its own HTTP(S) and assertion validation engines.

Please find below a step-by-step guide on setting up your own SAML SP endpoint.

• Register the IdP metadata using the LoadIDPMetadata method or its stream-based variant. Most IDPs let you download their metadata in XML format. The metadata file contains general parameters of the IdP endpoint, such as its web address and algorithm requirements.

   
   Copy
    server.LoadIDPMetadata("their_metadata.xml"); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>";   

• Configure the main server capabilities:

   
   Copy
    // public server endpoint (use "https://" and/or port 443 if required)
    server.URL = "http://sp.myapp.com";
    server.Port = 80; 
  
    // IdP triggers this URL to pull metadata
    server.MetadataURL = '/sp/metadata'; 
  
    // ACS is th "main" SP endpoint that receives assertions from the IdP
    server.AssertionConsumerService = '/sp/AssertionConsumerService';
    server.SPToIDPBinding = csbtRedirect; // the SP will use HTTP redirect to forward the browser to the IdP when required
    server.AssertionConsumerServiceBindings = 'POST'; // and we want the IdP to use POST to submit its assertions
    server.PreferredIDPToSPBinding = csbtPOST;
  
    // Single logout service setup
    server.SingleLogoutService = '/sp/SingleLogoutService';
    server.SingleLogoutServiceBindings = 'Redirect,POST,Artifact';
    server.LogoutPage = '/sp/logout';
    server.RedirectOnLogoutPage = 'https://www.nsoftware.com';
  
    // The document root of the server on the local system
    server.BaseDir = "D:\\Inetpub\\SAMLSP";
  
    // Security parameters: indicating that we want to sign both
    // the metadata and the requests
    server.SignAuthnRequests = true;
    server.SignMetadata = true;
  
    // We need to attach certificates to be able to sign.
    // Assume we have loaded our signing certificate into
    // a CertificateManager object.
    server.SigningCertificate = mgr.Certificate;
    server.MetaSigningCertificate = mgr.Certificate;

• Personalize the server:

   
   Copy
    server.Config("OrganizationName=My Organization Ltd");
    server.Config("OrganizationDisplayName=My Organization Pet Supplies");
    server.Config("OrganizationURL=http://myorg.com");
    server.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256");
    server.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256");
    server.Config("WantAssertionsSigned=true");

• Optionally, save metadata to an XML file. This will let you send/upload it to the IdP, so they could set your SP up. Some IdPs can download the metadata right from your SP using the MetadataURL that you've provided above, in which case saving it to a file is not necessary.

   
   Copy
    server.SaveMetadata("my_metadata.xml");

 
 Copy
  server.Start();

Now let us actually try to use the SAML functionality. Copy an arbitrary file - for example, a recent photo of your cat - to the directory you provided earlier via the BaseDir property (D:\Inetpub\SAMLSP). Having copied the file (suppose it is called clifford.jpg), try to access it in your browser by navigating to http://127.0.0.1:80/clifford.jpg.

This is where SAML kicks in. Since you are not authenticated for the SP server yet (we have just launched it, so no one is), the server redirects your browser to the IdP endpoint for authentication. The address of the IdP is taken from the their_metadata.xml file that you have loaded at the very beginning.

Note: you can configure which resources to restrict access to using the ProtectedResources property. If ProtectedResources is empty, the server considers all the files in BaseDir and its subfolders to be protected.

It is now the IdP services turn to authenticate you. Most IdPs on this stage will present you with a login form. Yet, if you have signed in recently, the IdP may still remember you, in which case it will skip the form and proceed directly to the next step. After establishing and proving your identity, the IdP will generate an assertion, a signed proof that effectively states that the IdP knows who you are and have verified your identity rigorously. Think of the assertion as your unique pass to the resources protected by the SP. The IdP will then submit that assertion back to the SP at its AssertionConsumerService endpoint, again using your browser.

Note that the SP service knows nothing about how IdP authenticates you. All the SP is interested in is an assertion.

If the assertion is well-formed and its signature is valid, the SAML exchange completes. At this point the SP accepts the assertion and creates a session for you. You can now access the resources protected by the SP for as long as the session lasts. If this step succeeds, you should see the photo of your cat in your browser.

Property List

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

Method List

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

Event List

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

Config Settings

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

Active Property (SAMLSPServer Class)

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

Syntax

public boolean isActive();

Default Value

False

Remarks

This property indicates whether the IdP server is in an active state.

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

ArtifactResolutionService Property (SAMLSPServer Class)

The location of the artifact resolution service.

Syntax

public String getArtifactResolutionService();


public void setArtifactResolutionService(String artifactResolutionService);

Default Value

"/sp/ArtifactResolutionService"

Remarks

Use this property to specify the location of the artifact resolution service of this Service Provider (SP).

AssertionConsumerService Property (SAMLSPServer Class)

The location of the Assertion Consumer Service.

Syntax

public String getAssertionConsumerService();


public void setAssertionConsumerService(String assertionConsumerService);

Default Value

"/sp/AssertionConsumerService"

Remarks

The Assertion Consumer Service (ACS) is the location that accepts SAML responses (artifacts) to establish a session based on assertions.

AssertionConsumerServiceBindings Property (SAMLSPServer Class)

Bindings supported by the Assertion Consumer Service.

Syntax

public String getAssertionConsumerServiceBindings();


public void setAssertionConsumerServiceBindings(String assertionConsumerServiceBindings);

Default Value

"+Artifact,+POST,+Redirect"

Remarks

Use this property to specify the bindings for the Assertion Consumer Service (ACS) provided by this SP.

BaseDir Property (SAMLSPServer Class)

Base directory on the server.

Syntax

public String getBaseDir();


public void setBaseDir(String baseDir);

Default Value

""

Remarks

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

ClientAuth Property (SAMLSPServer 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;

EncryptionCertificate Property (SAMLSPServer Class)

The certificate to be used to decrypt assertions.

Syntax

public Certificate getEncryptionCertificate();


public void setEncryptionCertificate(Certificate encryptionCertificate);

Remarks

Use this property to provide the certificate to be used for decrypting assertions included in IdP (Identity Provider) responses. This certificate should have a private key associated with it.

This property is not available at design time.

ErrorOrigin Property (SAMLSPServer 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 (SAMLSPServer 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 (SAMLSPServer Class)

Provides access to external signing and DC parameters.

Syntax

public ExternalCrypto getExternalCrypto();

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

FIPSMode Property (SAMLSPServer Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

Host Property (SAMLSPServer Class)

Specifies the host address of the SP server.

Syntax

public String getHost();


public void setHost(String host);

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections. To specify the listening port number, use Port.

Issuer Property (SAMLSPServer Class)

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

Syntax

public String getIssuer();


public void setIssuer(String issuer);

Default Value

""

Remarks

Use this property to set the name identifier of this Service Provider (SP) to be used in its requests.

LogoutPage Property (SAMLSPServer Class)

Specifies the location of the logout page.

Syntax

public String getLogoutPage();


public void setLogoutPage(String logoutPage);

Default Value

"/sp/logout"

Remarks

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

MetadataURL Property (SAMLSPServer Class)

The SP's metadata location.

Syntax

public String getMetadataURL();


public void setMetadataURL(String metadataURL);

Default Value

"/sp/metadata"

Remarks

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

MetaSigningCertificate Property (SAMLSPServer Class)

Specifies the metadata signing certificate.

Syntax

public Certificate getMetaSigningCertificate();


public void setMetaSigningCertificate(Certificate metaSigningCertificate);

Remarks

Use this property to specify the certificate to be used to sign the SP's metadata. This certificate should have a private key associated with it.

This property is not available at design time.

OfflineMode Property (SAMLSPServer Class)

Enables the Offline mode.

Syntax

public boolean isOfflineMode();


public void setOfflineMode(boolean offlineMode);

Default Value

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

Port Property (SAMLSPServer Class)

Specifies the listening port number.

Syntax

public int getPort();


public void setPort(int port);

Default Value

80

Remarks

Use this property to specify the port number on which the SP server should listen for incoming connections. To specify the server's IP address use Host.

PreferredIDPToSPBinding Property (SAMLSPServer Class)

Specifies the preferred IdP to SP binding.

Syntax

public int getPreferredIDPToSPBinding();


public void setPreferredIDPToSPBinding(int preferredIDPToSPBinding);


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

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

ProtectedResources Property (SAMLSPServer Class)

Specifies the list of protected resources.

Syntax

public String getProtectedResources();


public void setProtectedResources(String protectedResources);

Default Value

""

Remarks

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

RedirectOnLogoutPage Property (SAMLSPServer Class)

Specifies the location to redirect the user on logout.

Syntax

public String getRedirectOnLogoutPage();


public void setRedirectOnLogoutPage(String redirectOnLogoutPage);

Default Value

"https://secureblackbox.com"

Remarks

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

ServerCertificates Property (SAMLSPServer 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.

SigCanonicalizationMethod Property (SAMLSPServer 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 (SAMLSPServer 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 (SAMLSPServer 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.

SignArtifactResolveRequests Property (SAMLSPServer Class)

Specifies whether to sign artifact resolution requests.

Syntax

public boolean isSignArtifactResolveRequests();


public void setSignArtifactResolveRequests(boolean signArtifactResolveRequests);

Default Value

False

Remarks

Set this property to true to enable signing of artifact resolution requests.

SignAuthnRequests Property (SAMLSPServer Class)

Specifies whether to sign Authn requests.

Syntax

public boolean isSignAuthnRequests();


public void setSignAuthnRequests(boolean signAuthnRequests);

Default Value

False

Remarks

Set this property to true to enable signing of Authn requests.

SigningCertificate Property (SAMLSPServer Class)

The certificate for signing the SP requests.

Syntax

public Certificate getSigningCertificate();


public void setSigningCertificate(Certificate signingCertificate);

Remarks

Use this property to designate a certificate for signing the SP requests. The provided certificate must have a private key associated with it.

This property is not available at design time.

SigningChain Property (SAMLSPServer Class)

The signing certificate chain.

Syntax

public CertificateList getSigningChain();


public void setSigningChain(CertificateList signingChain);

Remarks

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

This property is not available at design time.

SignLogoutRequests Property (SAMLSPServer Class)

Specifies whether to sign Logout requests.

Syntax

public boolean isSignLogoutRequests();


public void setSignLogoutRequests(boolean signLogoutRequests);

Default Value

False

Remarks

Set this property to true to enable signing of logout requests.

SignMetadata Property (SAMLSPServer Class)

Specifies whether to sign the metadata.

Syntax

public boolean isSignMetadata();


public void setSignMetadata(boolean signMetadata);

Default Value

False

Remarks

Set this property to True to enforce signing of the metadata before saving it. Do not forget to assign the signing certificate to the MetaSigningCertificate property.

SingleLogoutService Property (SAMLSPServer Class)

The URL of the single logout service.

Syntax

public String getSingleLogoutService();


public void setSingleLogoutService(String singleLogoutService);

Default Value

"/sp/SingleLogoutService"

Remarks

Use this property to specify the relative URL of the single logout service.

SingleLogoutServiceBindings Property (SAMLSPServer 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.

SocketSettings Property (SAMLSPServer Class)

Manages network connection settings.

Syntax

public SocketSettings getSocketSettings();

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

SPToIDPBinding Property (SAMLSPServer Class)

Specifies the IdP to SP binding to use.

Syntax

public int getSPToIDPBinding();


public void setSPToIDPBinding(int SPToIDPBinding);


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

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

To specify the preferred binding, use PreferredIDPToSPBinding.

TLSSettings Property (SAMLSPServer Class)

Manages TLS layer settings.

Syntax

public TLSSettings getTLSSettings();

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

URL Property (SAMLSPServer Class)

Specifies the base URL of this SP server.

Syntax

public String getURL();


public void setURL(String URL);

Default Value

""

Remarks

Use this property to set the base URL for this Service Provider (SP) server.

Please make sure the URL you provide here aligns well with the relative endpoint resource paths, such as AssertionConsumerService or ArtifactResolutionService. The two parts (the URL and the endpoint paths) are concatenated to produce full endpoint URLs. Please double check that only one of the parts includes the slash character in it: either the endpoint paths at the beginning (the default configuration), or the base URL at the end.

Config Method (Samlspserver Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

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

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

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

DoAction Method (Samlspserver Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetClientBuffer Method (Samlspserver Class)

Obtains a pending connection buffer.

Syntax

public byte[] getClientBuffer(long connectionID);

Remarks

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

GetProviderProperty Method (Samlspserver Class)

Returns the value of a custom provider property.

Syntax

public String getProviderProperty(String name);

Remarks

This method, together with SetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

LoadIDPMetadata Method (Samlspserver Class)

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

Syntax

public void loadIDPMetadata(String fileName);

Remarks

The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from a file generated by an IdP.

FileName specifies the metadata file name.

LoadIDPMetadataFromStream Method (Samlspserver Class)

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

Syntax

public void loadIDPMetadataFromStream(java.io.InputStream stream);

Remarks

The Identity provider (IdP) may have different options and requirements for interactions with the Service Provider (SP). Usually all these options together with X.509 certificates needed for data exchange are stored as XML metadata. Use this method to load the metadata generated by the IdP from a stream.

Stream contains the metadata.

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

SaveMetadata Method (Samlspserver Class)

Saves the SP configuration to a metadata file.

Syntax

public void saveMetadata(String fileName);

Remarks

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

SaveMetadataToStream Method (Samlspserver Class)

Saves the SP configuration to a metadata file.

Syntax

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

Remarks

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

SetClientBuffer Method (Samlspserver Class)

Commits a data buffer to the connection.

Syntax

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

Remarks

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

SetProviderProperty Method (Samlspserver Class)

Sets the value of a custom provider property.

Syntax

public void setProviderProperty(String name, String value);

Remarks

This method, together with GetProviderProperty, provides an extensible way of managing the Service Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

Start Method (Samlspserver Class)

Starts the SP server.

Syntax

public void start();

Remarks

Use this method to start listening for incoming connections.

Stop Method (Samlspserver Class)

Stops the IdP server.

Syntax

public void stop();

Remarks

Call this method to stop listening for incoming connections.

Accept Event (Samlspserver Class)

Reports an incoming connection.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void accept(SamlspserverAcceptEvent e) {}
  ...
}

public class SamlspserverAcceptEvent {
  public String remoteAddress;
  public int remotePort;
  public boolean accept;
}

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

Notifies the application about the creation of a new assertion.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void assertionCreated(SamlspserverAssertionCreatedEvent e) {}
  ...
}

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

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

Notifies the user code about the receipt of an assertion.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void assertionReceived(SamlspserverAssertionReceivedEvent e) {}
  ...
}

public class SamlspserverAssertionReceivedEvent {
  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 (Samlspserver Class)

Reports an accepted connection.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void connect(SamlspserverConnectEvent e) {}
  ...
}

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

Remarks

The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as SessionClosed or SessionEstablished.

Disconnect Event (Samlspserver Class)

Fires to report a disconnected client.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void disconnect(SamlspserverDisconnectEvent e) {}
  ...
}

public class SamlspserverDisconnectEvent {
  public long connectionID;
}

Remarks

The class fires this event when a connected client disconnects.

Error Event (Samlspserver Class)

Information about errors during data delivery.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void error(SamlspserverErrorEvent e) {}
  ...
}

public class SamlspserverErrorEvent {
  public 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 (Samlspserver Class)

Handles remote or external signing initiated by the server protocol.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void externalSign(SamlspserverExternalSignEvent e) {}
  ...
}

public class SamlspserverExternalSignEvent {
  public long connectionID;
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData;
}

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:

 
 Copy
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 (Samlspserver Class)

Notifies the application about the metadata request.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void metadataRequest(SamlspserverMetadataRequestEvent e) {}
  ...
}

public class SamlspserverMetadataRequestEvent {
  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 (Samlspserver Class)

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

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void notification(SamlspserverNotificationEvent e) {}
  ...
}

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

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

ResourceClose Event (Samlspserver Class)

Tells the application that it can close the opened resource.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void resourceClose(SamlspserverResourceCloseEvent e) {}
  ...
}

public class SamlspserverResourceCloseEvent {
  public long connectionID;
}

Remarks

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

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

ResourceOpen Event (Samlspserver Class)

Requests the application to open the requested resource.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void resourceOpen(SamlspserverResourceOpenEvent e) {}
  ...
}

public class SamlspserverResourceOpenEvent {
  public long connectionID;
  public String URL;
  public int operationStatus;
}

Remarks

The class fires this event in virtualized mode if the application had returned the fraCustom modifier from the earlier ResourceRequest event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent ResourceRead event calls. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ResourceRead Event (Samlspserver Class)

Requests the application to read from an opened resource.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void resourceRead(SamlspserverResourceReadEvent e) {}
  ...
}

public class SamlspserverResourceReadEvent {
  public long connectionID;
  public int size;
  public int operationStatus;
}

Remarks

The class fires this event in virtualized mode to request another chunk of data from the resource opened earlier. The handler of this event should read up to Size bytes from the object, and pass them to the component with a SetClientBuffer call.

Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ResourceRead calls are needed.

Set OperationStatus to one of the following values:

ResourceRequest Event (Samlspserver Class)

Notifies the application that a server resource is requested.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void resourceRequest(SamlspserverResourceRequestEvent e) {}
  ...
}

public class SamlspserverResourceRequestEvent {
  public long connectionID;
  public String URL;
  public boolean resProtected;
  public boolean resSpecial;
  public int action;
}

Remarks

The class uses this event to notify the application that the connection has requested a server resource.

The URL parameter specifies the resource requested. ResProtected is set to true if the resource is protected by SAML. ResSpecial is set to true if the request is a SAML resource, such as the metadata or an Assertion Consumer Service page. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request).

Choose Action as one of the following values:

SessionClosed Event (Samlspserver Class)

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

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void sessionClosed(SamlspserverSessionClosedEvent e) {}
  ...
}

public class SamlspserverSessionClosedEvent {
  public long connectionID;
}

Remarks

ConnectionID contains the identifier of the closed session.

SessionEstablished Event (Samlspserver Class)

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

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void sessionEstablished(SamlspserverSessionEstablishedEvent e) {}
  ...
}

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

Remarks

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

SessionStageChanged Event (Samlspserver Class)

Notifies the application about the change of SAML session stage.

Syntax

public class DefaultSamlspserverEventListener implements SamlspserverEventListener {
  ...
  public void sessionStageChanged(SamlspserverSessionStageChangedEvent e) {}
  ...
}

public class SamlspserverSessionStageChangedEvent {
  public long connectionID;
  public String session;
  public String stage;
}

Remarks

class uses this method to notify your code about changed SAML session stage. The Session parameter specifies the session ID. The Stage parameter can take one of the following values:

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

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

 
 Copy
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";

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

SAMLSPServer Config Settings

Base Config Settings

Trappable Errors (Samlspserver Class)

SAMLSPServer Errors