SAMLSPServer Component

Properties   Methods   Events   Config Settings   Errors  

The SAMLSPServer component represents a SAML service provider.

Syntax

TsbxSAMLSPServer

Remarks

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

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

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

• Register the IdP metadata using the ImportSettings method. Most IDPs let you download their metadata in XML format. The metadata file contains general parameters of the IdP endpoint, such as its web address and algorithm requirements. server.ImportSettings(metadataBytes, false); // contains "<?xml version="1.0"?><md:EntityDescriptor ID="ab12" ... </md:EntityDescriptor>";
• Configure the main server capabilities: // public server endpoint (use "https://" and/or port 443 if required) server.URL = "http://sp.myapp.com"; server.Port = 80; // IdP triggers this URL to pull metadata server.MetadataURL = '/sp/metadata'; // ACS is th "main" SP endpoint that receives assertions from the IdP server.AssertionConsumerService = '/sp/AssertionConsumerService'; server.SPToIDPBinding = csbtRedirect; // the SP will use HTTP redirect to forward the browser to the IdP when required server.AssertionConsumerServiceBindings = 'POST'; // and we want the IdP to use POST to submit its assertions server.PreferredIDPToSPBinding = csbtPOST; // Single logout service setup server.SingleLogoutService = '/sp/SingleLogoutService'; server.SingleLogoutServiceBindings = 'Redirect,POST,Artifact'; server.LogoutPage = '/sp/logout'; server.RedirectOnLogoutPage = 'https://www.nsoftware.com'; // The document root of the server on the local system server.BaseDir = "D:\\Inetpub\\SAMLSP"; // Security parameters: indicating that we want to sign both // the metadata and the requests server.SignAuthnRequests = true; server.SignMetadata = true; // We need to attach certificates to be able to sign. // Assume we have loaded our signing certificate into // a CertificateManager object. server.SigningCertificate = mgr.Certificate; server.MetaSigningCertificate = mgr.Certificate;
• Personalize the server: server.Config("OrganizationName=My Organization Ltd"); server.Config("OrganizationDisplayName=My Organization Pet Supplies"); server.Config("OrganizationURL=http://myorg.com"); server.Config("SigDigestMethod=http://www.w3.org/2001/04/xmlenc#sha256"); server.Config("SigMethod=http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); server.Config("WantAssertionsSigned=true");
• Optionally, save metadata to an XML file. This will let you send/upload it to the IdP, so they could set your SP up. Some IdPs can download the metadata right from your SP using the MetadataURL that you've provided above, in which case saving it to a file is not necessary. server.SaveMetadata("my_metadata.xml");

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

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

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

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

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Active Property (SAMLSPServer Component)

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

Syntax

property Active: Boolean read get_Active;

Default Value

false

Remarks

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

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

BaseDir Property (SAMLSPServer Component)

Base directory on the server.

Syntax

property BaseDir: String read get_BaseDir write set_BaseDir;

Default Value

''

Remarks

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

BindingKey Property (SAMLSPServer Component)

Contains a private key to sign the redirect binding requests.

Syntax

property BindingKey: TsbxCryptoKey read get_BindingKey write set_BindingKey;

Remarks

Use this property to set the signing key for the redirect binding object. This is used to sign the content of the redirect binding.

Note that when using the redirect binding, the outgoing SAML message must not be signed in parallel with a certificate. Any assertions may still be signed.

This property is not available at design time.

DecryptionCertificate Property (SAMLSPServer Component)

The certificate to be used to decrypt assertions.

Syntax

property DecryptionCertificate: TsbxCertificate read get_DecryptionCertificate write set_DecryptionCertificate;

Remarks

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

This property is not available at design time.

ExternalCrypto Property (SAMLSPServer Component)

Provides access to external signing and DC parameters.

Syntax

property ExternalCrypto: TsbxExternalCrypto read get_ExternalCrypto;

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

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

HandshakeTimeout Property (SAMLSPServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

property HandshakeTimeout: Integer read get_HandshakeTimeout write set_HandshakeTimeout;

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (SAMLSPServer Component)

Specifies the host address of the SP server.

Syntax

property Host: String read get_Host write set_Host;

Default Value

''

Remarks

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

IdPServices Property (SAMLSPServer Component)

Populates a list of services supported by the IdP.

Syntax

property IdPServices: TsbxSAMLServiceInfoList read get_IdPServices;

Remarks

Use this property to access the list of services supported by the IdP. In the SAMLIdPServer, this is the list of services supported by the IdP. In the SAMLSPServer, this is the list of services advertised by the remote IdP server. These can be loaded from the respective IdP's metadata or set manually via AddIdPService method.

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

IdPSettings Property (SAMLSPServer Component)

Populates a list of SAML IdP entity settings.

Syntax

property IdPSettings: TsbxSAMLEntity read get_IdPSettings;

Remarks

Use this property to get or set properties of a SAML IdP entity. These properties can be adjusted manually or loaded from the respective metadata file.

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

Issuer Property (SAMLSPServer Component)

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

Syntax

property Issuer: String read get_Issuer write set_Issuer;

Default Value

''

Remarks

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

KnownCertificates Property (SAMLSPServer Component)

Additional certificates for chain validation.

Syntax

property KnownCertificates: TsbxCertificateList read get_KnownCertificates write set_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 component manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

This property is not available at design time.

KnownKeys Property (SAMLSPServer Component)

Public keys for low-level signature validation.

Syntax

property KnownKeys: TsbxCryptoKeyList read get_KnownKeys write set_KnownKeys;

Remarks

Use this property to supply a list of public keys that might be needed for redirect binding signature validation.

This property is not available at design time.

LogoutPage Property (SAMLSPServer Component)

Specifies the location of the logout page.

Syntax

property LogoutPage: String read get_LogoutPage write set_LogoutPage;

Default Value

'/sp/logout'

Remarks

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

MetadataURL Property (SAMLSPServer Component)

The SP's metadata location.

Syntax

property MetadataURL: String read get_MetadataURL write set_MetadataURL;

Default Value

'/sp/metadata'

Remarks

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

MetaSigningCertificate Property (SAMLSPServer Component)

Specifies the metadata signing certificate.

Syntax

property MetaSigningCertificate: TsbxCertificate read get_MetaSigningCertificate write set_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 Component)

Enables the Offline mode.

Syntax

property OfflineMode: Boolean read get_OfflineMode write set_OfflineMode;

Default Value

true

Remarks

In the Offline mode the server does not open the listening port. Instead, it expects all incoming requests to be relayed by the application via calls to ProcessAssertion, ProcessLogoutRequest ProcessArtifactResolveRequest, and other similar methods.

The Offline mode is a handy mechanism for attaching the server to external web engines, such as IIS or Tomcat. It lets you leave the HTTP matters to the engine, and only be responsible for handling the actual SAML traffic.

PinnedClient Property (SAMLSPServer Component)

Populates the pinned client details.

Syntax

property PinnedClient: TsbxTLSConnectionInfo read get_PinnedClient;

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

PinnedClientChain Property (SAMLSPServer Component)

Contains the certificate chain of the pinned client.

Syntax

property PinnedClientChain: TsbxCertificateList read get_PinnedClientChain;

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

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

Port Property (SAMLSPServer Component)

Specifies the listening port number.

Syntax

property Port: Integer read get_Port write set_Port;

Default Value

80

Remarks

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

ProtectedResources Property (SAMLSPServer Component)

Specifies the list of protected resources.

Syntax

property ProtectedResources: String read get_ProtectedResources write set_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 Component)

