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

You are now ready to start the server: server.Start(); The server should now be running on the local system, listening to incoming connections on the port that you have specified above (80). Use your browser to check if the server is responding by navigating to the metadata URL (http://127.0.0.1:80/sp/metadata). If the server has been set up right, you should see something like this:

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 bool Active = { read=FActive };

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.

Data Type

Boolean

BaseDir Property (SAMLSPServer Component)

Base directory on the server.

Syntax

__property String BaseDir = { read=FBaseDir, write=FSetBaseDir };

Default Value

""

Remarks

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

Data Type

String

DecryptionCertBytes Property (SAMLSPServer Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray DecryptionCertBytes = { read=FDecryptionCertBytes };

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

DecryptionCertHandle Property (SAMLSPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 DecryptionCertHandle = { read=FDecryptionCertHandle, write=FSetDecryptionCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

ExternalCryptoAsyncDocumentID Property (SAMLSPServer Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SAMLSPServer Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SAMLSPServer Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SAMLSPServer Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SAMLSPServer Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SAMLSPServer Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SAMLSPServer Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SAMLSPServer Component)

Specifies the asynchronous signing method.

Syntax

__property TsbxSAMLSPServerExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxSAMLSPServerExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (SAMLSPServer Component)

Specifies the external cryptography mode.

Syntax

__property TsbxSAMLSPServerExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxSAMLSPServerExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SAMLSPServer Component)

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

Default Value

""

Remarks

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (SAMLSPServer Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

Host Property (SAMLSPServer Component)

Specifies the host address of the SP server.

Syntax

__property String Host = { read=FHost, write=FSetHost };

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.

Data Type

String

IdPServiceCount Property (SAMLSPServer Component)

The number of records in the IdPService arrays.

Syntax

__property int IdPServiceCount = { read=FIdPServiceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• IdPServiceBindingType
• IdPServiceEntityID
• IdPServiceIndex
• IdPServiceLocation
• IdPServicePriority
• IdPServiceService

The array indices start at 0 and end at IdPServiceCount - 1.

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

Data Type

Integer

IdPServiceBindingType Property (SAMLSPServer Component)

Specifies the type of SAML binding that this endpoint accepts.

Syntax

__property TsbxSAMLSPServerIdPServiceBindingTypes IdPServiceBindingType[int IdPServiceIndex] = { read=FIdPServiceBindingType };

enum TsbxSAMLSPServerIdPServiceBindingTypes {
  csbtNone=0,
  csbtSOAP=1,
  csbtPAOS=2,
  csbtRedirect=3,
  csbtPOST=4,
  csbtArtifact=5
};

Default Value

csbtNone

Remarks

Specifies the type of SAML binding that this endpoint accepts.

Use this property to specify the binding type to use with this endpoint.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

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

Data Type

Integer

IdPServiceEntityID Property (SAMLSPServer Component)

Represents the SAML entity ID.

Syntax

__property String IdPServiceEntityID[int IdPServiceIndex] = { read=FIdPServiceEntityID };

Default Value

""

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

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

Data Type

String

IdPServiceIndex Property (SAMLSPServer Component)

The index of this endpoint.

Syntax

__property int IdPServiceIndex[int IdPServiceIndex] = { read=FIdPServiceIndex };

Default Value

0

Remarks

The index of this endpoint.

For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

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

Data Type

Integer

IdPServiceLocation Property (SAMLSPServer Component)

The location (URL) of the endpoint.

Syntax

__property String IdPServiceLocation[int IdPServiceIndex] = { read=FIdPServiceLocation };

Default Value

""

Remarks

The location (URL) of the endpoint.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

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

Data Type

String

IdPServicePriority Property (SAMLSPServer Component)

The priority of the endpoint in relation to other endpoints with the same Location .

Syntax

__property int IdPServicePriority[int IdPServiceIndex] = { read=FIdPServicePriority };

Default Value

-1

Remarks

The priority of the endpoint in relation to other endpoints with the same IdPLocation.

Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.

Leave all priorities at -1 to omit generation of the Default attribute.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

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

Data Type

Integer

IdPServiceService Property (SAMLSPServer Component)

The kind of the service being provided at this endpoint.

Syntax

__property int IdPServiceService[int IdPServiceIndex] = { read=FIdPServiceService };

Default Value

0

Remarks

The kind of the service being provided at this endpoint.

The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.

The IdPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the IdPServiceCount property.

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

Data Type

Integer

IdPContactPerson Property (SAMLSPServer Component)

The contact person or persons for the entity.

Syntax

__property String IdPContactPerson = { read=FIdPContactPerson, write=FSetIdPContactPerson };

Default Value

""

Remarks

The contact person or persons for the entity.

SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.

Each record contains a semicolon-separated list of contact person parameters, for example:

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

You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.

This property is not available at design time.

Data Type

String

IdPEncryptionKey Property (SAMLSPServer Component)

Contains the entity's encryption key.

Syntax

__property DynamicArray IdPEncryptionKey = { read=FIdPEncryptionKey, write=FSetIdPEncryptionKey };

Remarks

Contains the entity's encryption key.

This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).

Requests sent to the endpoint can be encrypted with the provided key or certificate.

This property is not available at design time.

Data Type

Byte Array

IdPEncryptionMethods Property (SAMLSPServer Component)

Specifies the list of encryption methods supported by the entity.

Syntax

__property String IdPEncryptionMethods = { read=FIdPEncryptionMethods, write=FSetIdPEncryptionMethods };

Default Value

""

Remarks

Specifies the list of encryption methods supported by the entity.

This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.

Examples of algorithms supported by this property:

• http://www.w3.org/2009/xmlenc11#aes128-gcm
• http://www.w3.org/2001/04/xmlenc#aes256-cbc

This property is not available at design time.

Data Type

String

IdPEntityID Property (SAMLSPServer Component)

Represents the SAML entity ID.

Syntax

__property String IdPEntityID = { read=FIdPEntityID, write=FSetIdPEntityID };

Default Value

""

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

This property is not available at design time.

Data Type

String

IdPFlags Property (SAMLSPServer Component)

Adjusts secondary entity properties.

Syntax

__property int IdPFlags = { read=FIdPFlags, write=FSetIdPFlags };

Default Value

0

Remarks

Adjusts secondary entity properties.

Use this bit mask property to adjust certain secondary settings. The following flags are supported:

• 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.

This property is not available at design time.

Data Type

Integer

IdPNameIDFormats Property (SAMLSPServer Component)

The list of NameID formats supported by this entity.

Syntax

__property String IdPNameIDFormats = { read=FIdPNameIDFormats, write=FSetIdPNameIDFormats };

Default Value

""

Remarks

The list of NameID formats supported by this entity.

Use this setting to get or set the list of NameID formats supported by the entity.

Use SAML notation for the formats:

• urn:oasis:names:tc:SAML:2.0:nameid-format:transient
• urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
• urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

This property is not available at design time.

Data Type

String

IdPOrganizationDisplayName Property (SAMLSPServer Component)

The friendly name of the organization that maintains the entity.

Syntax

__property String IdPOrganizationDisplayName = { read=FIdPOrganizationDisplayName, write=FSetIdPOrganizationDisplayName };

Default Value

""

Remarks

The friendly name of the organization that maintains the entity.

Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.

This property is not available at design time.

Data Type

String

IdPOrganizationLang Property (SAMLSPServer Component)

The language preferred by the organization.

Syntax

__property String IdPOrganizationLang = { read=FIdPOrganizationLang, write=FSetIdPOrganizationLang };

Default Value

""

Remarks

The language preferred by the organization.

This optional setting can be used to adjust the preferred language of the owning organization.

This property is not available at design time.

Data Type

String

IdPOrganizationName Property (SAMLSPServer Component)

The name of the organization that maintains the entity.

Syntax

__property String IdPOrganizationName = { read=FIdPOrganizationName, write=FSetIdPOrganizationName };

Default Value

""

Remarks

The name of the organization that maintains the entity.

Use this setting to get or set the name of the organization that maintains the SAML entity.

This property is not available at design time.

Data Type

String

IdPOrganizationURL Property (SAMLSPServer Component)

The web URL of the organization that maintains the entity.

Syntax

__property String IdPOrganizationURL = { read=FIdPOrganizationURL, write=FSetIdPOrganizationURL };

Default Value

""

Remarks

The web URL of the organization that maintains the entity.

Use this setting to get or set the web address of the organization responsible for this SAML entity.

This property is not available at design time.

Data Type

String

IdPSignatureValidationResult Property (SAMLSPServer Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxSAMLSPServerIdPSignatureValidationResults IdPSignatureValidationResult = { read=FIdPSignatureValidationResult };

enum TsbxSAMLSPServerIdPSignatureValidationResults {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4,
  svtReferenceCorrupted=5
};

Default Value

svtValid

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

Data Type

Integer

IdPSigned Property (SAMLSPServer Component)

Specifies whether the SAML entity information is or should be signed.

Syntax

__property bool IdPSigned = { read=FIdPSigned };

Default Value

false

Remarks

Specifies whether the SAML entity information is or should be signed.

Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.

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

Data Type

Boolean

IdPSignedWith Property (SAMLSPServer Component)

Contains the certificate or key that was used to sign the settings (metadata) document.

Syntax

__property DynamicArray IdPSignedWith = { read=FIdPSignedWith };

Remarks

Contains the certificate or key that was used to sign the settings (metadata) document.

This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.

The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the IdPSignatureValidationResult setting.

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

Data Type

Byte Array

IdPSigningKey Property (SAMLSPServer Component)

Contains the entity's signing key.

Syntax

__property DynamicArray IdPSigningKey = { read=FIdPSigningKey, write=FSetIdPSigningKey };

Remarks

Contains the entity's signing key.

This setting returns the public part of the entity's signing key. In most cases this is in the form of a DER-encoded X.509 certificate.

This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set SigningCertificate setting (for this-party settings).

Messages sent by the endpoint can be signed with the provided key or certificate.

This property is not available at design time.

Data Type

Byte Array

IdPValidUntil Property (SAMLSPServer Component)

Specifies the expiration time of the SAML entity information.

Syntax

__property String IdPValidUntil = { read=FIdPValidUntil, write=FSetIdPValidUntil };

Default Value

""

Remarks

Specifies the expiration time of the SAML entity information.

This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.

This property is not available at design time.

Data Type

String

Issuer Property (SAMLSPServer Component)

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

Syntax

__property String Issuer = { read=FIssuer, write=FSetIssuer };

Default Value

""

Remarks

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

Data Type

String

KnownCertCount Property (SAMLSPServer Component)

The number of records in the KnownCert arrays.

Syntax

__property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

The array indices start at 0 and end at KnownCertCount - 1.

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (SAMLSPServer Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray KnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes };

Remarks

Returns raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

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

Data Type

Byte Array

KnownCertHandle Property (SAMLSPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KnownCertHandle[int KnownCertIndex] = { read=FKnownCertHandle, write=FSetKnownCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

LogoutPage Property (SAMLSPServer Component)

Specifies the location of the logout page.

Syntax

__property String LogoutPage = { read=FLogoutPage, write=FSetLogoutPage };

Default Value

"/sp/logout"

Remarks

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

Data Type

String

MetadataURL Property (SAMLSPServer Component)

The SP's metadata location.

Syntax

__property String MetadataURL = { read=FMetadataURL, write=FSetMetadataURL };

Default Value

"/sp/metadata"

Remarks

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

Data Type

String

MetaSigningCertBytes Property (SAMLSPServer Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray MetaSigningCertBytes = { read=FMetaSigningCertBytes };

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

MetaSigningCertHandle Property (SAMLSPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 MetaSigningCertHandle = { read=FMetaSigningCertHandle, write=FSetMetaSigningCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

OfflineMode Property (SAMLSPServer Component)

Enables the Offline mode.

Syntax

__property bool OfflineMode = { read=FOfflineMode, write=FSetOfflineMode };

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.

Data Type

Boolean

Port Property (SAMLSPServer Component)

Specifies the listening port number.

Syntax

__property int Port = { read=FPort, write=FSetPort };

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.

Data Type

Integer

PreferredIDPToSPBinding Property (SAMLSPServer Component)

Specifies the preferred IdP to SP binding.

Syntax

__property TsbxSAMLSPServerPreferredIDPToSPBindings PreferredIDPToSPBinding = { read=FPreferredIDPToSPBinding, write=FSetPreferredIDPToSPBinding };

enum TsbxSAMLSPServerPreferredIDPToSPBindings {
  csbtNone=0,
  csbtSOAP=1,
  csbtPAOS=2,
  csbtRedirect=3,
  csbtPOST=4,
  csbtArtifact=5
};

Default Value

csbtPOST

Remarks

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

Data Type

Integer

ProtectedResources Property (SAMLSPServer Component)

Specifies the list of protected resources.

Syntax

__property String ProtectedResources = { read=FProtectedResources, write=FSetProtectedResources };

Default Value

""

Remarks

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

Data Type

String

RedirectOnLogoutPage Property (SAMLSPServer Component)

Specifies the location to redirect the user on logout.

Syntax

__property String RedirectOnLogoutPage = { read=FRedirectOnLogoutPage, write=FSetRedirectOnLogoutPage };

Default Value

"https://nsoftware.com"

Remarks

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

Data Type

String

SecurityCanonicalizationMethod Property (SAMLSPServer Component)

The canonicalization method to use in the signature.

Syntax

__property String SecurityCanonicalizationMethod = { read=FSecurityCanonicalizationMethod, write=FSetSecurityCanonicalizationMethod };

Default Value

""

Remarks

The canonicalization method to use in the signature.

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

This property is not available at design time.

Data Type

String

SecurityDigestMethod Property (SAMLSPServer Component)

The digest method to use.

Syntax

__property String SecurityDigestMethod = { read=FSecurityDigestMethod, write=FSetSecurityDigestMethod };

Default Value

""

Remarks

The digest method to use.

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

This property is not available at design time.

Data Type

String

SecurityEncryptionMethod Property (SAMLSPServer Component)

The encryption method used to encrypt the assertion.

Syntax

__property String SecurityEncryptionMethod = { read=FSecurityEncryptionMethod, write=FSetSecurityEncryptionMethod };

Default Value

"AES256"

Remarks

The encryption method used to encrypt the assertion.

This property contains the encryption algorithm used to encrypt the XML assertion.

Supported values:

This property is not available at design time.

Data Type

String

SecurityFlags Property (SAMLSPServer Component)

Provides access to secondary security parameters and tweaks.

Syntax

__property int SecurityFlags = { read=FSecurityFlags, write=FSetSecurityFlags };

Default Value

1

Remarks

Provides access to secondary security parameters and tweaks.

This property is a bitwise combination of zero or more flags. The following flags are currently supported:

• ssfSignatureAfterIssuer (0x00000001) - Signature after issuer
• ssfSignatureBeforeDescriptor (0x00000002) - Signature before descriptor
• ssfKeyDataIssuerSerial (0x00000004) - Include the IssuerSerial key data element
• ssfKeyDataSKI (0x00000008) - Include the SubjectKeyIdentifier key data element
• ssfKeyDataSubjectName (0x00000010) - Include the SubjectName key data element
• ssfKeyDataCertificate (0x00000020) - Include the Certificate key data element
• ssfKeyDataCRL (0x00000040) - Include the CRL key data element

TBD define enum

This property is not available at design time.

Data Type

Integer

SecuritySigMethod Property (SAMLSPServer Component)

The signature method to use.

Syntax

__property String SecuritySigMethod = { read=FSecuritySigMethod, write=FSetSecuritySigMethod };

Default Value

""

Remarks

The signature method to use.

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

This property is not available at design time.

Data Type

String

SenderCertCount Property (SAMLSPServer Component)

The number of records in the SenderChain arrays.

Syntax

__property int SenderCertCount = { read=FSenderCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SenderChainBytes
• SenderChainHandle

The array indices start at 0 and end at SenderCertCount - 1.

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

Data Type

Integer

SenderChainBytes Property (SAMLSPServer Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray SenderChainBytes[int SenderCertIndex] = { read=FSenderChainBytes };

Remarks

Returns raw certificate data in DER format.

The SenderCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.

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

Data Type

Byte Array

SenderChainHandle Property (SAMLSPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SenderChainHandle[int SenderCertIndex] = { read=FSenderChainHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SenderCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SenderCertCount property.

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

Data Type

Long64

SigningCertBytes Property (SAMLSPServer Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray SigningCertBytes = { read=FSigningCertBytes };

Remarks

Returns raw certificate data in DER format.

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

Data Type

Byte Array

SigningCertHandle Property (SAMLSPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SigningCertHandle = { read=FSigningCertHandle, write=FSetSigningCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SAMLSPServer Component)

The number of records in the SigningChain arrays.

Syntax

__property int SigningChainCount = { read=FSigningChainCount, write=FSetSigningChainCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

The array indices start at 0 and end at SigningChainCount - 1.

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SAMLSPServer Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray SigningChainBytes[int SigningChainIndex] = { read=FSigningChainBytes };

Remarks

Returns raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

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

Data Type

Byte Array

SigningChainHandle Property (SAMLSPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 SigningChainHandle[int SigningChainIndex] = { read=FSigningChainHandle, write=FSetSigningChainHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

SigningFlags Property (SAMLSPServer Component)

Adjusts signing behaviour.

Syntax

__property int SigningFlags = { read=FSigningFlags, write=FSetSigningFlags };

Default Value

0

Remarks

Use this bit mask property to adjust what entities are going to be signed by the server. The following flags are supported:

• 1 - ssfSignAuthnRequests - sign authentication requests
• 2 - ssfSignArtifactResolveRequests - sign artifact resolve requests
• 4 - ssfSignLogoutRequests - sign logout requests

Data Type

Integer

SocketIncomingSpeedLimit Property (SAMLSPServer Component)

The maximum number of bytes to read from the socket, per second.

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (SAMLSPServer Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SAMLSPServer Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SAMLSPServer Component)

The maximum number of bytes to write to the socket, per second.

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (SAMLSPServer Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (SAMLSPServer Component)

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SPServiceCount Property (SAMLSPServer Component)

The number of records in the SPService arrays.

Syntax

__property int SPServiceCount = { read=FSPServiceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SPServiceBindingType
• SPServiceEntityID
• SPServiceIndex
• SPServiceLocation
• SPServicePriority
• SPServiceService

The array indices start at 0 and end at SPServiceCount - 1.

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

Data Type

Integer

SPServiceBindingType Property (SAMLSPServer Component)

Specifies the type of SAML binding that this endpoint accepts.

Syntax

__property TsbxSAMLSPServerSPServiceBindingTypes SPServiceBindingType[int SPServiceIndex] = { read=FSPServiceBindingType };

enum TsbxSAMLSPServerSPServiceBindingTypes {
  csbtNone=0,
  csbtSOAP=1,
  csbtPAOS=2,
  csbtRedirect=3,
  csbtPOST=4,
  csbtArtifact=5
};

Default Value

csbtNone

Remarks

Specifies the type of SAML binding that this endpoint accepts.

Use this property to specify the binding type to use with this endpoint.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

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

Data Type

Integer

SPServiceEntityID Property (SAMLSPServer Component)

Represents the SAML entity ID.

Syntax

__property String SPServiceEntityID[int SPServiceIndex] = { read=FSPServiceEntityID };

Default Value

""

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

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

Data Type

String

SPServiceIndex Property (SAMLSPServer Component)

The index of this endpoint.

Syntax

__property int SPServiceIndex[int SPServiceIndex] = { read=FSPServiceIndex };

Default Value

0

Remarks

The index of this endpoint.

For endpoints that can accept requests via multiple bindings, Index is used to distinguish between individual endpoint specifiers.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

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

Data Type

Integer

SPServiceLocation Property (SAMLSPServer Component)

The location (URL) of the endpoint.

Syntax

__property String SPServiceLocation[int SPServiceIndex] = { read=FSPServiceLocation };

Default Value

""

Remarks

The location (URL) of the endpoint.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

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

Data Type

String

SPServicePriority Property (SAMLSPServer Component)

The priority of the endpoint in relation to other endpoints with the same Location .

Syntax

__property int SPServicePriority[int SPServiceIndex] = { read=FSPServicePriority };

Default Value

-1

Remarks

The priority of the endpoint in relation to other endpoints with the same SPLocation.

Indicates the relative priority of the endpoint. Use this setting to adjust priority of certain binding types before others. When composing the metadata XML, the endpoint with the highest priority gets described with a Default attribute.

Leave all priorities at -1 to omit generation of the Default attribute.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

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

Data Type

Integer

SPServiceService Property (SAMLSPServer Component)

The kind of the service being provided at this endpoint.

Syntax

__property int SPServiceService[int SPServiceIndex] = { read=FSPServiceService };

Default Value

0

Remarks

The kind of the service being provided at this endpoint.

The Service setting returns the kind of the service that is being provided at this endpoint. Typical SP services are AssertionConsumerService and ArtifactResolutionService. Typical IdP services are SingleSignOnService, SingleLogoutService, and ArtifactResolutionService.

The SPServiceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPServiceCount property.

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

Data Type

Integer

SPContactPerson Property (SAMLSPServer Component)

The contact person or persons for the entity.

Syntax

__property String SPContactPerson = { read=FSPContactPerson, write=FSetSPContactPerson };

Default Value

""

Remarks

The contact person or persons for the entity.

SAML assumes that more than one contact person can be specified. Each line of this potentially multi-line property contains one such record.

Each record contains a semicolon-separated list of contact person parameters, for example:

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

You can use LoadNameValuePairs and SaveNameValuePairs methods of the Utils class to process content of this property.

This property is not available at design time.

Data Type

String

SPEncryptionKey Property (SAMLSPServer Component)

Contains the entity's encryption key.

Syntax

__property DynamicArray SPEncryptionKey = { read=FSPEncryptionKey, write=FSetSPEncryptionKey };

Remarks

Contains the entity's encryption key.

This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings).

Requests sent to the endpoint can be encrypted with the provided key or certificate.

This property is not available at design time.

Data Type

Byte Array

SPEncryptionMethods Property (SAMLSPServer Component)

Specifies the list of encryption methods supported by the entity.

Syntax

__property String SPEncryptionMethods = { read=FSPEncryptionMethods, write=FSetSPEncryptionMethods };

Default Value

""

Remarks

Specifies the list of encryption methods supported by the entity.

This setting contains a list of encryption methods, in form of XML-ENC URLs separated with newline characters, supported by the entity. These can be considered when encrypting messages destined for this entity.

Examples of algorithms supported by this property:

• http://www.w3.org/2009/xmlenc11#aes128-gcm
• http://www.w3.org/2001/04/xmlenc#aes256-cbc

This property is not available at design time.

Data Type

String

SPEntityID Property (SAMLSPServer Component)

Represents the SAML entity ID.

Syntax

__property String SPEntityID = { read=FSPEntityID, write=FSetSPEntityID };

Default Value

""

Remarks

Represents the SAML entity ID.

Use this property to read or set the unique SAML entity ID. This is often the URI of the web endpoint (such as https://sp.myserver.com).

This property is not available at design time.

Data Type

String

SPFlags Property (SAMLSPServer Component)

Adjusts secondary entity properties.

Syntax

__property int SPFlags = { read=FSPFlags, write=FSetSPFlags };

Default Value

0

Remarks

Adjusts secondary entity properties.

Use this bit mask property to adjust certain secondary settings. The following flags are supported:

• 1 - sefRequireSignedRequests - the provider expects the consumers to sign requests they send in.

This property is not available at design time.

Data Type

Integer

SPNameIDFormats Property (SAMLSPServer Component)

The list of NameID formats supported by this entity.

Syntax

__property String SPNameIDFormats = { read=FSPNameIDFormats, write=FSetSPNameIDFormats };

Default Value

""

Remarks

The list of NameID formats supported by this entity.

Use this setting to get or set the list of NameID formats supported by the entity.

Use SAML notation for the formats:

• urn:oasis:names:tc:SAML:2.0:nameid-format:transient
• urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
• urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

This property is not available at design time.

Data Type

String

SPOrganizationDisplayName Property (SAMLSPServer Component)

The friendly name of the organization that maintains the entity.

Syntax

__property String SPOrganizationDisplayName = { read=FSPOrganizationDisplayName, write=FSetSPOrganizationDisplayName };

Default Value

""

Remarks

The friendly name of the organization that maintains the entity.

Use this setting to get or set the user-friendly name of the organization that maintains the SAML entity.

This property is not available at design time.

Data Type

String

SPOrganizationLang Property (SAMLSPServer Component)

The language preferred by the organization.

Syntax

__property String SPOrganizationLang = { read=FSPOrganizationLang, write=FSetSPOrganizationLang };

Default Value

""

Remarks

The language preferred by the organization.

This optional setting can be used to adjust the preferred language of the owning organization.

This property is not available at design time.

Data Type

String

SPOrganizationName Property (SAMLSPServer Component)

The name of the organization that maintains the entity.

Syntax

__property String SPOrganizationName = { read=FSPOrganizationName, write=FSetSPOrganizationName };

Default Value

""

Remarks

The name of the organization that maintains the entity.

Use this setting to get or set the name of the organization that maintains the SAML entity.

This property is not available at design time.

Data Type

String

SPOrganizationURL Property (SAMLSPServer Component)

The web URL of the organization that maintains the entity.

Syntax

__property String SPOrganizationURL = { read=FSPOrganizationURL, write=FSetSPOrganizationURL };

Default Value

""

Remarks

The web URL of the organization that maintains the entity.

Use this setting to get or set the web address of the organization responsible for this SAML entity.

This property is not available at design time.

Data Type

String

SPSignatureValidationResult Property (SAMLSPServer Component)

The outcome of the cryptographic signature validation.

Syntax

__property TsbxSAMLSPServerSPSignatureValidationResults SPSignatureValidationResult = { read=FSPSignatureValidationResult };

enum TsbxSAMLSPServerSPSignatureValidationResults {
  svtValid=0,
  svtUnknown=1,
  svtCorrupted=2,
  svtSignerNotFound=3,
  svtFailure=4,
  svtReferenceCorrupted=5
};

Default Value

svtValid

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

Data Type

Integer

SPSigned Property (SAMLSPServer Component)

Specifies whether the SAML entity information is or should be signed.

Syntax

__property bool SPSigned = { read=FSPSigned };

Default Value

false

Remarks

Specifies whether the SAML entity information is or should be signed.

Check this property to find out whether the metadata was signed by the sender, or set this property to true to indicate that the created metadata should be signed.

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

Data Type

Boolean

SPSignedWith Property (SAMLSPServer Component)

Contains the certificate or key that was used to sign the settings (metadata) document.

Syntax

__property DynamicArray SPSignedWith = { read=FSPSignedWith };

Remarks

Contains the certificate or key that was used to sign the settings (metadata) document.

This setting returns the public part of the metadata signing key. In most cases this is in the form of a DER-encoded X.509 certificate.

The value of this property is retrieved from the metadata file when it is loaded with the ImportSettings call. If the metadata is signed, you can check the integrity of the signature using the SPSignatureValidationResult setting.

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

Data Type

Byte Array

SPSigningKey Property (SAMLSPServer Component)

Contains the entity's signing key.

Syntax

__property DynamicArray SPSigningKey = { read=FSPSigningKey, write=FSetSPSigningKey };

Remarks

Contains the entity's signing key.

This setting returns the public part of the entity's signing key. In most cases this is in the form of a DER-encoded X.509 certificate.

This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set SigningCertificate setting (for this-party settings).

Messages sent by the endpoint can be signed with the provided key or certificate.

This property is not available at design time.

Data Type

Byte Array

SPValidUntil Property (SAMLSPServer Component)

Specifies the expiration time of the SAML entity information.

Syntax

__property String SPValidUntil = { read=FSPValidUntil, write=FSetSPValidUntil };

Default Value

""

Remarks

Specifies the expiration time of the SAML entity information.

This setting only makes sense when the information was loaded or is going to be saved to a metadata XML.

This property is not available at design time.

Data Type

String

SPToIDPBinding Property (SAMLSPServer Component)

Specifies the IdP to SP binding to use.

Syntax

__property TsbxSAMLSPServerSPToIDPBindings SPToIDPBinding = { read=FSPToIDPBinding, write=FSetSPToIDPBinding };

enum TsbxSAMLSPServerSPToIDPBindings {
  csbtNone=0,
  csbtSOAP=1,
  csbtPAOS=2,
  csbtRedirect=3,
  csbtPOST=4,
  csbtArtifact=5
};

Default Value

csbtRedirect

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.

Data Type

Integer

TLSServerCertCount Property (SAMLSPServer Component)

The number of records in the TLSServerCert arrays.

Syntax

__property int TLSServerCertCount = { read=FTLSServerCertCount, write=FSetTLSServerCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertHandle

The array indices start at 0 and end at TLSServerCertCount - 1.

This property is not available at design time.

Data Type

Integer

TLSServerCertBytes Property (SAMLSPServer Component)

Returns raw certificate data in DER format.

Syntax

__property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes };

Remarks

Returns raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertHandle Property (SAMLSPServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle, write=FSetTLSServerCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is not available at design time.

Data Type

Long64

TLSAutoValidateCertificates Property (SAMLSPServer Component)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (SAMLSPServer Component)

Selects the base configuration for the TLS settings.

Syntax

__property TsbxSAMLSPServerTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };

enum TsbxSAMLSPServerTLSBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

Remarks

Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (SAMLSPServer Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSClientAuth Property (SAMLSPServer Component)

Enables or disables certificate-based client authentication.

Syntax

__property TsbxSAMLSPServerTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };

enum TsbxSAMLSPServerTLSClientAuths {
  ccatNoAuth=0,
  ccatRequestCert=1,
  ccatRequireCert=2
};

Default Value

ccatNoAuth

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

Integer

TLSECCurves Property (SAMLSPServer Component)

Defines the elliptic curves to enable.

Syntax

__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SAMLSPServer Component)

Provides access to TLS extensions.

Syntax

__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SAMLSPServer Component)

Whether to force TLS session resumption when the destination address changes.

Syntax

__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (SAMLSPServer Component)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (SAMLSPServer Component)

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };

Default Value

""

Remarks

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (SAMLSPServer Component)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SAMLSPServer Component)

Selects renegotiation attack prevention mechanism.

Syntax

__property TsbxSAMLSPServerTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };

enum TsbxSAMLSPServerTLSRenegotiationAttackPreventionModes {
  crapmCompatible=0,
  crapmStrict=1,
  crapmAuto=2
};

Default Value

crapmAuto

Remarks

Selects renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (SAMLSPServer Component)

Specifies the kind(s) of revocation check to perform.

Syntax

__property TsbxSAMLSPServerTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };

enum TsbxSAMLSPServerTLSRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SAMLSPServer Component)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (SAMLSPServer Component)

Specifies the TLS mode to use.

Syntax

__property TsbxSAMLSPServerTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };

enum TsbxSAMLSPServerTLSTLSModes {
  smDefault=0,
  smNoTLS=1,
  smExplicitTLS=2,
  smImplicitTLS=3,
  smMixedTLS=4
};

Default Value

smDefault

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SAMLSPServer Component)

Enables Extended Master Secret Extension, as defined in RFC 7627.

Syntax

__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };

Default Value

false

Remarks

Enables Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (SAMLSPServer Component)

Enables or disables TLS session resumption capability.

Syntax

__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };

Default Value

false

Remarks

Enables or disables TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SAMLSPServer Component)

The SSL/TLS versions to enable by default.

Syntax

__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

URL Property (SAMLSPServer Component)

Specifies the base URL of this SP server.

Syntax

__property String URL = { read=FURL, write=FSetURL };

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.

Data Type

String

AddIdPService Method (SAMLSPServer Component)

Registers an IdP service in the IdPServices list.

Syntax

void __fastcall AddIdPService(int Service, int BindingType, String Location, int Priority, int Index);

Remarks

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

AddSPService Method (SAMLSPServer Component)

Registers an SP service in the SPServices list.

Syntax

void __fastcall AddSPService(int Service, int BindingType, String Location, int Priority, int Index);

Remarks

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

Config Method (SAMLSPServer Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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

String __fastcall DoAction(String ActionID, String ActionParams);

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

ExportSettings Method (SAMLSPServer Component)

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

Syntax

String __fastcall ExportSettings(bool SP);

Remarks

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

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

GetClientBuffer Method (SAMLSPServer Component)

Obtains a pending connection buffer.

Syntax

DynamicArray<Byte> __fastcall GetClientBuffer(__int64 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 Component)

Returns the value of a custom provider property.

Syntax

String __fastcall 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

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

void __fastcall ImportSettings(String Metadata, bool SP);

Remarks

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

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

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

InitiateArtifactResolve Method (SAMLSPServer Component)

TBD.

Syntax

int __fastcall InitiateArtifactResolve(__int64 ConnectionID, String SessionID, int IdPServiceIndex, String Artifact);

Remarks

You can use this method with or without the OfflineMode.

InitiateAttributeQuery Method (SAMLSPServer Component)

TBD.

Syntax

int __fastcall InitiateAttributeQuery(__int64 ConnectionID, String SessionID, int IdPServiceIndex, String Attributes);

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

int __fastcall InitiateAuth(__int64 ConnectionID, String SessionID, int IdPServiceIndex, String RelayState);

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

int __fastcall InitiateLogout(__int64 ConnectionID, String SessionID, int IdPServiceIndex, String RelayState);

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

ProcessArtifactResolveRequest Method (SAMLSPServer Component)

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

Syntax

int __fastcall ProcessArtifactResolveRequest(__int64 ConnectionID, String SessionID, String Request);

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

int __fastcall ProcessAssertion(__int64 ConnectionID, String SessionID, String Request);

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

int __fastcall ProcessGenericRequest(__int64 ConnectionID, String SessionID, String Request);

Remarks

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

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

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

int __fastcall ProcessLogoutRequest(__int64 ConnectionID, String SessionID, String Request);

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.

SetClientBuffer Method (SAMLSPServer Component)

Commits a data buffer to the connection.

Syntax

void __fastcall SetClientBuffer(__int64 ConnectionID, DynamicArray<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 Component)

Sets the value of a custom provider property.

Syntax

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

Starts the SP server.

Syntax

void __fastcall Start();

Remarks

Use this method to start listening for incoming connections.

Stop Method (SAMLSPServer Component)

Stops the IdP server.

Syntax

void __fastcall Stop();

Remarks

Call this method to stop listening for incoming connections.

Accept Event (SAMLSPServer Component)

Reports an incoming connection.

Syntax

typedef struct {
  String RemoteAddress;
  int RemotePort;
  bool Accept;
} TsbxSAMLSPServerAcceptEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerAcceptEvent)(System::TObject* Sender, TsbxSAMLSPServerAcceptEventParams *e);
__property TsbxSAMLSPServerAcceptEvent OnAccept = { 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

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String Artifact;
} TsbxSAMLSPServerArtifactResolveRequestPreparedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerArtifactResolveRequestPreparedEvent)(System::TObject* Sender, TsbxSAMLSPServerArtifactResolveRequestPreparedEventParams *e);
__property TsbxSAMLSPServerArtifactResolveRequestPreparedEvent OnArtifactResolveRequestPrepared = { read=FOnArtifactResolveRequestPrepared, write=FOnArtifactResolveRequestPrepared };

Remarks

TBD

ArtifactResolveRequestReceived Event (SAMLSPServer Component)

TBD.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  bool IsEncrypted;
  bool IsSigned;
  String Artifact;
  int Action;
} TsbxSAMLSPServerArtifactResolveRequestReceivedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerArtifactResolveRequestReceivedEvent)(System::TObject* Sender, TsbxSAMLSPServerArtifactResolveRequestReceivedEventParams *e);
__property TsbxSAMLSPServerArtifactResolveRequestReceivedEvent OnArtifactResolveRequestReceived = { read=FOnArtifactResolveRequestReceived, write=FOnArtifactResolveRequestReceived };

Remarks

AssertionReceived Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  bool IsEncrypted;
  bool IsSigned;
  String NameID;
  String SessionIndex;
  int Action;
} TsbxSAMLSPServerAssertionReceivedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerAssertionReceivedEvent)(System::TObject* Sender, TsbxSAMLSPServerAssertionReceivedEventParams *e);
__property TsbxSAMLSPServerAssertionReceivedEvent OnAssertionReceived = { 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.

AttributeQueryPrepared Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String Attributes;
} TsbxSAMLSPServerAttributeQueryPreparedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerAttributeQueryPreparedEvent)(System::TObject* Sender, TsbxSAMLSPServerAttributeQueryPreparedEventParams *e);
__property TsbxSAMLSPServerAttributeQueryPreparedEvent OnAttributeQueryPrepared = { read=FOnAttributeQueryPrepared, write=FOnAttributeQueryPrepared };

Remarks

TBD

AuthnRequestPrepared Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  bool ForceAuthn;
  bool NonInteractive;
} TsbxSAMLSPServerAuthnRequestPreparedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerAuthnRequestPreparedEvent)(System::TObject* Sender, TsbxSAMLSPServerAuthnRequestPreparedEventParams *e);
__property TsbxSAMLSPServerAuthnRequestPreparedEvent OnAuthnRequestPrepared = { read=FOnAuthnRequestPrepared, write=FOnAuthnRequestPrepared };

Remarks

TBD

Connect Event (SAMLSPServer Component)

Reports an accepted connection.

Syntax

typedef struct {
  __int64 ConnectionId;
  String RemoteAddress;
  int RemotePort;
} TsbxSAMLSPServerConnectEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerConnectEvent)(System::TObject* Sender, TsbxSAMLSPServerConnectEventParams *e);
__property TsbxSAMLSPServerConnectEvent OnConnect = { 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

typedef struct {
  __int64 ConnectionID;
} TsbxSAMLSPServerDisconnectEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerDisconnectEvent)(System::TObject* Sender, TsbxSAMLSPServerDisconnectEventParams *e);
__property TsbxSAMLSPServerDisconnectEvent OnDisconnect = { 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

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  bool NeedCredential;
  bool SkipThis;
} TsbxSAMLSPServerEncryptedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerEncryptedEvent)(System::TObject* Sender, TsbxSAMLSPServerEncryptedEventParams *e);
__property TsbxSAMLSPServerEncryptedEvent OnEncrypted = { 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

typedef struct {
  __int64 ConnectionID;
  int ErrorCode;
  String Description;
} TsbxSAMLSPServerErrorEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerErrorEvent)(System::TObject* Sender, TsbxSAMLSPServerErrorEventParams *e);
__property TsbxSAMLSPServerErrorEvent OnError = { 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

typedef struct {
  __int64 ConnectionID;
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxSAMLSPServerExternalSignEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerExternalSignEvent)(System::TObject* Sender, TsbxSAMLSPServerExternalSignEventParams *e);
__property TsbxSAMLSPServerExternalSignEvent OnExternalSign = { 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 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 contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for 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 a .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

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String NameID;
} TsbxSAMLSPServerLogoutRequestPreparedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerLogoutRequestPreparedEvent)(System::TObject* Sender, TsbxSAMLSPServerLogoutRequestPreparedEventParams *e);
__property TsbxSAMLSPServerLogoutRequestPreparedEvent OnLogoutRequestPrepared = { read=FOnLogoutRequestPrepared, write=FOnLogoutRequestPrepared };

