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

BindingKeyHandle Property (SAMLSPServer Component)

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

Syntax

__property __int64 BindingKeyHandle = { read=FBindingKeyHandle, write=FSetBindingKeyHandle };

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

BindingKeyKey Property (SAMLSPServer Component)

The byte array representation of the key.

Syntax

__property DynamicArray BindingKeyKey = { read=FBindingKeyKey };

Remarks

The byte array representation of the key. This may not be available for non-BindingKeyExportable keys.

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

Data Type

Byte Array

DecryptionCertBytes Property (SAMLSPServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray DecryptionCertBytes = { read=FDecryptionCertBytes };

Remarks

Returns the 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 the 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 the DCAuth component.

If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

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 an extra protection layer for the protocol and diminishes the risk of the 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 the 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 the 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

HandshakeTimeout Property (SAMLSPServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

__property int HandshakeTimeout = { read=FHandshakeTimeout, write=FSetHandshakeTimeout };

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

Integer

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
• IdPServiceLocation
• IdPServicePriority
• IdPServiceService
• IdPServiceServiceIndex

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

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

IdPServiceServiceIndex Property (SAMLSPServer Component)

The index of this endpoint.

Syntax

__property int IdPServiceServiceIndex[int IdPServiceIndex] = { read=FIdPServiceServiceIndex };

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

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 String IdPEncryptionKey = { read=FIdPEncryptionKey, write=FSetIdPEncryptionKey };

Default Value

""

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

String

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

IdPIdPSSOLink Property (SAMLSPServer Component)

Contains a local server page link that triggers SAML authentication to the SP.

Syntax

__property String IdPIdPSSOLink = { read=FIdPIdPSSOLink, write=FSetIdPIdPSSOLink };

Default Value

""

Remarks

Contains a local server page link that triggers SAML authentication to the SP.

This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.

One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.

This property is not available at design time.

Data Type

String

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 String IdPSignedWith = { read=FIdPSignedWith };

Default Value

""

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

String

IdPSigningKey Property (SAMLSPServer Component)

Contains the entity's signing key.

Syntax

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

Default Value

""

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 PKCS#1 RSA or ECDSA key.

The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.

This property is not available at design time.

Data Type

String

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 the raw certificate data in DER format.

Syntax

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

Remarks

Returns the 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

KnownKeyCount Property (SAMLSPServer Component)

The number of records in the KnownKey arrays.

Syntax

__property int KnownKeyCount = { read=FKnownKeyCount, write=FSetKnownKeyCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownKeyHandle

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

This property is not available at design time.

Data Type

Integer

KnownKeyHandle Property (SAMLSPServer Component)

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

Syntax

__property __int64 KnownKeyHandle[int KnownKeyIndex] = { read=FKnownKeyHandle, write=FSetKnownKeyHandle };

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 KnownKeyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownKeyCount 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 the raw certificate data in DER format.

Syntax

__property DynamicArray MetaSigningCertBytes = { read=FMetaSigningCertBytes };

Remarks

Returns the 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

PinnedClientAEADCipher Property (SAMLSPServer Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

__property bool PinnedClientAEADCipher = { read=FPinnedClientAEADCipher };

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

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

Data Type

Boolean

PinnedClientChainValidationDetails Property (SAMLSPServer Component)

The details of a certificate chain validation outcome.

Syntax

__property int PinnedClientChainValidationDetails = { read=FPinnedClientChainValidationDetails };

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

Data Type

Integer

PinnedClientChainValidationResult Property (SAMLSPServer Component)

The outcome of a certificate chain validation routine.

Syntax

__property TsbxSAMLSPServerPinnedClientChainValidationResults PinnedClientChainValidationResult = { read=FPinnedClientChainValidationResult };

enum TsbxSAMLSPServerPinnedClientChainValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

PinnedClientCiphersuite Property (SAMLSPServer Component)

The cipher suite employed by this connection.

Syntax

__property String PinnedClientCiphersuite = { read=FPinnedClientCiphersuite };

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

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

Data Type

String

PinnedClientClientAuthenticated Property (SAMLSPServer Component)

Specifies whether client authentication was performed during this connection.

Syntax

__property bool PinnedClientClientAuthenticated = { read=FPinnedClientClientAuthenticated };

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

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

Data Type

Boolean

PinnedClientClientAuthRequested Property (SAMLSPServer Component)

Specifies whether client authentication was requested during this connection.

Syntax

__property bool PinnedClientClientAuthRequested = { read=FPinnedClientClientAuthRequested };

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

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

Data Type

Boolean

PinnedClientConnectionEstablished Property (SAMLSPServer Component)

Indicates whether the connection has been established fully.

Syntax

__property bool PinnedClientConnectionEstablished = { read=FPinnedClientConnectionEstablished };

Default Value

false

Remarks

Indicates whether the connection has been established fully.

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

Data Type

Boolean

PinnedClientConnectionID Property (SAMLSPServer Component)

The unique identifier assigned to this connection.

Syntax

__property DynamicArray PinnedClientConnectionID = { read=FPinnedClientConnectionID };

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

PinnedClientDigestAlgorithm Property (SAMLSPServer Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

__property String PinnedClientDigestAlgorithm = { read=FPinnedClientDigestAlgorithm };

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

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

Data Type

String

PinnedClientEncryptionAlgorithm Property (SAMLSPServer Component)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

__property String PinnedClientEncryptionAlgorithm = { read=FPinnedClientEncryptionAlgorithm };

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

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

Data Type

String

PinnedClientExportable Property (SAMLSPServer Component)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

__property bool PinnedClientExportable = { read=FPinnedClientExportable };

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

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

Data Type

Boolean

PinnedClientID Property (SAMLSPServer Component)

The client connection's unique identifier.

Syntax

__property __int64 PinnedClientID = { read=FPinnedClientID };

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

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

Data Type

Long64

PinnedClientKeyExchangeAlgorithm Property (SAMLSPServer Component)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

__property String PinnedClientKeyExchangeAlgorithm = { read=FPinnedClientKeyExchangeAlgorithm };

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

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

Data Type

String

PinnedClientKeyExchangeKeyBits Property (SAMLSPServer Component)

The length of the key exchange key of a TLS-enabled connection.

Syntax

__property int PinnedClientKeyExchangeKeyBits = { read=FPinnedClientKeyExchangeKeyBits };

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

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

Data Type

Integer

PinnedClientNamedECCurve Property (SAMLSPServer Component)

The elliptic curve used in this connection.

Syntax

__property String PinnedClientNamedECCurve = { read=FPinnedClientNamedECCurve };

Default Value

""

Remarks

The elliptic curve used in this connection.

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

Data Type

String

PinnedClientPFSCipher Property (SAMLSPServer Component)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

__property bool PinnedClientPFSCipher = { read=FPinnedClientPFSCipher };

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

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

Data Type

Boolean

PinnedClientPreSharedIdentity Property (SAMLSPServer Component)

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

Syntax

__property String PinnedClientPreSharedIdentity = { read=FPinnedClientPreSharedIdentity };

Default Value

""

Remarks

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

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

Data Type

String

PinnedClientPreSharedIdentityHint Property (SAMLSPServer Component)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

__property String PinnedClientPreSharedIdentityHint = { read=FPinnedClientPreSharedIdentityHint };

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

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

Data Type

String

PinnedClientPublicKeyBits Property (SAMLSPServer Component)

The length of the public key.

Syntax

__property int PinnedClientPublicKeyBits = { read=FPinnedClientPublicKeyBits };

Default Value

0

Remarks

The length of the public key.

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

Data Type

Integer

PinnedClientRemoteAddress Property (SAMLSPServer Component)

The client's IP address.

Syntax

__property String PinnedClientRemoteAddress = { read=FPinnedClientRemoteAddress };

Default Value

""

Remarks

The client's IP address.

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

Data Type

String

PinnedClientRemotePort Property (SAMLSPServer Component)

The remote port of the client connection.

Syntax

__property int PinnedClientRemotePort = { read=FPinnedClientRemotePort };

Default Value

0

Remarks

The remote port of the client connection.

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

Data Type

Integer

PinnedClientResumedSession Property (SAMLSPServer Component)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

__property bool PinnedClientResumedSession = { read=FPinnedClientResumedSession };

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

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

Data Type

Boolean

PinnedClientSecureConnection Property (SAMLSPServer Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

__property bool PinnedClientSecureConnection = { read=FPinnedClientSecureConnection };

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

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

Data Type

Boolean

PinnedClientServerAuthenticated Property (SAMLSPServer Component)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

__property bool PinnedClientServerAuthenticated = { read=FPinnedClientServerAuthenticated };

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

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

Data Type

Boolean

PinnedClientSignatureAlgorithm Property (SAMLSPServer Component)

The signature algorithm used in a TLS handshake.

Syntax

__property String PinnedClientSignatureAlgorithm = { read=FPinnedClientSignatureAlgorithm };

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

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

Data Type

String

PinnedClientSymmetricBlockSize Property (SAMLSPServer Component)

The block size of the symmetric algorithm used.

Syntax

__property int PinnedClientSymmetricBlockSize = { read=FPinnedClientSymmetricBlockSize };

Default Value

0

Remarks

The block size of the symmetric algorithm used.

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

Data Type

Integer

PinnedClientSymmetricKeyBits Property (SAMLSPServer Component)

The key length of the symmetric algorithm used.

Syntax

__property int PinnedClientSymmetricKeyBits = { read=FPinnedClientSymmetricKeyBits };

Default Value

0

Remarks

The key length of the symmetric algorithm used.

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

Data Type

Integer

PinnedClientTotalBytesReceived Property (SAMLSPServer Component)

The total number of bytes received over this connection.

Syntax

__property __int64 PinnedClientTotalBytesReceived = { read=FPinnedClientTotalBytesReceived };

Default Value

0

Remarks

The total number of bytes received over this connection.

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

Data Type

Long64

PinnedClientTotalBytesSent Property (SAMLSPServer Component)

The total number of bytes sent over this connection.

Syntax

__property __int64 PinnedClientTotalBytesSent = { read=FPinnedClientTotalBytesSent };

Default Value

0

Remarks

The total number of bytes sent over this connection.

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

Data Type

Long64

PinnedClientValidationLog Property (SAMLSPServer Component)

Contains the server certificate's chain validation log.

Syntax

__property String PinnedClientValidationLog = { read=FPinnedClientValidationLog };

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

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

Data Type

String

PinnedClientVersion Property (SAMLSPServer Component)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

__property String PinnedClientVersion = { read=FPinnedClientVersion };

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

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

Data Type

String

PinnedClientCertCount Property (SAMLSPServer Component)

The number of records in the PinnedClientCert arrays.

Syntax

__property int PinnedClientCertCount = { read=FPinnedClientCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• PinnedClientCertBytes
• PinnedClientCertCAKeyID
• PinnedClientCertFingerprint
• PinnedClientCertHandle
• PinnedClientCertIssuer
• PinnedClientCertIssuerRDN
• PinnedClientCertKeyAlgorithm
• PinnedClientCertKeyBits
• PinnedClientCertKeyFingerprint
• PinnedClientCertKeyUsage
• PinnedClientCertPublicKeyBytes
• PinnedClientCertSelfSigned
• PinnedClientCertSerialNumber
• PinnedClientCertSigAlgorithm
• PinnedClientCertSubject
• PinnedClientCertSubjectKeyID
• PinnedClientCertSubjectRDN
• PinnedClientCertValidFrom
• PinnedClientCertValidTo

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

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

Data Type

Integer

PinnedClientCertBytes Property (SAMLSPServer Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray PinnedClientCertBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertBytes };

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertCAKeyID Property (SAMLSPServer Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

__property DynamicArray PinnedClientCertCAKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertCAKeyID };

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertFingerprint Property (SAMLSPServer Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

__property String PinnedClientCertFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertFingerprint };

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertHandle Property (SAMLSPServer Component)

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

Syntax

__property __int64 PinnedClientCertHandle[int PinnedClientCertIndex] = { read=FPinnedClientCertHandle };

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Long64

PinnedClientCertIssuer Property (SAMLSPServer Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String PinnedClientCertIssuer[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via PinnedClientCertIssuerRDN.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertIssuerRDN Property (SAMLSPServer Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

__property String PinnedClientCertIssuerRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuerRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyAlgorithm Property (SAMLSPServer Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String PinnedClientCertKeyAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the PinnedClientCertKeyBits, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes properties to get more details about the key the certificate contains.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyBits Property (SAMLSPServer Component)

Returns the length of the public key in bits.

Syntax

__property int PinnedClientCertKeyBits[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PinnedClientCertPublicKeyBytes or PinnedClientCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertKeyFingerprint Property (SAMLSPServer Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

__property String PinnedClientCertKeyFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyFingerprint };

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the PinnedClientCertFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertKeyUsage Property (SAMLSPServer Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int PinnedClientCertKeyUsage[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyUsage };

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Integer

PinnedClientCertPublicKeyBytes Property (SAMLSPServer Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray PinnedClientCertPublicKeyBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertPublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertSelfSigned Property (SAMLSPServer Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool PinnedClientCertSelfSigned[int PinnedClientCertIndex] = { read=FPinnedClientCertSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Boolean

PinnedClientCertSerialNumber Property (SAMLSPServer Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray PinnedClientCertSerialNumber[int PinnedClientCertIndex] = { read=FPinnedClientCertSerialNumber };

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertSigAlgorithm Property (SAMLSPServer Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String PinnedClientCertSigAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertSubject Property (SAMLSPServer Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String PinnedClientCertSubject[int PinnedClientCertIndex] = { read=FPinnedClientCertSubject };

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via PinnedClientCertSubjectRDN.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertSubjectKeyID Property (SAMLSPServer Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

__property DynamicArray PinnedClientCertSubjectKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectKeyID };

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The PinnedClientCertSubjectKeyID and PinnedClientCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

Byte Array

PinnedClientCertSubjectRDN Property (SAMLSPServer Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

__property String PinnedClientCertSubjectRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertValidFrom Property (SAMLSPServer Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String PinnedClientCertValidFrom[int PinnedClientCertIndex] = { read=FPinnedClientCertValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

PinnedClientCertValidTo Property (SAMLSPServer Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String PinnedClientCertValidTo[int PinnedClientCertIndex] = { read=FPinnedClientCertValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

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

Data Type

String

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

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: The following flags can be used with any SAML component (although they may not apply in all modes of use):

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

SecuritySignaturePolicy Property (SAMLSPServer Component)

Specifies the signature validation policy.

Syntax

__property TsbxSAMLSPServerSecuritySignaturePolicies SecuritySignaturePolicy = { read=FSecuritySignaturePolicy, write=FSetSecuritySignaturePolicy };

enum TsbxSAMLSPServerSecuritySignaturePolicies {
  sspAuto=0,
  sspValidate=1,
  sspRequire=2,
  sspIgnore=3
};

Default Value

sspAuto

Remarks

Specifies the signature validation policy.

Use this property to specify the signature validation policy for the component.

This property is not available at design time.

Data Type

Integer

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 the raw certificate data in DER format.

Syntax

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

Remarks

Returns the 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 the raw certificate data in DER format.

Syntax

__property DynamicArray SigningCertBytes = { read=FSigningCertBytes };

Remarks

Returns the 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 the raw certificate data in DER format.

Syntax

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

Remarks

Returns the 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

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
• SPServiceLocation
• SPServicePriority
• SPServiceService
• SPServiceServiceIndex

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

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

SPServiceServiceIndex Property (SAMLSPServer Component)

The index of this endpoint.

Syntax

__property int SPServiceServiceIndex[int SPServiceIndex] = { read=FSPServiceServiceIndex };

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

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 String SPEncryptionKey = { read=FSPEncryptionKey, write=FSetSPEncryptionKey };

Default Value

""

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

String

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

SPIdPSSOLink Property (SAMLSPServer Component)

Contains a local server page link that triggers SAML authentication to the SP.

Syntax

__property String SPIdPSSOLink = { read=FSPIdPSSOLink, write=FSetSPIdPSSOLink };

Default Value

""

Remarks

Contains a local server page link that triggers SAML authentication to the SP.

This property specifies the web link that initiates the transfer of SAML authentication fact to the SP.

One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider.

This property is not available at design time.

Data Type

String

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 String SPSignedWith = { read=FSPSignedWith };

Default Value

""

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

String

SPSigningKey Property (SAMLSPServer Component)

Contains the entity's signing key.

Syntax

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

Default Value

""

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 PKCS#1 RSA or ECDSA key.

The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates.

This property is not available at design time.

Data Type

String

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

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 the raw certificate data in DER format.

Syntax

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

Remarks

Returns the 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 offered and 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, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. 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:

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 key 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 key 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 the 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 the 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 for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

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 the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

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

Default Value

false

Remarks

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

Data Type

Boolean

TLSUseSessionResumption Property (SAMLSPServer Component)

Enables or disables the TLS session resumption capability.

Syntax

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

Default Value

false

Remarks

Enables or disables the 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 known external SAML services and their locations.

The service provider needs to be knowledgeable of the external IdP services that it needs to use. That information can either be provided in the form of a metadata file (see ImportSettings), or registered manually using this method.

When using this method, make sure to register all the services you expect to work with. Note that if the same IdP service is available through several different transports (bindings), you will need to register each (service, transport) pair individually:

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

Use the Service parameter to specify the service to register:

The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for SSO and SLS services to use POST or Redirect bindings. This information is typically provided by the identity provider.

The Location parameter specifies the absolute URL of the respective SAML web endpoint.

The Priority parameter specifies the relative priority of the transport among several identical services. The actual transport used may be different to the specified priority, as the request received from the SP (such as AuthnRequest) may explicitly request a specific transport to use.

The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.

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

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 SAML services and their locations provided by the SP.

A service provider can provide a variety of SAML services through a selection of endpoints, each supporting one or more transports (or bindings). Typical examples are an assertion consumer service or a single logout service, each of which can be served independently on the same or different endpoints, via a POST or Redirect transports (or both).

Each AddSPService call registers a single service offered via a single transport. If you would like to have the same service to be available using several different transports, you need to register each combination individually, even if the service runs at the same web endpoint:

sp.AddSPService(spsAssertionConsumerService, csbtPOST, '/saml/acs', -1, 1); sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2);

Use the Service parameter to specify the service to register:

The BindingType specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for ACS service to use POST binding (due to the size of assertions), and SLS to either use POST or Redirect.

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

sp.AddSPService(spsAssertionConsumerService, csbtPOST, 'https://app.com/saml/acs', -1, 1); // absolute path sp.AddSPService(spsAssertionConsumerService, csbtRedirect, '/saml/acs', -1, 2); // relative path

The Priority parameter is nominal as it only specifies the relative priority of the transport in the SP metadata. The actual transport used, among those supported, depends on the choice of the external identity provider. Pass -1 to stick with the default priority.

The Index parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly.

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

Cleanup Method (SAMLSPServer Component)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

void __fastcall Cleanup();

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

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 insensitive) of the action is provided in the ActionID parameter.

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

DropClient Method (SAMLSPServer Component)

Terminates a client connection.

Syntax

void __fastcall DropClient(__int64 ConnectionId, bool Forced);

Remarks

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

ExportSettings Method (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)

Acquires a piece of operation data.

Syntax

DynamicArray<Byte> __fastcall GetClientBuffer(__int64 ConnectionID, String Handle);

Remarks

Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.

A typical place to call this method is inside the ResourceWrite event handler, when implementing customized file transfers.

GetProviderProperty Method (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

GetRequestBytes Method (SAMLSPServer Component)

Returns the contents of the connected client's HTTP request.

Syntax

DynamicArray<Byte> __fastcall GetRequestBytes(__int64 ConnectionID, String RequestFilter);

Remarks

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

GetRequestHeader Method (SAMLSPServer Component)

Returns a request header value.

Syntax

String __fastcall GetRequestHeader(__int64 ConnectionId, String HeaderName);

Remarks

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

GetResponseHeader Method (SAMLSPServer Component)

Returns a response header value.

Syntax

String __fastcall GetResponseHeader(__int64 ConnectionId, String HeaderName);

Remarks

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

GetSessionProperty Method (SAMLSPServer Component)

Returns the value of a custom session property.

Syntax

String __fastcall GetSessionProperty(String SessionID, String Name);

Remarks

This method, together with SetSessionProperty, provides an extensible way of managing the Service Provider's session properties that are not available through the primary properties and events of the component. These methods can be called on any active browser session. Use SessionCreated and SessionDestroyed events to get notifications about session creation and disposal.

The following properties are supported for SP sessions and can be passed to the Name parameter of this method:

• AuthnRequestID: the AuthnRequest ID.
• Expires: the web session expiration time.
• LogoutRequestID: the LogoutRequest ID.
• NameID: the NameID of the user.
• NameIDFormat: the format of the NameID of the user.
• FormattedNameID: the formatted version of the NameID.
• RelayState: the current (last) relay state entry.
• Session: the session ID (the same as you pass as parameter).
• SessionIndex: a list of cross-network session indexes assigned to this session.
• URL: the current request's URL.
• UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.

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)

Initiates the artifact resolution protocol.

Syntax

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

Remarks

Use this event to initiate the artifact resolution protocol for Artifact. Specify the desired SP service endpoint via the IdPServiceIndex parameter.

You can use this method with or without the OfflineMode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

InitiateAttributeQuery Method (SAMLSPServer Component)

Initiates the attribute query.

Syntax

int __fastcall InitiateAttributeQuery(__int64 ConnectionID, String SessionID, int IdPServiceIndex, String NameID, String NameIDFormat, String Attributes, String AttrNameFormats, String AttrFriendlyNames, String Tag);

Remarks

Use this event to initiate the attribute query for user NameID. Specify the desired Attributes as a list of CRLF-separated attribute names. AttrNameFormats and AttrFriendlyNames can also be provided in the same way.

Specify the IdP AQS endpoint via the IdPServiceIndex parameter.

You can use this method with or without the OfflineMode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

InitiateAuth Method (SAMLSPServer Component)

Starts SP-initiated SAML authentication flow.

Syntax

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

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 NameID, String SessionIndex, String RelayState, String Tag);

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.

Use IdPServiceIndex to specify the identity provider's service that you want to use for signing out. Provide the existing SAML session details in one of the following ways:

• as an HTTP SessionID: in this case the component will try to pick the matching SAML session from its session cache.
• as a known NameID.
• as a known SAML SessionIndex.

You can use a combination of the above.

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.

Use RelayState to pass a value to the IdP that you want to be mirrored back in the IdP's response. The Tag value will be similarly mirrored, but in the component's events, such as ProcessingCompleted.

You can use this method with or without the OfflineMode.

ListClients Method (SAMLSPServer Component)

Enumerates the connected clients.

Syntax

String __fastcall ListClients();

Remarks

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

PinClient Method (SAMLSPServer Component)

Takes a snapshot of the connection's properties.

Syntax

void __fastcall PinClient(__int64 ConnectionId);

Remarks

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

ProcessArtifact Method (SAMLSPServer Component)

Processes an artifact request received from the IdP service at one of artifact receiver endpoints.

Syntax

int __fastcall ProcessArtifact(__int64 ConnectionID, String SessionID, String Request, String Tag);

Remarks

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

Artifact messages are typically very simple:

https://idp.server.com/sso/artifact?SAMLart=artifact

In response to the artifact received, the server initiates an artifact resolution protocol to retrieve the SAML message identified by the artifact. This will typically expose itself via an invocation of the ArtifactResolveRequestPrepared event, and, later on, of an event matching the type of the actual message received - such as AssertionReceived.

You can use this method with or without the OfflineMode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

ProcessArtifactResolveRequest Method (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, String Tag);

Remarks

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

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

You can use this method with or without the OfflineMode.

Note: this method is currently in development and will be available in later SecureBlackbox updates.

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, String Tag);

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

DynamicArray<Byte> __fastcall ProcessGenericRequest(__int64 ConnectionID, DynamicArray<Byte> Request);

Remarks

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

The Request parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. The 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).

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, String Tag);

Remarks

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

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

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

You can use this method with or without the OfflineMode.

Reset Method (SAMLSPServer Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

SetClientBuffer Method (SAMLSPServer Component)

Commits a data buffer to the connection.

Syntax

void __fastcall SetClientBuffer(__int64 ConnectionID, String Handle, 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

SetResponseHeader Method (SAMLSPServer Component)

Sets a response header.

Syntax

void __fastcall SetResponseHeader(__int64 ConnectionId, String HeaderName, String Value);

Remarks

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

SetSessionProperty Method (SAMLSPServer Component)

Sets the value of a custom provider session property.

Syntax

void __fastcall SetSessionProperty(String SessionID, String Name, String Value);

Remarks

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

The following properties can be adjusted for each individual session:

• AuthnRequestID: the AuthnRequest ID.
• LogoutRequestID: the LogoutRequest ID.
• NameID: the NameID of the user.
• RelayState: the current (last) relay state entry.
• Session: the session ID (the same as you pass as parameter).
• SessionIndex: a collection of cross-network session indexes assigned to this session.
• URL: the current request's URL.
• UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts.

Note: setting a session property invokes a call to SessionStateSave. The component does that to update the session state kept externally.

Note: changing session properties mindlessly may break the protocol flow. For example, changing AuthnRequestID to a different value may cause the Service Provider to reject the subsequent assertion message, as the incoming assertion will contain a now-unmatching In-Response-To entry.

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.

ArtifactReceived Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String Issuer;
  String Artifact;
  int Action;
} TsbxSAMLSPServerArtifactReceivedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerArtifactReceivedEvent)(System::TObject* Sender, TsbxSAMLSPServerArtifactReceivedEventParams *e);
__property TsbxSAMLSPServerArtifactReceivedEvent OnArtifactReceived = { read=FOnArtifactReceived, write=FOnArtifactReceived };

Remarks

The Artifact message is very simple and only contains the actual artifact (an opaque string). Depending on the choice of the Action parameter, the further flow may go as following:

• fraAuto: the server will prepare an ArtifactResolve request and sent it to the other side to retrieve the artifact.
• fraCustom: the server will acknowledge the receipt of the artifact, but it is the task of your code to request the message and pass it on to the server via ProcessGenericRequest method.
• fraReject: the server will discard the artifact.

Note that you still can choose fraAuto to let the server proceed, but alter the flow as required in further events, such as ArtifactResolveRequestPrepared.

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

ArtifactResolveRequestPrepared Event (SAMLSPServer Component)

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

Syntax

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

Remarks

Subscribe to this event to be notified about preparation of artifact resolution requests. This is fired right after the resolution request has been prepared, and just before the component sends it out to the identity provider.

ArtifactResolveRequestReceived Event (SAMLSPServer Component)

Reports receipt of ArtifactResolveRequest message.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String Issuer;
  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

The component fires this event to report receipt of incoming artifact resolution request. The Artifact parameter contains the artifact identifier received.

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

AssertionReceived Event (SAMLSPServer Component)

This event is fired when an assertion is received from the IdP.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String Issuer;
  String Body;
  bool IsEncrypted;
  bool IsSigned;
  String Auth;
  String NameID;
  String NameIDFormat;
  String SessionIndex;
  String Attributes;
  String ValidFrom;
  String ValidTo;
  String RelayState;
  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.

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

If the assertion is returned in response to this SP's AuthnRequest message, the RelayState parameter will contain the original relay state passed to the earlier InitiateAuth call.

AttributeQueryPrepared Event (SAMLSPServer Component)

Notifies the application of the preparation of an AttributeQuery.

Syntax

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

Remarks

The component uses this event to notify the application of the completion of the preparation of the AttributeQuery message. The NameID and NameIDFormat parameters indicate the attribute subject, and the Attributes parameter contains a list of attributes being requested.

This event may be fired in response to a InitiateAttributeQuery call (in offline mode), or intermittently in online mode.

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;
  String Destination;
  String NameIDFormat;
  bool ForceAuthn;
  bool NonInteractive;
  String RelayState;
} TsbxSAMLSPServerAuthnRequestPreparedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerAuthnRequestPreparedEvent)(System::TObject* Sender, TsbxSAMLSPServerAuthnRequestPreparedEventParams *e);
__property TsbxSAMLSPServerAuthnRequestPreparedEvent OnAuthnRequestPrepared = { read=FOnAuthnRequestPrepared, write=FOnAuthnRequestPrepared };

Remarks

Subscribe to this event to get notified about assertion requests prepared by the service provider. This event may fire from InitiateAuth method when working in OfflineMode, or at any time when working as a standalone live web server.

You can adjust the RelayState as required in the event handler to pass on a state to the IdP. The IdP will return this state back to you together with its authentication assertion.

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;
  String SessionID;
  int ErrorCode;
  bool Fatal;
  bool Remote;
  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 the SignedData parameter.

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

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

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

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

LogoutRequestPrepared Event (SAMLSPServer Component)

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

Syntax

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

Remarks

The component uses this event to report completion of the LogoutRequest preparation. The NameID, NameIDFormat, and SessionIndex parameters indicate the subject that is being logged out. The SP parameter references the service provider involved.

The RelayState contains the relay state value that is going to be passed with the LogoutRequest to the remote party and mirrored back (if the protocol supports it).

LogoutRequestReceived Event (SAMLSPServer Component)

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

Syntax

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

Remarks

The SAML SP server fires this event when a SAML logout request is received at a single logout service endpoint. The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.

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

LogoutResponsePrepared Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String Destination;
  String Body;
  String NameID;
  String NameIDFormat;
  String SessionIndex;
} TsbxSAMLSPServerLogoutResponsePreparedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerLogoutResponsePreparedEvent)(System::TObject* Sender, TsbxSAMLSPServerLogoutResponsePreparedEventParams *e);
__property TsbxSAMLSPServerLogoutResponsePreparedEvent OnLogoutResponsePrepared = { read=FOnLogoutResponsePrepared, write=FOnLogoutResponsePrepared };

Remarks

The IdP server fires this event when it has prepared a Logout Response message and is ready to send it out to the SP.

LogoutResponseReceived Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String Issuer;
  bool IsEncrypted;
  bool IsSigned;
  String NameID;
  String NameIDFormat;
  String SessionIndex;
  String RelayState;
  int Action;
} TsbxSAMLSPServerLogoutResponseReceivedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerLogoutResponseReceivedEvent)(System::TObject* Sender, TsbxSAMLSPServerLogoutResponseReceivedEventParams *e);
__property TsbxSAMLSPServerLogoutResponseReceivedEvent OnLogoutResponseReceived = { read=FOnLogoutResponseReceived, write=FOnLogoutResponseReceived };

Remarks

The SAML SP server fires this event when a SAML logout response is received at a single logout service endpoint following the LogoutRequest sent earlier. The RelayState is a mirrored back value included in the request.

The NameID, NameIDFormat, and SessionIndex parameters indicate the principal that is signing out.

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

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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

This component can fire this event with the following EventID values:

ProcessingCompleted Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String Tag;
  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.

ReadArtifact Event (SAMLSPServer Component)

Requests content identified by an artifact from the application.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RequestID;
  String Issuer;
  String Artifact;
  String Value;
  bool Skip;
} TsbxSAMLSPServerReadArtifactEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerReadArtifactEvent)(System::TObject* Sender, TsbxSAMLSPServerReadArtifactEventParams *e);
__property TsbxSAMLSPServerReadArtifactEvent OnReadArtifact = { read=FOnReadArtifact, write=FOnReadArtifact };

Remarks

The component fires this event to request the content matching Artifact from the application. This is normally happens within the artifact resolution protocol between the SP and the IdP server.

The application must provide the requested artifact content via the Value parameter. The application can choose not to provide the artifact content (for example, if it doesn't have it) by setting Skip to true.

ResourceClose Event (SAMLSPServer Component)

Tells the application that it can close the opened resource.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String Handle;
} 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.

ResourceOpen Event (SAMLSPServer Component)

Requests the application to open the requested resource.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String URL;
  String HttpMethod;
  int OperationStatus;
  String Handle;
} 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;
  String SessionID;
  String Handle;
  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 SessionID;
  String URL;
  String HttpMethod;
  bool ResProtected;
  bool ResSpecial;
  bool AllowWriting;
  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:

ResourceWrite Event (SAMLSPServer Component)

Requests the application to write to an opened resource.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String Handle;
  int OperationStatus;
} TsbxSAMLSPServerResourceWriteEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerResourceWriteEvent)(System::TObject* Sender, TsbxSAMLSPServerResourceWriteEventParams *e);
__property TsbxSAMLSPServerResourceWriteEvent OnResourceWrite = { read=FOnResourceWrite, write=FOnResourceWrite };

Remarks

The component fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the GetClientBuffer method and write them to the opened file descriptor.

Use the OperationStatus parameter to return the operation result back to the server:

SAMLMessagePrepared Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String MessageID;
  String Destination;
  String IssueInstant;
  String InResponseTo;
  String RequestBody;
  String MessageType;
  String MessageBody;
  String RelayState;
  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 every SAML message that has been prepared by the server. This event is fired for every type of the outgoing message (e.g. SAMLResponse or LogoutRequest). The InResponseTo contains the ID of the message in response to which the current message is sent (if applicable). The RequestBody parameter contains the body of such request.

The MessageType parameter indicates the type of the message that has been prepared, such as SAMLResponse. The MessageBody contains the XML body of the message. The Success parameter indicates whether the message contains a positive statement or an error. Both the MessageBody and Success parameters are adjustable.

SAMLMessageReceived Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String MessageID;
  String Issuer;
  String IssueInstant;
  String InResponseTo;
  String RequestBody;
  String MessageType;
  String MessageBody;
  bool IsSigned;
  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 incoming SAML messages.

The MessageType, MessageID, Issuer, and MessageBody parameters provide the details of the message received. The RequestBody and InResponseTo contain a reference to the request that this message is a response to (if any).

Set Action property as required to let the component know how to proceed.

SessionCreated Event (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 SAML session events.

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 event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes.

The SessionID parameter specifies the session ID, and the EventText parameter describes the event that happened. Below are a few typical examples of what EventText you can expect to get:

• Start
• AuthnRequestPrepared
• ResponseReceived
• ResourceSupplied
• LogoutRequestPrepared
• LogoutResponseReceived
• LogoutRequestReceived
• LogoutResponsePrepared
• ArtifactResolveRequestReceived
• ArtifactResponsePrepared
• Finish

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

SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them.

The components use a collection of Session* events to exchange session information with the application:

• SessionCreated is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie.
• SessionStateSave : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire SessionStateSave multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data.
• SessionStateRetrieve : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again.
• SessionInfoNeeded (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls ProcessLogoutRequest but passes an empty SessionID as a parameter.
• SessionDestroyed is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event.

SessionStateRetrieve Event (SAMLSPServer Component)

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

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

The component fires this event to request a session state that was previously provided to the application via the SessionStateSave call.

See the SessionInfoNeeded topic for more details about session management in offline mode.

SessionStateSave Event (SAMLSPServer Component)

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

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

The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a SessionStateRetrieve call.

See the SessionInfoNeeded topic for more details about session management in offline mode.

SignatureFound Event (SAMLSPServer Component)

Signifies the start of signature validation.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  int Scope;
  String Signer;
  String TargetID;
  String TargetType;
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  String SigMethod;
  String DigestMethod;
  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;
  int Scope;
  String Signer;
  String TargetID;
  String TargetType;
  String IssuerRDN;
  DynamicArray SerialNumber;
  DynamicArray SubjectKeyID;
  String SigMethod;
  String DigestMethod;
  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:

TLSCertValidate Event (SAMLSPServer Component)

Fires when a client certificate needs to be validated.

Syntax

typedef struct {
  __int64 ConnectionID;
  bool Accept;
} TsbxSAMLSPServerTLSCertValidateEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerTLSCertValidateEvent)(System::TObject* Sender, TsbxSAMLSPServerTLSCertValidateEventParams *e);
__property TsbxSAMLSPServerTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };

Remarks

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

TLSEstablished Event (SAMLSPServer Component)

Reports the setup of a TLS session.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxSAMLSPServerTLSEstablishedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerTLSEstablishedEvent)(System::TObject* Sender, TsbxSAMLSPServerTLSEstablishedEventParams *e);
__property TsbxSAMLSPServerTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };

Remarks

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

TLSHandshake Event (SAMLSPServer Component)

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

Syntax

typedef struct {
  __int64 ConnectionID;
  String ServerName;
  bool Abort;
} TsbxSAMLSPServerTLSHandshakeEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerTLSHandshakeEvent)(System::TObject* Sender, TsbxSAMLSPServerTLSHandshakeEventParams *e);
__property TsbxSAMLSPServerTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };

Remarks

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

TLSPSK Event (SAMLSPServer Component)

Requests a pre-shared key for TLS-PSK.

Syntax

typedef struct {
  __int64 ConnectionID;
  String Identity;
  String PSK;
  String Ciphersuite;
} TsbxSAMLSPServerTLSPSKEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerTLSPSKEvent)(System::TObject* Sender, TsbxSAMLSPServerTLSPSKEventParams *e);
__property TsbxSAMLSPServerTLSPSKEvent OnTLSPSK = { read=FOnTLSPSK, write=FOnTLSPSK };

Remarks

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

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

TLSShutdown Event (SAMLSPServer Component)

Reports closure of a TLS session.

Syntax

typedef struct {
  __int64 ConnectionID;
} TsbxSAMLSPServerTLSShutdownEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerTLSShutdownEvent)(System::TObject* Sender, TsbxSAMLSPServerTLSShutdownEventParams *e);
__property TsbxSAMLSPServerTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };

Remarks

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

UserAuthCompleted Event (SAMLSPServer Component)

Notifies the application about the success of user authentication flow.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String AssertionBody;
  String Auth;
  String NameID;
  String NameIDFormat;
  String SessionIndex;
  String ValidFrom;
  String ValidTo;
  String RelayState;
} TsbxSAMLSPServerUserAuthCompletedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerUserAuthCompletedEvent)(System::TObject* Sender, TsbxSAMLSPServerUserAuthCompletedEventParams *e);
__property TsbxSAMLSPServerUserAuthCompletedEvent OnUserAuthCompleted = { read=FOnUserAuthCompleted, write=FOnUserAuthCompleted };

Remarks

Subscribe to this event to get notified about completion of user authentication flow. The NameID, NameIDFormat, SessionIndex, ValidFrom, and ValidTo parameters contain the session parameters as stated in the assertion, which is provided via the AssertionBody parameter. The Auth parameter contain the authentication mechanism used.

The RelayState matches the original relay state that was used on the initiation stage of the authentication.

UserAuthFailed Event (SAMLSPServer Component)

Notifies the application about failure of user authentication flow.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String RelayState;
} TsbxSAMLSPServerUserAuthFailedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerUserAuthFailedEvent)(System::TObject* Sender, TsbxSAMLSPServerUserAuthFailedEventParams *e);
__property TsbxSAMLSPServerUserAuthFailedEvent OnUserAuthFailed = { read=FOnUserAuthFailed, write=FOnUserAuthFailed };