Specifies the location to redirect the user on logout.

Syntax

property RedirectOnLogoutPage: String read get_RedirectOnLogoutPage write set_RedirectOnLogoutPage;

Default Value

'https://nsoftware.com'

Remarks

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

Security Property (SAMLSPServer Component)

Provides access to the SAML security properties.

Syntax

property Security: TsbxSAMLSecuritySettings read get_Security;

Remarks

Use this property to access the security parameters of the server.

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

SenderChain Property (SAMLSPServer Component)

Contains the certificate chain of the message sender.

Syntax

property SenderChain: TsbxCertificateList read get_SenderChain;

Remarks

Use this property to access the certificate chain of the creator of the signed message or entity that is currently being processed. This property is only available from SignatureFound and SignatureValidated events.

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

SigningCertificate Property (SAMLSPServer Component)

The certificate for signing the SP requests.

Syntax

property SigningCertificate: TsbxCertificate read get_SigningCertificate write set_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 Component)

The signing certificate chain.

Syntax

property SigningChain: TsbxCertificateList read get_SigningChain write set_SigningChain;

Remarks

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

This property is not available at design time.

SocketSettings Property (SAMLSPServer Component)

Manages network connection settings.

Syntax

property SocketSettings: TsbxSocketSettings read get_SocketSettings;

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

SPServices Property (SAMLSPServer Component)

Populates a list of services supported by the SP.