Remarks

TBD

LogoutRequestReceived Event (SAMLSPServer Component)

TBD.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  bool IsEncrypted;
  bool IsSigned;
  String NameID;
  int Action;
} TsbxSAMLSPServerLogoutRequestReceivedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerLogoutRequestReceivedEvent)(System::TObject* Sender, TsbxSAMLSPServerLogoutRequestReceivedEventParams *e);
__property TsbxSAMLSPServerLogoutRequestReceivedEvent OnLogoutRequestReceived = { read=FOnLogoutRequestReceived, write=FOnLogoutRequestReceived };

Remarks

MetadataPrepared Event (SAMLSPServer Component)

Passes a prepared metadata object to the application.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Metadata;
} TsbxSAMLSPServerMetadataPreparedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerMetadataPreparedEvent)(System::TObject* Sender, TsbxSAMLSPServerMetadataPreparedEventParams *e);
__property TsbxSAMLSPServerMetadataPreparedEvent OnMetadataPrepared = { 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

typedef struct {
  String EventID;
  String EventParam;
} TsbxSAMLSPServerNotificationEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerNotificationEvent)(System::TObject* Sender, TsbxSAMLSPServerNotificationEventParams *e);
__property TsbxSAMLSPServerNotificationEvent OnNotification = { 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 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

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  int ProcessingResult;
  String Response;
  bool Redirect;
} TsbxSAMLSPServerProcessingCompletedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerProcessingCompletedEvent)(System::TObject* Sender, TsbxSAMLSPServerProcessingCompletedEventParams *e);
__property TsbxSAMLSPServerProcessingCompletedEvent OnProcessingCompleted = { 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

typedef struct {
  __int64 ConnectionID;
} TsbxSAMLSPServerResourceCloseEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerResourceCloseEvent)(System::TObject* Sender, TsbxSAMLSPServerResourceCloseEventParams *e);
__property TsbxSAMLSPServerResourceCloseEvent OnResourceClose = { 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

typedef struct {
  __int64 ConnectionID;
  String URL;
  int OperationStatus;
} TsbxSAMLSPServerResourceOpenEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerResourceOpenEvent)(System::TObject* Sender, TsbxSAMLSPServerResourceOpenEventParams *e);
__property TsbxSAMLSPServerResourceOpenEvent OnResourceOpen = { 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

typedef struct {
  __int64 ConnectionID;
  int Size;
  int OperationStatus;
} TsbxSAMLSPServerResourceReadEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerResourceReadEvent)(System::TObject* Sender, TsbxSAMLSPServerResourceReadEventParams *e);
__property TsbxSAMLSPServerResourceReadEvent OnResourceRead = { 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

typedef struct {
  __int64 ConnectionID;
  String URL;
  bool ResProtected;
  bool ResSpecial;
  int Action;
} TsbxSAMLSPServerResourceRequestEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerResourceRequestEvent)(System::TObject* Sender, TsbxSAMLSPServerResourceRequestEventParams *e);
__property TsbxSAMLSPServerResourceRequestEvent OnResourceRequest = { 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

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String InResponseTo;
  String RequestBody;
  String MessageType;
  String MessageBody;
  bool Success;
} TsbxSAMLSPServerSAMLMessagePreparedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSAMLMessagePreparedEvent)(System::TObject* Sender, TsbxSAMLSPServerSAMLMessagePreparedEventParams *e);
__property TsbxSAMLSPServerSAMLMessagePreparedEvent OnSAMLMessagePrepared = { 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

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String MessageType;
  String MessageID;
  String Issuer;
  String IssueInstant;
  String MessageBody;
  String RelayState;
  int Action;
} TsbxSAMLSPServerSAMLMessageReceivedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSAMLMessageReceivedEvent)(System::TObject* Sender, TsbxSAMLSPServerSAMLMessageReceivedEventParams *e);
__property TsbxSAMLSPServerSAMLMessageReceivedEvent OnSAMLMessageReceived = { 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

SessionCreated Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
} TsbxSAMLSPServerSessionCreatedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSessionCreatedEvent)(System::TObject* Sender, TsbxSAMLSPServerSessionCreatedEventParams *e);
__property TsbxSAMLSPServerSessionCreatedEvent OnSessionCreated = { 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

typedef struct {
  __int64 ConnectionID;
  String SessionID;
} TsbxSAMLSPServerSessionDestroyedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSessionDestroyedEvent)(System::TObject* Sender, TsbxSAMLSPServerSessionDestroyedEventParams *e);
__property TsbxSAMLSPServerSessionDestroyedEvent OnSessionDestroyed = { 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

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String EventText;
} TsbxSAMLSPServerSessionEventEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSessionEventEvent)(System::TObject* Sender, TsbxSAMLSPServerSessionEventEventParams *e);
__property TsbxSAMLSPServerSessionEventEvent OnSessionEvent = { 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

TBD

SessionInfoNeeded Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
} TsbxSAMLSPServerSessionInfoNeededEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSessionInfoNeededEvent)(System::TObject* Sender, TsbxSAMLSPServerSessionInfoNeededEventParams *e);
__property TsbxSAMLSPServerSessionInfoNeededEvent OnSessionInfoNeeded = { read=FOnSessionInfoNeeded, write=FOnSessionInfoNeeded };

