SAMLIdPServer Component
Properties Methods Events Config Settings Errors
The SAMLIdPServer component represents a SAML identity provider.
Syntax
TsbxSAMLIdPServer
Remarks
The identity provider in the SAML (Security Assertion Markup Language) exchange flow represents the server that issues authentication assertions for single sign-on (SSO).
Requests received by the IdP server from known service providers (SP) are processed automatically, in accordance with known SP metadata and IdP options. If the request is correct, the client is redirected to the IdP for authentication. The authentication algorithm depends on the IdP options and may be reduced to a simple IP check, X.509 certificate authentication, or login credentials check. TBD: article comparing two approaches to working with SAML (reader/writer and servers)
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Active | Tells whether the server is active and ready to process requests. |
AllowIDPSSO | Specifies if IdP-initiated Single Sign-On (SSO) is allowed. |
BaseDir | Base directory on the server. |
BindingKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
BindingKeyKey | The byte array representation of the key. |
EncryptionCertBytes | Returns the raw certificate data in DER format. |
EncryptionCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ExternalCryptoAsyncDocumentID | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
ExternalCryptoMethod | Specifies the asynchronous signing method. |
ExternalCryptoMode | Specifies the external cryptography mode. |
ExternalCryptoPublicKeyAlgorithm | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
FIPSMode | Reserved. |
HandshakeTimeout | Specifies the handshake timeout in milliseconds. |
Host | Specifies the host address of the IdP server. |
IdPServiceCount | The number of records in the IdPService arrays. |
IdPServiceBindingType | Specifies the type of SAML binding that this endpoint accepts. |
IdPServiceEntityID | Represents the SAML entity ID. |
IdPServiceLocation | The location (URL) of the endpoint. |
IdPServicePriority | The priority of the endpoint in relation to other endpoints with the same Location . |
IdPServiceService | The kind of the service being provided at this endpoint. |
IdPServiceServiceIndex | The index of this endpoint. |
IdPContactPerson | The contact person or persons for the entity. |
IdPEncryptionKey | Contains the entity's encryption key. |
IdPEncryptionMethods | Specifies the list of encryption methods supported by the entity. |
IdPEntityID | Represents the SAML entity ID. |
IdPFlags | Adjusts secondary entity properties. |
IdPIdPSSOLink | Contains a local server page link that triggers SAML authentication to the SP. |
IdPNameIDFormats | The list of NameID formats supported by this entity. |
IdPOrganizationDisplayName | The friendly name of the organization that maintains the entity. |
IdPOrganizationLang | The language preferred by the organization. |
IdPOrganizationName | The name of the organization that maintains the entity. |
IdPOrganizationURL | The web URL of the organization that maintains the entity. |
IdPSignatureValidationResult | The outcome of the cryptographic signature validation. |
IdPSigned | Specifies whether the SAML entity information is or should be signed. |
IdPSignedWith | Contains the certificate or key that was used to sign the settings (metadata) document. |
IdPSigningKey | Contains the entity's signing key. |
IdPValidUntil | Specifies the expiration time of the SAML entity information. |
IdPSSOPage | Specifies the relative URL of the IdP-initiated SSO page. |
IdPSSOPageTemplate | The content of the IdP-initiated SSO page. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns the raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownKeyCount | The number of records in the KnownKey arrays. |
KnownKeyHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
LoginAttemptsLimit | The maximum number of login attempts. |
MetadataURL | The IdP's metadata location. |
MetaSigningCertBytes | Returns the raw certificate data in DER format. |
MetaSigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
OfflineMode | Enables the Offline mode. |
PinnedClientAEADCipher | Indicates whether the encryption algorithm used is an AEAD cipher. |
PinnedClientChainValidationDetails | The details of a certificate chain validation outcome. |
PinnedClientChainValidationResult | The outcome of a certificate chain validation routine. |
PinnedClientCiphersuite | The cipher suite employed by this connection. |
PinnedClientClientAuthenticated | Specifies whether client authentication was performed during this connection. |
PinnedClientClientAuthRequested | Specifies whether client authentication was requested during this connection. |
PinnedClientConnectionEstablished | Indicates whether the connection has been established fully. |
PinnedClientConnectionID | The unique identifier assigned to this connection. |
PinnedClientDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
PinnedClientEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
PinnedClientExportable | Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
PinnedClientID | The client connection's unique identifier. |
PinnedClientKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
PinnedClientKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
PinnedClientNamedECCurve | The elliptic curve used in this connection. |
PinnedClientPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
PinnedClientPreSharedIdentity | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
PinnedClientPreSharedIdentityHint | A hint professed by the server to help the client select the PSK identity to use. |
PinnedClientPublicKeyBits | The length of the public key. |
PinnedClientRemoteAddress | The client's IP address. |
PinnedClientRemotePort | The remote port of the client connection. |
PinnedClientResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
PinnedClientSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
PinnedClientServerAuthenticated | Indicates whether server authentication was performed during a TLS-enabled connection. |
PinnedClientSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
PinnedClientSymmetricBlockSize | The block size of the symmetric algorithm used. |
PinnedClientSymmetricKeyBits | The key length of the symmetric algorithm used. |
PinnedClientTotalBytesReceived | The total number of bytes received over this connection. |
PinnedClientTotalBytesSent | The total number of bytes sent over this connection. |
PinnedClientValidationLog | Contains the server certificate's chain validation log. |
PinnedClientVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
PinnedClientCertCount | The number of records in the PinnedClientCert arrays. |
PinnedClientCertBytes | Returns the raw certificate data in DER format. |
PinnedClientCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
PinnedClientCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
PinnedClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
PinnedClientCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
PinnedClientCertIssuerRDN | A list of Property=Value pairs that uniquely identify the certificate issuer. |
PinnedClientCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
PinnedClientCertKeyBits | Returns the length of the public key in bits. |
PinnedClientCertKeyFingerprint | Returns a SHA1 fingerprint of the public key contained in the certificate. |
PinnedClientCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
PinnedClientCertPublicKeyBytes | Contains the certificate's public key in DER format. |
PinnedClientCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
PinnedClientCertSerialNumber | Returns the certificate's serial number. |
PinnedClientCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
PinnedClientCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
PinnedClientCertSubjectKeyID | Contains a unique identifier of the certificate's cryptographic key. |
PinnedClientCertSubjectRDN | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
PinnedClientCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
PinnedClientCertValidTo | The time point at which the certificate expires, in UTC. |
Port | The listening port number. |
SecurityCanonicalizationMethod | The canonicalization method to use in the signature. |
SecurityDigestMethod | The digest method to use. |
SecurityEncryptionMethod | The encryption method used to encrypt the assertion. |
SecurityFlags | Provides access to secondary security parameters and tweaks. |
SecuritySigMethod | The signature method to use. |
SecuritySignaturePolicy | Specifies the signature validation policy. |
SenderCertCount | The number of records in the SenderChain arrays. |
SenderChainBytes | Returns the raw certificate data in DER format. |
SenderChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningCertBytes | Returns the raw certificate data in DER format. |
SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningChainCount | The number of records in the SigningChain arrays. |
SigningChainBytes | Returns the raw certificate data in DER format. |
SigningChainHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SignOnPageTemplate | Defines the default authentication template (login page). |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
SPServiceCount | The number of records in the SPService arrays. |
SPServiceBindingType | Specifies the type of SAML binding that this endpoint accepts. |
SPServiceEntityID | Represents the SAML entity ID. |
SPServiceLocation | The location (URL) of the endpoint. |
SPServicePriority | The priority of the endpoint in relation to other endpoints with the same Location . |
SPServiceService | The kind of the service being provided at this endpoint. |
SPServiceServiceIndex | The index of this endpoint. |
SPCount | The number of records in the SP arrays. |
SPContactPerson | The contact person or persons for the entity. |
SPEncryptionKey | Contains the entity's encryption key. |
SPEncryptionMethods | Specifies the list of encryption methods supported by the entity. |
SPEntityID | Represents the SAML entity ID. |
SPFlags | Adjusts secondary entity properties. |
SPIdPSSOLink | Contains a local server page link that triggers SAML authentication to the SP. |
SPNameIDFormats | The list of NameID formats supported by this entity. |
SPOrganizationDisplayName | The friendly name of the organization that maintains the entity. |
SPOrganizationLang | The language preferred by the organization. |
SPOrganizationName | The name of the organization that maintains the entity. |
SPOrganizationURL | The web URL of the organization that maintains the entity. |
SPSignatureValidationResult | The outcome of the cryptographic signature validation. |
SPSigned | Specifies whether the SAML entity information is or should be signed. |
SPSignedWith | Contains the certificate or key that was used to sign the settings (metadata) document. |
SPSigningKey | Contains the entity's signing key. |
SPValidUntil | Specifies the expiration time of the SAML entity information. |
TLSServerCertCount | The number of records in the TLSServerCert arrays. |
TLSServerCertBytes | Returns the raw certificate data in DER format. |
TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSClientAuth | Enables or disables certificate-based client authentication. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects the renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | 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. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables the TLS session resumption capability. |
TLSVersions | The SSL/TLS versions to enable by default. |
URL | Specifies the base URL of this IdP server. |
UserCount | The number of records in the User arrays. |
UserAssociatedData | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
UserBasePath | Base path for this user in the server's file system. |
UserCertificate | Contains the user's certificate. |
UserData | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
UserEmail | The user's email address. |
UserHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UserHashAlgorithm | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. |
UserIncomingSpeedLimit | Specifies the incoming speed limit for this user. |
UserOtpAlgorithm | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). |
UserOTPLen | Specifies the length of the user's OTP password. |
UserOtpValue | The user's time interval (TOTP) or Counter (HOTP). |
UserOutgoingSpeedLimit | Specifies the outgoing speed limit for this user. |
UserPassword | The user's authentication password. |
UserSharedSecret | Contains the user's secret key, which is essentially a shared secret between the client and server. |
UserSSHKey | Contains the user's SSH key. |
UserUsername | The registered name (login) of the user. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddIdPService | Registers an IdP service in the IdPServices list. |
AddSP | Registers an SP entity in SPSettings list. |
AddSPService | Registers an SP service in the SPServices list. |
CompleteAuth | Initiates transfer of the authentication fact (assertion) to the IdP. |
Config | This method sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
DropClient | Terminates a client connection. |
ExportSettings | Saves the SP or IdP configuration to an XML metadata file. |
GetProviderProperty | Returns the value of a custom provider property. |
GetRequestBytes | Obtains a pending connection buffer. |
GetRequestHeader | Returns a request header value. |
GetResponseHeader | Returns a response header value. |
GetSessionProperty | Returns the value of a custom session property. |
ImportSettings | Loads the metadata required for information exchange with the identity provider. Both local (IdP-side) and remote (SP-side) metadata can be loaded with this call. |
InitiateAuth | Starts IdP-initiated SAML authentication flow. |
InitiateLogout | Starts IdP-initiated SAML logout flow. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
ProcessArtifactResolveRequest | Processes an artifact request received from the SP service at one of the ARS endpoints. |
ProcessAttributeQuery | Processes an attribute request received from the SP service at one of the AQS endpoints. |
ProcessGenericRequest | Processes a generic HTTP SAML request. |
ProcessLogoutRequest | Processes logout request received from the SP service at one of the SLS endpoints. |
ProcessSignOnRequest | Processes a single sign-on request received from the SP service at one of the SSO endpoints. |
ProcessSignOnResponse | Processes the submission of the login form previously generated by the IdP server. |
RemoveSP | Removes an SP from the list of trusted service providers. |
Reset | Resets the component settings. |
SetClientBuffer | Commits a data buffer to the connection. |
SetProviderProperty | Sets the value of a custom provider property. |
SetResponseHeader | Sets a response header. |
SetSessionProperty | Sets the value of a custom provider session property. |
Start | Starts the IdP server. |
Stop | Stops the IdP server. |
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.
Accept | Reports an incoming connection. |
ArtifactResolveRequestPrepared | This event is fired when a new authentication request message has been prepared. |
ArtifactResolveRequestReceived | TBD. |
AssertionPrepared | This event fires when a new assertion has been created by the IdP server. |
AttributeQueryReceived | TBD. |
AuthnRequestReceived | The server fires this event upon receiving an AuthnRequest message from the other side. |
Connect | Reports an accepted connection. |
Disconnect | Fires to report a disconnected client. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
LogoutRequestReceived | The component uses this event to notify the application about incoming SAML Logout Request message. |
LogoutResponsePrepared | The component uses this event to notify the application about the Logout Response message being ready to be sent. |
MetadataPrepared | Passes a prepared metadata object to the application. |
Notification | This event notifies the application about an underlying control flow event. |
ProcessingCompleted | This event notifies the application of the completion of request or response processing. |
ResourceClose | Tells the application that it can close the opened resource. |
ResourceOpen | Requests the application to open the requested resource. |
ResourceRead | Requests the application to read from an opened resource. |
ResourceRequest | Notifies the application that a server resource is requested. |
SAMLMessagePrepared | This event is fired when a SAML message has been prepared and is ready to be dispatched. |
SAMLMessageReceived | The server fires this event for every SAML message it receives. |
SessionCreated | This event is fired when a new session has been established. |
SessionDestroyed | This event is fired when the IdP server has closed a session. |
SessionEvent | Notifies the application about the change of SAML session stage. |
SessionInfoNeeded | This event is fired in OfflineMode to request the session ID for the current flow. |
SessionStateRetrieve | TBD. |
SessionStateSave | TBD. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Reports the signature validation result. |
SignOnPagePrepared | The server fires this event upon preparing the sign-on page. |
SignOnResponseReceived | TBD. |
TLSCertValidate | Fires when a client certificate needs to be validated. |
TLSEstablished | Reports the setup of a TLS session. |
TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
TLSPSK | Requests a pre-shared key for TLS-PSK. |
TLSShutdown | Reports closure of a TLS session. |
UserAuthCompleted | Notifies the application about the success of user authentication flow. |
UserAuthFailed | Notifies the application about the failure of user authentication flow. |
UserAuthStart | Notifies the application about the start of user authentication flow. |
UserAuthVerifyCredentials | Passes user credentials to the application for verification. |
UserLogoutCompleted | Notifies the application about the completion of user logout flow. |
UserLogoutStart | Notifies the application about the start of user logout flow. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AllowOptionsResponseWithoutAuth | Enables unauthenticated responses to OPTIONS requests. |
AssertionsOneTimeUse | Adds a one-time use condition to the assertion. |
AssertionsTTL | The assertions time-to-live value. |
AuthDigestExpire | Specifies digest expiration time for digest authentication. |
BoundPort | The port that was bound by the server. |
DefaultNameIDPolicyFormat | Default name ID policy format. |
DefaultPassiveAuthnContextClassRef | The default passive authentication context class. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
HandshakeTimeout | The HTTPS handshake timeout. |
HomePage | Specifies the home page resource name. |
MaxIssueInstantTimeDiff | The maximum issue-instant time delta. |
NotBeforeTimeout | The 'not-before' timeout to use. |
PortRangeFrom | The lower bound of allowed port scope to listen on. |
PortRangeTo | The higher bound of allowed port scope to listen on. |
RequestFilter | The request string modifier. |
ServerName | Specifies the server name for the created responses. |
SessionTimeout | The HTTP session timeout. |
SessionTTL | The SAML session time-to-live value. |
SubjectConfirmationMethod | Subject confirmation method. |
TempPath | Path for storing temporary files. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the component. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
Active Property (SAMLIdPServer 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
AllowIDPSSO Property (SAMLIdPServer Component)
Specifies if IdP-initiated Single Sign-On (SSO) is allowed.
Syntax
__property bool AllowIDPSSO = { read=FAllowIDPSSO, write=FSetAllowIDPSSO };
Default Value
false
Remarks
Set this property to true to allow IdP-initiated Single Sign-Ons. Use the IdPSSOLink parameter of AddSP method to add sign-on URLs.
Data Type
Boolean
BaseDir Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
The byte array representation of the key.
Syntax
__property DynamicArrayBindingKeyKey = { 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
EncryptionCertBytes Property (SAMLIdPServer Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayEncryptionCertBytes = { read=FEncryptionCertBytes };
Remarks
Returns the raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
EncryptionCertHandle Property (SAMLIdPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 EncryptionCertHandle = { read=FEncryptionCertHandle, write=FSetEncryptionCertHandle };
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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Data Type
String
ExternalCryptoKeyID Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
Specifies the asynchronous signing method.
Syntax
__property TsbxSAMLIdPServerExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };
enum TsbxSAMLIdPServerExternalCryptoMethods { 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:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Data Type
Integer
ExternalCryptoMode Property (SAMLIdPServer Component)
Specifies the external cryptography mode.
Syntax
__property TsbxSAMLIdPServerExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };
enum TsbxSAMLIdPServerExternalCryptoModes { ecmDefault=0, ecmDisabled=1, ecmGeneric=2, ecmDCAuth=3, ecmDCAuthJSON=4 };
Default Value
ecmDefault
Remarks
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with the OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
This property is not available at design time.
Data Type
Integer
ExternalCryptoPublicKeyAlgorithm Property (SAMLIdPServer 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.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Data Type
String
FIPSMode Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
Specifies the host address of the IdP 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 (SAMLIdPServer 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
This property is read-only and not available at design time.
Data Type
Integer
IdPServiceBindingType Property (SAMLIdPServer Component)
Specifies the type of SAML binding that this endpoint accepts.
Syntax
__property TsbxSAMLIdPServerIdPServiceBindingTypes IdPServiceBindingType[int IdPServiceIndex] = { read=FIdPServiceBindingType };
enum TsbxSAMLIdPServerIdPServiceBindingTypes { 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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. TBD:
This property is not available at design time.
Data Type
String
IdPEncryptionMethods Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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. TBD:
This property is not available at design time.
Data Type
String
IdPNameIDFormats Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
The outcome of the cryptographic signature validation.
Syntax
__property TsbxSAMLIdPServerIdPSignatureValidationResults IdPSignatureValidationResult = { read=FIdPSignatureValidationResult };
enum TsbxSAMLIdPServerIdPSignatureValidationResults { 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:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
This property is read-only and not available at design time.
Data Type
Integer
IdPSigned Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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.
TBD: TBD: rename to SigningCert? and EncryptionKey to EncryptionCert?
This property is not available at design time.
Data Type
String
IdPValidUntil Property (SAMLIdPServer 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
IdPSSOPage Property (SAMLIdPServer Component)
Specifies the relative URL of the IdP-initiated SSO page.
Syntax
__property String IdPSSOPage = { read=FIdPSSOPage, write=FSetIdPSSOPage };
Default Value
"/idpsso"
Remarks
Use this property to specify the address of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP). TBD:
Data Type
String
IdPSSOPageTemplate Property (SAMLIdPServer Component)
The content of the IdP-initiated SSO page.
Syntax
__property String IdPSSOPageTemplate = { read=FIdPSSOPageTemplate, write=FSetIdPSSOPageTemplate };
Default Value
""
Remarks
Use this property to specify the content of the Single Sign-On (SSO) page initiated by this Identity Provider (IdP).
Data Type
String
KnownCertCount Property (SAMLIdPServer 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:
The array indices start at 0 and end at KnownCertCount - 1.This property is not available at design time.
Data Type
Integer
KnownCertBytes Property (SAMLIdPServer Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayKnownCertBytes[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 (SAMLIdPServer 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 (SAMLIdPServer 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:
The array indices start at 0 and end at KnownKeyCount - 1.This property is not available at design time.
Data Type
Integer
KnownKeyHandle Property (SAMLIdPServer 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
LoginAttemptsLimit Property (SAMLIdPServer Component)
The maximum number of login attempts.
Syntax
__property int LoginAttemptsLimit = { read=FLoginAttemptsLimit, write=FSetLoginAttemptsLimit };
Default Value
3
Remarks
Use this property to set the maximum number of login attempts.
Data Type
Integer
MetadataURL Property (SAMLIdPServer Component)
The IdP's metadata location.
Syntax
__property String MetadataURL = { read=FMetadataURL, write=FSetMetadataURL };
Default Value
"/idp/metadata"
Remarks
This property specifies the metadata URL of this Identity Provider (IdP).
Data Type
String
MetaSigningCertBytes Property (SAMLIdPServer Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayMetaSigningCertBytes = { 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 (SAMLIdPServer 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 (SAMLIdPServer 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 incoming requests to be routed by the application via calls to ProcessSignOnRequest, ProcessLogoutRequest, ProcessSignOnResponse, 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 requests.
Data Type
Boolean
PinnedClientAEADCipher Property (SAMLIdPServer 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 (SAMLIdPServer 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:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientChainValidationResult Property (SAMLIdPServer Component)
The outcome of a certificate chain validation routine.
Syntax
__property TsbxSAMLIdPServerPinnedClientChainValidationResults PinnedClientChainValidationResult = { read=FPinnedClientChainValidationResult };
enum TsbxSAMLIdPServerPinnedClientChainValidationResults { cvtValid=0, cvtValidButUntrusted=1, cvtInvalid=2, cvtCantBeEstablished=3 };
Default Value
cvtValid
Remarks
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
The unique identifier assigned to this connection.
Syntax
__property DynamicArrayPinnedClientConnectionID = { 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertBytes Property (SAMLIdPServer Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayPinnedClientCertBytes[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 (SAMLIdPServer Component)
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Syntax
__property DynamicArrayPinnedClientCertCAKeyID[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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
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 (SAMLIdPServer Component)
Contains the certificate's public key in DER format.
Syntax
__property DynamicArrayPinnedClientCertPublicKeyBytes[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 (SAMLIdPServer 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 (SAMLIdPServer Component)
Returns the certificate's serial number.
Syntax
__property DynamicArrayPinnedClientCertSerialNumber[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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
Contains a unique identifier of the certificate's cryptographic key.
Syntax
__property DynamicArrayPinnedClientCertSubjectKeyID[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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
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 IdP server should listen for incoming connections. To specify server's IP address use Host.
Data Type
Integer
SecurityCanonicalizationMethod Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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:
SB_XML_ENCRYPTION_ALGORITHM_RC4 | RC4 | |
SB_XML_ENCRYPTION_ALGORITHM_DES | DES | |
SB_XML_ENCRYPTION_ALGORITHM_3DES | 3DEST | |
SB_XML_ENCRYPTION_ALGORITHM_AES128 | AES128 | |
SB_XML_ENCRYPTION_ALGORITHM_AES192 | AES192 | |
SB_XML_ENCRYPTION_ALGORITHM_AES256 | AES256 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA128 | Camellia128 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA192 | Camellia192 | |
SB_XML_ENCRYPTION_ALGORITHM_CAMELLIA256 | Camellia256 | |
SB_XML_ENCRYPTION_ALGORITHM_SEED | SEED |
This property is not available at design time.
Data Type
String
SecurityFlags Property (SAMLIdPServer 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):
- ssfSignatureAfterIssuer (0x00000001) - Signature after issuer
- ssfSignatureBeforeDescriptor (0x00000002) - Signature before descriptor
- ssfKeyDataIssuerSerial (0x00000004) - Include the IssuerSerial key data element
- ssfKeyDataSKI (0x00000008) - Include the SubjectKeyIdentifier key data element
- ssfKeyDataSubjectName (0x00000010) - Include the SubjectName key data element
- ssfKeyDataCertificate (0x00000020) - Include the Certificate key data element
- ssfKeyDataCRL (0x00000040) - Include the CRL key data element
- ssfSignAuthnRequests (0x00010000) - Sign authentication requests
- ssfSignArtifactResolveRequests (0x00020000) - Sign artifact resolve requests
- ssfSignLogoutRequests (0x00040000) - Sign logout requests
- ssfSignAssertions (0x00080000) - Sign outgoing assertions
- ssfSignResponses (0x00100000) - Sign all responses
- ssfEncryptAssertions (0x00200000) - Encrypt generated assertions
This property is not available at design time.
Data Type
Integer
SecuritySigMethod Property (SAMLIdPServer 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 (SAMLIdPServer Component)
Specifies the signature validation policy.
Syntax
__property TsbxSAMLIdPServerSecuritySignaturePolicies SecuritySignaturePolicy = { read=FSecuritySignaturePolicy, write=FSetSecuritySignaturePolicy };
enum TsbxSAMLIdPServerSecuritySignaturePolicies { 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 (SAMLIdPServer 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:
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 (SAMLIdPServer Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArraySenderChainBytes[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 (SAMLIdPServer 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 (SAMLIdPServer Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArraySigningCertBytes = { 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 (SAMLIdPServer 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 (SAMLIdPServer 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:
The array indices start at 0 and end at SigningChainCount - 1.This property is not available at design time.
Data Type
Integer
SigningChainBytes Property (SAMLIdPServer Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArraySigningChainBytes[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 (SAMLIdPServer 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
SignOnPageTemplate Property (SAMLIdPServer Component)
Defines the default authentication template (login page).
Syntax
__property String SignOnPageTemplate = { read=FSignOnPageTemplate, write=FSetSignOnPageTemplate };
Default Value
""
Remarks
This property contains the HTML code of the authentication form. You can use it to control the appearance of the login page.
Data Type
String
SocketIncomingSpeedLimit Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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
This property is read-only and not available at design time.
Data Type
Integer
SPServiceBindingType Property (SAMLIdPServer Component)
Specifies the type of SAML binding that this endpoint accepts.
Syntax
__property TsbxSAMLIdPServerSPServiceBindingTypes SPServiceBindingType[int SPServiceIndex] = { read=FSPServiceBindingType };
enum TsbxSAMLIdPServerSPServiceBindingTypes { 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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
SPCount Property (SAMLIdPServer Component)
The number of records in the SP arrays.
Syntax
__property int SPCount = { read=FSPCount, write=FSetSPCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- SPContactPerson
- SPEncryptionKey
- SPEncryptionMethods
- SPEntityID
- SPFlags
- SPIdPSSOLink
- SPNameIDFormats
- SPOrganizationDisplayName
- SPOrganizationLang
- SPOrganizationName
- SPOrganizationURL
- SPServiceBindingType
- SPServiceEntityID
- SPServiceLocation
- SPServicePriority
- SPServiceService
- SPServiceServiceIndex
- SPSignatureValidationResult
- SPSigned
- SPSignedWith
- SPSigningKey
- SPValidUntil
This property is not available at design time.
Data Type
Integer
SPContactPerson Property (SAMLIdPServer Component)
The contact person or persons for the entity.
Syntax
__property String SPContactPerson[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPEncryptionKey Property (SAMLIdPServer Component)
Contains the entity's encryption key.
Syntax
__property String SPEncryptionKey[int SPIndex] = { 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. TBD:
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPEncryptionMethods Property (SAMLIdPServer Component)
Specifies the list of encryption methods supported by the entity.
Syntax
__property String SPEncryptionMethods[int SPIndex] = { 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
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPEntityID Property (SAMLIdPServer Component)
Represents the SAML entity ID.
Syntax
__property String SPEntityID[int SPIndex] = { 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).
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPFlags Property (SAMLIdPServer Component)
Adjusts secondary entity properties.
Syntax
__property int SPFlags[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
Integer
SPIdPSSOLink Property (SAMLIdPServer Component)
Contains a local server page link that triggers SAML authentication to the SP.
Syntax
__property String SPIdPSSOLink[int SPIndex] = { 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. TBD:
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPNameIDFormats Property (SAMLIdPServer Component)
The list of NameID formats supported by this entity.
Syntax
__property String SPNameIDFormats[int SPIndex] = { 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
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPOrganizationDisplayName Property (SAMLIdPServer Component)
The friendly name of the organization that maintains the entity.
Syntax
__property String SPOrganizationDisplayName[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPOrganizationLang Property (SAMLIdPServer Component)
The language preferred by the organization.
Syntax
__property String SPOrganizationLang[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPOrganizationName Property (SAMLIdPServer Component)
The name of the organization that maintains the entity.
Syntax
__property String SPOrganizationName[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPOrganizationURL Property (SAMLIdPServer Component)
The web URL of the organization that maintains the entity.
Syntax
__property String SPOrganizationURL[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPSignatureValidationResult Property (SAMLIdPServer Component)
The outcome of the cryptographic signature validation.
Syntax
__property TsbxSAMLIdPServerSPSignatureValidationResults SPSignatureValidationResult[int SPIndex] = { read=FSPSignatureValidationResult };
enum TsbxSAMLIdPServerSPSignatureValidationResults { 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:
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is read-only and not available at design time.
Data Type
Integer
SPSigned Property (SAMLIdPServer Component)
Specifies whether the SAML entity information is or should be signed.
Syntax
__property bool SPSigned[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SPSignedWith Property (SAMLIdPServer Component)
Contains the certificate or key that was used to sign the settings (metadata) document.
Syntax
__property String SPSignedWith[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is read-only and not available at design time.
Data Type
String
SPSigningKey Property (SAMLIdPServer Component)
Contains the entity's signing key.
Syntax
__property String SPSigningKey[int SPIndex] = { 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.
TBD: TBD: rename to SigningCert? and EncryptionKey to EncryptionCert?
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
SPValidUntil Property (SAMLIdPServer Component)
Specifies the expiration time of the SAML entity information.
Syntax
__property String SPValidUntil[int SPIndex] = { 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.
The SPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SPCount property.
This property is not available at design time.
Data Type
String
TLSServerCertCount Property (SAMLIdPServer 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:
The array indices start at 0 and end at TLSServerCertCount - 1.This property is not available at design time.
Data Type
Integer
TLSServerCertBytes Property (SAMLIdPServer Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayTLSServerCertBytes[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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
Selects the base configuration for the TLS settings.
Syntax
__property TsbxSAMLIdPServerTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };
enum TsbxSAMLIdPServerTLSBaseConfigurations { 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.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (SAMLIdPServer 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 (SAMLIdPServer Component)
Enables or disables certificate-based client authentication.
Syntax
__property TsbxSAMLIdPServerTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };
enum TsbxSAMLIdPServerTLSClientAuths { ccatNoAuth=0, ccatRequestCert=1, ccatRequireCert=2 };
Default Value
ccatNoAuth
Remarks
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
ccatNoAuth | 0 | |
ccatRequestCert | 1 | |
ccatRequireCert | 2 |
Data Type
Integer
TLSECCurves Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
Selects the renegotiation attack prevention mechanism.
Syntax
__property TsbxSAMLIdPServerTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };
enum TsbxSAMLIdPServerTLSRenegotiationAttackPreventionModes { crapmCompatible=0, crapmStrict=1, crapmAuto=2 };
Default Value
crapmAuto
Remarks
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
Integer
TLSRevocationCheck Property (SAMLIdPServer Component)
Specifies the kind(s) of revocation check to perform.
Syntax
__property TsbxSAMLIdPServerTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };
enum TsbxSAMLIdPServerTLSRevocationChecks { 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.
crcNone | 0 | No revocation checking |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP | 3 | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP | 4 | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL | 5 | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP | 6 | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP | 7 | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to 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.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (SAMLIdPServer 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
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. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (SAMLIdPServer Component)
Specifies the TLS mode to use.
Syntax
__property TsbxSAMLIdPServerTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };
enum TsbxSAMLIdPServerTLSTLSModes { smDefault=0, smNoTLS=1, smExplicitTLS=2, smImplicitTLS=3, smMixedTLS=4 };
Default Value
smDefault
Remarks
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Data Type
Integer
URL Property (SAMLIdPServer Component)
Specifies the base URL of this IdP server.
Syntax
__property String URL = { read=FURL, write=FSetURL };
Default Value
""
Remarks
Use this property to set the base URL for this Identity Provider (IdP) server.
Data Type
String
UserCount Property (SAMLIdPServer Component)
The number of records in the User arrays.
Syntax
__property int UserCount = { read=FUserCount, write=FSetUserCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- UserAssociatedData
- UserBasePath
- UserCertificate
- UserData
- UserEmail
- UserHandle
- UserHashAlgorithm
- UserIncomingSpeedLimit
- UserOtpAlgorithm
- UserOTPLen
- UserOtpValue
- UserOutgoingSpeedLimit
- UserPassword
- UserSharedSecret
- UserSSHKey
- UserUsername
This property is not available at design time.
Data Type
Integer
UserAssociatedData Property (SAMLIdPServer Component)
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
Syntax
__property DynamicArrayUserAssociatedData[int UserIndex] = { read=FUserAssociatedData, write=FSetUserAssociatedData };
Remarks
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserBasePath Property (SAMLIdPServer Component)
Base path for this user in the server's file system.
Syntax
__property String UserBasePath[int UserIndex] = { read=FUserBasePath, write=FSetUserBasePath };
Default Value
""
Remarks
Base path for this user in the server's file system.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserCertificate Property (SAMLIdPServer Component)
Contains the user's certificate.
Syntax
__property DynamicArrayUserCertificate[int UserIndex] = { read=FUserCertificate, write=FSetUserCertificate };
Remarks
Contains the user's certificate.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserData Property (SAMLIdPServer Component)
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Syntax
__property String UserData[int UserIndex] = { read=FUserData, write=FSetUserData };
Default Value
""
Remarks
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserEmail Property (SAMLIdPServer Component)
The user's email address.
Syntax
__property String UserEmail[int UserIndex] = { read=FUserEmail, write=FSetUserEmail };
Default Value
""
Remarks
The user's email address.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserHandle Property (SAMLIdPServer Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 UserHandle[int UserIndex] = { read=FUserHandle, write=FSetUserHandle };
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 UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Long64
UserHashAlgorithm Property (SAMLIdPServer Component)
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
Syntax
__property String UserHashAlgorithm[int UserIndex] = { read=FUserHashAlgorithm, write=FSetUserHashAlgorithm };
Default Value
""
Remarks
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:
SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | |
SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | |
SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserIncomingSpeedLimit Property (SAMLIdPServer Component)
Specifies the incoming speed limit for this user.
Syntax
__property int UserIncomingSpeedLimit[int UserIndex] = { read=FUserIncomingSpeedLimit, write=FSetUserIncomingSpeedLimit };
Default Value
0
Remarks
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOtpAlgorithm Property (SAMLIdPServer Component)
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
Syntax
__property TsbxSAMLIdPServerUserOtpAlgorithms UserOtpAlgorithm[int UserIndex] = { read=FUserOtpAlgorithm, write=FSetUserOtpAlgorithm };
enum TsbxSAMLIdPServerUserOtpAlgorithms { oaNone=0, oaHmac=1, oaTime=2 };
Default Value
oaNone
Remarks
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.
oaHmac | 0 | |
oaTime | 1 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOTPLen Property (SAMLIdPServer Component)
Specifies the length of the user's OTP password.
Syntax
__property int UserOTPLen[int UserIndex] = { read=FUserOTPLen, write=FSetUserOTPLen };
Default Value
0
Remarks
Specifies the length of the user's OTP password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOtpValue Property (SAMLIdPServer Component)
The user's time interval (TOTP) or Counter (HOTP).
Syntax
__property int UserOtpValue[int UserIndex] = { read=FUserOtpValue, write=FSetUserOtpValue };
Default Value
0
Remarks
The user's time interval (TOTP) or Counter (HOTP).
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOutgoingSpeedLimit Property (SAMLIdPServer Component)
Specifies the outgoing speed limit for this user.
Syntax
__property int UserOutgoingSpeedLimit[int UserIndex] = { read=FUserOutgoingSpeedLimit, write=FSetUserOutgoingSpeedLimit };
Default Value
0
Remarks
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserPassword Property (SAMLIdPServer Component)
The user's authentication password.
Syntax
__property String UserPassword[int UserIndex] = { read=FUserPassword, write=FSetUserPassword };
Default Value
""
Remarks
The user's authentication password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserSharedSecret Property (SAMLIdPServer Component)
Contains the user's secret key, which is essentially a shared secret between the client and server.
Syntax
__property DynamicArrayUserSharedSecret[int UserIndex] = { read=FUserSharedSecret, write=FSetUserSharedSecret };
Remarks
Contains the user's secret key, which is essentially a shared secret between the client and server.
Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserSSHKey Property (SAMLIdPServer Component)
Contains the user's SSH key.
Syntax
__property DynamicArrayUserSSHKey[int UserIndex] = { read=FUserSSHKey, write=FSetUserSSHKey };
Remarks
Contains the user's SSH key.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserUsername Property (SAMLIdPServer Component)
The registered name (login) of the user.
Syntax
__property String UserUsername[int UserIndex] = { read=FUserUsername, write=FSetUserUsername };
Default Value
""
Remarks
The registered name (login) of the user.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
AddIdPService Method (SAMLIdPServer Component)
Registers an IdP service in the IdPServices list.
Syntax
void __fastcall AddIdPService(int Service, int BindingType, String Location, int Priority, int Index);
Remarks
Use this method to add an entry to the list of services and their locations provided by the IdP. TBD
spsUnknown | 0 | The service is of unknown or unsupported type |
spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
AddSP Method (SAMLIdPServer Component)
Registers an SP entity in SPSettings list.
Syntax
void __fastcall AddSP(String EntityID, String IdPSSOLink);
Remarks
This method adds an empty entry to the SPSettings list of known service providers. When registering a service provider manually (v.s. importing it from its metadata with a ImportSettings call), make sure to register all the individual SP service endpoints (assertion consumer services, single logout services, and so on) manually using the AddSPService method.
Once you have added the SP entry to the list, you can edit it using the SPSettings property.
AddSPService Method (SAMLIdPServer Component)
Registers an SP service in the SPServices list.
Syntax
void __fastcall AddSPService(int Service, int BindingType, String Location, int Priority, int Index, String EntityID);
Remarks
Use this method to add an entry to the list of services and their locations provided by the SP. TBD
spsUnknown | 0 | The service is of unknown or unsupported type |
spsAssertionConsumerService | 1 | The assertion consumer service (SP side only) |
spsSingleLogoutService | 2 | The single logout service (SP or IdP sides) |
spsArtifactResolutionService | 3 | The artifact resolution service (SP or IdP sides) |
spsAttributeQueryService | 4 | The attribute query service (IdP side only) |
spsSingleSignOnService | 5 | The single sign-on service (IdP side only) |
CompleteAuth Method (SAMLIdPServer Component)
Initiates transfer of the authentication fact (assertion) to the IdP.
Syntax
int __fastcall CompleteAuth(__int64 ConnectionID, String SessionID, String SP, String RelayState, String Tag);
Remarks
Use this method to pass a SAML assertion to a chosen SP after completion of the IdP-initiated SSO process.
Calling this method is equivalent to navigating to the SP-specific IdP link on the web server running the SAML IdP service.
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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
Config Method (SAMLIdPServer Component)
This method 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 (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer Component)
Saves the SP or IdP configuration to an XML metadata file.
Syntax
String __fastcall ExportSettings(bool IdP, int Index);
Remarks
Use this method to save the Identity Provider (IdP) or Service Provider (SP) configuration in the form of XML metadata. The IdP metadata file may then be transferred to identity providers (SP) to let them know about the IdP configuration.
When exporting IdP settings, adjust the identity provider configuration as required in IdPSettings object before calling this method. Assign MetaSigningCertificate to enforce signing of the metadata XML.
When exporting SP settings, provide the index of the service provider in the SPSettings list.
GetProviderProperty Method (SAMLIdPServer 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 Identity Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
GetRequestBytes Method (SAMLIdPServer Component)
Obtains a pending connection buffer.
Syntax
DynamicArray<Byte> __fastcall GetRequestBytes(__int64 ConnectionID, String RequestFilter);
Remarks
Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet. TBD: Possibly rename to GetRequestBytes (and align with declaration in HTTPServer)
GetRequestHeader Method (SAMLIdPServer 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 (SAMLIdPServer 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 (SAMLIdPServer 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 Identity Provider's session properties that are not available through the primary properties and events of the component.
TBD:
ImportSettings Method (SAMLIdPServer Component)
Loads the metadata required for information exchange with the identity provider. Both local (IdP-side) and remote (SP-side) metadata can be loaded with this call.
Syntax
void __fastcall ImportSettings(String Metadata, bool IdP);
Remarks
The Service provider (SP) may have a lot of different options and requirements for interactions with the Identity provider (IdP). Usually all these options together with X.509 certificates needed for data exchange are stored in XML metadata files. Use this method to load metadata from such file generated by the service provider.
The Metadata parameter contains metadata in the form of byte array. Set IdP parameter to true to indicate that it is the Identity Provider's own settings that are being loaded.
The loaded metadata is populated in the IdPSettings or SPSettings object (depending on the value of the IdP parameter).
InitiateAuth Method (SAMLIdPServer Component)
Starts IdP-initiated SAML authentication flow.
Syntax
int __fastcall InitiateAuth(__int64 ConnectionID, String SessionID, String Tag);
Remarks
Use this method to initiate SAML authentication flow on the IdP side.
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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
Once the user has been authenticated, you can use ProcessSignOnRequest to generate SAML assertions for specific SPs.
InitiateLogout Method (SAMLIdPServer Component)
Starts IdP-initiated SAML logout flow.
Syntax
int __fastcall InitiateLogout(__int64 ConnectionID, String SessionID, String SP, String Tag);
Remarks
Use this method to initiate SAML logout flow on the IdP side. Pass the index of the logout endpoint that you want to use to the SPServiceIndex parameter.
This method returns the processing result as one of the values given below. Right before it returns it passes the processing results back to the caller via the ProcessingCompleted event. This event fires independently of the processing outcome (success or failure), and contains the same ConnectionID that is passed to this call.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ListClients Method (SAMLIdPServer 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 (SAMLIdPServer 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.
ProcessArtifactResolveRequest Method (SAMLIdPServer 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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessAttributeQuery Method (SAMLIdPServer Component)
Processes an attribute request received from the SP service at one of the AQS endpoints.
Syntax
int __fastcall ProcessAttributeQuery(__int64 ConnectionID, String SessionID, String Request, String Tag);
Remarks
Use this method to pass a SAML attribute request received at one of the AttributeQueryService 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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessGenericRequest Method (SAMLIdPServer Component)
Processes a generic HTTP SAML request.
Syntax
int __fastcall ProcessGenericRequest(__int64 ConnectionID, String SessionID, String URL, String HttpMethod, String Request, String Tag);
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.
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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessLogoutRequest Method (SAMLIdPServer Component)
Processes logout request received from the SP 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 returned 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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessSignOnRequest Method (SAMLIdPServer Component)
Processes a single sign-on request received from the SP service at one of the SSO endpoints.
Syntax
int __fastcall ProcessSignOnRequest(__int64 ConnectionID, String SessionID, String Request, String Tag);
Remarks
Use this method to pass a SAML Single Sign-On request received at one of the SingleSignOnService 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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode.
ProcessSignOnResponse Method (SAMLIdPServer Component)
Processes the submission of the login form previously generated by the IdP server.
Syntax
int __fastcall ProcessSignOnResponse(__int64 ConnectionID, String SessionID, String Response, String Tag);
Remarks
Use this method to pass the login form data that was received from the user in response to the presented login form, to the IdP server. If the provided data matches the form, the credentials are passed to the application via the UserAuthVerifyCredentials event.
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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
You can use this method with or without the OfflineMode. TBD:
RemoveSP Method (SAMLIdPServer Component)
Removes an SP from the list of trusted service providers.
Syntax
void __fastcall RemoveSP(int Index);
Remarks
Use this method to remove information about a service provider from the SPSettings list. The IdP server will be unable to process any further requests from this provider once it is removed. TBD
Reset Method (SAMLIdPServer Component)
Resets the component settings.
Syntax
void __fastcall Reset();
Remarks
Reset is a generic method available in every component.
SetClientBuffer Method (SAMLIdPServer Component)
Commits a data buffer to the connection.
Syntax
void __fastcall SetClientBuffer(__int64 ConnectionID, DynamicArray<Byte> Value);
Remarks
Use this method from your ReadFile event handler to commit a chunk of file data to the server component.
SetProviderProperty Method (SAMLIdPServer 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 Identity Provider's settings that are not available through the primary properties of the component. As SAML usage scenarios evolve and new providers appear, the list of supported properties can be extended.
The following properties are currently supported:
- ContactPerson
- OrganizationName
- OrganizationDisplayName
- OrganizationURL
- OrganizationLang
SetResponseHeader Method (SAMLIdPServer Component)
Sets a response header.
Syntax
bool __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 (SAMLIdPServer 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 Identity Provider's session settings that are not available through the primary properties and events of the component.
TBD:
Start Method (SAMLIdPServer Component)
Starts the IdP server.
Syntax
void __fastcall Start();
Remarks
Use this method to start listening for incoming connections.
Stop Method (SAMLIdPServer Component)
Stops the IdP server.
Syntax
void __fastcall Stop();
Remarks
Call this method to stop listening for incoming connections.
Accept Event (SAMLIdPServer Component)
Reports an incoming connection.
Syntax
typedef struct { String RemoteAddress; int RemotePort; bool Accept; } TsbxSAMLIdPServerAcceptEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerAcceptEvent)(System::TObject* Sender, TsbxSAMLIdPServerAcceptEventParams *e); __property TsbxSAMLIdPServerAcceptEvent OnAccept = { read=FOnAccept, write=FOnAccept };
Remarks
This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.
Subscribe to Connect event to be notified of every connection that has been set up.
ArtifactResolveRequestPrepared Event (SAMLIdPServer Component)
This event is fired when a new authentication request message has been prepared.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String Artifact; } TsbxSAMLIdPServerArtifactResolveRequestPreparedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerArtifactResolveRequestPreparedEvent)(System::TObject* Sender, TsbxSAMLIdPServerArtifactResolveRequestPreparedEventParams *e); __property TsbxSAMLIdPServerArtifactResolveRequestPreparedEvent OnArtifactResolveRequestPrepared = { read=FOnArtifactResolveRequestPrepared, write=FOnArtifactResolveRequestPrepared };
Remarks
TBD
ArtifactResolveRequestReceived Event (SAMLIdPServer Component)
TBD.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; bool IsEncrypted; bool IsSigned; String Artifact; int Action; } TsbxSAMLIdPServerArtifactResolveRequestReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerArtifactResolveRequestReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerArtifactResolveRequestReceivedEventParams *e); __property TsbxSAMLIdPServerArtifactResolveRequestReceivedEvent OnArtifactResolveRequestReceived = { read=FOnArtifactResolveRequestReceived, write=FOnArtifactResolveRequestReceived };
Remarks
AssertionPrepared Event (SAMLIdPServer Component)
This event fires when a new assertion has been created by the IdP server.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; String Body; String Auth; String NameID; String NameIDFormat; String SessionIndex; String ValidFrom; String ValidTo; } TsbxSAMLIdPServerAssertionPreparedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerAssertionPreparedEvent)(System::TObject* Sender, TsbxSAMLIdPServerAssertionPreparedEventParams *e); __property TsbxSAMLIdPServerAssertionPreparedEvent OnAssertionPrepared = { read=FOnAssertionPrepared, write=FOnAssertionPrepared };
Remarks
The component fires this event when it has prepared an assertion to be sent to the other side as part of the authentication process. This event may fire from within ProcessSignOnRequest and ProcessSignOnResponse calls when working in OfflineMode, and at any time otherwise.
The RequestID parameter contains the request ID, in response to which the assertion was created. The NameID parameter contains the name identifier of the authenticated user, and SessionIndex the unique session index of the new session. TBD:
AttributeQueryReceived Event (SAMLIdPServer Component)
TBD.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; bool IsEncrypted; bool IsSigned; String Attributes; int Action; } TsbxSAMLIdPServerAttributeQueryReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerAttributeQueryReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerAttributeQueryReceivedEventParams *e); __property TsbxSAMLIdPServerAttributeQueryReceivedEvent OnAttributeQueryReceived = { read=FOnAttributeQueryReceived, write=FOnAttributeQueryReceived };
Remarks
AuthnRequestReceived Event (SAMLIdPServer Component)
The server fires this event upon receiving an AuthnRequest message from the other side.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; bool IsEncrypted; bool IsSigned; bool ForceAuthn; bool NonInteractive; bool Authenticated; int Action; } TsbxSAMLIdPServerAuthnRequestReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerAuthnRequestReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerAuthnRequestReceivedEventParams *e); __property TsbxSAMLIdPServerAuthnRequestReceivedEvent OnAuthnRequestReceived = { read=FOnAuthnRequestReceived, write=FOnAuthnRequestReceived };
Remarks
The event reports the details of the received AuthnRequest message. The ForceAuthn and NonInteractive parameters contain optional suggestions included in the request. The Authenticated parameter specifies whether the user has already been authenticated within this session. All the three parameters can be adjusted in the event handler to direct the authentication logic in the required direction.
In OfflineMode this event would typically be fired from ProcessSignOnRequest call.
Connect Event (SAMLIdPServer Component)
Reports an accepted connection.
Syntax
typedef struct { __int64 ConnectionId; String RemoteAddress; int RemotePort; } TsbxSAMLIdPServerConnectEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerConnectEvent)(System::TObject* Sender, TsbxSAMLIdPServerConnectEventParams *e); __property TsbxSAMLIdPServerConnectEvent 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 (SAMLIdPServer Component)
Fires to report a disconnected client.
Syntax
typedef struct { __int64 ConnectionID; } TsbxSAMLIdPServerDisconnectEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerDisconnectEvent)(System::TObject* Sender, TsbxSAMLIdPServerDisconnectEventParams *e); __property TsbxSAMLIdPServerDisconnectEvent OnDisconnect = { read=FOnDisconnect, write=FOnDisconnect };
Remarks
The component fires this event when a connected client disconnects.
Error Event (SAMLIdPServer Component)
Information about errors during data delivery.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; int ErrorCode; bool Fatal; bool Remote; String Description; } TsbxSAMLIdPServerErrorEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerErrorEvent)(System::TObject* Sender, TsbxSAMLIdPServerErrorEventParams *e); __property TsbxSAMLIdPServerErrorEvent 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 (SAMLIdPServer 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; } TsbxSAMLIdPServerExternalSignEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerExternalSignEvent)(System::TObject* Sender, TsbxSAMLIdPServerExternalSignEventParams *e); __property TsbxSAMLIdPServerExternalSignEvent 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();
};
LogoutRequestReceived Event (SAMLIdPServer Component)
The component uses this event to notify the application about incoming SAML Logout Request message.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; bool IsEncrypted; bool IsSigned; String NameID; int Action; } TsbxSAMLIdPServerLogoutRequestReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerLogoutRequestReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerLogoutRequestReceivedEventParams *e); __property TsbxSAMLIdPServerLogoutRequestReceivedEvent OnLogoutRequestReceived = { read=FOnLogoutRequestReceived, write=FOnLogoutRequestReceived };
Remarks
The SAML IdP server fires this event when a SAML logout request is received at one of the single logout service endpoints.
TBD
LogoutResponsePrepared Event (SAMLIdPServer 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 SP; String Body; String NameID; } TsbxSAMLIdPServerLogoutResponsePreparedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerLogoutResponsePreparedEvent)(System::TObject* Sender, TsbxSAMLIdPServerLogoutResponsePreparedEventParams *e); __property TsbxSAMLIdPServerLogoutResponsePreparedEvent 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.
MetadataPrepared Event (SAMLIdPServer Component)
Passes a prepared metadata object to the application.
Syntax
typedef struct { __int64 ConnectionID; String Metadata; } TsbxSAMLIdPServerMetadataPreparedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerMetadataPreparedEvent)(System::TObject* Sender, TsbxSAMLIdPServerMetadataPreparedEventParams *e); __property TsbxSAMLIdPServerMetadataPreparedEvent OnMetadataPrepared = { read=FOnMetadataPrepared, write=FOnMetadataPrepared };
Remarks
The component uses this event to notify the application about the prepared metadata object and let the user code adjust it if needed. This event may fire from within an ExportSettings call, or in response to the incoming metadata request if the server is operating in standalone mode.
The suggested metadata object is provided through the Metadata parameter. The application can adjust it as required if it needs to.
Notification Event (SAMLIdPServer Component)
This event notifies the application about an underlying control flow event.
Syntax
typedef struct { String EventID; String EventParam; } TsbxSAMLIdPServerNotificationEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerNotificationEvent)(System::TObject* Sender, TsbxSAMLIdPServerNotificationEventParams *e); __property TsbxSAMLIdPServerNotificationEvent 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.
ProcessingCompleted Event (SAMLIdPServer 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; } TsbxSAMLIdPServerProcessingCompletedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerProcessingCompletedEvent)(System::TObject* Sender, TsbxSAMLIdPServerProcessingCompletedEventParams *e); __property TsbxSAMLIdPServerProcessingCompletedEvent 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 ProcessSignOnRequest, ProcessSignOnResponse, 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 web page containing a login form.
- 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.
sprUnknown | 0 | Unknown or undefined processing result |
sprSAMLMessage | 1 | The result contains a new SAML message that needs to be conveyed to the other SAML party |
sprSignOnPage | 2 | The result contains a SAML login page |
sprSAMLError | 3 | The result contains a SAML error message. This still needs to be relayed to the other SAML party. |
sprTransportError | 4 | The result contains a transport-layer (HTTP) error message, for example where the SAML request could not be processed due to access permissions or wrong endpoint. |
sprSuccess | 5 | The processing completed successfully but no tangible result has been generated (e.g. when the assertion was processed). |
ResourceClose Event (SAMLIdPServer Component)
Tells the application that it can close the opened resource.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; } TsbxSAMLIdPServerResourceCloseEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerResourceCloseEvent)(System::TObject* Sender, TsbxSAMLIdPServerResourceCloseEventParams *e); __property TsbxSAMLIdPServerResourceCloseEvent OnResourceClose = { read=FOnResourceClose, write=FOnResourceClose };
Remarks
The component uses this event to notify the application that it can now close the resource opened earlier in its ResourceOpen handler.
After closing the resource, set the OperationStatus according to the outcome of the operation.
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceOpen Event (SAMLIdPServer Component)
Requests the application to open the requested resource.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String URL; int OperationStatus; } TsbxSAMLIdPServerResourceOpenEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerResourceOpenEvent)(System::TObject* Sender, TsbxSAMLIdPServerResourceOpenEventParams *e); __property TsbxSAMLIdPServerResourceOpenEvent 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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRead Event (SAMLIdPServer Component)
Requests the application to read from an opened resource.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; int Size; int OperationStatus; } TsbxSAMLIdPServerResourceReadEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerResourceReadEvent)(System::TObject* Sender, TsbxSAMLIdPServerResourceReadEventParams *e); __property TsbxSAMLIdPServerResourceReadEvent 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:
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ResourceRequest Event (SAMLIdPServer 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; int Action; } TsbxSAMLIdPServerResourceRequestEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerResourceRequestEvent)(System::TObject* Sender, TsbxSAMLIdPServerResourceRequestEventParams *e); __property TsbxSAMLIdPServerResourceRequestEvent 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:
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
SAMLMessagePrepared Event (SAMLIdPServer 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 Destination; String InResponseTo; String RequestBody; String MessageType; String MessageBody; bool Success; } TsbxSAMLIdPServerSAMLMessagePreparedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSAMLMessagePreparedEvent)(System::TObject* Sender, TsbxSAMLIdPServerSAMLMessagePreparedEventParams *e); __property TsbxSAMLIdPServerSAMLMessagePreparedEvent 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 (SAMLIdPServer Component)
The server fires this event for every SAML message it receives.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String MessageType; String MessageID; String Issuer; String IssueInstant; String MessageBody; int Action; } TsbxSAMLIdPServerSAMLMessageReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSAMLMessageReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerSAMLMessageReceivedEventParams *e); __property TsbxSAMLIdPServerSAMLMessageReceivedEvent 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
Set Action property as required to let the component know how to proceed.
fraAuto | 1 | Handle the requested action automatically by the server |
fraCustom | 2 | Override the action using the user code logic |
fraAbort | 3 | Abort the requested action |
SessionCreated Event (SAMLIdPServer Component)
This event is fired when a new session has been established.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; } TsbxSAMLIdPServerSessionCreatedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSessionCreatedEvent)(System::TObject* Sender, TsbxSAMLIdPServerSessionCreatedEventParams *e); __property TsbxSAMLIdPServerSessionCreatedEvent OnSessionCreated = { read=FOnSessionCreated, write=FOnSessionCreated };
Remarks
ConnectionID contains the identifier of the new session, SessionID specifies the ID of the new session.
SessionDestroyed Event (SAMLIdPServer Component)
This event is fired when the IdP server has closed a session.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; } TsbxSAMLIdPServerSessionDestroyedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSessionDestroyedEvent)(System::TObject* Sender, TsbxSAMLIdPServerSessionDestroyedEventParams *e); __property TsbxSAMLIdPServerSessionDestroyedEvent OnSessionDestroyed = { read=FOnSessionDestroyed, write=FOnSessionDestroyed };
Remarks
ConnectionID contains the identifier of the closed session.
SessionEvent Event (SAMLIdPServer Component)
Notifies the application about the change of SAML session stage.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String EventText; } TsbxSAMLIdPServerSessionEventEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSessionEventEvent)(System::TObject* Sender, TsbxSAMLIdPServerSessionEventEventParams *e); __property TsbxSAMLIdPServerSessionEventEvent OnSessionEvent = { read=FOnSessionEvent, write=FOnSessionEvent };
Remarks
component uses this method to notify your code about changed SAML session stage. The Session parameter specifies the session ID. The Stage parameter can take one of the following values:
- Start
- AuthnRequestSent
- ResponseReceived
- ResourceSupplied
- LogoutRequestSent
- LogoutResponseReceived
- LogoutRequestRecv
- LogoutResponseSent
- ArtifactResolveRecv
- ArtifactResponseSent
- Finish
SessionInfoNeeded Event (SAMLIdPServer Component)
This event is fired in OfflineMode to request the session ID for the current flow.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; } TsbxSAMLIdPServerSessionInfoNeededEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSessionInfoNeededEvent)(System::TObject* Sender, TsbxSAMLIdPServerSessionInfoNeededEventParams *e); __property TsbxSAMLIdPServerSessionInfoNeededEvent OnSessionInfoNeeded = { read=FOnSessionInfoNeeded, write=FOnSessionInfoNeeded };
Remarks
TBD
SessionStateRetrieve Event (SAMLIdPServer Component)
TBD.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String SessionState; } TsbxSAMLIdPServerSessionStateRetrieveEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSessionStateRetrieveEvent)(System::TObject* Sender, TsbxSAMLIdPServerSessionStateRetrieveEventParams *e); __property TsbxSAMLIdPServerSessionStateRetrieveEvent OnSessionStateRetrieve = { read=FOnSessionStateRetrieve, write=FOnSessionStateRetrieve };
Remarks
TBD
SessionStateSave Event (SAMLIdPServer Component)
TBD.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String SessionState; } TsbxSAMLIdPServerSessionStateSaveEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSessionStateSaveEvent)(System::TObject* Sender, TsbxSAMLIdPServerSessionStateSaveEventParams *e); __property TsbxSAMLIdPServerSessionStateSaveEvent OnSessionStateSave = { read=FOnSessionStateSave, write=FOnSessionStateSave };
Remarks
TBD
SignatureFound Event (SAMLIdPServer Component)
Signifies the start of signature validation.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String MessageType; String MessageID; String EntityID; int Scope; String IssuerRDN; DynamicArraySerialNumber; DynamicArray SubjectKeyID; String SigMethod; String DigestMethod; bool CertFound; bool Validate; } TsbxSAMLIdPServerSignatureFoundEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSignatureFoundEvent)(System::TObject* Sender, TsbxSAMLIdPServerSignatureFoundEventParams *e); __property TsbxSAMLIdPServerSignatureFoundEvent 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.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
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 (SAMLIdPServer Component)
Reports the signature validation result.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String MessageType; String MessageID; int Scope; String IssuerRDN; DynamicArraySerialNumber; DynamicArray SubjectKeyID; String SigMethod; String DigestMethod; int ValidationResult; } TsbxSAMLIdPServerSignatureValidatedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSignatureValidatedEvent)(System::TObject* Sender, TsbxSAMLIdPServerSignatureValidatedEventParams *e); __property TsbxSAMLIdPServerSignatureValidatedEvent 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.
sssUnknown | 0 | The scope of signature is unknown |
sssMessage | 1 | The signature covers the entire SAML message |
sssAssertion | 2 | The signature covers an assertion |
sssBinding | 3 | The signature covers the binding |
svtValid | 0 | The signature is valid |
svtUnknown | 1 | Signature validity is unknown |
svtCorrupted | 2 | The signature is corrupted |
svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
svtFailure | 4 | General failure |
svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
SignOnPagePrepared Event (SAMLIdPServer Component)
The server fires this event upon preparing the sign-on page.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String Request; String PageData; bool Redirect; } TsbxSAMLIdPServerSignOnPagePreparedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSignOnPagePreparedEvent)(System::TObject* Sender, TsbxSAMLIdPServerSignOnPagePreparedEventParams *e); __property TsbxSAMLIdPServerSignOnPagePreparedEvent OnSignOnPagePrepared = { read=FOnSignOnPagePrepared, write=FOnSignOnPagePrepared };
Remarks
The IdP server fires this event to notify the application that the sign-on page (login form) has been formed and is ready to be flushed. Use SignOnPageTemplate to assign the sign-on page template.
The form body is returned via the FormData parameter. You can adjust it in the event handler as required. The Redirect parameter advises whether the form should be returned as a Location header of the HTTP response with the 302 status, or as an HTTP body of text/html type.
SignOnResponseReceived Event (SAMLIdPServer Component)
TBD.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String ResponseData; int Action; } TsbxSAMLIdPServerSignOnResponseReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerSignOnResponseReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerSignOnResponseReceivedEventParams *e); __property TsbxSAMLIdPServerSignOnResponseReceivedEvent OnSignOnResponseReceived = { read=FOnSignOnResponseReceived, write=FOnSignOnResponseReceived };
Remarks
TLSCertValidate Event (SAMLIdPServer Component)
Fires when a client certificate needs to be validated.
Syntax
typedef struct { __int64 ConnectionID; bool Accept; } TsbxSAMLIdPServerTLSCertValidateEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerTLSCertValidateEvent)(System::TObject* Sender, TsbxSAMLIdPServerTLSCertValidateEventParams *e); __property TsbxSAMLIdPServerTLSCertValidateEvent 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 (SAMLIdPServer Component)
Reports the setup of a TLS session.
Syntax
typedef struct { __int64 ConnectionID; } TsbxSAMLIdPServerTLSEstablishedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerTLSEstablishedEvent)(System::TObject* Sender, TsbxSAMLIdPServerTLSEstablishedEventParams *e); __property TsbxSAMLIdPServerTLSEstablishedEvent 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 (SAMLIdPServer Component)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
typedef struct { __int64 ConnectionID; String ServerName; bool Abort; } TsbxSAMLIdPServerTLSHandshakeEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerTLSHandshakeEvent)(System::TObject* Sender, TsbxSAMLIdPServerTLSHandshakeEventParams *e); __property TsbxSAMLIdPServerTLSHandshakeEvent 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 (SAMLIdPServer Component)
Requests a pre-shared key for TLS-PSK.
Syntax
typedef struct { __int64 ConnectionID; String Identity; String PSK; String Ciphersuite; } TsbxSAMLIdPServerTLSPSKEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerTLSPSKEvent)(System::TObject* Sender, TsbxSAMLIdPServerTLSPSKEventParams *e); __property TsbxSAMLIdPServerTLSPSKEvent 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 (SAMLIdPServer Component)
Reports closure of a TLS session.
Syntax
typedef struct { __int64 ConnectionID; } TsbxSAMLIdPServerTLSShutdownEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerTLSShutdownEvent)(System::TObject* Sender, TsbxSAMLIdPServerTLSShutdownEventParams *e); __property TsbxSAMLIdPServerTLSShutdownEvent 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 (SAMLIdPServer Component)
Notifies the application about the success of user authentication flow.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String SP; String Auth; String Username; String NameID; String NameIDFormat; String SessionIndex; int AssertionTTL; } TsbxSAMLIdPServerUserAuthCompletedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerUserAuthCompletedEvent)(System::TObject* Sender, TsbxSAMLIdPServerUserAuthCompletedEventParams *e); __property TsbxSAMLIdPServerUserAuthCompletedEvent OnUserAuthCompleted = { read=FOnUserAuthCompleted, write=FOnUserAuthCompleted };
Remarks
TBD
UserAuthFailed Event (SAMLIdPServer Component)
Notifies the application about the failure of user authentication flow.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String SP; String Auth; String Username; bool CanRetry; bool TryAgain; } TsbxSAMLIdPServerUserAuthFailedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerUserAuthFailedEvent)(System::TObject* Sender, TsbxSAMLIdPServerUserAuthFailedEventParams *e); __property TsbxSAMLIdPServerUserAuthFailedEvent OnUserAuthFailed = { read=FOnUserAuthFailed, write=FOnUserAuthFailed };
Remarks
TBD - consider adding RequestID to this and other Auth events.
UserAuthStart Event (SAMLIdPServer Component)
Notifies the application about the start of user authentication flow.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String SP; String SupportedAuths; String SelectedAuth; int Action; } TsbxSAMLIdPServerUserAuthStartEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerUserAuthStartEvent)(System::TObject* Sender, TsbxSAMLIdPServerUserAuthStartEventParams *e); __property TsbxSAMLIdPServerUserAuthStartEvent OnUserAuthStart = { read=FOnUserAuthStart, write=FOnUserAuthStart };
Remarks
Set Action to Auto to proceed with the default sign on page based on SignOnPageTemplate, or to Custom to supply (or redirect to) your own authentication landing. TBD
UserAuthVerifyCredentials Event (SAMLIdPServer Component)
Passes user credentials to the application for verification.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String ClaimedUsername; String ClaimedPassword; String ClaimedBody; bool Accept; String Username; } TsbxSAMLIdPServerUserAuthVerifyCredentialsEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerUserAuthVerifyCredentialsEvent)(System::TObject* Sender, TsbxSAMLIdPServerUserAuthVerifyCredentialsEventParams *e); __property TsbxSAMLIdPServerUserAuthVerifyCredentialsEvent OnUserAuthVerifyCredentials = { read=FOnUserAuthVerifyCredentials, write=FOnUserAuthVerifyCredentials };
Remarks
Subscribe to this event to be notified about authentication attempts and adjust the acceptance result as required. This event fires after the user credentials have been validated against the configured database, and the value of the Accept parameter reflects the outcome of the validation.
The Username and Password parameters contain the provided credentials, and the Body parameter contains the unparsed form data.
UserLogoutCompleted Event (SAMLIdPServer Component)
Notifies the application about the completion of user logout flow.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String SP; String Username; String NameID; String SessionIndex; bool Partial; } TsbxSAMLIdPServerUserLogoutCompletedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerUserLogoutCompletedEvent)(System::TObject* Sender, TsbxSAMLIdPServerUserLogoutCompletedEventParams *e); __property TsbxSAMLIdPServerUserLogoutCompletedEvent OnUserLogoutCompleted = { read=FOnUserLogoutCompleted, write=FOnUserLogoutCompleted };
Remarks
TBD
UserLogoutStart Event (SAMLIdPServer Component)
Notifies the application about the start of user logout flow.
Syntax
typedef struct { __int64 ConnectionID; String SessionID; String SP; String Username; String NameID; String SessionIndex; bool Secondary; int Action; } TsbxSAMLIdPServerUserLogoutStartEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerUserLogoutStartEvent)(System::TObject* Sender, TsbxSAMLIdPServerUserLogoutStartEventParams *e); __property TsbxSAMLIdPServerUserLogoutStartEvent OnUserLogoutStart = { read=FOnUserLogoutStart, write=FOnUserLogoutStart };
Remarks
TBD
Config Settings (SAMLIdPServer 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.SAMLIdPServer Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (SAMLIdPServer Component)
SAMLIdPServer Errors
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |
30408705 | Invalid binding name (SB_ERROR_SAML_INVALID_BINDING_NAME) |
30408706 | Invalid SAML binding type (SB_ERROR_SAML_INVALID_BINDING_TYPE) |
30408707 | Base directory not set (SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET) |
30408708 | Invalid parameter (SB_ERROR_SAML_INVALID_PARAM) |
30408709 | Invalid input data (SB_ERROR_SAML_INVALID_DATA) |
30408710 | Data is not loaded (SB_ERROR_SAML_NOT_LOADED) |
30408711 | New document is not created (SB_ERROR_SAML_NOT_CREATED) |
30408716 | Endpoint of unsupported type encountered or cannot find appropriate IdP service (SB_ERROR_SAML_INVALID_SERVICE) |
30408717 | Multiple endpoints of the same kind are not supported (SB_ERROR_SAML_MULTIPLE_ENDPOINTS_NOT_SUPPORTED) |