Syntax

property SPServices: TsbxSAMLServiceInfoList read get_SPServices;

Remarks

Use this property to access the list of services supported by the SP. In the SAMLSPServer, this is the list of services supported by the SP. In the SAMLIdPServer, this is the list of services advertised by the remote SP server. These can be loaded from the respective SP's metadata or set manually via AddSPService method.

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

SPSettings Property (SAMLSPServer Component)

Populates a list of SAML SP entity settings.

Syntax

property SPSettings: TsbxSAMLEntity read get_SPSettings;

Remarks

Use this property to get or set properties of a SAML SP entity. These properties can be adjusted manually or loaded from the respective metadata file.

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

TLSServerChain Property (SAMLSPServer Component)

The server's TLS certificates.

Syntax

property TLSServerChain: TsbxCertificateList read get_TLSServerChain write set_TLSServerChain;

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

TLSSettings Property (SAMLSPServer Component)

Manages TLS layer settings.

Syntax

property TLSSettings: TsbxTLSSettings read get_TLSSettings;

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

URL Property (SAMLSPServer Component)

Specifies the base URL of this SP server.

Syntax

property URL: String read get_URL write set_URL;

Default Value

''

Remarks

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

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

AddIdPService Method (SAMLSPServer Component)

Registers an IdP service in the IdPServices list.

Syntax

procedure AddIdPService(Service: Integer; BindingType: Integer; Location: String; Priority: Integer; Index: Integer);

Remarks

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

AddSPService Method (SAMLSPServer Component)

Registers an SP service in the SPServices list.

Syntax

procedure AddSPService(Service: Integer; BindingType: Integer; Location: String; Priority: Integer; Index: Integer);

Remarks

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

Config Method (SAMLSPServer Component)

This method sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

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

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

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

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

DoAction Method (SAMLSPServer Component)

Performs an additional action.

Syntax

function DoAction(ActionID: String; ActionParams: String): String;

Remarks

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

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

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

DropClient Method (SAMLSPServer Component)

Terminates a client connection.

Syntax

procedure DropClient(ConnectionId: Int64; Forced: Boolean);

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

ExportSettings Method (SAMLSPServer Component)

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

Syntax

function ExportSettings(SP: Boolean): String;

Remarks

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

Adjust the provider configuration as required in SPSettings or IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.

GetProviderProperty Method (SAMLSPServer Component)

Returns the value of a custom provider property.

Syntax

function GetProviderProperty(Name: String): String;

Remarks

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

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

GetRequestBytes Method (SAMLSPServer Component)

Obtains a pending connection buffer.

Syntax

function GetRequestBytes(ConnectionID: Int64; RequestFilter: String): TBytes;

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. TBD: Possibly rename to GetRequestBytes (and align with declaration in HTTPServer)

GetRequestHeader Method (SAMLSPServer Component)

Returns a request header value.

Syntax

function GetRequestHeader(ConnectionId: Int64; HeaderName: String): String;

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

GetResponseHeader Method (SAMLSPServer Component)

Returns a response header value.

Syntax

function GetResponseHeader(ConnectionId: Int64; HeaderName: String): String;

Remarks

Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.

GetSessionProperty Method (SAMLSPServer Component)

Returns the value of a custom session property.

Syntax

function GetSessionProperty(SessionID: String; Name: String): String;

Remarks

This method, together with SetSessionProperty, provides an extensible way of managing the Service Provider's session properties that are not available through the primary properties and events of the component.

TBD:

ImportSettings Method (SAMLSPServer Component)

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

Syntax

procedure ImportSettings(Metadata: String; SP: Boolean);

Remarks

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

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

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

InitiateArtifactResolve Method (SAMLSPServer Component)

TBD.

Syntax

function InitiateArtifactResolve(ConnectionID: Int64; SessionID: String; IdPServiceIndex: Integer; Artifact: String; Tag: String): Integer;

Remarks

You can use this method with or without the OfflineMode.

InitiateAttributeQuery Method (SAMLSPServer Component)

TBD.

Syntax

function InitiateAttributeQuery(ConnectionID: Int64; SessionID: String; IdPServiceIndex: Integer; Attributes: String; Tag: String): Integer;

Remarks

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

You can use this method with or without the OfflineMode.

InitiateAuth Method (SAMLSPServer Component)

Starts SP-initiated SAML authentication flow.

Syntax

function InitiateAuth(ConnectionID: Int64; SessionID: String; IdPServiceIndex: Integer; RelayState: String; Tag: String): Integer;