Remarks

The component fires this event to notify the application about failed user authentication flow. The RelayState parameter matches the one included with the AuthnRequest message.

UserAuthStart Event (SAMLSPServer Component)

Notifies the application about the start of user authentication flow.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  int IdPServiceIndex;
  String RelayState;
} TsbxSAMLSPServerUserAuthStartEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerUserAuthStartEvent)(System::TObject* Sender, TsbxSAMLSPServerUserAuthStartEventParams *e);
__property TsbxSAMLSPServerUserAuthStartEvent OnUserAuthStart = { read=FOnUserAuthStart, write=FOnUserAuthStart };

Remarks

The component invokes this event to signal the start of the user authentication flow. This happens shortly before the component proceeds to generation of AuthnRequest message.

The RelayState is an arbitrary string that will be passed to the IdP and mirrored back with the assertion. It is typically used to remember the URL of the resource or page that kicked in the SAML authentication flow.

UserLogoutCompleted Event (SAMLSPServer Component)

Notifies the application about the completion of user logout flow.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  String NameID;
  String SessionIndex;
  String RelayState;
} TsbxSAMLSPServerUserLogoutCompletedEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerUserLogoutCompletedEvent)(System::TObject* Sender, TsbxSAMLSPServerUserLogoutCompletedEventParams *e);
__property TsbxSAMLSPServerUserLogoutCompletedEvent OnUserLogoutCompleted = { read=FOnUserLogoutCompleted, write=FOnUserLogoutCompleted };