Remarks

TBD

SessionStateRetrieve Event (SAMLSPServer Component)

TBD.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String SessionState;
} TsbxSAMLSPServerSessionStateRetrieveEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSessionStateRetrieveEvent)(System::TObject* Sender, TsbxSAMLSPServerSessionStateRetrieveEventParams *e);
__property TsbxSAMLSPServerSessionStateRetrieveEvent OnSessionStateRetrieve = { read=FOnSessionStateRetrieve, write=FOnSessionStateRetrieve };

Remarks

TBD

SessionStateSave Event (SAMLSPServer Component)

TBD.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String SessionState;
} TsbxSAMLSPServerSessionStateSaveEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSessionStateSaveEvent)(System::TObject* Sender, TsbxSAMLSPServerSessionStateSaveEventParams *e);
__property TsbxSAMLSPServerSessionStateSaveEvent OnSessionStateSave = { read=FOnSessionStateSave, write=FOnSessionStateSave };

Remarks

TBD

SignatureFound Event (SAMLSPServer Component)

Signifies the start of signature validation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  int Scope;
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  bool CertFound;
  bool Validate;
} TsbxSAMLSPServerSignatureFoundEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSignatureFoundEvent)(System::TObject* Sender, TsbxSAMLSPServerSignatureFoundEventParams *e);
__property TsbxSAMLSPServerSignatureFoundEvent OnSignatureFound = { 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.

SignatureValidated Event (SAMLSPServer Component)

Reports the signature validation result.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  int Scope;
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  int ValidationResult;
} TsbxSAMLSPServerSignatureValidatedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerSignatureValidatedEvent)(System::TObject* Sender, TsbxSAMLSPServerSignatureValidatedEventParams *e);
__property TsbxSAMLSPServerSignatureValidatedEvent OnSignatureValidated = { 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.

IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:

Config Settings (SAMLSPServer Component)

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

SAMLSPServer Config Settings

Base Config Settings

Trappable Errors (SAMLSPServer Component)

SAMLSPServer Errors