Remarks

Use this method to initiate SAML authentication flow on the SP side. Pass the index of the single sign-on service that you want to use to the IdPServiceIndex parameter. Leave it empty to let the component pick up the best one automatically. Use RelayState to pass the callback URL to the IdP service. This will be mirrored back by the IDP in its response.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

InitiateLogout Method (SAMLSPServer Component)

Starts SP-initiated SAML logout flow.

Syntax

function InitiateLogout(ConnectionID: Int64; SessionID: String; IdPServiceIndex: Integer; NameID: String; RelayState: String; Tag: String): Integer;

Remarks

Use this method to initiate SAML logout flow on the SP side. Pass the index of the single logout service that you want to use to the IdPServiceIndex parameter.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

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

ListClients Method (SAMLSPServer Component)

Enumerates the connected clients.

Syntax

function ListClients(): String;

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (SAMLSPServer Component)

Takes a snapshot of the connection's properties.

Syntax

procedure PinClient(ConnectionId: Int64);

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

ProcessArtifactResolveRequest Method (SAMLSPServer Component)

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

Syntax

function ProcessArtifactResolveRequest(ConnectionID: Int64; SessionID: String; Request: String; Tag: String): Integer;

Remarks

Use this method to pass a SAML artifact request received at one of the ArtifactResolutionService endpoints.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

ProcessAssertion Method (SAMLSPServer Component)

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

Syntax

function ProcessAssertion(ConnectionID: Int64; SessionID: String; Request: String; Tag: String): Integer;

Remarks

Use this method to pass a SAML assertion received at one of the AssertionConsumerService endpoints.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

ProcessGenericRequest Method (SAMLSPServer Component)

Processes a generic HTTP SAML request.

Syntax

function ProcessGenericRequest(ConnectionID: Int64; SessionID: String; URL: String; HttpMethod: String; Request: String; Tag: String): Integer;

Remarks

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

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

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

ProcessLogoutRequest Method (SAMLSPServer Component)

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

Syntax

function ProcessLogoutRequest(ConnectionID: Int64; SessionID: String; Request: String; Tag: String): Integer;

Remarks

Use this method to pass a SAML logout request received at one of the SingleLogoutService endpoints.

An SLS endpoint may receive requests of two kinds: LogoutRequest and LogoutResponse. If Request contains a LogoutRequest, the content generated by this method will contain a corresponding LogoutResponse. If Request contains a LogoutResponse, the generated content is empty.

This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.

You can use this method with or without the OfflineMode.

Reset Method (SAMLSPServer Component)

Resets the component settings.

Syntax

procedure Reset();

Remarks

Reset is a generic method available in every component.

SetClientBuffer Method (SAMLSPServer Component)

Commits a data buffer to the connection.

Syntax

procedure SetClientBuffer(ConnectionID: Int64; Value: TBytes);

Remarks

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

SetProviderProperty Method (SAMLSPServer Component)

Sets the value of a custom provider property.

Syntax

procedure SetProviderProperty(Name: String; Value: String);

Remarks

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

The following properties are currently supported:

• ContactPerson
• OrganizationName
• OrganizationDisplayName
• OrganizationURL
• OrganizationLang

SetResponseHeader Method (SAMLSPServer Component)

Sets a response header.

Syntax

function SetResponseHeader(ConnectionId: Int64; HeaderName: String; Value: String): Boolean;

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest.

SetSessionProperty Method (SAMLSPServer Component)

Sets the value of a custom provider session property.

Syntax

procedure SetSessionProperty(SessionID: String; Name: String; Value: String);

Remarks

This method, together with GetSessionProperty, provides an extensible way of managing the Service Provider's session settings that are not available through the primary properties and events of the component.

TBD:

Start Method (SAMLSPServer Component)

Starts the SP server.

Syntax

procedure Start();

Remarks

Use this method to start listening for incoming connections.

Stop Method (SAMLSPServer Component)

Stops the IdP server.

Syntax

procedure Stop();

Remarks

Call this method to stop listening for incoming connections.

Accept Event (SAMLSPServer Component)

Reports an incoming connection.

Syntax

type TAcceptEvent = procedure (
  Sender: TObject;
  const RemoteAddress: String;
  RemotePort: Integer;
  var Accept: Boolean
) of Object;

property OnAccept: TAcceptEvent read FOnAccept write FOnAccept;

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

ArtifactResolveRequestPrepared Event (SAMLSPServer Component)

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

Syntax

type TArtifactResolveRequestPreparedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  const Artifact: String
) of Object;

property OnArtifactResolveRequestPrepared: TArtifactResolveRequestPreparedEvent read FOnArtifactResolveRequestPrepared write FOnArtifactResolveRequestPrepared;

Remarks

TBD

ArtifactResolveRequestReceived Event (SAMLSPServer Component)

TBD.

Syntax

type TArtifactResolveRequestReceivedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  IsEncrypted: Boolean;
  IsSigned: Boolean;
  const Artifact: String;
  var Action: Integer
) of Object;

property OnArtifactResolveRequestReceived: TArtifactResolveRequestReceivedEvent read FOnArtifactResolveRequestReceived write FOnArtifactResolveRequestReceived;

Remarks

AssertionReceived Event (SAMLSPServer Component)

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

Syntax

type TAssertionReceivedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  const Body: String;
  IsEncrypted: Boolean;
  IsSigned: Boolean;
  const Auth: String;
  const NameID: String;
  const NameIDFormat: String;
  const SessionIndex: String;
  const ValidFrom: String;
  const ValidTo: String;
  const RelayState: String;
  var Action: Integer
) of Object;

property OnAssertionReceived: TAssertionReceivedEvent read FOnAssertionReceived write FOnAssertionReceived;

Remarks

The AssertionReceived event notifies the application that an assertion has been received at the ACS endpoint. In OfflineMode this event may fire in response to a ProcessAssertion call. In online mode it can fire at any time while the server is active.

The ConnectionID and SessionID specify the IDs of the current client connection and HTTP session. The RequestID contains the ID of the original AuthnRequest message, if it was sent by the service provider. The IsEncrypted and IsSigned parameters indicate the security properties of the assertion. The NameID parameter contains the unique name identifier of the authenticated principal, and the SessionIndex contains the SAML session identifier. In rare cases SessionIndex may contain multiple indices, if the SP has more than one session at the IdP. TBD: RelayState?

AttributeQueryPrepared Event (SAMLSPServer Component)

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

Syntax

type TAttributeQueryPreparedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  const Attributes: String
) of Object;

property OnAttributeQueryPrepared: TAttributeQueryPreparedEvent read FOnAttributeQueryPrepared write FOnAttributeQueryPrepared;

Remarks

TBD

AuthnRequestPrepared Event (SAMLSPServer Component)

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

Syntax

type TAuthnRequestPreparedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  ForceAuthn: Boolean;
  NonInteractive: Boolean;
  var RelayState: String
) of Object;

property OnAuthnRequestPrepared: TAuthnRequestPreparedEvent read FOnAuthnRequestPrepared write FOnAuthnRequestPrepared;

Remarks

TBD

Connect Event (SAMLSPServer Component)

Reports an accepted connection.

Syntax

type TConnectEvent = procedure (
  Sender: TObject;
  ConnectionId: Int64;
  const RemoteAddress: String;
  RemotePort: Integer
) of Object;

property OnConnect: TConnectEvent read FOnConnect write FOnConnect;

Remarks

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

Disconnect Event (SAMLSPServer Component)

Fires to report a disconnected client.

Syntax

type TDisconnectEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnDisconnect: TDisconnectEvent read FOnDisconnect write FOnDisconnect;

Remarks

The component fires this event when a connected client disconnects.

Encrypted Event (SAMLSPServer Component)

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

Syntax

type TEncryptedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  const IssuerRDN: String;
  const SerialNumber: TBytes;
  const SubjectKeyID: TBytes;
  NeedCredential: Boolean;
  var SkipThis: Boolean
) of Object;

property OnEncrypted: TEncryptedEvent read FOnEncrypted write FOnEncrypted;

Remarks

The component fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.

This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the DecryptionCertificate property (depending on encryption method used), or sets SkipThis to true.

The IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own OnEncrypted event loop.

The NeedCredential parameter specifies whether the correct credential is already available to the component or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the DecryptionCertificate property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.

Error Event (SAMLSPServer Component)

Information about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  ErrorCode: Integer;
  Fatal: Boolean;
  Remote: Boolean;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the section.

ExternalSign Event (SAMLSPServer Component)

Handles remote or external signing initiated by the server protocol.

Syntax

type TExternalSignEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const OperationId: String;
  const HashAlgorithm: String;
  const Pars: String;
  const Data: String;
  var SignedData: String
) of Object;

property OnExternalSign: TExternalSignEvent read FOnExternalSign write FOnExternalSign;

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via the SignedData parameter.

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

