# SAMLIdPServer Component The SAMLIdPServer component represents a SAML identity provider. ## Syntax ```text 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. ## 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](#active-property-samlidpserver-component) | Tells whether the server is active and ready to process requests. | | [AllowIDPSSO](#allowidpsso-property-samlidpserver-component) | Specifies if IdP-initiated Single Sign-On (SSO) is allowed. | | [BaseDir](#basedir-property-samlidpserver-component) | Base directory on the server. | | [BindingKeyHandle](#bindingkeyhandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [EncryptionCertBytes](#encryptioncertbytes-property-samlidpserver-component) | Returns the raw certificate data in DER format. | | [EncryptionCertHandle](#encryptioncerthandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-samlidpserver-component) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [ExternalCryptoCustomParams](#externalcryptocustomparams-property-samlidpserver-component) | Custom parameters to be passed to the signing service (uninterpreted). | | [ExternalCryptoData](#externalcryptodata-property-samlidpserver-component) | Additional data to be included in the async state and mirrored back by the requestor. | | [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-samlidpserver-component) | Specifies whether the message hash is to be calculated at the external endpoint. | | [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-samlidpserver-component) | Specifies the request's signature hash algorithm. | | [ExternalCryptoKeyID](#externalcryptokeyid-property-samlidpserver-component) | The ID of the pre-shared key used for DC request authentication. | | [ExternalCryptoKeySecret](#externalcryptokeysecret-property-samlidpserver-component) | The pre-shared key used for DC request authentication. | | [ExternalCryptoMethod](#externalcryptomethod-property-samlidpserver-component) | Specifies the asynchronous signing method. | | [ExternalCryptoMode](#externalcryptomode-property-samlidpserver-component) | Specifies the external cryptography mode. | | [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-samlidpserver-component) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [FIPSMode](#fipsmode-property-samlidpserver-component) | Reserved. | | [HandshakeTimeout](#handshaketimeout-property-samlidpserver-component) | Specifies the handshake timeout in milliseconds. | | [Host](#host-property-samlidpserver-component) | Specifies the host address of the IdP server. | | [IdPServiceCount](#idpservicecount-property-samlidpserver-component) | The number of records in the IdPService arrays. | | [IdPServiceBindingType](#idpservicebindingtype-property-samlidpserver-component) | Specifies the type of SAML binding that this endpoint accepts. | | [IdPServiceEntityID](#idpserviceentityid-property-samlidpserver-component) | Represents the SAML entity ID. | | [IdPServiceLocation](#idpservicelocation-property-samlidpserver-component) | The location (URL) of the endpoint. | | [IdPServicePriority](#idpservicepriority-property-samlidpserver-component) | The priority of the endpoint in relation to other endpoints with the same Location . | | [IdPServiceService](#idpserviceservice-property-samlidpserver-component) | The kind of the service being provided at this endpoint. | | [IdPServiceServiceIndex](#idpserviceserviceindex-property-samlidpserver-component) | The index of this endpoint. | | [IdPContactPerson](#idpcontactperson-property-samlidpserver-component) | The contact person or persons for the entity. | | [IdPEncryptionKey](#idpencryptionkey-property-samlidpserver-component) | Contains the entity's encryption key. | | [IdPEncryptionMethods](#idpencryptionmethods-property-samlidpserver-component) | Specifies the list of encryption methods supported by the entity. | | [IdPEntityID](#idpentityid-property-samlidpserver-component) | Represents the SAML entity ID. | | [IdPFlags](#idpflags-property-samlidpserver-component) | Adjusts secondary entity properties. | | [IdPSSOLink](#idpssolink-property-samlidpserver-component) | Contains a local server page link that triggers SAML authentication to the SP. | | [IdPNameIDFormats](#idpnameidformats-property-samlidpserver-component) | The list of NameID formats supported by this entity. | | [IdPOrganizationDisplayName](#idporganizationdisplayname-property-samlidpserver-component) | The friendly name of the organization that maintains the entity. | | [IdPOrganizationLang](#idporganizationlang-property-samlidpserver-component) | The language preferred by the organization. | | [IdPOrganizationName](#idporganizationname-property-samlidpserver-component) | The name of the organization that maintains the entity. | | [IdPOrganizationURL](#idporganizationurl-property-samlidpserver-component) | The web URL of the organization that maintains the entity. | | [IdPSignatureValidationResult](#idpsignaturevalidationresult-property-samlidpserver-component) | The outcome of the cryptographic signature validation. | | [IdPSigned](#idpsigned-property-samlidpserver-component) | Specifies whether the SAML entity information is or should be signed. | | [IdPSignedWith](#idpsignedwith-property-samlidpserver-component) | Contains the certificate or key that was used to sign the settings (metadata) document. | | [IdPSigningKey](#idpsigningkey-property-samlidpserver-component) | Contains the entity's signing key. | | [IdPValidUntil](#idpvaliduntil-property-samlidpserver-component) | Specifies the expiration time of the SAML entity information. | | [IdPSSOPage](#idpssopage-property-samlidpserver-component) | Specifies the relative URL of the IdP-initiated SSO page. | | [IdPSSOPageTemplate](#idpssopagetemplate-property-samlidpserver-component) | The content of the IdP-initiated SSO page. | | [KnownCertCount](#knowncertcount-property-samlidpserver-component) | The number of records in the KnownCert arrays. | | [KnownCertBytes](#knowncertbytes-property-samlidpserver-component) | Returns the raw certificate data in DER format. | | [KnownCertHandle](#knowncerthandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [KnownKeyCount](#knownkeycount-property-samlidpserver-component) | The number of records in the KnownKey arrays. | | [KnownKeyHandle](#knownkeyhandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [LoginAttemptsLimit](#loginattemptslimit-property-samlidpserver-component) | The maximum number of login attempts. | | [MetadataURL](#metadataurl-property-samlidpserver-component) | The IdP's metadata location. | | [MetaSigningCertBytes](#metasigningcertbytes-property-samlidpserver-component) | Returns the raw certificate data in DER format. | | [MetaSigningCertHandle](#metasigningcerthandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [OfflineMode](#offlinemode-property-samlidpserver-component) | Enables the Offline mode. | | [PinnedClientAEADCipher](#pinnedclientaeadcipher-property-samlidpserver-component) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [PinnedClientChainValidationDetails](#pinnedclientchainvalidationdetails-property-samlidpserver-component) | The details of a certificate chain validation outcome. | | [PinnedClientChainValidationResult](#pinnedclientchainvalidationresult-property-samlidpserver-component) | The outcome of a certificate chain validation routine. | | [PinnedClientCiphersuite](#pinnedclientciphersuite-property-samlidpserver-component) | The cipher suite employed by this connection. | | [PinnedClientClientAuthenticated](#pinnedclientclientauthenticated-property-samlidpserver-component) | Specifies whether client authentication was performed during this connection. | | [PinnedClientClientAuthRequested](#pinnedclientclientauthrequested-property-samlidpserver-component) | Specifies whether client authentication was requested during this connection. | | [PinnedClientConnectionEstablished](#pinnedclientconnectionestablished-property-samlidpserver-component) | Indicates whether the connection has been established fully. | | [PinnedClientConnectionID](#pinnedclientconnectionid-property-samlidpserver-component) | The unique identifier assigned to this connection. | | [PinnedClientDigestAlgorithm](#pinnedclientdigestalgorithm-property-samlidpserver-component) | The digest algorithm used in a TLS-enabled connection. | | [PinnedClientEncryptionAlgorithm](#pinnedclientencryptionalgorithm-property-samlidpserver-component) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [PinnedClientExportable](#pinnedclientexportable-property-samlidpserver-component) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [PinnedClientGroup](#pinnedclientgroup-property-samlidpserver-component) | The elliptic curve used in this connection. | | [PinnedClientID](#pinnedclientid-property-samlidpserver-component) | The client connection's unique identifier. | | [PinnedClientKeyExchangeAlgorithm](#pinnedclientkeyexchangealgorithm-property-samlidpserver-component) | The key exchange algorithm used in a TLS-enabled connection. | | [PinnedClientKeyExchangeKeyBits](#pinnedclientkeyexchangekeybits-property-samlidpserver-component) | The length of the key exchange key of a TLS-enabled connection. | | [PinnedClientPFSCipher](#pinnedclientpfscipher-property-samlidpserver-component) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [PinnedClientPreSharedIdentity](#pinnedclientpresharedidentity-property-samlidpserver-component) | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [PinnedClientPreSharedIdentityHint](#pinnedclientpresharedidentityhint-property-samlidpserver-component) | A hint professed by the server to help the client select the PSK identity to use. | | [PinnedClientPublicKeyBits](#pinnedclientpublickeybits-property-samlidpserver-component) | The length of the public key. | | [PinnedClientRemoteAddress](#pinnedclientremoteaddress-property-samlidpserver-component) | The client's IP address. | | [PinnedClientRemotePort](#pinnedclientremoteport-property-samlidpserver-component) | The remote port of the client connection. | | [PinnedClientResumedSession](#pinnedclientresumedsession-property-samlidpserver-component) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [PinnedClientSecureConnection](#pinnedclientsecureconnection-property-samlidpserver-component) | Indicates whether TLS or SSL is enabled for this connection. | | [PinnedClientServerAuthenticated](#pinnedclientserverauthenticated-property-samlidpserver-component) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [PinnedClientSignatureAlgorithm](#pinnedclientsignaturealgorithm-property-samlidpserver-component) | The signature algorithm used in a TLS handshake. | | [PinnedClientSymmetricBlockSize](#pinnedclientsymmetricblocksize-property-samlidpserver-component) | The block size of the symmetric algorithm used. | | [PinnedClientSymmetricKeyBits](#pinnedclientsymmetrickeybits-property-samlidpserver-component) | The key length of the symmetric algorithm used. | | [PinnedClientTotalBytesReceived](#pinnedclienttotalbytesreceived-property-samlidpserver-component) | The total number of bytes received over this connection. | | [PinnedClientTotalBytesSent](#pinnedclienttotalbytessent-property-samlidpserver-component) | The total number of bytes sent over this connection. | | [PinnedClientValidationLog](#pinnedclientvalidationlog-property-samlidpserver-component) | Contains the server certificate's chain validation log. | | [PinnedClientVersion](#pinnedclientversion-property-samlidpserver-component) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [PinnedClientCertCount](#pinnedclientcertcount-property-samlidpserver-component) | The number of records in the PinnedClientCert arrays. | | [PinnedClientCertBytes](#pinnedclientcertbytes-property-samlidpserver-component) | Returns the raw certificate data in DER format. | | [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-samlidpserver-component) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [PinnedClientCertFingerprint](#pinnedclientcertfingerprint-property-samlidpserver-component) | Contains the fingerprint (a hash imprint) of this certificate. | | [PinnedClientCertHandle](#pinnedclientcerthandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [PinnedClientCertIssuer](#pinnedclientcertissuer-property-samlidpserver-component) | The common name of the certificate issuer (CA), typically a company name. | | [PinnedClientCertIssuerRDN](#pinnedclientcertissuerrdn-property-samlidpserver-component) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [PinnedClientCertKeyAlgorithm](#pinnedclientcertkeyalgorithm-property-samlidpserver-component) | Specifies the public key algorithm of this certificate. | | [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-samlidpserver-component) | Returns the length of the public key in bits. | | [PinnedClientCertKeyFingerprint](#pinnedclientcertkeyfingerprint-property-samlidpserver-component) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [PinnedClientCertKeyUsage](#pinnedclientcertkeyusage-property-samlidpserver-component) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-samlidpserver-component) | Contains the certificate's public key in DER format. | | [PinnedClientCertSelfSigned](#pinnedclientcertselfsigned-property-samlidpserver-component) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [PinnedClientCertSerialNumber](#pinnedclientcertserialnumber-property-samlidpserver-component) | Returns the certificate's serial number. | | [PinnedClientCertSigAlgorithm](#pinnedclientcertsigalgorithm-property-samlidpserver-component) | Indicates the algorithm that was used by the CA to sign this certificate. | | [PinnedClientCertSubject](#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. | | [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-samlidpserver-component) | Contains a unique identifier of the certificate's cryptographic key. | | [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-samlidpserver-component) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [PinnedClientCertValidFrom](#pinnedclientcertvalidfrom-property-samlidpserver-component) | The time point at which the certificate becomes valid, in UTC. | | [PinnedClientCertValidTo](#pinnedclientcertvalidto-property-samlidpserver-component) | The time point at which the certificate expires, in UTC. | | [Port](#port-property-samlidpserver-component) | The listening port number. | | [SecurityCanonicalizationMethod](#securitycanonicalizationmethod-property-samlidpserver-component) | The canonicalization method to use in the signature. | | [SecurityDigestMethod](#securitydigestmethod-property-samlidpserver-component) | The digest method to use. | | [SecurityEncryptionMethod](#securityencryptionmethod-property-samlidpserver-component) | The encryption method used to encrypt the assertion. | | [SecurityFlags](#securityflags-property-samlidpserver-component) | Provides access to secondary security parameters and tweaks. | | [SecuritySigMethod](#securitysigmethod-property-samlidpserver-component) | The signature method to use. | | [SecuritySignaturePolicy](#securitysignaturepolicy-property-samlidpserver-component) | Specifies the signature validation policy. | | [SenderCertCount](#sendercertcount-property-samlidpserver-component) | The number of records in the SenderChain arrays. | | [SenderChainBytes](#senderchainbytes-property-samlidpserver-component) | Returns the raw certificate data in DER format. | | [SenderChainHandle](#senderchainhandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SigningCertBytes](#signingcertbytes-property-samlidpserver-component) | Returns the raw certificate data in DER format. | | [SigningCertHandle](#signingcerthandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SigningChainCount](#signingchaincount-property-samlidpserver-component) | The number of records in the SigningChain arrays. | | [SigningChainBytes](#signingchainbytes-property-samlidpserver-component) | Returns the raw certificate data in DER format. | | [SigningChainHandle](#signingchainhandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SignOnPageTemplate](#signonpagetemplate-property-samlidpserver-component) | Defines the default authentication template (login page). | | [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-samlidpserver-component) | The maximum number of bytes to read from the socket, per second. | | [SocketLocalAddress](#socketlocaladdress-property-samlidpserver-component) | The local network interface to bind the socket to. | | [SocketLocalPort](#socketlocalport-property-samlidpserver-component) | The local port number to bind the socket to. | | [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-samlidpserver-component) | The maximum number of bytes to write to the socket, per second. | | [SocketTimeout](#sockettimeout-property-samlidpserver-component) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [SocketUseIPv6](#socketuseipv6-property-samlidpserver-component) | Enables or disables IP protocol version 6. | | [SPServiceCount](#spservicecount-property-samlidpserver-component) | The number of records in the SPService arrays. | | [SPServiceBindingType](#spservicebindingtype-property-samlidpserver-component) | Specifies the type of SAML binding that this endpoint accepts. | | [SPServiceEntityID](#spserviceentityid-property-samlidpserver-component) | Represents the SAML entity ID. | | [SPServiceLocation](#spservicelocation-property-samlidpserver-component) | The location (URL) of the endpoint. | | [SPServicePriority](#spservicepriority-property-samlidpserver-component) | The priority of the endpoint in relation to other endpoints with the same Location . | | [SPServiceService](#spserviceservice-property-samlidpserver-component) | The kind of the service being provided at this endpoint. | | [SPServiceServiceIndex](#spserviceserviceindex-property-samlidpserver-component) | The index of this endpoint. | | [SPCount](#spcount-property-samlidpserver-component) | The number of records in the SP arrays. | | [SPContactPerson](#spcontactperson-property-samlidpserver-component) | The contact person or persons for the entity. | | [SPEncryptionKey](#spencryptionkey-property-samlidpserver-component) | Contains the entity's encryption key. | | [SPEncryptionMethods](#spencryptionmethods-property-samlidpserver-component) | Specifies the list of encryption methods supported by the entity. | | [SPEntityID](#spentityid-property-samlidpserver-component) | Represents the SAML entity ID. | | [SPFlags](#spflags-property-samlidpserver-component) | Adjusts secondary entity properties. | | [SPIdPSSOLink](#spidpssolink-property-samlidpserver-component) | Contains a local server page link that triggers SAML authentication to the SP. | | [SPNameIDFormats](#spnameidformats-property-samlidpserver-component) | The list of NameID formats supported by this entity. | | [SPOrganizationDisplayName](#sporganizationdisplayname-property-samlidpserver-component) | The friendly name of the organization that maintains the entity. | | [SPOrganizationLang](#sporganizationlang-property-samlidpserver-component) | The language preferred by the organization. | | [SPOrganizationName](#sporganizationname-property-samlidpserver-component) | The name of the organization that maintains the entity. | | [SPOrganizationURL](#sporganizationurl-property-samlidpserver-component) | The web URL of the organization that maintains the entity. | | [SPSignatureValidationResult](#spsignaturevalidationresult-property-samlidpserver-component) | The outcome of the cryptographic signature validation. | | [SPSigned](#spsigned-property-samlidpserver-component) | Specifies whether the SAML entity information is or should be signed. | | [SPSignedWith](#spsignedwith-property-samlidpserver-component) | Contains the certificate or key that was used to sign the settings (metadata) document. | | [SPSigningKey](#spsigningkey-property-samlidpserver-component) | Contains the entity's signing key. | | [SPValidUntil](#spvaliduntil-property-samlidpserver-component) | Specifies the expiration time of the SAML entity information. | | [TLSServerCertCount](#tlsservercertcount-property-samlidpserver-component) | The number of records in the TLSServerCert arrays. | | [TLSServerCertBytes](#tlsservercertbytes-property-samlidpserver-component) | Returns the raw certificate data in DER format. | | [TLSServerCertHandle](#tlsservercerthandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TLSAutoValidateCertificates](#tlsautovalidatecertificates-property-samlidpserver-component) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [TLSBaseConfiguration](#tlsbaseconfiguration-property-samlidpserver-component) | Selects the base configuration for the TLS settings. | | [TLSCiphersuites](#tlsciphersuites-property-samlidpserver-component) | A list of ciphersuites separated with commas or semicolons. | | [TLSClientAuth](#tlsclientauth-property-samlidpserver-component) | Enables or disables certificate-based client authentication. | | [TLSExtensions](#tlsextensions-property-samlidpserver-component) | Provides access to TLS extensions. | | [TLSForceResumeIfDestinationChanges](#tlsforceresumeifdestinationchanges-property-samlidpserver-component) | Whether to force TLS session resumption when the destination address changes. | | [TLSGroups](#tlsgroups-property-samlidpserver-component) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [TLSPreSharedIdentity](#tlspresharedidentity-property-samlidpserver-component) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [TLSPreSharedKey](#tlspresharedkey-property-samlidpserver-component) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [TLSPreSharedKeyCiphersuite](#tlspresharedkeyciphersuite-property-samlidpserver-component) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [TLSRenegotiationAttackPreventionMode](#tlsrenegotiationattackpreventionmode-property-samlidpserver-component) | Selects the renegotiation attack prevention mechanism. | | [TLSRevocationCheck](#tlsrevocationcheck-property-samlidpserver-component) | Specifies the kind(s) of revocation check to perform. | | [TLSSSLOptions](#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. | | [TLSMode](#tlsmode-property-samlidpserver-component) | Specifies the TLS mode to use. | | [TLSUseExtendedMasterSecret](#tlsuseextendedmastersecret-property-samlidpserver-component) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [TLSUseSessionResumption](#tlsusesessionresumption-property-samlidpserver-component) | Enables or disables the TLS session resumption capability. | | [TLSVersions](#tlsversions-property-samlidpserver-component) | The SSL/TLS versions to enable by default. | | [URL](#url-property-samlidpserver-component) | Specifies the base URL of this IdP server. | | [UserCount](#usercount-property-samlidpserver-component) | The number of records in the User arrays. | | [UserAssociatedData](#userassociateddata-property-samlidpserver-component) | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. | | [UserBasePath](#userbasepath-property-samlidpserver-component) | Base path for this user in the server's file system. | | [UserCertificate](#usercertificate-property-samlidpserver-component) | Contains the user's certificate. | | [UserData](#userdata-property-samlidpserver-component) | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. | | [UserEmail](#useremail-property-samlidpserver-component) | The user's email address. | | [UserHandle](#userhandle-property-samlidpserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [UserHashAlgorithm](#userhashalgorithm-property-samlidpserver-component) | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. | | [UserIncomingSpeedLimit](#userincomingspeedlimit-property-samlidpserver-component) | Specifies the incoming speed limit for this user. | | [UserOtpAlgorithm](#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). | | [UserOTPLen](#userotplen-property-samlidpserver-component) | Specifies the length of the user's OTP password. | | [UserOtpValue](#userotpvalue-property-samlidpserver-component) | The user's time interval (TOTP) or Counter (HOTP). | | [UserOutgoingSpeedLimit](#useroutgoingspeedlimit-property-samlidpserver-component) | Specifies the outgoing speed limit for this user. | | [UserPassword](#userpassword-property-samlidpserver-component) | The user's authentication password. | | [UserSharedSecret](#usersharedsecret-property-samlidpserver-component) | Contains the user's secret key, which is essentially a shared secret between the client and server. | | [UserSSHKey](#usersshkey-property-samlidpserver-component) | Contains the user's SSH key. | | [Username](#username-property-samlidpserver-component) | 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](#addidpservice-method-samlidpserver-component) | Registers an IdP service in the IdPServices list. | | [AddSP](#addsp-method-samlidpserver-component) | Registers an SP entity in SPSettings list. | | [AddSPService](#addspservice-method-samlidpserver-component) | Registers an SP service in the SPServices list. | | [Cleanup](#cleanup-method-samlidpserver-component) | Cleans up the server environment by purging expired sessions and cleaning caches. | | [CompleteAuth](#completeauth-method-samlidpserver-component) | Initiates transfer of the authentication fact (assertion) to the SP. | | [Config](#config-method-samlidpserver-component) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-samlidpserver-component) | Performs an additional action. | | [DropClient](#dropclient-method-samlidpserver-component) | Terminates a client connection. | | [ExportSettings](#exportsettings-method-samlidpserver-component) | Saves the SP or IdP configuration to an XML metadata file. | | [GetClientBuffer](#getclientbuffer-method-samlidpserver-component) | Acquires a piece of operation data. | | [GetProviderProperty](#getproviderproperty-method-samlidpserver-component) | Returns the value of a custom provider property. | | [GetRequestBytes](#getrequestbytes-method-samlidpserver-component) | Returns the contents of the received HTTP request. | | [GetRequestHeader](#getrequestheader-method-samlidpserver-component) | Returns a request header value. | | [GetResponseHeader](#getresponseheader-method-samlidpserver-component) | Returns a response header value. | | [GetSessionProperty](#getsessionproperty-method-samlidpserver-component) | Returns the value of a custom session property. | | [ImportSettings](#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. | | [InitiateArtifactResolve](#initiateartifactresolve-method-samlidpserver-component) | Initiates the artifact resolution protocol. | | [InitiateAuth](#initiateauth-method-samlidpserver-component) | Starts IdP-initiated SAML authentication flow. | | [InitiateLogout](#initiatelogout-method-samlidpserver-component) | Starts IdP-initiated SAML logout flow. | | [ListClients](#listclients-method-samlidpserver-component) | Enumerates the connected clients. | | [PinClient](#pinclient-method-samlidpserver-component) | Takes a snapshot of the connection's properties. | | [ProcessArtifact](#processartifact-method-samlidpserver-component) | Processes an artifact request received from the SP service at one of artifact receiver endpoints. | | [ProcessArtifactResolveRequest](#processartifactresolverequest-method-samlidpserver-component) | Processes an artifact request received from the SP service at one of the ARS endpoints. | | [ProcessAttributeQuery](#processattributequery-method-samlidpserver-component) | Processes an attribute request received from the SP service at one of the AQS endpoints. | | [ProcessGenericRequest](#processgenericrequest-method-samlidpserver-component) | Processes a generic HTTP SAML request. | | [ProcessLogoutRequest](#processlogoutrequest-method-samlidpserver-component) | Processes logout request received from the SP service at one of the SLS endpoints. | | [ProcessSignOnRequest](#processsignonrequest-method-samlidpserver-component) | Processes a single sign-on request received from the SP service at one of the SSO endpoints. | | [ProcessSignOnResponse](#processsignonresponse-method-samlidpserver-component) | Processes the submission of the login form previously generated by the IdP server. | | [RemoveSP](#removesp-method-samlidpserver-component) | Removes an SP from the list of known service providers. | | [Reset](#reset-method-samlidpserver-component) | Resets the component settings. | | [SetClientBuffer](#setclientbuffer-method-samlidpserver-component) | Commits a data buffer to the connection. | | [SetProviderProperty](#setproviderproperty-method-samlidpserver-component) | Sets the value of a custom provider property. | | [SetResponseHeader](#setresponseheader-method-samlidpserver-component) | Sets a response header. | | [SetSessionProperty](#setsessionproperty-method-samlidpserver-component) | Sets the value of a custom provider session property. | | [Start](#start-method-samlidpserver-component) | Starts the IdP server. | | [Stop](#stop-method-samlidpserver-component) | 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](#accept-event-samlidpserver-component) | Reports an incoming connection. | | [ArtifactReceived](#artifactreceived-event-samlidpserver-component) | The server fires this event upon receiving an Artifact message from the other side. | | [ArtifactResolveRequestPrepared](#artifactresolverequestprepared-event-samlidpserver-component) | This event is fired when a new artifact resolution request message has been prepared by the component. | | [ArtifactResolveRequestReceived](#artifactresolverequestreceived-event-samlidpserver-component) | Reports receipt of ArtifactResolveRequest message. | | [AssertionPrepared](#assertionprepared-event-samlidpserver-component) | This event fires when a new assertion has been prepared by the IdP server. | | [AttributeQueryReceived](#attributequeryreceived-event-samlidpserver-component) | Notifies the application about receipt of an AttributeQuery. | | [AuthnRequestReceived](#authnrequestreceived-event-samlidpserver-component) | The server fires this event upon receiving an AuthnRequest message from the other side. | | [Connect](#connect-event-samlidpserver-component) | Reports an accepted connection. | | [Disconnect](#disconnect-event-samlidpserver-component) | Fires to report a disconnected client. | | [Error](#error-event-samlidpserver-component) | Information about errors during data delivery. | | [ExternalSign](#externalsign-event-samlidpserver-component) | Handles remote or external signing initiated by the server protocol. | | [LogoutRequestPrepared](#logoutrequestprepared-event-samlidpserver-component) | This event is fired when a new logout request has been prepared. | | [LogoutRequestReceived](#logoutrequestreceived-event-samlidpserver-component) | The component uses this event to notify the application about an incoming SAML Logout Request message. | | [LogoutResponsePrepared](#logoutresponseprepared-event-samlidpserver-component) | The component uses this event to notify the application about the Logout Response message being ready to be sent. | | [LogoutResponseReceived](#logoutresponsereceived-event-samlidpserver-component) | The component uses this event to notify the application about an incoming SAML LogoutResponse message. | | [NewAssertion](#newassertion-event-samlidpserver-component) | This event reports a new assertion initiated by the IdP server. | | [Notification](#notification-event-samlidpserver-component) | This event notifies the application about an underlying control flow event. | | [ProcessingCompleted](#processingcompleted-event-samlidpserver-component) | This event notifies the application of the completion of request or response processing. | | [ReadArtifact](#readartifact-event-samlidpserver-component) | Requests content identified by an artifact from the application. | | [ReadAttribute](#readattribute-event-samlidpserver-component) | Requests an attribute from the application. | | [ResourceClose](#resourceclose-event-samlidpserver-component) | Tells the application that it can close the opened resource. | | [ResourceOpen](#resourceopen-event-samlidpserver-component) | Requests the application to open the requested resource. | | [ResourceRead](#resourceread-event-samlidpserver-component) | Requests the application to read from an opened resource. | | [ResourceRequest](#resourcerequest-event-samlidpserver-component) | Notifies the application that a server resource is requested. | | [ResourceWrite](#resourcewrite-event-samlidpserver-component) | Requests the application to write to an opened resource. | | [SAMLMessagePrepared](#samlmessageprepared-event-samlidpserver-component) | This event is fired when a SAML message has been prepared and is ready to be dispatched. | | [SAMLMessageReceived](#samlmessagereceived-event-samlidpserver-component) | The server fires this event for every SAML message it receives. | | [SessionCreated](#sessioncreated-event-samlidpserver-component) | This event is fired when a new session has been established. | | [SessionDestroyed](#sessiondestroyed-event-samlidpserver-component) | This event is fired when the IdP server has closed a session. | | [SessionEvent](#sessionevent-event-samlidpserver-component) | Notifies the application about SAML session events. | | [SessionInfoNeeded](#sessioninfoneeded-event-samlidpserver-component) | This event is fired in OfflineMode to request the session ID for the current flow. | | [SessionStateRetrieve](#sessionstateretrieve-event-samlidpserver-component) | This event fires to retrieve session state information from the application. | | [SessionStateSave](#sessionstatesave-event-samlidpserver-component) | This event passes a session state object to the application for safekeeping. | | [SignatureFound](#signaturefound-event-samlidpserver-component) | Notifies the application about the start of signature validation. | | [SignatureValidated](#signaturevalidated-event-samlidpserver-component) | Reports the signature validation result. | | [SignOnPagePrepared](#signonpageprepared-event-samlidpserver-component) | The server fires this event upon preparing the sign-on page. | | [SignOnResponseReceived](#signonresponsereceived-event-samlidpserver-component) | Notifies the application about the received response to the sign-on page. | | [TLSCertValidate](#tlscertvalidate-event-samlidpserver-component) | Fires when a client certificate needs to be validated. | | [TLSEstablished](#tlsestablished-event-samlidpserver-component) | Reports the setup of a TLS session. | | [TLSHandshake](#tlshandshake-event-samlidpserver-component) | Fires when a newly established client connection initiates a TLS handshake. | | [TLSPSK](#tlspsk-event-samlidpserver-component) | Requests a pre-shared key for TLS-PSK. | | [TLSShutdown](#tlsshutdown-event-samlidpserver-component) | Reports closure of a TLS session. | | [UserAuthCompleted](#userauthcompleted-event-samlidpserver-component) | Notifies the application about the success of user authentication flow. | | [UserAuthFailed](#userauthfailed-event-samlidpserver-component) | Notifies the application about failure of user authentication flow. | | [UserAuthStart](#userauthstart-event-samlidpserver-component) | Notifies the application about the start of user authentication flow. | | [UserAuthVerifyCredentials](#userauthverifycredentials-event-samlidpserver-component) | Passes user credentials to the application for verification. | | [UserLogoutCompleted](#userlogoutcompleted-event-samlidpserver-component) | Notifies the application about the completion of user logout flow. | | [UserLogoutStart](#userlogoutstart-event-samlidpserver-component) | 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](#AllowOptionsResponseWithoutAuth) | Enables unauthenticated responses to OPTIONS requests. | | [AssertionsOneTimeUse](#AssertionsOneTimeUse) | Adds a one-time use condition to the assertion. | | [AssertionsTTL](#AssertionsTTL) | The assertions time-to-live value. | | [AuthDigestExpire](#AuthDigestExpire) | Specifies digest expiration time for digest authentication. | | [BoundPort](#BoundPort) | The port that was bound by the server. | | [ContactPerson](#ContactPerson) | The ContactPerson entry of the provider metadata. | | [DefaultNameIDPolicyFormat](#DefaultNameIDPolicyFormat) | Default name ID policy format. | | [DefaultPassiveAuthnContextClassRef](#DefaultPassiveAuthnContextClassRef) | The default passive authentication context class. | | [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. | | [HandshakeTimeout](#HandshakeTimeout) | The HTTPS handshake timeout. | | [HomePage](#HomePage) | Specifies the home page resource name. | | [MaxIssueInstantTimeDiff](#MaxIssueInstantTimeDiff) | The maximum issue-instant time delta. | | [NotBeforeTimeout](#NotBeforeTimeout) | The 'not-before' timeout to use. | | [OAuthAllowAccessByDefault](#OAuthAllowAccessByDefault) | Specifies whether access to a resource is allowed by default. | | [OAuthAutoValidateTokens](#OAuthAutoValidateTokens) | Allows to validate OAuth 2.0 access tokens automatically. | | [OAuthIntrospectionClientID](#OAuthIntrospectionClientID) | Specifies a client ID on the authentication service. | | [OAuthIntrospectionClientSecret](#OAuthIntrospectionClientSecret) | Specifies a client secret on the authentication service. | | [OAuthIntrospectionURL](#OAuthIntrospectionURL) | Specifies the URL to be used to introspect access tokens. | | [OAuthTokenValidationKeys](#OAuthTokenValidationKeys) | Specifies JW keys in JSON format for validating access token signatures. | | [OrganizationDisplayName](#OrganizationDisplayName) | The OrganizationDisplayName entry of the provider metadata. | | [OrganizationLang](#OrganizationLang) | The OrganizationLang key of the provider metadata. | | [OrganizationName](#OrganizationName) | The OrganizationName element of the provider metadata. | | [OrganizationURL](#OrganizationURL) | The OrganizationURL element of the provider metadata. | | [PortRangeFrom](#PortRangeFrom) | The lower bound of allowed port scope to listen on. | | [PortRangeTo](#PortRangeTo) | The higher bound of allowed port scope to listen on. | | [RequestFilter](#RequestFilter) | The request string modifier. | | [ServerName](#ServerName) | Specifies the server name for the created responses. | | [SessionTimeout](#SessionTimeout) | The HTTP session timeout. | | [SessionTTL](#SessionTTL) | The SAML session time-to-live value. | | [SubjectConfirmationMethod](#SubjectConfirmationMethod) | Subject confirmation method. | | [TempPath](#TempPath) | Path for storing temporary files. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the component. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server components. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client components created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client components should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # Active Property ([SAMLIdPServer](#samlidpserver-component) Component) Tells whether the server is active and ready to process requests. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies if IdP-initiated Single Sign-On (SSO) is allowed. ## Syntax *C++ Builder Syntax* ```text __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](#addsp-method-samlidpserver-component) method to add sign-on URLs. ## Data Type Boolean # BaseDir Property ([SAMLIdPServer](#samlidpserver-component) Component) Base directory on the server. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # EncryptionCertBytes Property ([SAMLIdPServer](#samlidpserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray EncryptionCertBytes = { 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](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # ExternalCryptoAsyncDocumentID Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Custom parameters to be passed to the signing service (uninterpreted). ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Additional data to be included in the async state and mirrored back by the requestor. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies the request's signature hash algorithm. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The ID of the pre-shared key used for DC request authentication. ## Syntax *C++ Builder Syntax* ```text __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](#externalcryptokeysecret-property-samlidpserver-component) 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: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` ## Data Type String # ExternalCryptoKeySecret Property ([SAMLIdPServer](#samlidpserver-component) Component) The pre-shared key used for DC request authentication. ## Syntax *C++ Builder Syntax* ```text __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](#externalcryptokeyid-property-samlidpserver-component) topic. ## Data Type String # ExternalCryptoMethod Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the asynchronous signing method. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies the external cryptography mode. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax *C++ Builder Syntax* ```text __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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Data Type String # FIPSMode Property ([SAMLIdPServer](#samlidpserver-component) Component) Reserved. ## Syntax *C++ Builder Syntax* ```text __property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode }; ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # HandshakeTimeout Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the handshake timeout in milliseconds. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies the host address of the IdP server. ## Syntax *C++ Builder Syntax* ```text __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](#port-property-samlidpserver-component). ## Data Type String # IdPServiceCount Property ([SAMLIdPServer](#samlidpserver-component) Component) The number of records in the IdPService arrays. ## Syntax *C++ Builder Syntax* ```text __property int IdPServiceCount = { read=FIdPServiceCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [IdPServiceBindingType](#idpservicebindingtype-property-samlidpserver-component) - [IdPServiceEntityID](#idpserviceentityid-property-samlidpserver-component) - [IdPServiceLocation](#idpservicelocation-property-samlidpserver-component) - [IdPServicePriority](#idpservicepriority-property-samlidpserver-component) - [IdPServiceService](#idpserviceservice-property-samlidpserver-component) - [IdPServiceServiceIndex](#idpserviceserviceindex-property-samlidpserver-component) The array indices start at *0* and end at *IdPServiceCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # IdPServiceBindingType Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the type of SAML binding that this endpoint accepts. ## Syntax *C++ Builder Syntax* ```text __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](#idpservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # IdPServiceEntityID Property ([SAMLIdPServer](#samlidpserver-component) Component) Represents the SAML entity ID. ## Syntax *C++ Builder Syntax* ```text __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](#idpservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # IdPServiceLocation Property ([SAMLIdPServer](#samlidpserver-component) Component) The location (URL) of the endpoint. ## Syntax *C++ Builder Syntax* ```text __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](#idpservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # IdPServicePriority Property ([SAMLIdPServer](#samlidpserver-component) Component) The priority of the endpoint in relation to other endpoints with the same Location . ## Syntax *C++ Builder Syntax* ```text __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](#SAMLIdPServer_p_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](#idpservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # IdPServiceService Property ([SAMLIdPServer](#samlidpserver-component) Component) The kind of the service being provided at this endpoint. ## Syntax *C++ Builder Syntax* ```text __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](#idpservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # IdPServiceServiceIndex Property ([SAMLIdPServer](#samlidpserver-component) Component) The index of this endpoint. ## Syntax *C++ Builder Syntax* ```text __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](#idpservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # IdPContactPerson Property ([SAMLIdPServer](#samlidpserver-component) Component) The contact person or persons for the entity. ## Syntax *C++ Builder Syntax* ```text __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: ```text 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](#samlidpserver-component) Component) Contains the entity's encryption key. ## Syntax *C++ Builder Syntax* ```text __property String IdPEncryptionKey = { read=FIdPEncryptionKey, write=FSetIdPEncryptionKey }; ``` ## Default Value "" ## Remarks Contains the entity's encryption key. This setting returns the entity's public encryption key. In most cases this is in the form of a DER-encoded X.509 certificate. This property cannot be set in code; it is either taken from the processed metadata file (for other-party settings), or derived from the locally set EncryptionCertificate setting (for this-party settings). Requests sent to the endpoint can be encrypted with the provided key or certificate. This property is not available at design time. ## Data Type String # IdPEncryptionMethods Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the list of encryption methods supported by the entity. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Represents the SAML entity ID. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Adjusts secondary entity properties. ## Syntax *C++ Builder Syntax* ```text __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 # IdPSSOLink Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains a local server page link that triggers SAML authentication to the SP. ## Syntax *C++ Builder Syntax* ```text __property String IdPSSOLink = { read=FIdPSSOLink, write=FSetIdPSSOLink }; ``` ## Default Value "" ## Remarks Contains a local server page link that triggers SAML authentication to the SP. This property specifies the web link that initiates the transfer of SAML authentication fact to the SP. One scenario where this property can be used is triggering the assertion dispatch in IdP-initiated SSO flows. Navigating to the link will make the IdP server generate the authentication assertion (if the user had been authenticated) and forward this assertion to the respective service provider. This property is not available at design time. ## Data Type String # IdPNameIDFormats Property ([SAMLIdPServer](#samlidpserver-component) Component) The list of NameID formats supported by this entity. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The friendly name of the organization that maintains the entity. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The language preferred by the organization. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The name of the organization that maintains the entity. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The web URL of the organization that maintains the entity. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The outcome of the cryptographic signature validation. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies whether the SAML entity information is or should be signed. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Contains the certificate or key that was used to sign the settings (metadata) document. ## Syntax *C++ Builder Syntax* ```text __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](#idpsignaturevalidationresult-property-samlidpserver-component) setting. This property is read-only and not available at design time. ## Data Type String # IdPSigningKey Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the entity's signing key. ## Syntax *C++ Builder Syntax* ```text __property String IdPSigningKey = { read=FIdPSigningKey, write=FSetIdPSigningKey }; ``` ## Default Value "" ## Remarks Contains the entity's signing key. This setting returns the public part of the entity's signing key. In most cases this is in the form of a PKCS#1 RSA or ECDSA key. The signing key is used to sign message conveyed over Redirect binding. Redirect signatures are simpler than SAML message signatures and are made with raw keys rather than certificates. This property is not available at design time. ## Data Type String # IdPValidUntil Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the expiration time of the SAML entity information. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies the relative URL of the IdP-initiated SSO page. ## Syntax *C++ Builder Syntax* ```text __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). ## Data Type String # IdPSSOPageTemplate Property ([SAMLIdPServer](#samlidpserver-component) Component) The content of the IdP-initiated SSO page. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The number of records in the KnownCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownCertBytes](#knowncertbytes-property-samlidpserver-component) - [KnownCertHandle](#knowncerthandle-property-samlidpserver-component) 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](#samlidpserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray KnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # KnownCertHandle Property ([SAMLIdPServer](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text 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](#knowncertcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Long64 # KnownKeyCount Property ([SAMLIdPServer](#samlidpserver-component) Component) The number of records in the KnownKey arrays. ## Syntax *C++ Builder Syntax* ```text __property int KnownKeyCount = { read=FKnownKeyCount, write=FSetKnownKeyCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownKeyHandle](#knownkeyhandle-property-samlidpserver-component) 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](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text 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](#knownkeycount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Long64 # LoginAttemptsLimit Property ([SAMLIdPServer](#samlidpserver-component) Component) The maximum number of login attempts. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The IdP's metadata location. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray MetaSigningCertBytes = { read=FMetaSigningCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only and not available at design time. ## Data Type Byte Array # MetaSigningCertHandle Property ([SAMLIdPServer](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # OfflineMode Property ([SAMLIdPServer](#samlidpserver-component) Component) Enables the Offline mode. ## Syntax *C++ Builder Syntax* ```text __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](#processsignonrequest-method-samlidpserver-component), [ProcessLogoutRequest](#processlogoutrequest-method-samlidpserver-component), [ProcessSignOnResponse](#processsignonresponse-method-samlidpserver-component), 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](#samlidpserver-component) Component) Indicates whether the encryption algorithm used is an AEAD cipher. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The details of a certificate chain validation outcome. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The outcome of a certificate chain validation routine. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The cipher suite employed by this connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies whether client authentication was performed during this connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies whether client authentication was requested during this connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Indicates whether the connection has been established fully. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The unique identifier assigned to this connection. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientConnectionID = { read=FPinnedClientConnectionID }; ``` ## Remarks The unique identifier assigned to this connection. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientDigestAlgorithm Property ([SAMLIdPServer](#samlidpserver-component) Component) The digest algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The symmetric encryption algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Indicates whether a TLS connection uses a reduced-strength exportable cipher. ## Syntax *C++ Builder Syntax* ```text __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 # PinnedClientGroup Property ([SAMLIdPServer](#samlidpserver-component) Component) The elliptic curve used in this connection. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientGroup = { read=FPinnedClientGroup }; ``` ## Default Value "" ## Remarks The elliptic curve used in this connection. This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions. This property is read-only and not available at design time. ## Data Type String # PinnedClientID Property ([SAMLIdPServer](#samlidpserver-component) Component) The client connection's unique identifier. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The key exchange algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The length of the key exchange key of a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __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 # PinnedClientPFSCipher Property ([SAMLIdPServer](#samlidpserver-component) Component) Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) A hint professed by the server to help the client select the PSK identity to use. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The length of the public key. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The client's IP address. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The remote port of the client connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Indicates whether a TLS-enabled connection was spawned from another TLS connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Indicates whether TLS or SSL is enabled for this connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Indicates whether server authentication was performed during a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The signature algorithm used in a TLS handshake. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The block size of the symmetric algorithm used. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The key length of the symmetric algorithm used. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The total number of bytes received over this connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The total number of bytes sent over this connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Contains the server certificate's chain validation log. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Indicates the version of SSL/TLS protocol negotiated during this connection. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The number of records in the PinnedClientCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientCertCount = { read=FPinnedClientCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [PinnedClientCertBytes](#pinnedclientcertbytes-property-samlidpserver-component) - [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-samlidpserver-component) - [PinnedClientCertFingerprint](#pinnedclientcertfingerprint-property-samlidpserver-component) - [PinnedClientCertHandle](#pinnedclientcerthandle-property-samlidpserver-component) - [PinnedClientCertIssuer](#pinnedclientcertissuer-property-samlidpserver-component) - [PinnedClientCertIssuerRDN](#pinnedclientcertissuerrdn-property-samlidpserver-component) - [PinnedClientCertKeyAlgorithm](#pinnedclientcertkeyalgorithm-property-samlidpserver-component) - [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-samlidpserver-component) - [PinnedClientCertKeyFingerprint](#pinnedclientcertkeyfingerprint-property-samlidpserver-component) - [PinnedClientCertKeyUsage](#pinnedclientcertkeyusage-property-samlidpserver-component) - [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-samlidpserver-component) - [PinnedClientCertSelfSigned](#pinnedclientcertselfsigned-property-samlidpserver-component) - [PinnedClientCertSerialNumber](#pinnedclientcertserialnumber-property-samlidpserver-component) - [PinnedClientCertSigAlgorithm](#pinnedclientcertsigalgorithm-property-samlidpserver-component) - [PinnedClientCertSubject](#pinnedclientcertsubject-property-samlidpserver-component) - [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-samlidpserver-component) - [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-samlidpserver-component) - [PinnedClientCertValidFrom](#pinnedclientcertvalidfrom-property-samlidpserver-component) - [PinnedClientCertValidTo](#pinnedclientcertvalidto-property-samlidpserver-component) The array indices start at *0* and end at *PinnedClientCertCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertBytes Property ([SAMLIdPServer](#samlidpserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertCAKeyID Property ([SAMLIdPServer](#samlidpserver-component) Component) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertCAKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertCAKeyID }; ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-samlidpserver-component) 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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertFingerprint Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertHandle Property ([SAMLIdPServer](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text 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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Long64 # PinnedClientCertIssuer Property ([SAMLIdPServer](#samlidpserver-component) Component) The common name of the certificate issuer (CA), typically a company name. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertissuerrdn-property-samlidpserver-component). The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertIssuerRDN Property ([SAMLIdPServer](#samlidpserver-component) Component) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyAlgorithm Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the public key algorithm of this certificate. ## Syntax *C++ Builder Syntax* ```text __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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-samlidpserver-component), [PinnedClientCertCurve](#SAMLIdPServer_p_PinnedClientCertCurve), and [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-samlidpserver-component) 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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyBits Property ([SAMLIdPServer](#samlidpserver-component) Component) Returns the length of the public key in bits. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertpublickeybytes-property-samlidpserver-component) or [PinnedClientCertPrivateKeyBytes](#SAMLIdPServer_p_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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertKeyFingerprint Property ([SAMLIdPServer](#samlidpserver-component) Component) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertfingerprint-property-samlidpserver-component) property. The key fingerprint 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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyUsage Property ([SAMLIdPServer](#samlidpserver-component) Component) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertPublicKeyBytes Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the certificate's public key in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertPublicKeyBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertPublicKeyBytes }; ``` ## Remarks Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertSelfSigned Property ([SAMLIdPServer](#samlidpserver-component) Component) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertSerialNumber Property ([SAMLIdPServer](#samlidpserver-component) Component) Returns the certificate's serial number. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertSerialNumber[int PinnedClientCertIndex] = { read=FPinnedClientCertSerialNumber }; ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertSigAlgorithm Property ([SAMLIdPServer](#samlidpserver-component) Component) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertSubject Property ([SAMLIdPServer](#samlidpserver-component) Component) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertsubjectrdn-property-samlidpserver-component). The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertSubjectKeyID Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains a unique identifier of the certificate's cryptographic key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertSubjectKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectKeyID }; ``` ## Remarks Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-samlidpserver-component) and [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-samlidpserver-component) 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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertSubjectRDN Property ([SAMLIdPServer](#samlidpserver-component) Component) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertValidFrom Property ([SAMLIdPServer](#samlidpserver-component) Component) The time point at which the certificate becomes valid, in UTC. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertValidTo Property ([SAMLIdPServer](#samlidpserver-component) Component) The time point at which the certificate expires, in UTC. ## Syntax *C++ Builder Syntax* ```text __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](#pinnedclientcertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # Port Property ([SAMLIdPServer](#samlidpserver-component) Component) The listening port number. ## Syntax *C++ Builder Syntax* ```text __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](#host-property-samlidpserver-component). ## Data Type Integer # SecurityCanonicalizationMethod Property ([SAMLIdPServer](#samlidpserver-component) Component) The canonicalization method to use in the signature. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The digest method to use. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The encryption method used to encrypt the assertion. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Provides access to secondary security parameters and tweaks. ## Syntax *C++ Builder Syntax* ```text __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 | 1 | Place the Signature tag after the issuer tag in the XML document | | ssfSignatureBeforeDescriptor | 2 | Place the Signature tag before the entity descriptor tag in the XML metadata | | ssfKeyDataIssuerSerial | 4 | Include the IssuerSerial key data element | | ssfKeyDataSKI | 8 | Include the SubjectKeyIdentifier key data element | | ssfKeyDataSubjectName | 16 | Include the SubjectName key data element | | ssfKeyDataCertificate | 32 | Include the Certificate key data element | | ssfKeyDataCRL | 64 | Include the CRL key data element | | ssfSignAuthnRequests | 65536 | Sign authentication requests (SP only) | | ssfSignArtifactResolveRequests | 131072 | Sign artifact resolve requests | | ssfSignLogoutRequests | 262144 | Sign logout requests | | ssfSignAssertions | 524288 | Sign outgoing assertions (IdP only) | | ssfSignResponses | 1048576 | Sign all responses (IdP only) | | ssfEncryptAssertions | 2097152 | Encrypt generated assertions (IdP only) | This property is not available at design time. ## Data Type Integer # SecuritySigMethod Property ([SAMLIdPServer](#samlidpserver-component) Component) The signature method to use. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies the signature validation policy. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The number of records in the SenderChain arrays. ## Syntax *C++ Builder Syntax* ```text __property int SenderCertCount = { read=FSenderCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SenderChainBytes](#senderchainbytes-property-samlidpserver-component) - [SenderChainHandle](#senderchainhandle-property-samlidpserver-component) 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](#samlidpserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray SenderChainBytes[int SenderCertIndex] = { read=FSenderChainBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *SenderCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SenderCertCount](#sendercertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # SenderChainHandle Property ([SAMLIdPServer](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text 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](#sendercertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Long64 # SigningCertBytes Property ([SAMLIdPServer](#samlidpserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray SigningCertBytes = { read=FSigningCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only and not available at design time. ## Data Type Byte Array # SigningCertHandle Property ([SAMLIdPServer](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is not available at design time. ## Data Type Long64 # SigningChainCount Property ([SAMLIdPServer](#samlidpserver-component) Component) The number of records in the SigningChain arrays. ## Syntax *C++ Builder Syntax* ```text __property int SigningChainCount = { read=FSigningChainCount, write=FSetSigningChainCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SigningChainBytes](#signingchainbytes-property-samlidpserver-component) - [SigningChainHandle](#signingchainhandle-property-samlidpserver-component) 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](#samlidpserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray SigningChainBytes[int SigningChainIndex] = { read=FSigningChainBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *SigningChainIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningChainCount](#signingchaincount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # SigningChainHandle Property ([SAMLIdPServer](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text 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](#signingchaincount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Long64 # SignOnPageTemplate Property ([SAMLIdPServer](#samlidpserver-component) Component) Defines the default authentication template (login page). ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The maximum number of bytes to read from the socket, per second. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The local network interface to bind the socket to. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The local port number to bind the socket to. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The maximum number of bytes to write to the socket, per second. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Enables or disables IP protocol version 6. ## Syntax *C++ Builder Syntax* ```text __property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 }; ``` ## Default Value false ## Remarks Enables or disables IP protocol version 6. ## Data Type Boolean # SPServiceCount Property ([SAMLIdPServer](#samlidpserver-component) Component) The number of records in the SPService arrays. ## Syntax *C++ Builder Syntax* ```text __property int SPServiceCount = { read=FSPServiceCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SPServiceBindingType](#spservicebindingtype-property-samlidpserver-component) - [SPServiceEntityID](#spserviceentityid-property-samlidpserver-component) - [SPServiceLocation](#spservicelocation-property-samlidpserver-component) - [SPServicePriority](#spservicepriority-property-samlidpserver-component) - [SPServiceService](#spserviceservice-property-samlidpserver-component) - [SPServiceServiceIndex](#spserviceserviceindex-property-samlidpserver-component) The array indices start at *0* and end at *SPServiceCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # SPServiceBindingType Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the type of SAML binding that this endpoint accepts. ## Syntax *C++ Builder Syntax* ```text __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](#spservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # SPServiceEntityID Property ([SAMLIdPServer](#samlidpserver-component) Component) Represents the SAML entity ID. ## Syntax *C++ Builder Syntax* ```text __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](#spservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # SPServiceLocation Property ([SAMLIdPServer](#samlidpserver-component) Component) The location (URL) of the endpoint. ## Syntax *C++ Builder Syntax* ```text __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](#spservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # SPServicePriority Property ([SAMLIdPServer](#samlidpserver-component) Component) The priority of the endpoint in relation to other endpoints with the same Location . ## Syntax *C++ Builder Syntax* ```text __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](#SAMLIdPServer_p_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](#spservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # SPServiceService Property ([SAMLIdPServer](#samlidpserver-component) Component) The kind of the service being provided at this endpoint. ## Syntax *C++ Builder Syntax* ```text __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](#spservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # SPServiceServiceIndex Property ([SAMLIdPServer](#samlidpserver-component) Component) The index of this endpoint. ## Syntax *C++ Builder Syntax* ```text __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](#spservicecount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # SPCount Property ([SAMLIdPServer](#samlidpserver-component) Component) The number of records in the SP arrays. ## Syntax *C++ Builder Syntax* ```text __property int SPCount = { read=FSPCount, write=FSetSPCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SPContactPerson](#spcontactperson-property-samlidpserver-component) - [SPEncryptionKey](#spencryptionkey-property-samlidpserver-component) - [SPEncryptionMethods](#spencryptionmethods-property-samlidpserver-component) - [SPEntityID](#spentityid-property-samlidpserver-component) - [SPFlags](#spflags-property-samlidpserver-component) - [SPIdPSSOLink](#spidpssolink-property-samlidpserver-component) - [SPNameIDFormats](#spnameidformats-property-samlidpserver-component) - [SPOrganizationDisplayName](#sporganizationdisplayname-property-samlidpserver-component) - [SPOrganizationLang](#sporganizationlang-property-samlidpserver-component) - [SPOrganizationName](#sporganizationname-property-samlidpserver-component) - [SPOrganizationURL](#sporganizationurl-property-samlidpserver-component) - [SPServiceBindingType](#spservicebindingtype-property-samlidpserver-component) - [SPServiceEntityID](#spserviceentityid-property-samlidpserver-component) - [SPServiceLocation](#spservicelocation-property-samlidpserver-component) - [SPServicePriority](#spservicepriority-property-samlidpserver-component) - [SPServiceService](#spserviceservice-property-samlidpserver-component) - [SPServiceServiceIndex](#spserviceserviceindex-property-samlidpserver-component) - [SPSignatureValidationResult](#spsignaturevalidationresult-property-samlidpserver-component) - [SPSigned](#spsigned-property-samlidpserver-component) - [SPSignedWith](#spsignedwith-property-samlidpserver-component) - [SPSigningKey](#spsigningkey-property-samlidpserver-component) - [SPValidUntil](#spvaliduntil-property-samlidpserver-component) The array indices start at *0* and end at *SPCount - 1*. This property is not available at design time. ## Data Type Integer # SPContactPerson Property ([SAMLIdPServer](#samlidpserver-component) Component) The contact person or persons for the entity. ## Syntax *C++ Builder Syntax* ```text __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: ```text 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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPEncryptionKey Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the entity's encryption key. ## Syntax *C++ Builder Syntax* ```text __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. The *SPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SPCount](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPEncryptionMethods Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the list of encryption methods supported by the entity. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPEntityID Property ([SAMLIdPServer](#samlidpserver-component) Component) Represents the SAML entity ID. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPFlags Property ([SAMLIdPServer](#samlidpserver-component) Component) Adjusts secondary entity properties. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Integer # SPIdPSSOLink Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains a local server page link that triggers SAML authentication to the SP. ## Syntax *C++ Builder Syntax* ```text __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. The *SPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SPCount](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPNameIDFormats Property ([SAMLIdPServer](#samlidpserver-component) Component) The list of NameID formats supported by this entity. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPOrganizationDisplayName Property ([SAMLIdPServer](#samlidpserver-component) Component) The friendly name of the organization that maintains the entity. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPOrganizationLang Property ([SAMLIdPServer](#samlidpserver-component) Component) The language preferred by the organization. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPOrganizationName Property ([SAMLIdPServer](#samlidpserver-component) Component) The name of the organization that maintains the entity. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPOrganizationURL Property ([SAMLIdPServer](#samlidpserver-component) Component) The web URL of the organization that maintains the entity. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPSignatureValidationResult Property ([SAMLIdPServer](#samlidpserver-component) Component) The outcome of the cryptographic signature validation. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # SPSigned Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies whether the SAML entity information is or should be signed. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # SPSignedWith Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the certificate or key that was used to sign the settings (metadata) document. ## Syntax *C++ Builder Syntax* ```text __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](#spsignaturevalidationresult-property-samlidpserver-component) setting. The *SPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SPCount](#spcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type String # SPSigningKey Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the entity's signing key. ## Syntax *C++ Builder Syntax* ```text __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. The *SPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SPCount](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # SPValidUntil Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the expiration time of the SAML entity information. ## Syntax *C++ Builder Syntax* ```text __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](#spcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # TLSServerCertCount Property ([SAMLIdPServer](#samlidpserver-component) Component) The number of records in the TLSServerCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int TLSServerCertCount = { read=FTLSServerCertCount, write=FSetTLSServerCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TLSServerCertBytes](#tlsservercertbytes-property-samlidpserver-component) - [TLSServerCertHandle](#tlsservercerthandle-property-samlidpserver-component) 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](#samlidpserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-samlidpserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # TLSServerCertHandle Property ([SAMLIdPServer](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text 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](#tlsservercertcount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Long64 # TLSAutoValidateCertificates Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Selects the base configuration for the TLS settings. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) A list of ciphersuites separated with commas or semicolons. ## Syntax *C++ Builder Syntax* ```text __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](#tlsbaseconfiguration-property-samlidpserver-component). 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](#samlidpserver-component) Component) Enables or disables certificate-based client authentication. ## Syntax *C++ Builder Syntax* ```text __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 # TLSExtensions Property ([SAMLIdPServer](#samlidpserver-component) Component) Provides access to TLS extensions. ## Syntax *C++ Builder Syntax* ```text __property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions }; ``` ## Default Value "" ## Remarks Provides access to TLS extensions. ## Data Type String # TLSForceResumeIfDestinationChanges Property ([SAMLIdPServer](#samlidpserver-component) Component) Whether to force TLS session resumption when the destination address changes. ## Syntax *C++ Builder Syntax* ```text __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 # TLSGroups Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax *C++ Builder Syntax* ```text __property String TLSGroups = { read=FTLSGroups, write=FSetTLSGroups }; ``` ## Default Value "" ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. ## Data Type String # TLSPreSharedIdentity Property ([SAMLIdPServer](#samlidpserver-component) Component) Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Selects the renegotiation attack prevention mechanism. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) Specifies the kind(s) of revocation check to perform. ## Syntax *C++ Builder Syntax* ```text __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 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. This property is not available at design time. ## Data Type Integer # TLSSSLOptions Property ([SAMLIdPServer](#samlidpserver-component) 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 *C++ Builder Syntax* ```text __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 # TLSMode Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the TLS mode to use. ## Syntax *C++ Builder Syntax* ```text __property TsbxSAMLIdPServerTLSModes TLSMode = { read=FTLSMode, write=FSetTLSMode }; enum TsbxSAMLIdPServerTLSModes { 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](#samlidpserver-component) Component) Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax *C++ Builder Syntax* ```text __property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret }; ``` ## Default Value true ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Data Type Boolean # TLSUseSessionResumption Property ([SAMLIdPServer](#samlidpserver-component) Component) Enables or disables the TLS session resumption capability. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The SSL/TLS versions to enable by default. ## Syntax *C++ Builder Syntax* ```text __property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions }; ``` ## Default Value 48 ## 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](#samlidpserver-component) Component) Specifies the base URL of this IdP server. ## Syntax *C++ Builder Syntax* ```text __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](#samlidpserver-component) Component) The number of records in the User arrays. ## Syntax *C++ Builder Syntax* ```text __property int UserCount = { read=FUserCount, write=FSetUserCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [UserAssociatedData](#userassociateddata-property-samlidpserver-component) - [UserBasePath](#userbasepath-property-samlidpserver-component) - [UserCertificate](#usercertificate-property-samlidpserver-component) - [UserData](#userdata-property-samlidpserver-component) - [UserEmail](#useremail-property-samlidpserver-component) - [UserHandle](#userhandle-property-samlidpserver-component) - [UserHashAlgorithm](#userhashalgorithm-property-samlidpserver-component) - [UserIncomingSpeedLimit](#userincomingspeedlimit-property-samlidpserver-component) - [Username](#username-property-samlidpserver-component) - [UserOtpAlgorithm](#userotpalgorithm-property-samlidpserver-component) - [UserOTPLen](#userotplen-property-samlidpserver-component) - [UserOtpValue](#userotpvalue-property-samlidpserver-component) - [UserOutgoingSpeedLimit](#useroutgoingspeedlimit-property-samlidpserver-component) - [UserPassword](#userpassword-property-samlidpserver-component) - [UserSharedSecret](#usersharedsecret-property-samlidpserver-component) - [UserSSHKey](#usersshkey-property-samlidpserver-component) The array indices start at *0* and end at *UserCount - 1*. This property is not available at design time. ## Data Type Integer # UserAssociatedData Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray UserAssociatedData[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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Byte Array # UserBasePath Property ([SAMLIdPServer](#samlidpserver-component) Component) Base path for this user in the server's file system. ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # UserCertificate Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the user's certificate. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray UserCertificate[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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Byte Array # UserData Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # UserEmail Property ([SAMLIdPServer](#samlidpserver-component) Component) The user's email address. ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # UserHandle Property ([SAMLIdPServer](#samlidpserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __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. ```text 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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Long64 # UserHashAlgorithm Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # UserIncomingSpeedLimit Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the incoming speed limit for this user. ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Integer # UserOtpAlgorithm Property ([SAMLIdPServer](#samlidpserver-component) Component) The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Integer # UserOTPLen Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the length of the user's OTP password. ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Integer # UserOtpValue Property ([SAMLIdPServer](#samlidpserver-component) Component) The user's time interval (TOTP) or Counter (HOTP). ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Integer # UserOutgoingSpeedLimit Property ([SAMLIdPServer](#samlidpserver-component) Component) Specifies the outgoing speed limit for this user. ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Integer # UserPassword Property ([SAMLIdPServer](#samlidpserver-component) Component) The user's authentication password. ## Syntax *C++ Builder Syntax* ```text __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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # UserSharedSecret Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the user's secret key, which is essentially a shared secret between the client and server. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray UserSharedSecret[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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Byte Array # UserSSHKey Property ([SAMLIdPServer](#samlidpserver-component) Component) Contains the user's SSH key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray UserSSHKey[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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type Byte Array # Username Property ([SAMLIdPServer](#samlidpserver-component) Component) The registered name (login) of the user. ## Syntax *C++ Builder Syntax* ```text __property String Username[int UserIndex] = { read=FUsername, write=FSetUsername }; ``` ## 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](#usercount-property-samlidpserver-component) property. This property is not available at design time. ## Data Type String # AddIdPService Method ([SAMLIdPServer](#samlidpserver-component) Component) Registers an IdP service in the IdPServices list. ## Syntax *C++ Builder Syntax* ```text 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. An identity provider can provide a variety of identity services through a selection of endpoints, each supporting one or more transports (or *bindings*). Typical examples are a single sign-on or a single logout service, each of which can be served independently on the same or different endpoints, via a POST or Redirect transports (or both). Each AddIdPService call registers a single service offered via a single transport. If you would like to have the same service to be available using several different transports, you need to register each combination individually, even if the service runs at the same web endpoint: ```text idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); idp.AddIdPService(spsSingleSignOnService, csbtPOST, "/saml/sso", -1, -1); ``` Use the *Service* parameter to specify the service to register: | | | | | --- | --- | --- | | 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) | The *BindingType* specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for SSO and SLO services to support POST and Redirect bindings. The *Location* parameter specifies an absolute or relative path to the service within the SAML web service: ```text idp.AddIdPService(spsSingleSignOnService, csbtPOST, "https://idp.identityserver/saml/sso", -1, -1); // absolute path idp.AddIdPService(spsSingleSignOnService, csbtRedirect, "/saml/sso", -1, -1); // relative path ``` The *Priority* parameter is nominal as it only specifies the relative priority of the transport in the IdP metadata. The actual transport used, among those supported, depends on the choice of the external service provider / application. Pass -1 to stick with the default priority. The *Index* parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly. Note that this method registers the identity provider's *own* service - something that the identity provider provides. This is different to [AddSPService](#addspservice-method-samlidpserver-component) method, which registers a foreign service provider's service - something that the identity provider should *be aware of*. # AddSP Method ([SAMLIdPServer](#samlidpserver-component) Component) Registers an SP entity in SPSettings list. ## Syntax *C++ Builder Syntax* ```text 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](#importsettings-method-samlidpserver-component) call), make sure to register all the individual SP service endpoints (assertion consumer services, single logout services, and so on) manually using the [AddSPService](#addspservice-method-samlidpserver-component) method. Once you have added the SP entry to the list, you can edit it using the SPSettings property. # AddSPService Method ([SAMLIdPServer](#samlidpserver-component) Component) Registers an SP service in the SPServices list. ## Syntax *C++ Builder Syntax* ```text 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 known external SAML services and their locations. The identity provider needs to be knowledgeable of external SP services (applications) that it provides services to. That information can either be provided in the form of a metadata file (see [ImportSettings](#importsettings-method-samlidpserver-component)), or registered manually using this method. When using this method, make sure to register all the services you expect to work with. Note that if the same SP service is available through several different transports (*bindings*), you will need to register each (service, transport) pair individually: ```text idp.AddSPService(spsAssertionConsumerService, csbtPOST, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata"); idp.AddSPService(spsAssertionConsumerService, csbtRedirect, "https://app.com/saml/acs", -1, -1, "http://app.com/saml/metadata"); ``` Use the *Service* parameter to specify the service to register: | | | | | --- | --- | --- | | 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) | The *BindingType* specifies the transport type that the service being registered should use. Note that not every kind of service supports every kind of transport. It is typical for ACS service to use POST binding (due to the size of assertions), and SLS to either use POST or Redirect. This information is typically provided by the service provider. The *Location* parameter specifies the absolute URL of the respective SAML web endpoint. The *Priority* parameter specifies the relative priority of the transport among several identical services. The actual transport used may be different to the specified priority, as the request received from the SP (such as AuthnRequest) may explicitly request a specific transport to use. The *Index* parameter specifies the index of the endpoint, which is a unique value assigned to each endpoint. Pass -1 unless you want to provide the index explicitly. The *EntityID* parameter provides a unique identifier of the service provider. It is common to use the URL of the provider's metadata file as the Entity ID, although that is not a requirement. Note that this method registers a *known* service - something that the identity provider should be aware of. This is different to the purpose of the [AddIdPService](#addidpservice-method-samlidpserver-component) method, which registers the identity provider's *own* service. # Cleanup Method ([SAMLIdPServer](#samlidpserver-component) Component) Cleans up the server environment by purging expired sessions and cleaning caches. ## Syntax *C++ Builder Syntax* ```text void __fastcall Cleanup(); ``` ## Remarks Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches. # CompleteAuth Method ([SAMLIdPServer](#samlidpserver-component) Component) Initiates transfer of the authentication fact (assertion) to the SP. ## Syntax *C++ Builder Syntax* ```text int __fastcall CompleteAuth(__int64 ConnectionID, String SessionID, int SPServiceIndex, 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](#processingcompleted-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). # Config Method ([SAMLIdPServer](#samlidpserver-component) Component) Sets or retrieves a configuration setting. ## Syntax *C++ Builder Syntax* ```text String __fastcall Config(String ConfigurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-samlidpserver-component) 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](#config-settings-samlidpserver-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([SAMLIdPServer](#samlidpserver-component) Component) Performs an additional action. ## Syntax *C++ Builder Syntax* ```text 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;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # DropClient Method ([SAMLIdPServer](#samlidpserver-component) Component) Terminates a client connection. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Saves the SP or IdP configuration to an XML metadata file. ## Syntax *C++ Builder Syntax* ```text 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. # GetClientBuffer Method ([SAMLIdPServer](#samlidpserver-component) Component) Acquires a piece of operation data. ## Syntax *C++ Builder Syntax* ```text DynamicArray __fastcall GetClientBuffer(__int64 ConnectionID, String Handle); ``` ## Remarks Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way. A typical place to call this method is inside the [ResourceWrite](#resourcewrite-event-samlidpserver-component) event handler, when implementing customized file transfers. # GetProviderProperty Method ([SAMLIdPServer](#samlidpserver-component) Component) Returns the value of a custom provider property. ## Syntax *C++ Builder Syntax* ```text String __fastcall GetProviderProperty(String Name); ``` ## Remarks This method, together with [SetProviderProperty](#setproviderproperty-method-samlidpserver-component), 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](#samlidpserver-component) Component) Returns the contents of the received HTTP request. ## Syntax *C++ Builder Syntax* ```text DynamicArray __fastcall GetRequestBytes(__int64 ConnectionID, String RequestFilter); ``` ## Remarks Use this method to get the body of the received HTTP request. Note that the body of GET and HEAD requests is empty. The method returns the requested content. # GetRequestHeader Method ([SAMLIdPServer](#samlidpserver-component) Component) Returns a request header value. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Returns a response header value. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Returns the value of a custom session property. ## Syntax *C++ Builder Syntax* ```text String __fastcall GetSessionProperty(String SessionID, String Name); ``` ## Remarks This method, together with [SetSessionProperty](#setsessionproperty-method-samlidpserver-component), 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. These methods can be called on any active browser session. Use [SessionCreated](#sessioncreated-event-samlidpserver-component) and [SessionDestroyed](#sessiondestroyed-event-samlidpserver-component) events to get notifications about session creation and disposal. The following properties are supported for IdP sessions and can be passed to the *Name* parameter of this method: - AuthnContextClassRef: the authentication context Auth class. - AuthnRequestID: the AuthnRequest ID. - Binding: the binding type used. - Certificate: the certificate that signed the request (in base16 DER-encoded format). - CustomAuthFlow: whether the session uses a custom authentication flow. - Expires: the web session expiration time. - LoggedIn: whether the user associated with this session has successfully undergone the authentication procedures. - Login: the login name used by the user to authenticate themselves. - LoginAttempts: the number of login attempts available for the user. - LogoutRequestID: the LogoutRequest ID. - NameID: the NameID of the user. - NameIDFormat: the format of the NameID of the user. - FormattedNameID: the formatted version of the NameID. - NameIDPolicyFormat: the name ID policy format. - NameIDPolicyIdentifier: the name ID policy identifier. - RelayState: the current (last) relay state entry. - ResponseLocation: the location where the response should be sent. - Session: the session ID (the same as you pass as parameter). - SessionIndex: the cross-network session index assigned to this session. - SP: the entity ID of the service provider. - URL: the current request's URL. - UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts. # ImportSettings Method ([SAMLIdPServer](#samlidpserver-component) 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 *C++ Builder Syntax* ```text 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). # InitiateArtifactResolve Method ([SAMLIdPServer](#samlidpserver-component) Component) Initiates the artifact resolution protocol. ## Syntax *C++ Builder Syntax* ```text int __fastcall InitiateArtifactResolve(__int64 ConnectionID, String SessionID, int SPServiceIndex, String Artifact, String Tag); ``` ## Remarks Use this event to initiate the artifact resolution protocol for *Artifact*. Specify the desired SP service endpoint via the *SPServiceIndex* parameter. | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). Note: this method is currently in development and will be available in later SecureBlackbox updates. # InitiateAuth Method ([SAMLIdPServer](#samlidpserver-component) Component) Starts IdP-initiated SAML authentication flow. ## Syntax *C++ Builder Syntax* ```text int __fastcall InitiateAuth(__int64 ConnectionID, String SessionID, int SPServiceIndex, 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](#processingcompleted-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). Once the user has been authenticated, you can use [ProcessSignOnRequest](#processsignonrequest-method-samlidpserver-component) to generate SAML assertions for specific SPs. # InitiateLogout Method ([SAMLIdPServer](#samlidpserver-component) Component) Starts IdP-initiated SAML logout flow. ## Syntax *C++ Builder Syntax* ```text int __fastcall InitiateLogout(__int64 ConnectionID, String SessionID, int SPServiceIndex, 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](#processingcompleted-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). # ListClients Method ([SAMLIdPServer](#samlidpserver-component) Component) Enumerates the connected clients. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Takes a snapshot of the connection's properties. ## Syntax *C++ Builder Syntax* ```text void __fastcall PinClient(__int64 ConnectionId); ``` ## Remarks Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties. # ProcessArtifact Method ([SAMLIdPServer](#samlidpserver-component) Component) Processes an artifact request received from the SP service at one of artifact receiver endpoints. ## Syntax *C++ Builder Syntax* ```text int __fastcall ProcessArtifact(__int64 ConnectionID, String SessionID, String Request, String Tag); ``` ## Remarks Use this method to pass a SAML artifact received at one of the artifact endpoints. Artifact messages are typically very simple: ```text https://idp.server.com/sso/artifact?SAMLart=artifact ``` In response to the artifact received, the server initiates an artifact resolution protocol to retrieve the SAML message identified by the artifact. This will typically expose itself via an invocation of the [ArtifactResolveRequestPrepared](#artifactresolverequestprepared-event-samlidpserver-component) event, and, later on, of an event matching the type of the actual message received - such as [AuthnRequestReceived](#authnrequestreceived-event-samlidpserver-component). | | | | | --- | --- | --- | | sprUnknown | 0 | Unknown or undefined processing result | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). Note: this method is currently in development and will be available in later SecureBlackbox updates. # ProcessArtifactResolveRequest Method ([SAMLIdPServer](#samlidpserver-component) Component) Processes an artifact request received from the SP service at one of the ARS endpoints. ## Syntax *C++ Builder Syntax* ```text 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](#processingcompleted-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). Note: this method is currently in development and will be available in later SecureBlackbox updates. # ProcessAttributeQuery Method ([SAMLIdPServer](#samlidpserver-component) Component) Processes an attribute request received from the SP service at one of the AQS endpoints. ## Syntax *C++ Builder Syntax* ```text 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](#processingcompleted-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). Note: this method is currently in development and will be available in later SecureBlackbox updates. # ProcessGenericRequest Method ([SAMLIdPServer](#samlidpserver-component) Component) Processes a generic HTTP SAML request. ## Syntax *C++ Builder Syntax* ```text DynamicArray __fastcall ProcessGenericRequest(__int64 ConnectionID, DynamicArray Request); ``` ## Remarks Use this method to process a generic well-formed HTTP SAML request obtained elsewhere. This is a handy mechanism to bind the SAML processor to an external web engine. The *Request* parameter is expected to contain a full HTTP request, including the HTTP method string (GET, POST) and all the headers. You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). # ProcessLogoutRequest Method ([SAMLIdPServer](#samlidpserver-component) Component) Processes logout request received from the SP service at one of the SLS endpoints. ## Syntax *C++ Builder Syntax* ```text 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](#processingcompleted-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). # ProcessSignOnRequest Method ([SAMLIdPServer](#samlidpserver-component) Component) Processes a single sign-on request received from the SP service at one of the SSO endpoints. ## Syntax *C++ Builder Syntax* ```text 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](#processingcompleted-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). # ProcessSignOnResponse Method ([SAMLIdPServer](#samlidpserver-component) Component) Processes the submission of the login form previously generated by the IdP server. ## Syntax *C++ Builder Syntax* ```text 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](#userauthverifycredentials-event-samlidpserver-component) 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](#processingcompleted-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | You can use this method with or without the [OfflineMode](#offlinemode-property-samlidpserver-component). # RemoveSP Method ([SAMLIdPServer](#samlidpserver-component) Component) Removes an SP from the list of known service providers. ## Syntax *C++ Builder Syntax* ```text 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. # Reset Method ([SAMLIdPServer](#samlidpserver-component) Component) Resets the component settings. ## Syntax *C++ Builder Syntax* ```text void __fastcall Reset(); ``` ## Remarks Reset is a generic method available in every component. # SetClientBuffer Method ([SAMLIdPServer](#samlidpserver-component) Component) Commits a data buffer to the connection. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetClientBuffer(__int64 ConnectionID, String Handle, DynamicArray Value); ``` ## Remarks Use this method from your [ResourceRead](#resourceread-event-samlidpserver-component) event handler to commit a chunk of file data to the server component. # SetProviderProperty Method ([SAMLIdPServer](#samlidpserver-component) Component) Sets the value of a custom provider property. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetProviderProperty(String Name, String Value); ``` ## Remarks This method, together with [GetProviderProperty](#getproviderproperty-method-samlidpserver-component), 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](#samlidpserver-component) Component) Sets a response header. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetResponseHeader(__int64 ConnectionId, String HeaderName, String Value); ``` ## Remarks Use this method to set a response header. A good place to call this method is a request-marking event, such as GetRequest or PostRequest. # SetSessionProperty Method ([SAMLIdPServer](#samlidpserver-component) Component) Sets the value of a custom provider session property. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetSessionProperty(String SessionID, String Name, String Value); ``` ## Remarks This method, together with [GetSessionProperty](#getsessionproperty-method-samlidpserver-component), 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. The following properties can be adjusted for each individual session: - AuthnContextClassRef: the authentication context Auth class. - AuthnRequestID: the AuthnRequest ID. - Certificate: the certificate that signed the request (in base16 DER-encoded format). - CustomAuthFlow: whether the session uses a custom authentication flow. - Login: the login name used by the user to authenticate themselves. - LoginAttempts: the number of login attempts available for the user. - LogoutRequestID: the LogoutRequest ID. - NameID: the NameID of the user. - NameIDPolicyFormat: the name ID policy format. - NameIDPolicyIdentifier: the name ID policy identifier. - RelayState: the current (last) relay state entry. - ResponseLocation: the location where the response should be sent. - Session: the session ID (the same as you pass as parameter). - SessionIndex: the cross-network session index assigned to this session. - URL: the current request's URL. - UserData: the protocol-independent user data. Use this session property to store custom information associated with the session across contexts. Note: setting a session property invokes a call to [SessionStateSave](#sessionstatesave-event-samlidpserver-component). The component does that to update the session state kept externally. Note: changing session properties mindlessly may break the protocol flow. For example, changing *AuthnRequestID* to a different value may cause the Service Provider to reject the subsequent assertion message, as it will contain a now-unmatching In-Response-To entry. # Start Method ([SAMLIdPServer](#samlidpserver-component) Component) Starts the IdP server. ## Syntax *C++ Builder Syntax* ```text void __fastcall Start(); ``` ## Remarks Use this method to start listening for incoming connections. # Stop Method ([SAMLIdPServer](#samlidpserver-component) Component) Stops the IdP server. ## Syntax *C++ Builder Syntax* ```text void __fastcall Stop(); ``` ## Remarks Call this method to stop listening for incoming connections. # Accept Event ([SAMLIdPServer](#samlidpserver-component) Component) Reports an incoming connection. ## Syntax *C++ Builder Syntax* ```text 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](#connect-event-samlidpserver-component) event to be notified of every connection that has been set up. # ArtifactReceived Event ([SAMLIdPServer](#samlidpserver-component) Component) The server fires this event upon receiving an Artifact message from the other side. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; String Artifact; int Action; } TsbxSAMLIdPServerArtifactReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerArtifactReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerArtifactReceivedEventParams *e); __property TsbxSAMLIdPServerArtifactReceivedEvent OnArtifactReceived = { read=FOnArtifactReceived, write=FOnArtifactReceived }; ``` ## Remarks The Artifact message is very simple and only contains the actual artifact (an opaque string). Depending on the choice of the *Action* parameter, the further flow may go as following: - fraAuto: the server will prepare an ArtifactResolve request and sent it to the other side to retrieve the artifact. - fraCustom: the server will acknowledge the receipt of the artifact, but it is the task of your code to request the message and pass it on to the server via [ProcessGenericRequest](#processgenericrequest-method-samlidpserver-component) method. - fraReject: the server will discard the artifact. Note that you still can choose fraAuto to let the server proceed, but alter the flow as required in further events, such as [ArtifactResolveRequestPrepared](#artifactresolverequestprepared-event-samlidpserver-component). In [OfflineMode](#offlinemode-property-samlidpserver-component) this event would typically be fired from [ProcessArtifact](#processartifact-method-samlidpserver-component) call. # ArtifactResolveRequestPrepared Event ([SAMLIdPServer](#samlidpserver-component) Component) This event is fired when a new artifact resolution request message has been prepared by the component. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; String Artifact; } TsbxSAMLIdPServerArtifactResolveRequestPreparedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerArtifactResolveRequestPreparedEvent)(System::TObject* Sender, TsbxSAMLIdPServerArtifactResolveRequestPreparedEventParams *e); __property TsbxSAMLIdPServerArtifactResolveRequestPreparedEvent OnArtifactResolveRequestPrepared = { read=FOnArtifactResolveRequestPrepared, write=FOnArtifactResolveRequestPrepared }; ``` ## Remarks Subscribe to this event to be notified about preparation of artifact resolution requests. This is fired right after the resolution request has been prepared, and just before the component sends it out to the service provider. # ArtifactResolveRequestReceived Event ([SAMLIdPServer](#samlidpserver-component) Component) Reports receipt of ArtifactResolveRequest message. ## Syntax *C++ Builder Syntax* ```text 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 The component fires this event to report receipt of incoming artifact resolution request. The *Artifact* parameter contains the artifact identifier received. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | 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 | # AssertionPrepared Event ([SAMLIdPServer](#samlidpserver-component) Component) This event fires when a new assertion has been prepared by the IdP server. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; String Body; String Auth; String NameID; String NameIDFormat; String SessionIndex; String Attributes; 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 SP as part of the authentication process. This event may fire from within [ProcessSignOnRequest](#processsignonrequest-method-samlidpserver-component) and [ProcessSignOnResponse](#processsignonresponse-method-samlidpserver-component) calls when working in [OfflineMode](#offlinemode-property-samlidpserver-component), and at any time otherwise. The *RequestID* parameter contains the request ID, in response to which the assertion was created. The *SP* parameter contains the identifier of the service provider where the assertion will be sent to. The *Body* parameter contains the assertion itself in XML format. The *NameID* parameter contains the name identifier of the authenticated user, and *SessionIndex* the unique session index of the new session. The *ValidFrom* and *ValidTo* parameters specify the validity period of the assertion. # AttributeQueryReceived Event ([SAMLIdPServer](#samlidpserver-component) Component) Notifies the application about receipt of an AttributeQuery. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; bool IsEncrypted; bool IsSigned; String NameID; String NameIDFormat; String Attributes; int Action; } TsbxSAMLIdPServerAttributeQueryReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerAttributeQueryReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerAttributeQueryReceivedEventParams *e); __property TsbxSAMLIdPServerAttributeQueryReceivedEvent OnAttributeQueryReceived = { read=FOnAttributeQueryReceived, write=FOnAttributeQueryReceived }; ``` ## Remarks The component fires this event to notify the application of receipt of an AttributeQuery message. The parameters of the event detail the properties included in the request. The *NameID* and *NameIDFormat* specify the subject, and the *Attributes* string contains a list of attributes being requested. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | 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 | If the application chooses to process the request manually, the component will go ahead to fire [ReadAttribute](#readattribute-event-samlidpserver-component) event repeatedly for each attribute in the list. The application must subscribe to the event and return the attribute parameters and values from there. # AuthnRequestReceived Event ([SAMLIdPServer](#samlidpserver-component) Component) The server fires this event upon receiving an AuthnRequest message from the other side. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; bool IsEncrypted; bool IsSigned; String NameIDFormat; 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. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | 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 | In [OfflineMode](#offlinemode-property-samlidpserver-component) this event would typically be fired from [ProcessSignOnRequest](#processsignonrequest-method-samlidpserver-component) call. # Connect Event ([SAMLIdPServer](#samlidpserver-component) Component) Reports an accepted connection. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Fires to report a disconnected client. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Information about errors during data delivery. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Handles remote or external signing initiated by the server protocol. ## Syntax *C++ Builder Syntax* ```text 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: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # LogoutRequestPrepared Event ([SAMLIdPServer](#samlidpserver-component) Component) This event is fired when a new logout request has been prepared. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; String NameID; String NameIDFormat; String SessionIndex; String RelayState; } TsbxSAMLIdPServerLogoutRequestPreparedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerLogoutRequestPreparedEvent)(System::TObject* Sender, TsbxSAMLIdPServerLogoutRequestPreparedEventParams *e); __property TsbxSAMLIdPServerLogoutRequestPreparedEvent OnLogoutRequestPrepared = { read=FOnLogoutRequestPrepared, write=FOnLogoutRequestPrepared }; ``` ## Remarks The component uses this event to report completion of the LogoutRequest preparation. The *NameID*, *NameIDFormat*, and *SessionIndex* parameters indicate the subject that is being logged out. The *SP* parameter references the service provider involved. The *RelayState* contains the relay state value that is going to be passed with the LogoutRequest to the remote party and mirrored back (if the protocol supports it). # LogoutRequestReceived Event ([SAMLIdPServer](#samlidpserver-component) Component) The component uses this event to notify the application about an incoming SAML Logout Request message. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; bool IsEncrypted; bool IsSigned; String NameID; String NameIDFormat; String SessionIndex; 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 a single logout service endpoint. The *NameID*, *NameIDFormat*, and *SessionIndex* parameters indicate the principal that is signing out. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | 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 | # LogoutResponsePrepared Event ([SAMLIdPServer](#samlidpserver-component) Component) The component uses this event to notify the application about the Logout Response message being ready to be sent. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; String Body; String NameID; String NameIDFormat; String SessionIndex; } 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. # LogoutResponseReceived Event ([SAMLIdPServer](#samlidpserver-component) Component) The component uses this event to notify the application about an incoming SAML LogoutResponse message. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; bool IsEncrypted; bool IsSigned; String NameID; String NameIDFormat; String SessionIndex; String RelayState; int Action; } TsbxSAMLIdPServerLogoutResponseReceivedEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerLogoutResponseReceivedEvent)(System::TObject* Sender, TsbxSAMLIdPServerLogoutResponseReceivedEventParams *e); __property TsbxSAMLIdPServerLogoutResponseReceivedEvent OnLogoutResponseReceived = { read=FOnLogoutResponseReceived, write=FOnLogoutResponseReceived }; ``` ## Remarks The SAML IdP server fires this event when a SAML logout response is received at a single logout service endpoint following the LogoutRequest sent earlier. The *RelayState* is a mirrored back value included in the request. The *NameID*, *NameIDFormat*, and *SessionIndex* parameters indicate the principal that is signing out. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | 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 | # NewAssertion Event ([SAMLIdPServer](#samlidpserver-component) Component) This event reports a new assertion initiated by the IdP server. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; int Reason; String AuthInstant; String AuthContext; String NameID; String NameIDFormat; String SessionIndex; String Attributes; String ValidFrom; String ValidTo; bool Sign; bool Encrypt; } TsbxSAMLIdPServerNewAssertionEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerNewAssertionEvent)(System::TObject* Sender, TsbxSAMLIdPServerNewAssertionEventParams *e); __property TsbxSAMLIdPServerNewAssertionEvent OnNewAssertion = { read=FOnNewAssertion, write=FOnNewAssertion }; ``` ## Remarks The component fires this event when it is about to prepare an assertion to be sent to the SP as part of the authentication or attribute request process. This event may fire from within the [ProcessSignOnRequest](#processsignonrequest-method-samlidpserver-component) and [ProcessSignOnResponse](#processsignonresponse-method-samlidpserver-component) calls when working in [OfflineMode](#offlinemode-property-samlidpserver-component), and at any time otherwise. The *RequestID* parameter contains the request ID, in response to which the assertion is being created. The *SP* parameter contains the identifier of the service provider where the assertion will be sent to. The *Reason* parameter contains the reason for the assertion to be generated. This can be an authentication request or an attribute request being received. The *AuthInstant*, *AuthContext*, *NameID*, *SessionIndex*, *Attributes*, *ValidFrom*, and *ValidTo* parameters indicate the initial parameters of the new assertion. Further events, such as [ReadAttribute](#readattribute-event-samlidpserver-component) or [AssertionPrepared](#assertionprepared-event-samlidpserver-component) will be fired later on to clarify the contents of the assertion. # Notification Event ([SAMLIdPServer](#samlidpserver-component) Component) This event notifies the application about an underlying control flow event. ## Syntax *C++ Builder Syntax* ```text 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. This component can fire this event with the following *EventID* values: | | | | --- | --- | | ListeningStarted | Notifies the application that the server has started listening for incoming connections. | | ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. | # ProcessingCompleted Event ([SAMLIdPServer](#samlidpserver-component) Component) This event notifies the application of the completion of request or response processing. ## Syntax *C++ Builder Syntax* ```text 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](#offlinemode-property-samlidpserver-component) in response to calls such as [ProcessSignOnRequest](#processsignonrequest-method-samlidpserver-component), [ProcessSignOnResponse](#processsignonresponse-method-samlidpserver-component), 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](#sessioninfoneeded-event-samlidpserver-component) 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 | | sprSuccess | 1 | The processing completed successfully. No tangible output has been generated (e.g. an artifact was resolved and acknowledged, but nothing needs to be sent to the browser). | | sprSAMLMessage | 2 | The processing was fully or partially successful. The output contains a new SAML message that needs to be conveyed to the other SAML party. | | sprSignOnPage | 3 | The processing was fully or partially successful. The output contains or redirects to a SAML login page. | | sprResource | 4 | The processing was fully or partially successful. The output contains, or redirects to, a generic web resource. | | sprSAMLError | 5 | The processing failed due to SAML-related issue (bad sign-on parameters, unknown principal etc.). The output contains a SAML error message. This still needs to be relayed to the other SAML party. | | sprTransportError | 6 | The operation could not be completed due to an issue with configuration (e.g. non-existent SAML endpoint), permissions, or network. The SAML protocol could not commence. The output contains a transport-layer (HTTP) error message which can/should be displayed to the user in the browser. | # ReadArtifact Event ([SAMLIdPServer](#samlidpserver-component) Component) Requests content identified by an artifact from the application. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; String Artifact; String Value; bool Skip; } TsbxSAMLIdPServerReadArtifactEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerReadArtifactEvent)(System::TObject* Sender, TsbxSAMLIdPServerReadArtifactEventParams *e); __property TsbxSAMLIdPServerReadArtifactEvent OnReadArtifact = { read=FOnReadArtifact, write=FOnReadArtifact }; ``` ## Remarks The component fires this event to request the content matching *Artifact* from the application. This is normally happens within the artifact resolution protocol between an SP and the IdP server. The application must provide the requested artifact content via the *Value* parameter. The application can choose not to provide the artifact content (for example, if it doesn't have it) by setting *Skip* to true. # ReadAttribute Event ([SAMLIdPServer](#samlidpserver-component) Component) Requests an attribute from the application. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; String NameID; String NameIDFormat; String AttrName; String AttrNameFormat; String AttrFriendlyName; String Value; bool Skip; } TsbxSAMLIdPServerReadAttributeEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerReadAttributeEvent)(System::TObject* Sender, TsbxSAMLIdPServerReadAttributeEventParams *e); __property TsbxSAMLIdPServerReadAttributeEvent OnReadAttribute = { read=FOnReadAttribute, write=FOnReadAttribute }; ``` ## Remarks The component fires this event to request an attribute from the application. This event can be invoked multiple times after the [AttributeQueryReceived](#attributequeryreceived-event-samlidpserver-component) event has fired, to collect every attribute requested. The application is expected to set the *Value* and, optionally, *AttrNameFormat* and *AttrFriendlyName* for every attribute requested. The *AttrName* matches the name requested by the remote party, but the event handler can change it too if required. If the application has no knowledge of or does not support the *AttrName* attribute, it can set *Skip* to true to avoid sending it. # ResourceClose Event ([SAMLIdPServer](#samlidpserver-component) Component) Tells the application that it can close the opened resource. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String Handle; } 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](#resourceopen-event-samlidpserver-component) handler. # ResourceOpen Event ([SAMLIdPServer](#samlidpserver-component) Component) Requests the application to open the requested resource. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String URL; String HttpMethod; int OperationStatus; String Handle; } 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](#resourcerequest-event-samlidpserver-component) event call. Your code is expected to open the requested resource and be prepared to read from it in subsequent [ResourceRead](#resourceread-event-samlidpserver-component) 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](#samlidpserver-component) Component) Requests the application to read from an opened resource. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String Handle; 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](#setclientbuffer-method-samlidpserver-component) 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](#samlidpserver-component) Component) Notifies the application that a server resource is requested. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String URL; String HttpMethod; bool ResProtected; bool ResSpecial; bool AllowWriting; 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](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code ('virtualize' the request). This event may fire more than once for one resource if the client is forced to re-submit the request with a session cookie. 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 | # ResourceWrite Event ([SAMLIdPServer](#samlidpserver-component) Component) Requests the application to write to an opened resource. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String Handle; int OperationStatus; } TsbxSAMLIdPServerResourceWriteEventParams; typedef void __fastcall (__closure *TsbxSAMLIdPServerResourceWriteEvent)(System::TObject* Sender, TsbxSAMLIdPServerResourceWriteEventParams *e); __property TsbxSAMLIdPServerResourceWriteEvent OnResourceWrite = { read=FOnResourceWrite, write=FOnResourceWrite }; ``` ## Remarks The component fires this event in virtualized mode to pass another chunk of data to a resource opened earlier. This event is called for write-enabled requests, such as POST or PUT. The handler of this event should read the pending data using the [GetClientBuffer](#getclientbuffer-method-samlidpserver-component) method and write them to the opened file descriptor. Use the *OperationStatus* parameter to return the operation result back to the server: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # SAMLMessagePrepared Event ([SAMLIdPServer](#samlidpserver-component) Component) This event is fired when a SAML message has been prepared and is ready to be dispatched. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String MessageID; String Destination; String IssueInstant; 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, LogoutRequest, or IdP metadata). 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](#samlidpserver-component) Component) The server fires this event for every SAML message it receives. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String MessageID; String Issuer; String IssueInstant; String InResponseTo; String RequestBody; String MessageType; String MessageBody; bool IsSigned; 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 of the message received. The *RequestBody* and *InResponseTo* contain a reference to the request that this message is a response to (if any). Set Action property as required to let the component know how to proceed. | | | | | --- | --- | --- | | 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](#samlidpserver-component) Component) This event is fired when a new session has been established. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) This event is fired when the IdP server has closed a session. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Notifies the application about SAML session events. ## Syntax *C++ Builder Syntax* ```text 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 event to notify your code about events that happen within the lifeline of a SAML session. Handling it may be useful for development, logging, and monitoring purposes. The *SessionID* parameter specifies the session ID, and the *EventText* parameter describes the event that happened. Below are a few typical examples of what *EventText* you can expect to get: - Start - IdPSSOReceived - AuthnRequestReceived - ChallengePrepared - CredentialsReceived - ResponsePrepared - LoggedIn - LogoutRequestReceived - LogoutResponsePrepared - ArtifactResolveReceived - ArtifactResponsePrepared - AttributeQueryReceived - AttributeResponsePrepared - Finish # SessionInfoNeeded Event ([SAMLIdPServer](#samlidpserver-component) Component) This event is fired in OfflineMode to request the session ID for the current flow. ## Syntax *C++ Builder Syntax* ```text 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 SAML protocol is stateful, which means that SAML services need to keep session-related information between connections. When used in online mode - where the components listen and serve connections automatically - the components can use HTTP cookies to track connecting clients and maintain the session store at the background. However, when used in offline mode, the components do not have access to the HTTP layer and live too short for the session store to survive. That is why in offline mode the components rely on the application code to keep the session information for them. The components use a collection of Session* events to exchange session information with the application: - [SessionCreated](#sessioncreated-event-samlidpserver-component) is called when the component establishes a new session. In offline mode, the application should associate the session ID with the connected user, for example by returning it as a cookie. - [SessionStateSave](#sessionstatesave-event-samlidpserver-component) : the component passes the session state to the application and expects that the application saves it somewhere to return it back to the component at its request at some point in the future. The session state is an opaque string. The application can use a hash table to store a collection of (SessionID, SessionState) pairs over the lifetime of the SAML service. The server may fire [SessionStateSave](#sessionstatesave-event-samlidpserver-component) multiple times for the same SessionID. If this happens, the existing SessionID entry should be overwritten with the fresh session data. - [SessionStateRetrieve](#sessionstateretrieve-event-samlidpserver-component) : the component passes a session ID to the application and expects it to return the session state saved in the hash table earlier. The application should not delete the state from the hash table, as it may be needed again. - SessionInfoNeeded (this event): the component expects the application to return the session ID corresponding to the connection ID back to them. This event fires, for example, if the application calls [ProcessLogoutRequest](#processlogoutrequest-method-samlidpserver-component) but passes an empty SessionID as a parameter. - [SessionDestroyed](#sessiondestroyed-event-samlidpserver-component) is called when a session is destroyed. The component can remove the session from the hash table upon receiving this event. # SessionStateRetrieve Event ([SAMLIdPServer](#samlidpserver-component) Component) This event fires to retrieve session state information from the application. ## Syntax *C++ Builder Syntax* ```text 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 The component fires this event to request a session state that was previously provided to the application via the [SessionStateSave](#sessionstatesave-event-samlidpserver-component) call. See the [SessionInfoNeeded](#sessioninfoneeded-event-samlidpserver-component) topic for more details about session management in offline mode. # SessionStateSave Event ([SAMLIdPServer](#samlidpserver-component) Component) This event passes a session state object to the application for safekeeping. ## Syntax *C++ Builder Syntax* ```text 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 The component fires this event to pass a session state to the application. The application is expected to save the state object (which is an opaque string) in a hash table, and be ready to return it back to the component when it requests it using a [SessionStateRetrieve](#sessionstateretrieve-event-samlidpserver-component) call. See the [SessionInfoNeeded](#sessioninfoneeded-event-samlidpserver-component) topic for more details about session management in offline mode. # SignatureFound Event ([SAMLIdPServer](#samlidpserver-component) Component) Notifies the application about the start of signature validation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; int Scope; String Signer; String TargetID; String TargetType; String IssuerRDN; DynamicArray SerialNumber; DynamicArray SubjectKeyID; String SigMethod; String DigestMethod; bool CertFound; bool Validate; } 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. The *TargetID* and *TargetType* provide additional details. | | | | | --- | --- | --- | | 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](CertificateValidator.md#CertificateValidator) component to validate its chain. Use the *Validate* parameter to tell the reader whether it should validate the signature. # SignatureValidated Event ([SAMLIdPServer](#samlidpserver-component) Component) Reports the signature validation result. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; int Scope; String Signer; String TargetID; String TargetType; String IssuerRDN; DynamicArray SerialNumber; DynamicArray SubjectKeyID; String SigMethod; String DigestMethod; int ValidationResult; } 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 signature validation process is completed. The *Scope* parameter specifies the subject of the signature. This can be the outermost SAML message or an embedded assertion. The *TargetID* and *TargetType* parameters provide the details. | | | | | --- | --- | --- | | 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 | Signing certificates are typically identified either by an (*IssuerRDN*, *SerialNumber*) pair, or via their unique *SubjectKeyID*. Use these parameters to look for the signing certificate if it is not available in the signature. The *ValidationResult* parameter specifies whether the signature is established to be valid or not. You can alter it in the event handler to override the built-in validation outcome. | | | | | --- | --- | --- | | 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](#samlidpserver-component) Component) The server fires this event upon preparing the sign-on page. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String RequestID; String SP; 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](#signonpagetemplate-property-samlidpserver-component) to assign the sign-on page template. The form body is returned via the *PageData* 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](#samlidpserver-component) Component) Notifies the application about the received response to the sign-on page. ## Syntax *C++ Builder Syntax* ```text 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 The component uses this event to report that the login form previously generated by the component has been filled in and returned by the user. *ResponseData* contains the content submitted by the user (the URL-encoded form fields, or any authentication data if the custom authentication flow is used). The application that chose to use custom authentication process can use this data to authenticate the user. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | 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 | # TLSCertValidate Event ([SAMLIdPServer](#samlidpserver-component) Component) Fires when a client certificate needs to be validated. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Reports the setup of a TLS session. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Fires when a newly established client connection initiates a TLS handshake. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Requests a pre-shared key for TLS-PSK. ## Syntax *C++ Builder Syntax* ```text 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](#samlidpserver-component) Component) Reports closure of a TLS session. ## Syntax *C++ Builder Syntax* ```text 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](#disconnect-event-samlidpserver-component), which marks the closure of the underlying TCP session. # UserAuthCompleted Event ([SAMLIdPServer](#samlidpserver-component) Component) Notifies the application about the success of user authentication flow. ## Syntax *C++ Builder Syntax* ```text 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 Subscribe to this event to get notified about completion of user authentication flow. The *NameID*, *NameIDFormat*, *SessionIndex*, and *AssertionTTL* parameters contain the proposed session parameters. You can alter them in your event handler as required. # UserAuthFailed Event ([SAMLIdPServer](#samlidpserver-component) Component) Notifies the application about failure of user authentication flow. ## Syntax *C++ Builder Syntax* ```text 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 The component fires this event to notify the application about failed user authentication step - for example, if a wrong password was supplied. The *CanRetry* parameter indicates whether another attempt of the same type can be performed. If you would like to use that opportunity, set *TryAgain* to true to restart the process. # UserAuthStart Event ([SAMLIdPServer](#samlidpserver-component) Component) Notifies the application about the start of user authentication flow. ## Syntax *C++ Builder Syntax* ```text 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](#signonpagetemplate-property-samlidpserver-component), or to Custom to supply (or redirect to) your own authentication landing. The *SupportedAuths* parameter contains the list of authentication methods supported by the server. If you are looking to use a particular authentication method, return it to the server via *SelectedAuth* parameter. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | 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 | # UserAuthVerifyCredentials Event ([SAMLIdPServer](#samlidpserver-component) Component) Passes user credentials to the application for verification. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String SessionID; String SP; 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](#samlidpserver-component) Component) Notifies the application about the completion of user logout flow. ## Syntax *C++ Builder Syntax* ```text 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 Subscribe to this event to be notified about the logout flow completion. # UserLogoutStart Event ([SAMLIdPServer](#samlidpserver-component) Component) Notifies the application about the start of user logout flow. ## Syntax *C++ Builder Syntax* ```text 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 The component uses this event to notify the application about the start of user logout flow. The *Secondary* parameter indicates that the logout is initiated in response to request received from a remote party. The application can choose to accept or reject the request, or process it manually, using the *Action* parameter: | | | | | --- | --- | --- | | 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 | # Config Settings ([SAMLIdPServer](#samlidpserver-component) 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](#config-method-samlidpserver-component) method. ### SAMLIdPServer Config Settings **AllowOptionsResponseWithoutAuth**: Enables unauthenticated responses to OPTIONS requests.Set this property to true to allow the server serve OPTIONS requests without prior authentication of the client. **AssertionsOneTimeUse**: Adds a one-time use condition to the assertion.This setting instructs the server to add a one-time use condition to the assertion. **AssertionsTTL**: The assertions time-to-live value.Specifies the time-to-live value for the created assertions, in milliseconds. The default value is 60000. **AuthDigestExpire**: Specifies digest expiration time for digest authentication.Use this property to specify the digest expiration time for digest authentication, in seconds. The default setting is 20. **BoundPort**: The port that was bound by the server.Returns the port number that was bound by the server. **ContactPerson**: The ContactPerson entry of the provider metadata.Use this configuration setting to set or get the ContactPerson element of the provider metadata record. **DefaultNameIDPolicyFormat**: Default name ID policy format.Provides means to set the default name ID policy format. The default value is urn:oasis:names:tc:SAML:2.0:nameid-format:transient. **DefaultPassiveAuthnContextClassRef**: The default passive authentication context class.Use this property to specify the default passive authentication context class. The default value is urn:oasis:names:tc:SAML:2.0:ac:classes:TLSClient. **DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. **HandshakeTimeout**: The HTTPS handshake timeout.The HTTPS handshake timeout in milliseconds. **HomePage**: Specifies the home page resource name.Use this property to specify the home page (/) resource name. **MaxIssueInstantTimeDiff**: The maximum issue-instant time delta.This property specifies the maximum time delta for serving issue-instant requests, in milliseconds. The default value is 30000. **NotBeforeTimeout**: The 'not-before' timeout to use.Specifies the 'too-early' timeout for the requests in milliseconds. The default value is -60000. **OAuthAllowAccessByDefault**: Specifies whether access to a resource is allowed by default.Use this property to enable or disable access to a resource in case if no scopes defined or the resource doesn't match any of the user's scopes. **OAuthAutoValidateTokens**: Allows to validate OAuth 2.0 access tokens automatically.Use this property to enable or disable pre-validation of access tokens. **OAuthIntrospectionClientID**: Specifies a client ID on the authentication service.Use this property to provide a client ID for access token introspection. **OAuthIntrospectionClientSecret**: Specifies a client secret on the authentication service.Use this property to provide a client secret for access token introspection. **OAuthIntrospectionURL**: Specifies the URL to be used to introspect access tokens.Use this property to provide the URL for introspection. **OAuthTokenValidationKeys**: Specifies JW keys in JSON format for validating access token signatures. **OrganizationDisplayName**: The OrganizationDisplayName entry of the provider metadata.Use this property to provide or get the OrganizationDisplayName element of the provider metadata. **OrganizationLang**: The OrganizationLang key of the provider metadata.Use this property to get or set the OrganizationLog element of the provider metadata. **OrganizationName**: The OrganizationName element of the provider metadata.This configuration property allows you to set or get the OrganizationName element of the provider metadata. **OrganizationURL**: The OrganizationURL element of the provider metadata.Use this configuration setting to set or get the OrganizationURL parameter of the provider metadata. **PortRangeFrom**: The lower bound of allowed port scope to listen on.Specifies the lowest port number the server may use if dynamic allocation is used. **PortRangeTo**: The higher bound of allowed port scope to listen on.Specifies the highest port number the server may use if dynamic allocation is used. **RequestFilter**: The request string modifier.Use this property to tune up the request string as returned by GetRequestString method. Supported filters: params (request parameters only), params[Index] or params['Name'] (a specific request parameter), parts[Index] (the contents of a particular part of a multipart message). An empty request filter makes GetRequestString return the whole body of the request. **ServerName**: Specifies the server name for the created responses.Use this property to specify the server name to be included in the generated responses. **SessionTimeout**: The HTTP session timeout.The HTTP session timeout in milliseconds. **SessionTTL**: The SAML session time-to-live value.The SAML session time-to-live value, in milliseconds. The default value is 600000 (10 minutes). **SubjectConfirmationMethod**: Subject confirmation method.Provides means to set the subject confirmation method. The default value is urn:oasis:names:tc:SAML:2.0:cm:bearer. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the component. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the component.Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. 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 | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. 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 | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. 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. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | 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) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the components. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([SAMLIdPServer](#samlidpserver-component) Component) ### SAMLIdPServer Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 30408705 | Invalid binding name ([SB_ERROR_SAML_INVALID_BINDING_NAME](constants.md#const_SBERRORSAMLINVALIDBINDINGNAME)) | | 30408706 | Invalid SAML binding type ([SB_ERROR_SAML_INVALID_BINDING_TYPE](constants.md#const_SBERRORSAMLINVALIDBINDINGTYPE)) | | 30408707 | Base directory not set ([SB_ERROR_SAML_SP_BASE_DIRECTORY_NOT_SET](constants.md#const_SBERRORSAMLSPBASEDIRECTORYNOTSET)) | | 30408708 | Invalid parameter ([SB_ERROR_SAML_INVALID_PARAM](constants.md#const_SBERRORSAMLINVALIDPARAM)) | | 30408709 | Invalid input data ([SB_ERROR_SAML_INVALID_DATA](constants.md#const_SBERRORSAMLINVALIDDATA)) | | 30408710 | Data is not loaded ([SB_ERROR_SAML_NOT_LOADED](constants.md#const_SBERRORSAMLNOTLOADED)) | | 30408711 | New document is not created ([SB_ERROR_SAML_NOT_CREATED](constants.md#const_SBERRORSAMLNOTCREATED)) | | 30408716 | Endpoint of unsupported type encountered or cannot find appropriate IdP service ([SB_ERROR_SAML_INVALID_SERVICE](constants.md#const_SBERRORSAMLINVALIDSERVICE)) | | 30408717 | Multiple endpoints of the same kind are not supported ([SB_ERROR_SAML_MULTIPLE_ENDPOINTS_NOT_SUPPORTED](constants.md#const_SBERRORSAMLMULTIPLEENDPOINTSNOTSUPPORTED)) | | 30408718 | Failed to process the request ([SB_ERROR_SAML_PROCESSING_FAILED](constants.md#const_SBERRORSAMLPROCESSINGFAILED)) | | 30408719 | Session not found ([SB_ERROR_SAML_SESSION_NOT_FOUND](constants.md#const_SBERRORSAMLSESSIONNOTFOUND)) |