Remarks

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

UserLogoutStart Event (SAMLSPServer Component)

Notifies the application about the start of user logout flow.

Syntax

typedef struct {
  __int64 ConnectionID;
  String SessionID;
  int IdPServiceIndex;
  String NameID;
  String SessionIndex;
  bool Secondary;
  String RelayState;
} TsbxSAMLSPServerUserLogoutStartEventParams;
typedef void __fastcall (__closure *TsbxSAMLSPServerUserLogoutStartEvent)(System::TObject* Sender, TsbxSAMLSPServerUserLogoutStartEventParams *e);
__property TsbxSAMLSPServerUserLogoutStartEvent OnUserLogoutStart = { read=FOnUserLogoutStart, write=FOnUserLogoutStart };

Remarks

Subscribe to this event to get notified about the start of the user logout flow.

The logout process can be initiated on either the SP or IdP side. This event is fired at the earliest opportunity that this fact becomes known to the service provider: from within the InitiateLogout method, ProcessLogoutRequest method, or upon receiving a logout request at the SLS endpoint.

Independently of the timing and the stage of this event, the subsequent flow is the same: the logout protocol is initiated. The application will be notified of the completion of the protocol using the UserLogoutCompleted event. Note that the UserLogoutCompleted event may not fire if the connectivity to the IdP is lost prematurely or the IdP chooses not to respond. Due to that, it is reasonable to consider the user as logged out immediately after the current event fires.

The IdPServiceIndex parameter contains the index of the IdP service in the IdPServices collection. NameID indicates the name identifier of the user that is being logged out, and SessionIndex contain the unique SAML session identifier. The Secondary flag indicates whether the the SP is responding to IdP-initiated logout request.

The RelayState parameter is an optional SP-generated token that the IdP will return back in its LogoutResponse message. This is often set to the destination page where the browser should be redirected upon completion of the signout process.

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