The component uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

LogoutRequestPrepared Event (SAMLSPServer Component)

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

Syntax

type TLogoutRequestPreparedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  const NameID: String;
  var RelayState: String
) of Object;

property OnLogoutRequestPrepared: TLogoutRequestPreparedEvent read FOnLogoutRequestPrepared write FOnLogoutRequestPrepared;

Remarks

TBD

LogoutRequestReceived Event (SAMLSPServer Component)

TBD.

Syntax

type TLogoutRequestReceivedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  IsEncrypted: Boolean;
  IsSigned: Boolean;
  const NameID: String;
  const RelayState: String;
  var Action: Integer
) of Object;

property OnLogoutRequestReceived: TLogoutRequestReceivedEvent read FOnLogoutRequestReceived write FOnLogoutRequestReceived;

Remarks

LogoutResponseReceived Event (SAMLSPServer Component)

TBD.

Syntax

type TLogoutResponseReceivedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RequestID: String;
  IsEncrypted: Boolean;
  IsSigned: Boolean;
  const NameID: String;
  const RelayState: String
) of Object;

property OnLogoutResponseReceived: TLogoutResponseReceivedEvent read FOnLogoutResponseReceived write FOnLogoutResponseReceived;

Remarks

MetadataPrepared Event (SAMLSPServer Component)

Passes a prepared metadata object to the application.

Syntax

type TMetadataPreparedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Metadata: String
) of Object;

property OnMetadataPrepared: TMetadataPreparedEvent read FOnMetadataPrepared write FOnMetadataPrepared;

Remarks

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

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

Notification Event (SAMLSPServer Component)

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

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;

Remarks

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

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

ProcessingCompleted Event (SAMLSPServer Component)

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

Syntax

type TProcessingCompletedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const Tag: String;
  ProcessingResult: Integer;
  const Response: String;
  Redirect: Boolean
) of Object;

property OnProcessingCompleted: TProcessingCompletedEvent read FOnProcessingCompleted write FOnProcessingCompleted;

Remarks

The component fires ProcessingCompleted to notify the application about completion of an earlier initiated processing operation. It is only fired in OfflineMode in response to calls such as ProcessAssertion, ProcessLogoutRequest, or similar. The main purpose of this event is to notify the application of the outcomes of the processing and return any prepared SAML entity for subsequent relay to the browser.

This event is fired strictly once for each Process* call, with the ConnectionID matching the value passed to the Process* method.

The SessionID parameter contains the identifier of the current virtual session. It may differ to the value passed to the Process* method if the session information was provided on the fly via the SessionInfoNeeded event. The ProcessingResult indicates the type of deliverable that was created during the processing (see below for possible values). The Response parameter contains the body of the deliverable. This can take one of the forms:

• a self-submitting form containing a SAML message.
• a redirect URL.
• a SOAP XML response.
• an empty string if ProcessingResult is set to sprSuccess.

The Redirect parameter indicates whether the value of Response should be passed to the browser within the 302 Location header, or as a document body.

ResourceClose Event (SAMLSPServer Component)

Tells the application that it can close the opened resource.

Syntax

type TResourceCloseEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String
) of Object;

property OnResourceClose: TResourceCloseEvent read FOnResourceClose write FOnResourceClose;

Remarks

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

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

ResourceOpen Event (SAMLSPServer Component)

Requests the application to open the requested resource.

Syntax

type TResourceOpenEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const URL: String;
  var OperationStatus: Integer
) of Object;

property OnResourceOpen: TResourceOpenEvent read FOnResourceOpen write FOnResourceOpen;

Remarks

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

ResourceRead Event (SAMLSPServer Component)

Requests the application to read from an opened resource.

Syntax

type TResourceReadEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  Size: Integer;
  var OperationStatus: Integer
) of Object;

property OnResourceRead: TResourceReadEvent read FOnResourceRead write FOnResourceRead;

Remarks

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

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

Set OperationStatus to one of the following values:

ResourceRequest Event (SAMLSPServer Component)

Notifies the application that a server resource is requested.

Syntax

type TResourceRequestEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const URL: String;
  const HttpMethod: String;
  var ResProtected: Boolean;
  var ResSpecial: Boolean;
  var Action: Integer
) of Object;

property OnResourceRequest: TResourceRequestEvent read FOnResourceRequest write FOnResourceRequest;

Remarks

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

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

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

Choose Action as one of the following values:

SAMLMessagePrepared Event (SAMLSPServer Component)

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

Syntax

type TSAMLMessagePreparedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const InResponseTo: String;
  const RequestBody: String;
  const MessageType: String;
  var MessageBody: String;
  var Success: Boolean
) of Object;

property OnSAMLMessagePrepared: TSAMLMessagePreparedEvent read FOnSAMLMessagePrepared write FOnSAMLMessagePrepared;

Remarks

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

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

SAMLMessageReceived Event (SAMLSPServer Component)

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

Syntax

type TSAMLMessageReceivedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const MessageType: String;
  const MessageID: String;
  const Issuer: String;
  const IssueInstant: String;
  const MessageBody: String;
  const RelayState: String;
  var Action: Integer
) of Object;

property OnSAMLMessageReceived: TSAMLMessageReceivedEvent read FOnSAMLMessageReceived write FOnSAMLMessageReceived;

Remarks

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

Set Action property in accordance with desired handling option. TBD TBD: consider adding Signed parameter, for redirect bindings and message-level signatures

SessionCreated Event (SAMLSPServer Component)

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

Syntax

type TSessionCreatedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String
) of Object;

property OnSessionCreated: TSessionCreatedEvent read FOnSessionCreated write FOnSessionCreated;

Remarks

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

SessionDestroyed Event (SAMLSPServer Component)

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

Syntax

type TSessionDestroyedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String
) of Object;

property OnSessionDestroyed: TSessionDestroyedEvent read FOnSessionDestroyed write FOnSessionDestroyed;

Remarks

ConnectionID contains the identifier of the closed session.

SessionEvent Event (SAMLSPServer Component)

Notifies the application about the change of SAML session stage.

Syntax

type TSessionEventEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const EventText: String
) of Object;

property OnSessionEvent: TSessionEventEvent read FOnSessionEvent write FOnSessionEvent;

Remarks

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

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

SessionInfoNeeded Event (SAMLSPServer Component)

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

Syntax

type TSessionInfoNeededEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var SessionID: String
) of Object;

property OnSessionInfoNeeded: TSessionInfoNeededEvent read FOnSessionInfoNeeded write FOnSessionInfoNeeded;

Remarks

TBD

SessionStateRetrieve Event (SAMLSPServer Component)

TBD.

Syntax

type TSessionStateRetrieveEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  var SessionState: String
) of Object;

property OnSessionStateRetrieve: TSessionStateRetrieveEvent read FOnSessionStateRetrieve write FOnSessionStateRetrieve;

Remarks

TBD

SessionStateSave Event (SAMLSPServer Component)

TBD.

Syntax

type TSessionStateSaveEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const SessionState: String
) of Object;

property OnSessionStateSave: TSessionStateSaveEvent read FOnSessionStateSave write FOnSessionStateSave;

Remarks

TBD

SignatureFound Event (SAMLSPServer Component)

Signifies the start of signature validation.

Syntax

type TSignatureFoundEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const MessageType: String;
  const MessageID: String;
  Scope: Integer;
  const IssuerRDN: String;
  const SerialNumber: TBytes;
  const SubjectKeyID: TBytes;
  const SigMethod: String;
  const DigestMethod: String;
  CertFound: Boolean;
  var Validate: Boolean
) of Object;

property OnSignatureFound: TSignatureFoundEvent read FOnSignatureFound write FOnSignatureFound;

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified message.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.

The details of the reported signature are populated in the Security object. For assertion signatures, you can update the details by pinning the assertion.

The CertFound is set to True if the component has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. SAMLReader only supports signature validation. To validate the chain, grab the signing certificate from the SigningCertificate property and the associated certificates from the Certificates collection, and pass them to the CertificateValidator component to validate its chain.

Use the Validate parameter to tell the reader whether it should validate the signature. TBD: consider adding EntityID parameter as in IDPServer

SignatureValidated Event (SAMLSPServer Component)

Reports the signature validation result.

Syntax

type TSignatureValidatedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const MessageType: String;
  const MessageID: String;
  Scope: Integer;
  const IssuerRDN: String;
  const SerialNumber: TBytes;
  const SubjectKeyID: TBytes;
  const SigMethod: String;
  const DigestMethod: String;
  var ValidationResult: Integer
) of Object;

property OnSignatureValidated: TSignatureValidatedEvent read FOnSignatureValidated write FOnSignatureValidated;

Remarks

This event is fired when the complete XML signature validation process is finished.

The Scope parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion.

TLSCertValidate Event (SAMLSPServer Component)

Fires when a client certificate needs to be validated.

Syntax

type TTLSCertValidateEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  var Accept: Boolean
) of Object;

property OnTLSCertValidate: TTLSCertValidateEvent read FOnTLSCertValidate write FOnTLSCertValidate;

Remarks

The component fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (SAMLSPServer Component)

Reports the setup of a TLS session.

Syntax

type TTLSEstablishedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnTLSEstablished: TTLSEstablishedEvent read FOnTLSEstablished write FOnTLSEstablished;

Remarks

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

TLSHandshake Event (SAMLSPServer Component)

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

Syntax

type TTLSHandshakeEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const ServerName: String;
  var Abort: Boolean
) of Object;

property OnTLSHandshake: TTLSHandshakeEvent read FOnTLSHandshake write FOnTLSHandshake;

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (SAMLSPServer Component)

Requests a pre-shared key for TLS-PSK.

Syntax

type TTLSPSKEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const Identity: String;
  var PSK: String;
  var Ciphersuite: String
) of Object;

property OnTLSPSK: TTLSPSKEvent read FOnTLSPSK write FOnTLSPSK;

Remarks

The component fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (SAMLSPServer Component)

Reports closure of a TLS session.

Syntax

type TTLSShutdownEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64
) of Object;

property OnTLSShutdown: TTLSShutdownEvent read FOnTLSShutdown write FOnTLSShutdown;

Remarks

The component fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

UserAuthCompleted Event (SAMLSPServer Component)

Notifies the application about the success of user authentication flow.

Syntax

type TUserAuthCompletedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const AssertionBody: String;
  const Auth: String;
  const NameID: String;
  const NameIDFormat: String;
  const SessionIndex: String;
  const ValidFrom: String;
  const ValidTo: String;
  const RelayState: String
) of Object;

property OnUserAuthCompleted: TUserAuthCompletedEvent read FOnUserAuthCompleted write FOnUserAuthCompleted;

Remarks

TBD

UserAuthFailed Event (SAMLSPServer Component)

Notifies the application about the failure of user authentication flow.

Syntax

type TUserAuthFailedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const RelayState: String
) of Object;

property OnUserAuthFailed: TUserAuthFailedEvent read FOnUserAuthFailed write FOnUserAuthFailed;

Remarks

TBD

UserAuthStart Event (SAMLSPServer Component)

Notifies the application about the start of user authentication flow.

Syntax

type TUserAuthStartEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  IdPServiceIndex: Integer;
  var RelayState: String
) of Object;

property OnUserAuthStart: TUserAuthStartEvent read FOnUserAuthStart write FOnUserAuthStart;

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

UserLogoutCompleted Event (SAMLSPServer Component)

Notifies the application about the completion of user logout flow.

Syntax

type TUserLogoutCompletedEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  const NameID: String;
  const RelayState: String
) of Object;

property OnUserLogoutCompleted: TUserLogoutCompletedEvent read FOnUserLogoutCompleted write FOnUserLogoutCompleted;

Remarks

TBD TODO: - session index?

UserLogoutStart Event (SAMLSPServer Component)

Notifies the application about the start of user logout flow.

Syntax

type TUserLogoutStartEvent = procedure (
  Sender: TObject;
  ConnectionID: Int64;
  const SessionID: String;
  IdPServiceIndex: Integer;
  const NameID: String;
  const SessionIndex: String;
  Secondary: Boolean;
  var RelayState: String
) of Object;

property OnUserLogoutStart: TUserLogoutStartEvent read FOnUserLogoutStart write FOnUserLogoutStart;

Remarks

TBD

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

>

constructor Create();

Creates a new object with default field values.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

>

constructor Create();

Creates an empty crypto key object.

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

>

constructor Create();

Creates a new ExternalCrypto object with default field values.

SAMLEntity Type

Represents SAML entity details.

Remarks

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

Fields

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

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

Constructors

>

constructor Create();

Creates a new SAMLEntity object.

SAMLSecuritySettings Type

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

Remarks

This type is a container for SAML security parameters.

Fields

Constructors

>

constructor Create();

Creates a new SAMLSecuritySettings object.

SAMLServiceInfo Type

Represents SAML service details.

Remarks

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

Fields

Constructors

>

constructor Create();

Creates a new SAMLServiceInfo object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

>

constructor Create();

Creates a new SocketSettings object.

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

>

constructor Create();

Creates a new TLSConnectionInfo 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

>

constructor Create();

Creates a new TLSSettings object.

Config Settings (SAMLSPServer Component)

SAMLSPServer Config Settings

Base Config Settings