# XMLVerifier Component
The XMLVerifier component provides simplified XML signature validation capabilities.
## Syntax
```text
TsbxXMLVerifier
```
## Remarks
Use this control to validate XML-SIG signatures. XMLVerifier is capable of validating the integrity of the references covered by the signature and the integrity of the signature itself, using the certificate contained in the signature or provided from the user' code.
Note that this component only validates the cryptographic aspects of the signatures, but does not perform any chain of trust validation. As such, it is the task of your code to ensure that the signing certificate is good for its purpose and is trusted in your environment.
If you are looking to validate certificate trust in addition to the cryptographic capabilities, please consider using [XAdESVerifier](XAdESVerifier.md#XAdESVerifier). XAdESVerifier provides full support for advanced signature ecosystem, including revocation and Trusted List checking, timing checks, and chain of trust validation.
## Property List
*The following is the full list of the properties of the component with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [AllSignaturesValid](#allsignaturesvalid-property-xmlverifier-component) | The cumulative validity of all signatures. |
| [AutoValidateSignatures](#autovalidatesignatures-property-xmlverifier-component) | Specifies whether component should validate any present signatures when the document is opened. |
| [CertCount](#certcount-property-xmlverifier-component) | The number of records in the Cert arrays. |
| [CertBytes](#certbytes-property-xmlverifier-component) | Returns the raw certificate data in DER format. |
| [CertCA](#certca-property-xmlverifier-component) | Indicates whether the certificate has a CA capability. |
| [CertCAKeyID](#certcakeyid-property-xmlverifier-component) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| [CertType](#certtype-property-xmlverifier-component) | Returns the type of the entity contained in the Certificate object. |
| [CertCRLDistributionPoints](#certcrldistributionpoints-property-xmlverifier-component) | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| [CertCurve](#certcurve-property-xmlverifier-component) | Specifies the elliptic curve associated with the certificate's public key. |
| [CertFingerprint](#certfingerprint-property-xmlverifier-component) | Contains the fingerprint (a hash imprint) of this certificate. |
| [CertFriendlyName](#certfriendlyname-property-xmlverifier-component) | Contains an associated alias (friendly name) of the certificate. |
| [CertHandle](#certhandle-property-xmlverifier-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [CertHashAlgorithm](#certhashalgorithm-property-xmlverifier-component) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| [CertIssuer](#certissuer-property-xmlverifier-component) | The common name of the certificate issuer (CA), typically a company name. |
| [CertIssuerRDN](#certissuerrdn-property-xmlverifier-component) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [CertKeyAlgorithm](#certkeyalgorithm-property-xmlverifier-component) | Specifies the public key algorithm of this certificate. |
| [CertKeyBits](#certkeybits-property-xmlverifier-component) | Returns the length of the public key in bits. |
| [CertKeyFingerprint](#certkeyfingerprint-property-xmlverifier-component) | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| [CertKeyUsage](#certkeyusage-property-xmlverifier-component) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| [CertKeyValid](#certkeyvalid-property-xmlverifier-component) | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| [CertOCSPLocations](#certocsplocations-property-xmlverifier-component) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. |
| [CertOCSPNoCheck](#certocspnocheck-property-xmlverifier-component) | Accessor to the value of the certificate's ocsp-no-check extension. |
| [CertOrigin](#certorigin-property-xmlverifier-component) | Returns the location that the certificate was taken or loaded from. |
| [CertPolicyIDs](#certpolicyids-property-xmlverifier-component) | Contains identifiers (OIDs) of the applicable certificate policies. |
| [CertPrivateKeyBytes](#certprivatekeybytes-property-xmlverifier-component) | Returns the certificate's private key in DER-encoded format. |
| [CertPrivateKeyExists](#certprivatekeyexists-property-xmlverifier-component) | Indicates whether the certificate has a usable private key associated with it. |
| [CertPrivateKeyExtractable](#certprivatekeyextractable-property-xmlverifier-component) | Indicates whether the private key is extractable (exportable). |
| [CertPublicKeyBytes](#certpublickeybytes-property-xmlverifier-component) | Contains the certificate's public key in DER format. |
| [CertQualified](#certqualified-property-xmlverifier-component) | Indicates whether the certificate is qualified. |
| [CertQualifiedStatements](#certqualifiedstatements-property-xmlverifier-component) | Returns a simplified qualified status of the certificate. |
| [CertQualifiers](#certqualifiers-property-xmlverifier-component) | A list of qualifiers. |
| [CertSelfSigned](#certselfsigned-property-xmlverifier-component) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [CertSerialNumber](#certserialnumber-property-xmlverifier-component) | Returns the certificate's serial number. |
| [CertSigAlgorithm](#certsigalgorithm-property-xmlverifier-component) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [CertSource](#certsource-property-xmlverifier-component) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| [CertSubject](#certsubject-property-xmlverifier-component) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| [CertSubjectAlternativeName](#certsubjectalternativename-property-xmlverifier-component) | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| [CertSubjectKeyID](#certsubjectkeyid-property-xmlverifier-component) | Contains a unique identifier of the certificate's cryptographic key. |
| [CertSubjectRDN](#certsubjectrdn-property-xmlverifier-component) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [CertValid](#certvalid-property-xmlverifier-component) | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. |
| [CertValidFrom](#certvalidfrom-property-xmlverifier-component) | The time point at which the certificate becomes valid, in UTC. |
| [CertValidTo](#certvalidto-property-xmlverifier-component) | The time point at which the certificate expires, in UTC. |
| [DataBytes](#databytes-property-xmlverifier-component) | Use this property to pass the external data to component in the byte array form. |
| [DataFile](#datafile-property-xmlverifier-component) | A file containing the external data covered by a detached signature. |
| [DataType](#datatype-property-xmlverifier-component) | Specifies the external data type. |
| [DataURI](#datauri-property-xmlverifier-component) | Specifies a detached data resource URI. |
| [Encoding](#encoding-property-xmlverifier-component) | Specifies XML encoding. |
| [FIPSMode](#fipsmode-property-xmlverifier-component) | Reserved. |
| [InputBytes](#inputbytes-property-xmlverifier-component) | Use this property to pass the input to component in byte array form. |
| [InputFile](#inputfile-property-xmlverifier-component) | A signed XML file. |
| [KnownCertCount](#knowncertcount-property-xmlverifier-component) | The number of records in the KnownCert arrays. |
| [KnownCertBytes](#knowncertbytes-property-xmlverifier-component) | Returns the raw certificate data in DER format. |
| [KnownCertHandle](#knowncerthandle-property-xmlverifier-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [OutputBytes](#outputbytes-property-xmlverifier-component) | Use this property to read the output the component object has produced. |
| [OutputFile](#outputfile-property-xmlverifier-component) | The file where the modified signed document will be saved. |
| [ReferenceCount](#referencecount-property-xmlverifier-component) | The number of records in the Reference arrays. |
| [ReferenceCanonicalizationMethod](#referencecanonicalizationmethod-property-xmlverifier-component) | Use this property to specify the canonicalization method for the transform of the reference. |
| [ReferenceCustomElementId](#referencecustomelementid-property-xmlverifier-component) | Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. |
| [ReferenceDigestValue](#referencedigestvalue-property-xmlverifier-component) | Use this property to get or set the value of the digest calculated over the referenced data. |
| [ReferenceHandle](#referencehandle-property-xmlverifier-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [ReferenceHashAlgorithm](#referencehashalgorithm-property-xmlverifier-component) | Specifies the hash algorithm to be used. |
| [ReferenceHasURI](#referencehasuri-property-xmlverifier-component) | Specifies whether the URI is set (even when it is empty). |
| [ReferenceID](#referenceid-property-xmlverifier-component) | A user-defined identifier (ID) attribute of this Reference element. |
| [ReferenceInclusiveNamespacesPrefixList](#referenceinclusivenamespacesprefixlist-property-xmlverifier-component) | Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. |
| [ReferenceType](#referencetype-property-xmlverifier-component) | The Reference's type attribute as defined in XMLDSIG specification. |
| [ReferenceTargetData](#referencetargetdata-property-xmlverifier-component) | Contains the referenced external data when the digest value is not explicitly specified. |
| [ReferenceTargetType](#referencetargettype-property-xmlverifier-component) | The reference's target type to use. |
| [ReferenceTargetXMLElement](#referencetargetxmlelement-property-xmlverifier-component) | This property specifies the referenced XML element. |
| [ReferenceURI](#referenceuri-property-xmlverifier-component) | Use this property to get or set the URL which references the data. |
| [ReferenceUseBase64Transform](#referenceusebase64transform-property-xmlverifier-component) | Specifies whether Base64 transform is included in transform chain. |
| [ReferenceUseEnvelopedSignatureTransform](#referenceuseenvelopedsignaturetransform-property-xmlverifier-component) | Specifies whether enveloped signature transform is included in transform chain. |
| [ReferenceUseXPathFilter2Transform](#referenceusexpathfilter2transform-property-xmlverifier-component) | Specifies whether XPath Filter 2. |
| [ReferenceUseXPathTransform](#referenceusexpathtransform-property-xmlverifier-component) | Specifies whether XPath transform is included in transform chain. |
| [ReferenceValidationResult](#referencevalidationresult-property-xmlverifier-component) | The outcome of the cryptographic reference validation. |
| [ReferenceXPathExpression](#referencexpathexpression-property-xmlverifier-component) | Use this property to specify XPath expression for XPath transform of the reference. |
| [ReferenceXPathFilter2Expressions](#referencexpathfilter2expressions-property-xmlverifier-component) | Use this property to specify XPointer expression(s) for XPath Filter 2. |
| [ReferenceXPathFilter2Filters](#referencexpathfilter2filters-property-xmlverifier-component) | Use this property to specify XPointer filter(s) for XPath Filter 2. |
| [ReferenceXPathFilter2PrefixList](#referencexpathfilter2prefixlist-property-xmlverifier-component) | Use this property to specify a prefix list for XPath Filter 2. |
| [ReferenceXPathPrefixList](#referencexpathprefixlist-property-xmlverifier-component) | Use this property to specify a prefix list for XPath transform of the reference. |
| [SignatureCount](#signaturecount-property-xmlverifier-component) | The number of records in the Signature arrays. |
| [SignatureCanonicalizationMethod](#signaturecanonicalizationmethod-property-xmlverifier-component) | The XML canonicalization method that was used for signing. |
| [SignatureCompatibilityErrors](#signaturecompatibilityerrors-property-xmlverifier-component) | Returns compatibility errors encountered during validation. |
| [SignatureEntityLabel](#signatureentitylabel-property-xmlverifier-component) | Use this property to get the signature entity label. |
| [SignatureHandle](#signaturehandle-property-xmlverifier-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [SignatureHashAlgorithm](#signaturehashalgorithm-property-xmlverifier-component) | The hash algorithm used for signing. |
| [SignatureIssuerRDN](#signatureissuerrdn-property-xmlverifier-component) | The Relative Distinguished Name of the signing certificate's issuer. |
| [SignatureParentEntity](#signatureparententity-property-xmlverifier-component) | Use this property to get the parent signature label. |
| [SignatureSerialNumber](#signatureserialnumber-property-xmlverifier-component) | The serial number of the signing certificate. |
| [SignatureBytes](#signaturebytes-property-xmlverifier-component) | Returns the binary representation of the XML signature. |
| [SignatureType](#signaturetype-property-xmlverifier-component) | The signature type to employ when signing the document. |
| [SignatureValidationResult](#signaturevalidationresult-property-xmlverifier-component) | The outcome of the cryptographic signature validation. |
| [SignatureSubjectKeyID](#signaturesubjectkeyid-property-xmlverifier-component) | Contains the subject key identifier of the signing certificate. |
| [SignatureSubjectRDN](#signaturesubjectrdn-property-xmlverifier-component) | Contains information about the person owning the signing certificate. |
| [SignatureXMLElement](#signaturexmlelement-property-xmlverifier-component) | Specifies the XML element where to save the signature or containing the signature. |
## Method List
*The following is the full list of the methods of the component with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [AddKnownNamespace](#addknownnamespace-method-xmlverifier-component) | Adds known prefix and correspondent namespace URI. |
| [Close](#close-method-xmlverifier-component) | Closes an opened document. |
| [Config](#config-method-xmlverifier-component) | Sets or retrieves a configuration setting. |
| [DoAction](#doaction-method-xmlverifier-component) | Performs an additional action. |
| [GetInnerXML](#getinnerxml-method-xmlverifier-component) | Get the inner XML content of the selected XML element. |
| [GetOuterXML](#getouterxml-method-xmlverifier-component) | Get the outer XML content of the selected XML element. |
| [GetSignedData](#getsigneddata-method-xmlverifier-component) | Returns the part of the XML document that is covered by the signature. |
| [GetTextContent](#gettextcontent-method-xmlverifier-component) | Get the text content of the selected XML element. |
| [Open](#open-method-xmlverifier-component) | Opens a document for verifying or removing signatures. |
| [Reset](#reset-method-xmlverifier-component) | Resets the component settings. |
| [Revalidate](#revalidate-method-xmlverifier-component) | Revalidates a signature in accordance with current settings. |
| [SelectInfo](#selectinfo-method-xmlverifier-component) | Select signature information for a specific entity. |
| [SetInnerXML](#setinnerxml-method-xmlverifier-component) | Set the inner XML content of the selected XML element. |
| [SetTextContent](#settextcontent-method-xmlverifier-component) | Set the text content of the selected XML element. |
| [Unsign](#unsign-method-xmlverifier-component) | Deletes a signature from the document. |
| [Verify](#verify-method-xmlverifier-component) | Verifies a signed XML document. |
| [VerifyDetached](#verifydetached-method-xmlverifier-component) | Verifies a detached signature over external XML data. |
## 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.*
| | |
| --- | --- |
| [DocumentLoaded](#documentloaded-event-xmlverifier-component) | This event is fired when the document has been loaded into memory. |
| [Error](#error-event-xmlverifier-component) | Information about errors during signature verification. |
| [Notification](#notification-event-xmlverifier-component) | This event notifies the application about an underlying control flow event. |
| [ReferenceValidated](#referencevalidated-event-xmlverifier-component) | Marks the end of a reference validation. |
| [ResolveReference](#resolvereference-event-xmlverifier-component) | Asks the application to resolve a reference. |
| [SignatureFound](#signaturefound-event-xmlverifier-component) | Signifies the start of signature validation. |
| [SignatureValidated](#signaturevalidated-event-xmlverifier-component) | Marks the completion of the signature validation routine. |
## Config Settings
*The following is a list of config settings for the component with short descriptions. Click on the links for further details.*
| | |
| --- | --- |
| [AddAllDataObjectsTimestamp](#AddAllDataObjectsTimestamp) | Whether to add all data objects timestamp during signing. |
| [AsyncDocumentID](#AsyncDocumentID) | Specifies the document ID for SignAsyncEnd() call. |
| [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. |
| [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. |
| [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. |
| [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. |
| [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. |
| [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. |
| [ChainCurrentCACert](#ChainCurrentCACert) | Returns the current CA certificate. |
| [ChainCurrentCert](#ChainCurrentCert) | Returns the certificate that is currently being validated. |
| [ChainCurrentCRL](#ChainCurrentCRL) | Returns the current CRL. |
| [ChainCurrentCRLSize](#ChainCurrentCRLSize) | Returns the size of the current CRL. |
| [ChainCurrentOCSP](#ChainCurrentOCSP) | Returns the current OCSP response. |
| [ChainCurrentOCSPSigner](#ChainCurrentOCSPSigner) | Returns the signer of the current OCSP object. |
| [ChainInterimDetails](#ChainInterimDetails) | Returns the current interim validation details. |
| [ChainInterimResult](#ChainInterimResult) | Returns the current interim validation result. |
| [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. |
| [ClaimedRolesXML](#ClaimedRolesXML) | The XML content of the claimed roles. |
| [ClaimedRoleText](#ClaimedRoleText) | The text of the claimed role. |
| [CommitmentTypeIndicationAllSignedDataObjects\[Index\]](#CommitmentTypeIndicationAllSignedDataObjects[Index]) | Specifies the CommitmentTypeIndication's AllSignedDataObjects. |
| [CommitmentTypeIndicationCount](#CommitmentTypeIndicationCount) | The number of the CommitmentTypeIndication elements. |
| [CommitmentTypeIndicationIdentifier\[Index\]](#CommitmentTypeIndicationIdentifier[Index]) | Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier. |
| [CommitmentTypeIndicationIdentifierDescription\[Index\]](#CommitmentTypeIndicationIdentifierDescription[Index]) | Specifies the CommitmentTypeIndication's CommitmentTypeId's Description. |
| [CommitmentTypeIndicationIdentifierDocumentationReferences\[Index\]](#CommitmentTypeIndicationIdentifierDocumentationReferences[Index]) | Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences. |
| [CommitmentTypeIndicationIdentifierQualifier\[Index\]](#CommitmentTypeIndicationIdentifierQualifier[Index]) | Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier. |
| [CommitmentTypeIndicationObjectReference\[Index\]](#CommitmentTypeIndicationObjectReference[Index]) | Specifies the CommitmentTypeIndication's ObjectReference. |
| [CommitmentTypeIndicationQualifiersXML\[Index\]](#CommitmentTypeIndicationQualifiersXML[Index]) | The XML content of the CommitmentTypeIndication's Qualifiers. |
| [CustomTrustedLists](#CustomTrustedLists) | Specifies the custom TrustedLists. |
| [CustomTSLs](#CustomTSLs) | Specifies the custom TrustedLists. |
| [DataObjectFormatCount](#DataObjectFormatCount) | The number of the DataObjectFormat elements. |
| [DataObjectFormatDescription\[Index\]](#DataObjectFormatDescription[Index]) | Specifies the DataObjectFormat's Description. |
| [DataObjectFormatEncoding\[Index\]](#DataObjectFormatEncoding[Index]) | Specifies the DataObjectFormat's Encoding. |
| [DataObjectFormatMimeType\[Index\]](#DataObjectFormatMimeType[Index]) | Specifies the DataObjectFormat's MimeType. |
| [DataObjectFormatObjectIdentifier\[Index\]](#DataObjectFormatObjectIdentifier[Index]) | Specifies the DataObjectFormat's ObjectIdentifier's Identifier. |
| [DataObjectFormatObjectIdentifierDescription\[Index\]](#DataObjectFormatObjectIdentifierDescription[Index]) | Specifies the DataObjectFormat's ObjectIdentifier's Description. |
| [DataObjectFormatObjectIdentifierDocumentationReferences\[Index\]](#DataObjectFormatObjectIdentifierDocumentationReferences[Index]) | Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences. |
| [DataObjectFormatObjectIdentifierQualifier\[Index\]](#DataObjectFormatObjectIdentifierQualifier[Index]) | Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier. |
| [DataObjectFormatObjectReference\[Index\]](#DataObjectFormatObjectReference[Index]) | Specifies the DataObjectFormat's ObjectReference. |
| [DataType](#DataType) | Specifies the external data type. |
| [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. |
| [DetachedResourceURI](#DetachedResourceURI) | Specifies a detached resource URI. |
| [DislikeOpenEndedOCSPs](#DislikeOpenEndedOCSPs) | Tells the component to discourage OCSP responses without an explicit NextUpdate parameter. |
| [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. |
| [EvaluateSystemTrustForSelfSignedCertificates](#EvaluateSystemTrustForSelfSignedCertificates) | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. |
| [EvaluateSystemTrustForSSL](#EvaluateSystemTrustForSSL) | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. |
| [ExclusiveCanonicalizationPrefix](#ExclusiveCanonicalizationPrefix) | Specifies the exclusive canonicalization prefix. |
| [ForceCompleteChainValidation](#ForceCompleteChainValidation) | Whether to check the CA certificates when the signing certificate is invalid. |
| [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| [GracePeriod](#GracePeriod) | Specifies a grace period to apply during revocation information checks. |
| [HMACKey](#HMACKey) | The key value for HMAC. |
| [HMACOutputLength](#HMACOutputLength) | Sets the length of the HMAC output. |
| [HMACSigningUsed](#HMACSigningUsed) | Whether to use HMAC signing. |
| [IDAttributeName](#IDAttributeName) | Specifies the custom name of ID attribute. |
| [IDAttributeNamespaceURI](#IDAttributeNamespaceURI) | Specifies the custom namespace URI of ID attribute. |
| [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. |
| [IgnoreChainValidationErrors](#IgnoreChainValidationErrors) | Whether to ignore any certificate chain validation issues. |
| [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. |
| [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. |
| [IgnoreTimestampFailure](#IgnoreTimestampFailure) | Whether to ignore time-stamping failure during signing. |
| [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. |
| [IncludeKey](#IncludeKey) | Specifies whether to include the signing key to the signature. |
| [IncludeKeyValue](#IncludeKeyValue) | Specifies whether the key value must be included to the signature. |
| [IncludeKnownRevocationInfoToSignature](#IncludeKnownRevocationInfoToSignature) | Whether to include custom revocation info to the signature. |
| [InclusiveNamespacesPrefixList](#InclusiveNamespacesPrefixList) | Specifies the InclusiveNamespaces PrefixList. |
| [InsertBeforeXMLElement](#InsertBeforeXMLElement) | Defines the reference XML element for signature insertion. |
| [KeyInfoCustomXML](#KeyInfoCustomXML) | The custom XML content for KeyInfo element. |
| [KeyInfoDetails](#KeyInfoDetails) | Specifies the signing key info details to include to the signature. |
| [KeyInfoID](#KeyInfoID) | Specifies the ID for KeyInfo element. |
| [KeyName](#KeyName) | Contains information about the key used for signing. |
| [ManifestCount](#ManifestCount) | TBD. |
| [ManifestID\[i\]](#ManifestID[i]) | TBD. |
| [ManifestObjectIndex\[i\]](#ManifestObjectIndex[i]) | TBD. |
| [ManifestXML\[i\]](#ManifestXML[i]) | TBD. |
| [NormalizeNewLine](#NormalizeNewLine) | Controls whether newline combinations should be automatically normalized. |
| [ObjectCount](#ObjectCount) | TBD. |
| [ObjectEncoding\[i\]](#ObjectEncoding[i]) | TBD. |
| [ObjectID\[i\]](#ObjectID[i]) | TBD. |
| [ObjectMimeType\[i\]](#ObjectMimeType[i]) | TBD. |
| [ObjectSignaturePropertiesCount](#ObjectSignaturePropertiesCount) | TBD. |
| [ObjectSignaturePropertiesID\[i\]](#ObjectSignaturePropertiesID[i]) | TBD. |
| [ObjectSignaturePropertiesObjectIndex\[i\]](#ObjectSignaturePropertiesObjectIndex[i]) | TBD. |
| [ObjectSignaturePropertiesXML\[i\]](#ObjectSignaturePropertiesXML[i]) | TBD. |
| [ObjectSignaturePropertyCount](#ObjectSignaturePropertyCount) | TBD. |
| [ObjectSignaturePropertyID\[i\]](#ObjectSignaturePropertyID[i]) | TBD. |
| [ObjectSignaturePropertyPropertiesIndex\[i\]](#ObjectSignaturePropertyPropertiesIndex[i]) | TBD. |
| [ObjectSignaturePropertyTarget\[i\]](#ObjectSignaturePropertyTarget[i]) | TBD. |
| [ObjectSignaturePropertyXML\[i\]](#ObjectSignaturePropertyXML[i]) | TBD. |
| [ObjectXML\[i\]](#ObjectXML[i]) | TBD. |
| [PolicyDescription](#PolicyDescription) | signature policy description. |
| [PolicyExplicitText](#PolicyExplicitText) | The explicit text of the user notice. |
| [PolicyUNNumbers](#PolicyUNNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. |
| [PolicyUNOrganization](#PolicyUNOrganization) | The organization part of the NoticeReference qualifier. |
| [ProductionPlace](#ProductionPlace) | Identifies the place of the signature production. |
| [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. |
| [PSSUsed](#PSSUsed) | Whether to use RSASSA-PSS algorithm. |
| [QualifyingPropertiesID](#QualifyingPropertiesID) | Specifies the ID for QualifyingProperties element. |
| [QualifyingPropertiesObjectID](#QualifyingPropertiesObjectID) | Specifies the ID for object with QualifyingProperties element. |
| [QualifyingPropertiesReferenceCount](#QualifyingPropertiesReferenceCount) | The number of the QualifyingPropertiesReference elements. |
| [QualifyingPropertiesReferenceID\[Index\]](#QualifyingPropertiesReferenceID[Index]) | Specifies the QualifyingPropertiesReference's ID. |
| [QualifyingPropertiesReferenceURI\[Index\]](#QualifyingPropertiesReferenceURI[Index]) | Specifies the QualifyingPropertiesReference's URI. |
| [RefsTimestampType](#RefsTimestampType) | Specifies references timestamp type to include to the signature. |
| [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. |
| [SchemeParams](#SchemeParams) | The algorithm scheme parameters to employ. |
| [SignatureCompliance](#SignatureCompliance) | SIgnature compliance with XMLDSig/EBICS. |
| [SignatureID](#SignatureID) | Specifies the ID for Signature element. |
| [SignaturePrefix](#SignaturePrefix) | Specifies the signature prefix. |
| [SignatureValueID](#SignatureValueID) | Specifies the ID for SignatureValue element. |
| [SignedInfoID](#SignedInfoID) | Specifies the ID for SignedInfo element. |
| [SignedPropertiesID](#SignedPropertiesID) | Specifies the ID for SignedProperties element. |
| [SignedPropertiesReferenceCanonicalizationMethod](#SignedPropertiesReferenceCanonicalizationMethod) | Specifies the canonicalization method used in SignedProperties reference. |
| [SignedPropertiesReferenceHashAlgorithm](#SignedPropertiesReferenceHashAlgorithm) | Specifies the hash algorithm used in SignedProperties reference. |
| [SignedPropertiesReferenceID](#SignedPropertiesReferenceID) | Specifies the ID for Reference element that points to SignedProperties element. |
| [SignedPropertiesReferenceInclusiveNamespacesPrefixList](#SignedPropertiesReferenceInclusiveNamespacesPrefixList) | Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference. |
| [SignedPropertiesReferenceIndex](#SignedPropertiesReferenceIndex) | Specifies the index of SignedProperties reference. |
| [SignedSignaturePropertiesID](#SignedSignaturePropertiesID) | Specifies the ID for SignedSignatureProperties element. |
| [SigningCertificatesChain](#SigningCertificatesChain) | Specifies which certificates from SigningChain are included in the xades:SigningCertificate element. |
| [SigningCertificatesHashAlgorithm](#SigningCertificatesHashAlgorithm) | Specifies the hash algorithm used for SigningCertificates. |
| [SigningTimeFormat](#SigningTimeFormat) | Specifies the date time format for the XAdES signing time. |
| [SigningTimeIsUTC](#SigningTimeIsUTC) | Specifies whether the XAdES signing time is in UTC. |
| [SigningTimeZoneOffset](#SigningTimeZoneOffset) | Specifies the time zone offset for the XAdES signing time. |
| [SigPolicyDescription](#SigPolicyDescription) | signature policy description. |
| [SigPolicyExplicitText](#SigPolicyExplicitText) | The explicit text of the user notice. |
| [SigPolicyHash](#SigPolicyHash) | The EPES policy hash. |
| [SigPolicyHashAlgorithm](#SigPolicyHashAlgorithm) | The hash algorithm that was used to generate the EPES policy hash. |
| [SigPolicyID](#SigPolicyID) | The EPES policy ID. |
| [SigPolicyNoticeNumbers](#SigPolicyNoticeNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. |
| [SigPolicyNoticeOrganization](#SigPolicyNoticeOrganization) | The organization part of the NoticeReference qualifier. |
| [SigPolicyURI](#SigPolicyURI) | The EPES policy URI. |
| [StripWhitespace](#StripWhitespace) | Controls whether excessive whitespace characters should be stripped off when loading the document. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [TimestampCanonicalizationMethod](#TimestampCanonicalizationMethod) | Specifies canonicalization method used in timestamp. |
| [TimestampResponse](#TimestampResponse) | A base16-encoded timestamp response received from a TSA. |
| [TimestampValidationDataDetails](#TimestampValidationDataDetails) | Specifies timestamp validation data details to include to the signature. |
| [TLSChainValidationDetails](#TLSChainValidationDetails) | Contains the advanced details of the TLS server certificate validation. |
| [TLSChainValidationResult](#TLSChainValidationResult) | Contains the result of the TLS server certificate validation. |
| [TLSClientAuthRequested](#TLSClientAuthRequested) | Indicates whether the TLS server requests client authentication. |
| [TLSValidationLog](#TLSValidationLog) | Contains the log of the TLS server certificate validation. |
| [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. |
| [TspAttemptCount](#TspAttemptCount) | Specifies the number of timestamping request attempts. |
| [TspHashAlgorithm](#TspHashAlgorithm) | Sets a specific hash algorithm for use with the timestamping service. |
| [TspReqPolicy](#TspReqPolicy) | Sets a request policy ID to include in the timestamping request. |
| [UseDefaultTrustedLists](#UseDefaultTrustedLists) | Enables or disables the use of the default TrustedLists. |
| [UseDefaultTSLs](#UseDefaultTSLs) | Enables or disables the use of the default TrustedLists. |
| [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. |
| [UseHMACSigning](#UseHMACSigning) | Whether to use HMAC signing. |
| [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| [UsePSS](#UsePSS) | Whether to use RSASSA-PSS algorithm. |
| [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. |
| [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. |
| [UseValidatorSettingsForTLSValidation](#UseValidatorSettingsForTLSValidation) | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. |
| [ValidationDataRefsDetails](#ValidationDataRefsDetails) | Specifies validation data references details to include to the signature. |
| [ValidationDataRefsHashAlgorithm](#ValidationDataRefsHashAlgorithm) | Specifies the hash algorithm used in validation data references. |
| [ValidationDataValuesDetails](#ValidationDataValuesDetails) | Specifies validation data values details to include to the signature. |
| [WriteBOM](#WriteBOM) | Specifies whether byte-order mark should be written when saving the document. |
| [XAdESPrefix](#XAdESPrefix) | Specifies the XAdES prefix. |
| [XAdESv141Prefix](#XAdESv141Prefix) | Specifies the XAdES v1.4.1 prefix. |
| [XMLFormatting](#XMLFormatting) | Specifies the signature XML formatting. |
| [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. |
# AllSignaturesValid Property ([XMLVerifier](#xmlverifier-component) Component)
The cumulative validity of all signatures.
## Syntax
*C++ Builder Syntax*
```text
__property bool AllSignaturesValid = { read=FAllSignaturesValid };
```
## Default Value
false
## Remarks
Use this property to check if all the signatures found in the message or document are valid.
This property is read-only and not available at design time.
## Data Type
Boolean
# AutoValidateSignatures Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies whether component should validate any present signatures when the document is opened.
## Syntax
*C++ Builder Syntax*
```text
__property bool AutoValidateSignatures = { read=FAutoValidateSignatures, write=FSetAutoValidateSignatures };
```
## Default Value
true
## Remarks
This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the [Revalidate](#revalidate-method-xmlverifier-component) method.
## Data Type
Boolean
# CertCount Property ([XMLVerifier](#xmlverifier-component) Component)
The number of records in the Cert arrays.
## Syntax
*C++ Builder Syntax*
```text
__property int CertCount = { read=FCertCount };
```
## Default Value
0
## Remarks
This property controls the size of the following arrays:
- [CertBytes](#certbytes-property-xmlverifier-component)
- [CertCA](#certca-property-xmlverifier-component)
- [CertCAKeyID](#certcakeyid-property-xmlverifier-component)
- [CertCRLDistributionPoints](#certcrldistributionpoints-property-xmlverifier-component)
- [CertCurve](#certcurve-property-xmlverifier-component)
- [CertFingerprint](#certfingerprint-property-xmlverifier-component)
- [CertFriendlyName](#certfriendlyname-property-xmlverifier-component)
- [CertHandle](#certhandle-property-xmlverifier-component)
- [CertHashAlgorithm](#certhashalgorithm-property-xmlverifier-component)
- [CertIssuer](#certissuer-property-xmlverifier-component)
- [CertIssuerRDN](#certissuerrdn-property-xmlverifier-component)
- [CertKeyAlgorithm](#certkeyalgorithm-property-xmlverifier-component)
- [CertKeyBits](#certkeybits-property-xmlverifier-component)
- [CertKeyFingerprint](#certkeyfingerprint-property-xmlverifier-component)
- [CertKeyUsage](#certkeyusage-property-xmlverifier-component)
- [CertKeyValid](#certkeyvalid-property-xmlverifier-component)
- [CertOCSPLocations](#certocsplocations-property-xmlverifier-component)
- [CertOCSPNoCheck](#certocspnocheck-property-xmlverifier-component)
- [CertOrigin](#certorigin-property-xmlverifier-component)
- [CertPolicyIDs](#certpolicyids-property-xmlverifier-component)
- [CertPrivateKeyBytes](#certprivatekeybytes-property-xmlverifier-component)
- [CertPrivateKeyExists](#certprivatekeyexists-property-xmlverifier-component)
- [CertPrivateKeyExtractable](#certprivatekeyextractable-property-xmlverifier-component)
- [CertPublicKeyBytes](#certpublickeybytes-property-xmlverifier-component)
- [CertQualified](#certqualified-property-xmlverifier-component)
- [CertQualifiedStatements](#certqualifiedstatements-property-xmlverifier-component)
- [CertQualifiers](#certqualifiers-property-xmlverifier-component)
- [CertSelfSigned](#certselfsigned-property-xmlverifier-component)
- [CertSerialNumber](#certserialnumber-property-xmlverifier-component)
- [CertSigAlgorithm](#certsigalgorithm-property-xmlverifier-component)
- [CertSource](#certsource-property-xmlverifier-component)
- [CertSubject](#certsubject-property-xmlverifier-component)
- [CertSubjectAlternativeName](#certsubjectalternativename-property-xmlverifier-component)
- [CertSubjectKeyID](#certsubjectkeyid-property-xmlverifier-component)
- [CertSubjectRDN](#certsubjectrdn-property-xmlverifier-component)
- [CertType](#certtype-property-xmlverifier-component)
- [CertValid](#certvalid-property-xmlverifier-component)
- [CertValidFrom](#certvalidfrom-property-xmlverifier-component)
- [CertValidTo](#certvalidto-property-xmlverifier-component)
The array indices start at *0* and end at *CertCount - 1*.
This property is read-only and not available at design time.
## Data Type
Integer
# CertBytes Property ([XMLVerifier](#xmlverifier-component) Component)
Returns the raw certificate data in DER format.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray CertBytes[int CertIndex] = { read=FCertBytes };
```
## Remarks
Returns the raw certificate data in DER format.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# CertCA Property ([XMLVerifier](#xmlverifier-component) Component)
Indicates whether the certificate has a CA capability.
## Syntax
*C++ Builder Syntax*
```text
__property bool CertCA[int CertIndex] = { read=FCertCA };
```
## Default Value
false
## Remarks
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# CertCAKeyID Property ([XMLVerifier](#xmlverifier-component) Component)
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray CertCAKeyID[int CertIndex] = { read=FCertCAKeyID };
```
## 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 [CertSubjectKeyID](#certsubjectkeyid-property-xmlverifier-component) setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# CertType Property ([XMLVerifier](#xmlverifier-component) Component)
Returns the type of the entity contained in the Certificate object.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierCertTypes CertType[int CertIndex] = { read=FCertType };
enum TsbxXMLVerifierCertTypes {
ctUnknown=0,
ctX509Certificate=1,
ctX509CertificateRequest=2
};
```
## Default Value
ctUnknown
## Remarks
Returns the type of the entity contained in the [Certificate](#Type_Certificate) object.
A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the [CertificateManager](#CertificateManager) component to load or create new certificate and certificate requests objects.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# CertCRLDistributionPoints Property ([XMLVerifier](#xmlverifier-component) Component)
Contains a list of locations of CRL distribution points used to check this certificate's validity.
## Syntax
*C++ Builder Syntax*
```text
__property String CertCRLDistributionPoints[int CertIndex] = { read=FCertCRLDistributionPoints };
```
## Default Value
""
## Remarks
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertCurve Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies the elliptic curve associated with the certificate's public key.
## Syntax
*C++ Builder Syntax*
```text
__property String CertCurve[int CertIndex] = { read=FCertCurve };
```
## Default Value
""
## Remarks
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
| | | |
| --- | --- | --- |
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 | |
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertFingerprint Property ([XMLVerifier](#xmlverifier-component) Component)
Contains the fingerprint (a hash imprint) of this certificate.
## Syntax
*C++ Builder Syntax*
```text
__property String CertFingerprint[int CertIndex] = { read=FCertFingerprint };
```
## 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertFriendlyName Property ([XMLVerifier](#xmlverifier-component) Component)
Contains an associated alias (friendly name) of the certificate.
## Syntax
*C++ Builder Syntax*
```text
__property String CertFriendlyName[int CertIndex] = { read=FCertFriendlyName };
```
## Default Value
""
## Remarks
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertHandle Property ([XMLVerifier](#xmlverifier-component) Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
## Syntax
*C++ Builder Syntax*
```text
__property __int64 CertHandle[int CertIndex] = { read=FCertHandle };
```
## 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Long64
# CertHashAlgorithm Property ([XMLVerifier](#xmlverifier-component) Component)
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
## Syntax
*C++ Builder Syntax*
```text
__property String CertHashAlgorithm[int CertIndex] = { read=FCertHashAlgorithm };
```
## Default Value
""
## Remarks
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [CertSigAlgorithm](#certsigalgorithm-property-xmlverifier-component) to find out the hash algorithm that is part of the certificate signature.
| | | |
| --- | --- | --- |
| 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 | |
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertIssuer Property ([XMLVerifier](#xmlverifier-component) Component)
The common name of the certificate issuer (CA), typically a company name.
## Syntax
*C++ Builder Syntax*
```text
__property String CertIssuer[int CertIndex] = { read=FCertIssuer };
```
## 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 [CertIssuerRDN](#certissuerrdn-property-xmlverifier-component).
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertIssuerRDN Property ([XMLVerifier](#xmlverifier-component) Component)
A list of Property=Value pairs that uniquely identify the certificate issuer.
## Syntax
*C++ Builder Syntax*
```text
__property String CertIssuerRDN[int CertIndex] = { read=FCertIssuerRDN };
```
## 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertKeyAlgorithm Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies the public key algorithm of this certificate.
## Syntax
*C++ Builder Syntax*
```text
__property String CertKeyAlgorithm[int CertIndex] = { read=FCertKeyAlgorithm };
```
## 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 [CertKeyBits](#certkeybits-property-xmlverifier-component), [CertCurve](#certcurve-property-xmlverifier-component), and [CertPublicKeyBytes](#certpublickeybytes-property-xmlverifier-component) properties to get more details about the key the certificate contains.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertKeyBits Property ([XMLVerifier](#xmlverifier-component) Component)
Returns the length of the public key in bits.
## Syntax
*C++ Builder Syntax*
```text
__property int CertKeyBits[int CertIndex] = { read=FCertKeyBits };
```
## 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 [CertPublicKeyBytes](#certpublickeybytes-property-xmlverifier-component) or [CertPrivateKeyBytes](#certprivatekeybytes-property-xmlverifier-component) property would typically contain auxiliary values, and therefore be longer.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# CertKeyFingerprint Property ([XMLVerifier](#xmlverifier-component) Component)
Returns a SHA1 fingerprint of the public key contained in the certificate.
## Syntax
*C++ Builder Syntax*
```text
__property String CertKeyFingerprint[int CertIndex] = { read=FCertKeyFingerprint };
```
## 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 [CertFingerprint](#certfingerprint-property-xmlverifier-component) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertKeyUsage Property ([XMLVerifier](#xmlverifier-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 CertKeyUsage[int CertIndex] = { read=FCertKeyUsage };
```
## 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# CertKeyValid Property ([XMLVerifier](#xmlverifier-component) Component)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
## Syntax
*C++ Builder Syntax*
```text
__property bool CertKeyValid[int CertIndex] = { read=FCertKeyValid };
```
## Default Value
false
## Remarks
Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# CertOCSPLocations Property ([XMLVerifier](#xmlverifier-component) Component)
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
## Syntax
*C++ Builder Syntax*
```text
__property String CertOCSPLocations[int CertIndex] = { read=FCertOCSPLocations };
```
## Default Value
""
## Remarks
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this property before calling the certificate manager's [Generate](#CertificateManager_m_Generate) method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertOCSPNoCheck Property ([XMLVerifier](#xmlverifier-component) Component)
Accessor to the value of the certificate's ocsp-no-check extension.
## Syntax
*C++ Builder Syntax*
```text
__property bool CertOCSPNoCheck[int CertIndex] = { read=FCertOCSPNoCheck };
```
## Default Value
false
## Remarks
Accessor to the value of the certificate's ocsp-no-check extension.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# CertOrigin Property ([XMLVerifier](#xmlverifier-component) Component)
Returns the location that the certificate was taken or loaded from.
## Syntax
*C++ Builder Syntax*
```text
__property int CertOrigin[int CertIndex] = { read=FCertOrigin };
```
## Default Value
0
## Remarks
Returns the location that the certificate was taken or loaded from.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# CertPolicyIDs Property ([XMLVerifier](#xmlverifier-component) Component)
Contains identifiers (OIDs) of the applicable certificate policies.
## Syntax
*C++ Builder Syntax*
```text
__property String CertPolicyIDs[int CertIndex] = { read=FCertPolicyIDs };
```
## Default Value
""
## Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this property when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertPrivateKeyBytes Property ([XMLVerifier](#xmlverifier-component) Component)
Returns the certificate's private key in DER-encoded format.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray CertPrivateKeyBytes[int CertIndex] = { read=FCertPrivateKeyBytes };
```
## Remarks
Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# CertPrivateKeyExists Property ([XMLVerifier](#xmlverifier-component) Component)
Indicates whether the certificate has a usable private key associated with it.
## Syntax
*C++ Builder Syntax*
```text
__property bool CertPrivateKeyExists[int CertIndex] = { read=FCertPrivateKeyExists };
```
## Default Value
false
## Remarks
Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption.
This property is independent from [CertPrivateKeyBytes](#certprivatekeybytes-property-xmlverifier-component), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# CertPrivateKeyExtractable Property ([XMLVerifier](#xmlverifier-component) Component)
Indicates whether the private key is extractable (exportable).
## Syntax
*C++ Builder Syntax*
```text
__property bool CertPrivateKeyExtractable[int CertIndex] = { read=FCertPrivateKeyExtractable };
```
## Default Value
false
## Remarks
Indicates whether the private key is extractable (exportable).
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# CertPublicKeyBytes Property ([XMLVerifier](#xmlverifier-component) Component)
Contains the certificate's public key in DER format.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray CertPublicKeyBytes[int CertIndex] = { read=FCertPublicKeyBytes };
```
## 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# CertQualified Property ([XMLVerifier](#xmlverifier-component) Component)
Indicates whether the certificate is qualified.
## Syntax
*C++ Builder Syntax*
```text
__property bool CertQualified[int CertIndex] = { read=FCertQualified };
```
## Default Value
false
## Remarks
Indicates whether the certificate is qualified.
This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# CertQualifiedStatements Property ([XMLVerifier](#xmlverifier-component) Component)
Returns a simplified qualified status of the certificate.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierCertQualifiedStatements CertQualifiedStatements[int CertIndex] = { read=FCertQualifiedStatements };
enum TsbxXMLVerifierCertQualifiedStatements {
qstNonQualified=0,
qstQualifiedHardware=1,
qstQualifiedSoftware=2
};
```
## Default Value
qstNonQualified
## Remarks
Returns a simplified qualified status of the certificate.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# CertQualifiers Property ([XMLVerifier](#xmlverifier-component) Component)
A list of qualifiers.
## Syntax
*C++ Builder Syntax*
```text
__property String CertQualifiers[int CertIndex] = { read=FCertQualifiers };
```
## Default Value
""
## Remarks
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertSelfSigned Property ([XMLVerifier](#xmlverifier-component) Component)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
## Syntax
*C++ Builder Syntax*
```text
__property bool CertSelfSigned[int CertIndex] = { read=FCertSelfSigned };
```
## Default Value
false
## Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# CertSerialNumber Property ([XMLVerifier](#xmlverifier-component) Component)
Returns the certificate's serial number.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray CertSerialNumber[int CertIndex] = { read=FCertSerialNumber };
```
## 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# CertSigAlgorithm Property ([XMLVerifier](#xmlverifier-component) Component)
Indicates the algorithm that was used by the CA to sign this certificate.
## Syntax
*C++ Builder Syntax*
```text
__property String CertSigAlgorithm[int CertIndex] = { read=FCertSigAlgorithm };
```
## 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertSource Property ([XMLVerifier](#xmlverifier-component) Component)
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierCertSources CertSource[int CertIndex] = { read=FCertSource };
enum TsbxXMLVerifierCertSources {
pksUnknown=0,
pksSignature=1,
pksDocument=2,
pksUser=3,
pksLocal=4,
pksOnline=5
};
```
## Default Value
pksUnknown
## Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# CertSubject Property ([XMLVerifier](#xmlverifier-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 CertSubject[int CertIndex] = { read=FCertSubject };
```
## 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 [CertSubjectRDN](#certsubjectrdn-property-xmlverifier-component).
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertSubjectAlternativeName Property ([XMLVerifier](#xmlverifier-component) Component)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
## Syntax
*C++ Builder Syntax*
```text
__property String CertSubjectAlternativeName[int CertIndex] = { read=FCertSubjectAlternativeName };
```
## Default Value
""
## Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main [CertSubjectRDN](#certsubjectrdn-property-xmlverifier-component) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertSubjectKeyID Property ([XMLVerifier](#xmlverifier-component) Component)
Contains a unique identifier of the certificate's cryptographic key.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray CertSubjectKeyID[int CertIndex] = { read=FCertSubjectKeyID };
```
## 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 [CertSubjectKeyID](#certsubjectkeyid-property-xmlverifier-component) and [CertCAKeyID](#certcakeyid-property-xmlverifier-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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# CertSubjectRDN Property ([XMLVerifier](#xmlverifier-component) Component)
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
## Syntax
*C++ Builder Syntax*
```text
__property String CertSubjectRDN[int CertIndex] = { read=FCertSubjectRDN };
```
## 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertValid Property ([XMLVerifier](#xmlverifier-component) Component)
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
## Syntax
*C++ Builder Syntax*
```text
__property bool CertValid[int CertIndex] = { read=FCertValid };
```
## Default Value
false
## Remarks
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# CertValidFrom Property ([XMLVerifier](#xmlverifier-component) Component)
The time point at which the certificate becomes valid, in UTC.
## Syntax
*C++ Builder Syntax*
```text
__property String CertValidFrom[int CertIndex] = { read=FCertValidFrom };
```
## Default Value
""
## Remarks
The time point at which the certificate becomes valid, in UTC.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# CertValidTo Property ([XMLVerifier](#xmlverifier-component) Component)
The time point at which the certificate expires, in UTC.
## Syntax
*C++ Builder Syntax*
```text
__property String CertValidTo[int CertIndex] = { read=FCertValidTo };
```
## Default Value
""
## Remarks
The time point at which the certificate expires, in UTC.
The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# DataBytes Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to pass the external data to component in the byte array form.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray DataBytes = { read=FDataBytes, write=FSetDataBytes };
```
## Remarks
Assign a byte array containing the external data to be processed to this property.
This property is not available at design time.
## Data Type
Byte Array
# DataFile Property ([XMLVerifier](#xmlverifier-component) Component)
A file containing the external data covered by a detached signature.
## Syntax
*C++ Builder Syntax*
```text
__property String DataFile = { read=FDataFile, write=FSetDataFile };
```
## Default Value
""
## Remarks
In the case of a detached signature, use this property to provide the external data to the component from a file. Alternatively, provide the data via DataStream.
## Data Type
String
# DataType Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies the external data type.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierDataTypes DataType = { read=FDataType, write=FSetDataType };
enum TsbxXMLVerifierDataTypes {
cxdtXML=0,
cxdtBinary=1,
cxdtBase64=2
};
```
## Default Value
cxdtXML
## Remarks
Use this property to specify the type of the external data (either [DataFile](#datafile-property-xmlverifier-component), DataStream or [DataBytes](#databytes-property-xmlverifier-component) properties) for component.
## Data Type
Integer
# DataURI Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies a detached data resource URI.
## Syntax
*C++ Builder Syntax*
```text
__property String DataURI = { read=FDataURI, write=FSetDataURI };
```
## Default Value
""
## Remarks
Specifies a URI used for data being signed, usually the data filename if stored along with a detached signature.
## Data Type
String
# Encoding Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies XML encoding.
## Syntax
*C++ Builder Syntax*
```text
__property String Encoding = { read=FEncoding, write=FSetEncoding };
```
## Default Value
""
## Remarks
Use this property to specify the encoding to apply to the XML documents.
## Data Type
String
# FIPSMode Property ([XMLVerifier](#xmlverifier-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
# InputBytes Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to pass the input to component in byte array form.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray InputBytes = { read=FInputBytes, write=FSetInputBytes };
```
## Remarks
Assign a byte array containing the data to be processed to this property.
This property is not available at design time.
## Data Type
Byte Array
# InputFile Property ([XMLVerifier](#xmlverifier-component) Component)
A signed XML file.
## Syntax
*C++ Builder Syntax*
```text
__property String InputFile = { read=FInputFile, write=FSetInputFile };
```
## Default Value
""
## Remarks
Provide a path to the signed XML document in this property.
## Data Type
String
# KnownCertCount Property ([XMLVerifier](#xmlverifier-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-xmlverifier-component)
- [KnownCertHandle](#knowncerthandle-property-xmlverifier-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 ([XMLVerifier](#xmlverifier-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-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# KnownCertHandle Property ([XMLVerifier](#xmlverifier-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-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Long64
# OutputBytes Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to read the output the component object has produced.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray OutputBytes = { read=FOutputBytes };
```
## Remarks
Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the [OutputFile](#outputfile-property-xmlverifier-component) and OutputStream properties had not been assigned.
This property is read-only and not available at design time.
## Data Type
Byte Array
# OutputFile Property ([XMLVerifier](#xmlverifier-component) Component)
The file where the modified signed document will be saved.
## Syntax
*C++ Builder Syntax*
```text
__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };
```
## Default Value
""
## Remarks
Provide the full path to the file where the modified signed document should be saved.
## Data Type
String
# ReferenceCount Property ([XMLVerifier](#xmlverifier-component) Component)
The number of records in the Reference arrays.
## Syntax
*C++ Builder Syntax*
```text
__property int ReferenceCount = { read=FReferenceCount, write=FSetReferenceCount };
```
## Default Value
0
## Remarks
This property controls the size of the following arrays:
- [ReferenceCanonicalizationMethod](#referencecanonicalizationmethod-property-xmlverifier-component)
- [ReferenceCustomElementId](#referencecustomelementid-property-xmlverifier-component)
- [ReferenceDigestValue](#referencedigestvalue-property-xmlverifier-component)
- [ReferenceHandle](#referencehandle-property-xmlverifier-component)
- [ReferenceHashAlgorithm](#referencehashalgorithm-property-xmlverifier-component)
- [ReferenceHasURI](#referencehasuri-property-xmlverifier-component)
- [ReferenceID](#referenceid-property-xmlverifier-component)
- [ReferenceInclusiveNamespacesPrefixList](#referenceinclusivenamespacesprefixlist-property-xmlverifier-component)
- [ReferenceTargetData](#referencetargetdata-property-xmlverifier-component)
- [ReferenceTargetType](#referencetargettype-property-xmlverifier-component)
- [ReferenceTargetXMLElement](#referencetargetxmlelement-property-xmlverifier-component)
- [ReferenceType](#referencetype-property-xmlverifier-component)
- [ReferenceURI](#referenceuri-property-xmlverifier-component)
- [ReferenceUseBase64Transform](#referenceusebase64transform-property-xmlverifier-component)
- [ReferenceUseEnvelopedSignatureTransform](#referenceuseenvelopedsignaturetransform-property-xmlverifier-component)
- [ReferenceUseXPathFilter2Transform](#referenceusexpathfilter2transform-property-xmlverifier-component)
- [ReferenceUseXPathTransform](#referenceusexpathtransform-property-xmlverifier-component)
- [ReferenceValidationResult](#referencevalidationresult-property-xmlverifier-component)
- [ReferenceXPathExpression](#referencexpathexpression-property-xmlverifier-component)
- [ReferenceXPathFilter2Expressions](#referencexpathfilter2expressions-property-xmlverifier-component)
- [ReferenceXPathFilter2Filters](#referencexpathfilter2filters-property-xmlverifier-component)
- [ReferenceXPathFilter2PrefixList](#referencexpathfilter2prefixlist-property-xmlverifier-component)
- [ReferenceXPathPrefixList](#referencexpathprefixlist-property-xmlverifier-component)
The array indices start at *0* and end at *ReferenceCount - 1*.
This property is not available at design time.
## Data Type
Integer
# ReferenceCanonicalizationMethod Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to specify the canonicalization method for the transform of the reference.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierReferenceCanonicalizationMethods ReferenceCanonicalizationMethod[int ReferenceIndex] = { read=FReferenceCanonicalizationMethod, write=FSetReferenceCanonicalizationMethod };
enum TsbxXMLVerifierReferenceCanonicalizationMethods {
cxcmNone=0,
cxcmCanon=1,
cxcmCanonComment=2,
cxcmExclCanon=3,
cxcmExclCanonComment=4,
cxcmMinCanon=5,
cxcmCanon_v1_1=6,
cxcmCanonComment_v1_1=7
};
```
## Default Value
cxcmNone
## Remarks
Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.
| | | |
| --- | --- | --- |
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 | |
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Integer
# ReferenceCustomElementId Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceCustomElementId[int ReferenceIndex] = { read=FReferenceCustomElementId, write=FSetReferenceCustomElementId };
```
## Default Value
""
## Remarks
Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and *URI* property is empty.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceDigestValue Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to get or set the value of the digest calculated over the referenced data.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray ReferenceDigestValue[int ReferenceIndex] = { read=FReferenceDigestValue, write=FSetReferenceDigestValue };
```
## Remarks
Use this property to get or set the value of the digest calculated over the referenced data.
This property is optional and should be set only if you don't provide the actual data via *TargetData* or *URI*. If the data is set, then you don't need to set *DigestValue* since it will be calculated automatically.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Byte Array
# ReferenceHandle Property ([XMLVerifier](#xmlverifier-component) Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
## Syntax
*C++ Builder Syntax*
```text
__property __int64 ReferenceHandle[int ReferenceIndex] = { read=FReferenceHandle, write=FSetReferenceHandle };
```
## 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 *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Long64
# ReferenceHashAlgorithm Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies the hash algorithm to be used.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceHashAlgorithm[int ReferenceIndex] = { read=FReferenceHashAlgorithm, write=FSetReferenceHashAlgorithm };
```
## Default Value
"SHA256"
## Remarks
Specifies the hash algorithm to be used.
Supported values:
| | | |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| 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_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceHasURI Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies whether the URI is set (even when it is empty).
## Syntax
*C++ Builder Syntax*
```text
__property bool ReferenceHasURI[int ReferenceIndex] = { read=FReferenceHasURI, write=FSetReferenceHasURI };
```
## Default Value
true
## Remarks
Specifies whether the *URI* is set (even when it is empty).
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Boolean
# ReferenceID Property ([XMLVerifier](#xmlverifier-component) Component)
A user-defined identifier (ID) attribute of this Reference element.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceID[int ReferenceIndex] = { read=FReferenceID, write=FSetReferenceID };
```
## Default Value
""
## Remarks
A user-defined identifier (ID) attribute of this Reference element.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceInclusiveNamespacesPrefixList Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceInclusiveNamespacesPrefixList[int ReferenceIndex] = { read=FReferenceInclusiveNamespacesPrefixList, write=FSetReferenceInclusiveNamespacesPrefixList };
```
## Default Value
""
## Remarks
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceType Property ([XMLVerifier](#xmlverifier-component) Component)
The Reference's type attribute as defined in XMLDSIG specification.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceType[int ReferenceIndex] = { read=FReferenceType, write=FSetReferenceType };
```
## Default Value
""
## Remarks
The Reference's *type* attribute as defined in XMLDSIG specification.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceTargetData Property ([XMLVerifier](#xmlverifier-component) Component)
Contains the referenced external data when the digest value is not explicitly specified.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray ReferenceTargetData[int ReferenceIndex] = { read=FReferenceTargetData, write=FSetReferenceTargetData };
```
## Remarks
Contains the referenced external data when the digest value is not explicitly specified.
This property is optional and should only be set if you reference the external data via *URI*, and you don't provide the digest value explicitly via *DigestValue*.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Byte Array
# ReferenceTargetType Property ([XMLVerifier](#xmlverifier-component) Component)
The reference's target type to use.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierReferenceTargetTypes ReferenceTargetType[int ReferenceIndex] = { read=FReferenceTargetType, write=FSetReferenceTargetType };
enum TsbxXMLVerifierReferenceTargetTypes {
rttAuto=0,
rttXMLElement=1,
rttData=2,
rttURI=3
};
```
## Default Value
rttAuto
## Remarks
The reference's target type to use.
Use this property to specify the reference's target type to use when forming the signature.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Integer
# ReferenceTargetXMLElement Property ([XMLVerifier](#xmlverifier-component) Component)
This property specifies the referenced XML element.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceTargetXMLElement[int ReferenceIndex] = { read=FReferenceTargetXMLElement, write=FSetReferenceTargetXMLElement };
```
## Default Value
""
## Remarks
This property specifies the referenced XML element. Used when the *URI* property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the *URI* property is set, this property is ignored until the *ResolveReference* event.
Supported values are:
| | |
| --- | --- |
| "" | an empty string indicates the Document element. |
| "#id" | indicates an XML element with specified Id. |
| XPointer expression | indicates an XML element selected using XPointer expression. Use the AddKnownNamespace method to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via AddKnownNamespace method. |
| Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". |
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceURI Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to get or set the URL which references the data.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceURI[int ReferenceIndex] = { read=FReferenceURI, write=FSetReferenceURI };
```
## Default Value
""
## Remarks
Use this property to get or set the URL which references the data. If the data is external, the application must set either *TargetData* or *DigestValue*. If *TargetData* is set, the digest is calculated automatically unless it is explicitly set by the application via *DigestValue*.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceUseBase64Transform Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies whether Base64 transform is included in transform chain.
## Syntax
*C++ Builder Syntax*
```text
__property bool ReferenceUseBase64Transform[int ReferenceIndex] = { read=FReferenceUseBase64Transform, write=FSetReferenceUseBase64Transform };
```
## Default Value
false
## Remarks
Specifies whether Base64 transform is included in transform chain.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Boolean
# ReferenceUseEnvelopedSignatureTransform Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies whether enveloped signature transform is included in transform chain.
## Syntax
*C++ Builder Syntax*
```text
__property bool ReferenceUseEnvelopedSignatureTransform[int ReferenceIndex] = { read=FReferenceUseEnvelopedSignatureTransform, write=FSetReferenceUseEnvelopedSignatureTransform };
```
## Default Value
false
## Remarks
Specifies whether enveloped signature transform is included in transform chain.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Boolean
# ReferenceUseXPathFilter2Transform Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies whether XPath Filter 2.
## Syntax
*C++ Builder Syntax*
```text
__property bool ReferenceUseXPathFilter2Transform[int ReferenceIndex] = { read=FReferenceUseXPathFilter2Transform, write=FSetReferenceUseXPathFilter2Transform };
```
## Default Value
false
## Remarks
Specifies whether XPath Filter 2.0 transform is included in transform chain.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Boolean
# ReferenceUseXPathTransform Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies whether XPath transform is included in transform chain.
## Syntax
*C++ Builder Syntax*
```text
__property bool ReferenceUseXPathTransform[int ReferenceIndex] = { read=FReferenceUseXPathTransform, write=FSetReferenceUseXPathTransform };
```
## Default Value
false
## Remarks
Specifies whether XPath transform is included in transform chain.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
Boolean
# ReferenceValidationResult Property ([XMLVerifier](#xmlverifier-component) Component)
The outcome of the cryptographic reference validation.
## Syntax
*C++ Builder Syntax*
```text
__property bool ReferenceValidationResult[int ReferenceIndex] = { read=FReferenceValidationResult };
```
## Default Value
false
## Remarks
The outcome of the cryptographic reference validation.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Boolean
# ReferenceXPathExpression Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to specify XPath expression for XPath transform of the reference.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceXPathExpression[int ReferenceIndex] = { read=FReferenceXPathExpression, write=FSetReferenceXPathExpression };
```
## Default Value
""
## Remarks
Use this property to specify XPath expression for XPath transform of the reference.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceXPathFilter2Expressions Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to specify XPointer expression(s) for XPath Filter 2.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceXPathFilter2Expressions[int ReferenceIndex] = { read=FReferenceXPathFilter2Expressions, write=FSetReferenceXPathFilter2Expressions };
```
## Default Value
""
## Remarks
Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceXPathFilter2Filters Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to specify XPointer filter(s) for XPath Filter 2.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceXPathFilter2Filters[int ReferenceIndex] = { read=FReferenceXPathFilter2Filters, write=FSetReferenceXPathFilter2Filters };
```
## Default Value
""
## Remarks
Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.
Supported values:
| | |
| --- | --- |
| "intersect" | Intersect filter computes the intersection of the selected subtrees with the filter node-set. |
| "subtract" | Subtract filter computes the subtraction of the selected subtrees with the filter node-set. |
| "union" | Union filter computes the union of the selected subtrees with the filter node-set. |
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceXPathFilter2PrefixList Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to specify a prefix list for XPath Filter 2.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceXPathFilter2PrefixList[int ReferenceIndex] = { read=FReferenceXPathFilter2PrefixList, write=FSetReferenceXPathFilter2PrefixList };
```
## Default Value
""
## Remarks
Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from *XPathNamespaces* property.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# ReferenceXPathPrefixList Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to specify a prefix list for XPath transform of the reference.
## Syntax
*C++ Builder Syntax*
```text
__property String ReferenceXPathPrefixList[int ReferenceIndex] = { read=FReferenceXPathPrefixList, write=FSetReferenceXPathPrefixList };
```
## Default Value
""
## Remarks
Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from *XPathNamespaces* property.
The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlverifier-component) property.
This property is not available at design time.
## Data Type
String
# SignatureCount Property ([XMLVerifier](#xmlverifier-component) Component)
The number of records in the Signature arrays.
## Syntax
*C++ Builder Syntax*
```text
__property int SignatureCount = { read=FSignatureCount };
```
## Default Value
0
## Remarks
This property controls the size of the following arrays:
- [SignatureBytes](#signaturebytes-property-xmlverifier-component)
- [SignatureCanonicalizationMethod](#signaturecanonicalizationmethod-property-xmlverifier-component)
- [SignatureCompatibilityErrors](#signaturecompatibilityerrors-property-xmlverifier-component)
- [SignatureEntityLabel](#signatureentitylabel-property-xmlverifier-component)
- [SignatureHandle](#signaturehandle-property-xmlverifier-component)
- [SignatureHashAlgorithm](#signaturehashalgorithm-property-xmlverifier-component)
- [SignatureIssuerRDN](#signatureissuerrdn-property-xmlverifier-component)
- [SignatureParentEntity](#signatureparententity-property-xmlverifier-component)
- [SignatureSerialNumber](#signatureserialnumber-property-xmlverifier-component)
- [SignatureSubjectKeyID](#signaturesubjectkeyid-property-xmlverifier-component)
- [SignatureSubjectRDN](#signaturesubjectrdn-property-xmlverifier-component)
- [SignatureType](#signaturetype-property-xmlverifier-component)
- [SignatureValidationResult](#signaturevalidationresult-property-xmlverifier-component)
- [SignatureXMLElement](#signaturexmlelement-property-xmlverifier-component)
The array indices start at *0* and end at *SignatureCount - 1*.
This property is read-only and not available at design time.
## Data Type
Integer
# SignatureCanonicalizationMethod Property ([XMLVerifier](#xmlverifier-component) Component)
The XML canonicalization method that was used for signing.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierSignatureCanonicalizationMethods SignatureCanonicalizationMethod[int SignatureIndex] = { read=FSignatureCanonicalizationMethod };
enum TsbxXMLVerifierSignatureCanonicalizationMethods {
cxcmNone=0,
cxcmCanon=1,
cxcmCanonComment=2,
cxcmExclCanon=3,
cxcmExclCanonComment=4,
cxcmMinCanon=5,
cxcmCanon_v1_1=6,
cxcmCanonComment_v1_1=7
};
```
## Default Value
cxcmNone
## Remarks
The XML canonicalization method that was used for signing.
Supported canonicalization methods:
| | | |
| --- | --- | --- |
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 | |
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# SignatureCompatibilityErrors Property ([XMLVerifier](#xmlverifier-component) Component)
Returns compatibility errors encountered during validation.
## Syntax
*C++ Builder Syntax*
```text
__property int SignatureCompatibilityErrors[int SignatureIndex] = { read=FSignatureCompatibilityErrors };
```
## Default Value
0
## Remarks
Returns compatibility errors encountered during validation.
Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# SignatureEntityLabel Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to get the signature entity label.
## Syntax
*C++ Builder Syntax*
```text
__property String SignatureEntityLabel[int SignatureIndex] = { read=FSignatureEntityLabel };
```
## Default Value
""
## Remarks
Use this property to get the signature entity label.
This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# SignatureHandle Property ([XMLVerifier](#xmlverifier-component) Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
## Syntax
*C++ Builder Syntax*
```text
__property __int64 SignatureHandle[int SignatureIndex] = { read=FSignatureHandle };
```
## 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 *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Long64
# SignatureHashAlgorithm Property ([XMLVerifier](#xmlverifier-component) Component)
The hash algorithm used for signing.
## Syntax
*C++ Builder Syntax*
```text
__property String SignatureHashAlgorithm[int SignatureIndex] = { read=FSignatureHashAlgorithm };
```
## Default Value
"Unknown"
## Remarks
The hash algorithm used for signing.
| | | |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| 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_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# SignatureIssuerRDN Property ([XMLVerifier](#xmlverifier-component) Component)
The Relative Distinguished Name of the signing certificate's issuer.
## Syntax
*C++ Builder Syntax*
```text
__property String SignatureIssuerRDN[int SignatureIndex] = { read=FSignatureIssuerRDN };
```
## Default Value
""
## Remarks
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# SignatureParentEntity Property ([XMLVerifier](#xmlverifier-component) Component)
Use this property to get the parent signature label.
## Syntax
*C++ Builder Syntax*
```text
__property String SignatureParentEntity[int SignatureIndex] = { read=FSignatureParentEntity };
```
## Default Value
""
## Remarks
Use this property to get the parent signature label.
This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# SignatureSerialNumber Property ([XMLVerifier](#xmlverifier-component) Component)
The serial number of the signing certificate.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray SignatureSerialNumber[int SignatureIndex] = { read=FSignatureSerialNumber };
```
## Remarks
The serial number of the signing certificate.
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# SignatureBytes Property ([XMLVerifier](#xmlverifier-component) Component)
Returns the binary representation of the XML signature.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray SignatureBytes[int SignatureIndex] = { read=FSignatureBytes };
```
## Remarks
Returns the binary representation of the XML signature.
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# SignatureType Property ([XMLVerifier](#xmlverifier-component) Component)
The signature type to employ when signing the document.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierSignatureTypes SignatureType[int SignatureIndex] = { read=FSignatureType };
enum TsbxXMLVerifierSignatureTypes {
cxstDetached=1,
cxstEnveloping=2,
cxstEnveloped=4
};
```
## Default Value
cxstEnveloped
## Remarks
The signature type to employ when signing the document.
This property specifies the signature type to be used when signing the document.
Supported values:
| | | |
| --- | --- | --- |
| cxstDetached | 1 | Specifies whether a detached signature should be produced. I.e., a signature which is kept separately from the signed document. |
| cxstEnveloping | 2 | Specifies whether an enveloping signature should be produced. |
| cxstEnveloped | 4 | Specifies whether an enveloped signature should be produced. |
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# SignatureValidationResult Property ([XMLVerifier](#xmlverifier-component) Component)
The outcome of the cryptographic signature validation.
## Syntax
*C++ Builder Syntax*
```text
__property TsbxXMLVerifierSignatureValidationResults SignatureValidationResult[int SignatureIndex] = { read=FSignatureValidationResult };
enum TsbxXMLVerifierSignatureValidationResults {
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 *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Integer
# SignatureSubjectKeyID Property ([XMLVerifier](#xmlverifier-component) Component)
Contains the subject key identifier of the signing certificate.
## Syntax
*C++ Builder Syntax*
```text
__property DynamicArray SignatureSubjectKeyID[int SignatureIndex] = { read=FSignatureSubjectKeyID };
```
## Remarks
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
Byte Array
# SignatureSubjectRDN Property ([XMLVerifier](#xmlverifier-component) Component)
Contains information about the person owning the signing certificate.
## Syntax
*C++ Builder Syntax*
```text
__property String SignatureSubjectRDN[int SignatureIndex] = { read=FSignatureSubjectRDN };
```
## Default Value
""
## Remarks
Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# SignatureXMLElement Property ([XMLVerifier](#xmlverifier-component) Component)
Specifies the XML element where to save the signature or containing the signature.
## Syntax
*C++ Builder Syntax*
```text
__property String SignatureXMLElement[int SignatureIndex] = { read=FSignatureXMLElement };
```
## Default Value
""
## Remarks
Specifies the XML element where to save the signature or containing the signature.
This property specifies the XML element where to save the electronic signature or that contains the signature to be validated.
Supported values are:
| | |
| --- | --- |
| "" | an empty string indicates the Document element |
| "#id" | indicates an XML element with specified Id |
| XPath expression | indicates an XML element selected using XPath expression. Use AddKnownNamespace method to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via AddKnownNamespace method. |
| Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". |
The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-xmlverifier-component) property.
This property is read-only and not available at design time.
## Data Type
String
# AddKnownNamespace Method ([XMLVerifier](#xmlverifier-component) Component)
Adds known prefix and correspondent namespace URI.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall AddKnownNamespace(String Prefix, String URI);
```
## Remarks
Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.
# Close Method ([XMLVerifier](#xmlverifier-component) Component)
Closes an opened document.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall Close(bool SaveChanges);
```
## Remarks
Use this method to close a previously opened document. Set *SaveChanges* to true to apply any changes made.
# Config Method ([XMLVerifier](#xmlverifier-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-xmlverifier-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-xmlverifier-component), you must call *Config("PROPERTY")*. The value will be returned as a string.
# DoAction Method ([XMLVerifier](#xmlverifier-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. |
# GetInnerXML Method ([XMLVerifier](#xmlverifier-component) Component)
Get the inner XML content of the selected XML element.
## Syntax
*C++ Builder Syntax*
```text
String __fastcall GetInnerXML(String XPath);
```
## Remarks
Call this method to get the inner XML content of the selected XML element.
# GetOuterXML Method ([XMLVerifier](#xmlverifier-component) Component)
Get the outer XML content of the selected XML element.
## Syntax
*C++ Builder Syntax*
```text
String __fastcall GetOuterXML(String XPath);
```
## Remarks
Call this method to get the outer XML content of the selected XML element.
# GetSignedData Method ([XMLVerifier](#xmlverifier-component) Component)
Returns the part of the XML document that is covered by the signature.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall GetSignedData(String SigLabel, int RefIndex);
```
## Remarks
Use this method to retrieve the part of the XML document or data that is covered by the *SigLabel* signature and referenced by *RefIndex* reference.
The output can be collected in one of the following ways: either by passing the destination path or stream via [OutputFile](#outputfile-property-xmlverifier-component) and OutputStream respectively, or by reading the resulting data bytes from the [OutputBytes](#outputbytes-property-xmlverifier-component) property after the operation completes.
# GetTextContent Method ([XMLVerifier](#xmlverifier-component) Component)
Get the text content of the selected XML element.
## Syntax
*C++ Builder Syntax*
```text
String __fastcall GetTextContent(String XPath);
```
## Remarks
Call this method to get the text content of the selected XML element.
# Open Method ([XMLVerifier](#xmlverifier-component) Component)
Opens a document for verifying or removing signatures.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall Open();
```
## Remarks
Use this method to open a document for verifying or removing signatures. When finished, call [Close](#close-method-xmlverifier-component) to complete or discard the operation.
# Reset Method ([XMLVerifier](#xmlverifier-component) Component)
Resets the component settings.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall Reset();
```
## Remarks
Reset is a generic method available in every component.
# Revalidate Method ([XMLVerifier](#xmlverifier-component) Component)
Revalidates a signature in accordance with current settings.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall Revalidate(String SigLabel, bool Detached);
```
## Remarks
Use this method to re-validate a signature in the opened XML document.
# SelectInfo Method ([XMLVerifier](#xmlverifier-component) Component)
Select signature information for a specific entity.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall SelectInfo(String EntityLabel, int InfoType, bool ClearSelection);
```
## Remarks
Use this method to select (or filter) signature-related information for a specific signature element.
Provide the unique label of the entity that you are interested in via the *EntityLabel* parameter. Use one of the following filters, or their combination, to specify what information you are interested in:
| | | |
| --- | --- | --- |
| sitEntity | 1 | Select the current entity |
| sitParentEntity | 2 | Select the parent entity of the current entity |
| sitTimestamps | 4 | Select all timestamps covering the current entity |
| sitSignatures | 8 | Select all signatures covering the current entity |
| sitSigningChain | 16 | Select the signing chain of the current entity |
| sitEmbeddedCertificates | 256 | Select all certificates embedded in the current entity |
| sitEmbeddedCRLs | 512 | Select all CRLs embedded in the current entity |
| sitEmbeddedOCSPs | 1024 | Select all OCSP responses embedded in the current entity |
| sitEmbeddedRevInfo | 1792 | Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs) |
| sitUsedCertificates | 4096 | Select all the certificates used to validate this entity's chain |
| sitUsedCRLs | 8192 | Select all the CRLs used to validate this entity's chain |
| sitUsedOCSPs | 16384 | Select all the OCSP responses used to validate this entity's chain |
| sitUsedRevInfo | 28672 | Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses) |
| sitAttributes | 65536 | Select this entity's CMS attributes |
| sitReferences | 131072 | Select this entity's XML references |
| sitSignedParts | 262144 | Select this entity's signed parts |
Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping *ClearSelection* set to false.
This method is useful if you would like to read/display detailed information about a particular signature or timestamp.
# SetInnerXML Method ([XMLVerifier](#xmlverifier-component) Component)
Set the inner XML content of the selected XML element.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall SetInnerXML(String XPath, String Value);
```
## Remarks
Call this method to set the inner XML content of the selected XML element.
# SetTextContent Method ([XMLVerifier](#xmlverifier-component) Component)
Set the text content of the selected XML element.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall SetTextContent(String XPath, String Value);
```
## Remarks
Call this method to set the text content of the selected XML element.
# Unsign Method ([XMLVerifier](#xmlverifier-component) Component)
Deletes a signature from the document.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall Unsign(String SigLabel);
```
## Remarks
Use this method to delete an existing signature from the document. Use *SigLabel* parameter to specify the signature to be removed.
# Verify Method ([XMLVerifier](#xmlverifier-component) Component)
Verifies a signed XML document.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall Verify();
```
## Remarks
Call this method to verify the signature embedded in the document. Pass the document via InputStream or [InputFile](#inputfile-property-xmlverifier-component) property. Use [VerifyDetached](#verifydetached-method-xmlverifier-component) to verify the external data in case of a detached signature.
# VerifyDetached Method ([XMLVerifier](#xmlverifier-component) Component)
Verifies a detached signature over external XML data.
## Syntax
*C++ Builder Syntax*
```text
void __fastcall VerifyDetached();
```
## Remarks
Call this method to verify a signature over external (detached) data provided via DataStream or [DataFile](#datafile-property-xmlverifier-component).
# DocumentLoaded Event ([XMLVerifier](#xmlverifier-component) Component)
This event is fired when the document has been loaded into memory.
## Syntax
*C++ Builder Syntax*
```text
typedef struct {
bool Cancel;
} TsbxXMLVerifierDocumentLoadedEventParams;
typedef void __fastcall (__closure *TsbxXMLVerifierDocumentLoadedEvent)(System::TObject* Sender, TsbxXMLVerifierDocumentLoadedEventParams *e);
__property TsbxXMLVerifierDocumentLoadedEvent OnDocumentLoaded = { read=FOnDocumentLoaded, write=FOnDocumentLoaded };
```
## Remarks
The handler for this event is a good place to check document properties, which may be useful when preparing the signature, for example, the document format.
Set *Cancel* to true to terminate document processing on this stage.
# Error Event ([XMLVerifier](#xmlverifier-component) Component)
Information about errors during signature verification.
## Syntax
*C++ Builder Syntax*
```text
typedef struct {
int ErrorCode;
String Description;
} TsbxXMLVerifierErrorEventParams;
typedef void __fastcall (__closure *TsbxXMLVerifierErrorEvent)(System::TObject* Sender, TsbxXMLVerifierErrorEventParams *e);
__property TsbxXMLVerifierErrorEvent OnError = { read=FOnError, write=FOnError };
```
## Remarks
The event is fired in case of exceptional conditions during verification.
*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 [XML](#trappable-errors-xmlverifier-component).
# Notification Event ([XMLVerifier](#xmlverifier-component) Component)
This event notifies the application about an underlying control flow event.
## Syntax
*C++ Builder Syntax*
```text
typedef struct {
String EventID;
String EventParam;
} TsbxXMLVerifierNotificationEventParams;
typedef void __fastcall (__closure *TsbxXMLVerifierNotificationEvent)(System::TObject* Sender, TsbxXMLVerifierNotificationEventParams *e);
__property TsbxXMLVerifierNotificationEvent 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:
| | |
| --- | --- |
| DocumentLoaded | Notifies the application that the document has been loaded. This is a backward-compatibility-only notification. Use OnDocumentLoaded event instead. |
| SignaturesLoaded | Notifies the application that the component has finished loading signatures. |
| RetrieveQualifyingProperties | TBD |
| BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
| TimestampError | This event is only fired if the component failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |
| TimestampRequest | A timestamp is requested from the custom timestamping authority. This event is only fired if TimestampServer was set to a virtual:// URI. The EventParam parameter contains the TSP request (or the plain hash, depending on the value provided to TimestampServer), in base16, that needs to be sent to the TSA. Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property. |
# ReferenceValidated Event ([XMLVerifier](#xmlverifier-component) Component)
Marks the end of a reference validation.
## Syntax
*C++ Builder Syntax*
```text
typedef struct {
int ReferenceIndex;
String ID;
String URI;
String RefType;
bool DigestValid;
} TsbxXMLVerifierReferenceValidatedEventParams;
typedef void __fastcall (__closure *TsbxXMLVerifierReferenceValidatedEvent)(System::TObject* Sender, TsbxXMLVerifierReferenceValidatedEventParams *e);
__property TsbxXMLVerifierReferenceValidatedEvent OnReferenceValidated = { read=FOnReferenceValidated, write=FOnReferenceValidated };
```
## Remarks
The component fires this event to report completion of a reference validation. A reference is a building block of a signature as it binds signature coverage to a particular piece of the document.
# ResolveReference Event ([XMLVerifier](#xmlverifier-component) Component)
Asks the application to resolve a reference.
## Syntax
*C++ Builder Syntax*
```text
typedef struct {
int ReferenceIndex;
String URI;
} TsbxXMLVerifierResolveReferenceEventParams;
typedef void __fastcall (__closure *TsbxXMLVerifierResolveReferenceEvent)(System::TObject* Sender, TsbxXMLVerifierResolveReferenceEventParams *e);
__property TsbxXMLVerifierResolveReferenceEvent OnResolveReference = { read=FOnResolveReference, write=FOnResolveReference };
```
## Remarks
This event is fired when the control could not automatically resolve a reference and requires custom treatment.
*URI* contains a reference to the data.
*ReferenceIndex* specifies the index of the reference to process.
Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.
# SignatureFound Event ([XMLVerifier](#xmlverifier-component) Component)
Signifies the start of signature validation.
## Syntax
*C++ Builder Syntax*
```text
typedef struct {
int Index;
String EntityLabel;
String IssuerRDN;
DynamicArray SerialNumber;
DynamicArray SubjectKeyID;
bool CertFound;
bool ValidateSignature;
bool ValidateChain;
} TsbxXMLVerifierSignatureFoundEventParams;
typedef void __fastcall (__closure *TsbxXMLVerifierSignatureFoundEvent)(System::TObject* Sender, TsbxXMLVerifierSignatureFoundEventParams *e);
__property TsbxXMLVerifierSignatureFoundEvent 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 document or message.
The *CertFound* parameter 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 the KnownCertificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.
Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation.
# SignatureValidated Event ([XMLVerifier](#xmlverifier-component) Component)
Marks the completion of the signature validation routine.
## Syntax
*C++ Builder Syntax*
```text
typedef struct {
int Index;
String EntityLabel;
String IssuerRDN;
DynamicArray SerialNumber;
DynamicArray SubjectKeyID;
int ValidationResult;
bool Cancel;
} TsbxXMLVerifierSignatureValidatedEventParams;
typedef void __fastcall (__closure *TsbxXMLVerifierSignatureValidatedEvent)(System::TObject* Sender, TsbxXMLVerifierSignatureValidatedEventParams *e);
__property TsbxXMLVerifierSignatureValidatedEvent OnSignatureValidated = { read=FOnSignatureValidated, write=FOnSignatureValidated };
```
## Remarks
This event is fired upon the completion of the signature validation routine, and reports the respective validation result.
Use the *IssuerRDN*, *SerialNumber*, and/or *SubjectKeyID* parameters to identify the signing certificate.
*ValidationResult* is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.
| | | |
| --- | --- | --- |
| 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) |
# Config Settings ([XMLVerifier](#xmlverifier-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-xmlverifier-component) method.
### XMLVerifier Config Settings
**AddAllDataObjectsTimestamp**: Whether to add all data objects timestamp during signing.If this property is set to True, the all data objects timestamp (xades:AllDataObjectsTimeStamp element) will be added.
**AsyncDocumentID**: Specifies the document ID for SignAsyncEnd() call.Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
**CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.
The default value is 1 day (86400 seconds). A value of 0 disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.
**CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.
The default value is 50 percent. Values are interpreted in the 0..100 range. A value of 0 disables the CRL ratio check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.
**CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.
The default value is 10 minutes (600 seconds). A value of 0 disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.
This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.
**CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.
The default value is 1 hour (3600 seconds). A value of 0 disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.
**CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.
The default value is 50 percent. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. A value of 0 disables the OCSP response ratio check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.
**CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.
The default value is 10 minutes (600 seconds). A value of 0 disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.
This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.
**ChainCurrentCACert**: Returns the current CA certificate.This property returns the CA certificate that is used on the current step.
**ChainCurrentCert**: Returns the certificate that is currently being validated.Use this property to obtain the body of the certificate that is currently being validated.
**ChainCurrentCRL**: Returns the current CRL.Returns the CRL object that is currently being processed.
**ChainCurrentCRLSize**: Returns the size of the current CRL.This property returns the size of the CRL object that is currently being processed.
**ChainCurrentOCSP**: Returns the current OCSP response.Returns the OCSP object that is currently being processed.
**ChainCurrentOCSPSigner**: Returns the signer of the current OCSP object.Returns the signer/CA that has issued the OCSP response that is currently being processed.
**ChainInterimDetails**: Returns the current interim validation details.This property returns the interim chain validation details.
**ChainInterimResult**: Returns the current interim validation result.Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes.
**CheckValidityPeriodForTrusted**: Whether to check validity period for trusted certificates.Whether to check validity period for trusted certificates.
**ClaimedRolesXML**: The XML content of the claimed roles.Use this property to get/specify the XML content of the claimed roles element.
**ClaimedRoleText**: The text of the claimed role.Use this property to get/specify the text of the first claimed role.
**CommitmentTypeIndicationAllSignedDataObjects[Index]**: Specifies the CommitmentTypeIndication's AllSignedDataObjects.This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element.
**CommitmentTypeIndicationCount**: The number of the CommitmentTypeIndication elements.Returns the number of the xades:CommitmentTypeIndication elements available.
**CommitmentTypeIndicationIdentifier[Index]**: Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element.
**CommitmentTypeIndicationIdentifierDescription[Index]**: Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element.
**CommitmentTypeIndicationIdentifierDocumentationReferences[Index]**: Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element.
**CommitmentTypeIndicationIdentifierQualifier[Index]**: Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element.
**CommitmentTypeIndicationObjectReference[Index]**: Specifies the CommitmentTypeIndication's ObjectReference.This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element.
**CommitmentTypeIndicationQualifiersXML[Index]**: The XML content of the CommitmentTypeIndication's Qualifiers.This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element.
**CustomTrustedLists**: Specifies the custom TrustedLists.Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.
**CustomTSLs**: Specifies the custom TrustedLists.Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.
**DataObjectFormatCount**: The number of the DataObjectFormat elements.Returns the number of the xades:DataObjectFormat elements available.
**DataObjectFormatDescription[Index]**: Specifies the DataObjectFormat's Description.This property contains textual information related to the signed data object in the DataObjectFormat's Description element. Index value could be omitted for the first DataObjectFormat element.
**DataObjectFormatEncoding[Index]**: Specifies the DataObjectFormat's Encoding.This property contains an indication of the encoding format of the signed data object in the DataObjectFormat's Encoding element. Index value could be omitted for the first DataObjectFormat element.
**DataObjectFormatMimeType[Index]**: Specifies the DataObjectFormat's MimeType.This property contains an indication of the MIME type of the signed data object in the DataObjectFormat's MimeType element. Index value could be omitted for the first DataObjectFormat element.
**DataObjectFormatObjectIdentifier[Index]**: Specifies the DataObjectFormat's ObjectIdentifier's Identifier.This property contains an identifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Identifier element. Index value could be omitted for the first DataObjectFormat element.
**DataObjectFormatObjectIdentifierDescription[Index]**: Specifies the DataObjectFormat's ObjectIdentifier's Description.This property contains an identifier's description indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Description element. Index value could be omitted for the first DataObjectFormat element.
**DataObjectFormatObjectIdentifierDocumentationReferences[Index]**: Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences.This property contains an identifier's documentation references indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's DocumentationReferences element. Index value could be omitted for the first DataObjectFormat element.
**DataObjectFormatObjectIdentifierQualifier[Index]**: Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier.This property contains an identifier qualifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's IdentifierQualifier element. Index value could be omitted for the first DataObjectFormat element.
**DataObjectFormatObjectReference[Index]**: Specifies the DataObjectFormat's ObjectReference.This property contains the DataObjectFormat's ObjectReference element that reference the ds:Reference element of the ds:Signature corresponding with the data object qualified by this property.
For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value.
Index value could be omitted for the first DataObjectFormat element.
**DataType**: Specifies the external data type.Use this property to specify the type of the external data (either [DataFile](#datafile-property-xmlverifier-component), DataStream or [DataBytes](#databytes-property-xmlverifier-component) properties) for component.
The following data types are supported:
| | | |
| --- | --- | --- |
| "" or "XML" | | an XML document (by default). |
| "data" | | a binary data. |
**DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during revocation checks performed by the AdES component.
The default value is **dcrlpPreferComplete** (1).
Supported values:
- **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
- **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.
**DetachedResourceURI**: Specifies a detached resource URI.Specifies a URI of the provided data, usually the data filename if stored along with a detached signature.
**DislikeOpenEndedOCSPs**: Tells the component to discourage OCSP responses without an explicit NextUpdate parameter.When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the component is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022).
**EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is disabled by default, because enabling it may prevent the AdES components from collecting full revocation information required for long-term validation (LTV) signatures.
**EvaluateSystemTrustForSelfSignedCertificates**: Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) for self-signed certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default.
**EvaluateSystemTrustForSSL**: Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) specifically for SSL/TLS certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default.
**ExclusiveCanonicalizationPrefix**: Specifies the exclusive canonicalization prefix.Specifies the prefix for the ec:InclusiveNamespaces element for the exclusive canonicalization.
Default value is "ec". In this case "ec:" prefix will be used.
Special values:
| | |
| --- | --- |
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
**ForceCompleteChainValidation**: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid.
**ForceCompleteChainValidationForTrusted**: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.
**GracePeriod**: Specifies a grace period to apply during revocation information checks.Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.
**HMACKey**: The key value for HMAC.Use this property to set the HMAC key. The component uses base16 (hex) encoding for this configuration value.
**HMACOutputLength**: Sets the length of the HMAC output.Use this property to configure the length of the HMAC output, in bytes.
**HMACSigningUsed**: Whether to use HMAC signing.Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography. TBD
**IDAttributeName**: Specifies the custom name of ID attribute.This property contains the custom name of identifier (ID) attribute. Used to identify the target XML element when reference URI has "#id_name" value or when ID attribute should be auto-generated for a target XML element.
**IDAttributeNamespaceURI**: Specifies the custom namespace URI of ID attribute.This property contains the custom namespace URI of identifier (ID) attribute. Used to identify the target XML element when reference URI has "#id_name" value or when ID attribute should be auto-generated for a target XML element.
**IgnoreChainLoops**: Whether chain loops should be ignored.Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.
**IgnoreChainValidationErrors**: Whether to ignore any certificate chain validation issues.Enable this property to ignore any chain validation errors when creating a signature. This may be useful if the signature is created in an environment which uses different trust settings to the validation environment.
**IgnoreOCSPNoCheckExtension**: Whether the OCSP NoCheck extension should be ignored.Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.
**IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store.
If [IgnoreSystemTrust](#IgnoreSystemTrust) is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.
**IgnoreTimestampFailure**: Whether to ignore time-stamping failure during signing.If this property is set to True, any failure during time-stamping process will be ignored.
**ImplicitlyTrustSelfSignedCertificates**: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows emulating the verifying environment without actually changing its security settings.
**IncludeKey**: Specifies whether to include the signing key to the signature.Set this property to True to include the public part of the signing key to the signature.
**IncludeKeyValue**: Specifies whether the key value must be included to the signature.Set this property to True if the key value (its public part) should be included to the signature.
**IncludeKnownRevocationInfoToSignature**: Whether to include custom revocation info to the signature.This property specifies whether revocation pieces provided via KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.
**InclusiveNamespacesPrefixList**: Specifies the InclusiveNamespaces PrefixList.Use this property to read/specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details.
**InsertBeforeXMLElement**: Defines the reference XML element for signature insertion.Use this property to specify XML element before which the signature should be inserted, but it must be under the element specified by the [NewSigXMLElement](#XMLVerifier_p_NewSigXMLElement) property.
Supported values are:
| | |
| --- | --- |
| "" | an empty string indicates the Document element |
| "#id" | indicates an XML element with specified Id |
| XPath expression | indicates an XML element selected using XPath expression. Use [AddKnownNamespace](#addknownnamespace-method-xmlverifier-component) method to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via [AddKnownNamespace](#addknownnamespace-method-xmlverifier-component) method. |
| Node name | indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data". |
**KeyInfoCustomXML**: The custom XML content for KeyInfo element.Use this property to specify the custom XML content of the ds:KeyInfo element.
The empty elements in the custom XML content act as a placeholder for auto-generated elements.
For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: ""
**KeyInfoDetails**: Specifies the signing key info details to include to the signature.Contains a comma-separated list of values that specifies which signing key info details to include to the signature.
Supported values are:
| | | |
| --- | --- | --- |
| certificate | | Base64-encoded [X509v3] certificate is placed to the signature |
| issuerserial | | X.509 issuer distinguished name/serial number pair are placed to the signature |
| subjectname | | X.509 subject distinguished name is placed to the signature |
| ski | | Base64 encoded plain (i.e. non-DER-encoded) value of a X509 V.3 SubjectKeyIdentifier extension is placed to the signature |
| crl | | Base64-encoded certificate revocation list (CRL) is placed to the signature |
**KeyInfoID**: Specifies the ID for KeyInfo element.This property contains the identifier (ID) attribute of the ds:KeyInfo element.
**KeyName**: Contains information about the key used for signing.The KeyName element contains a string value (with significant whitespaces) which may be used by the signer to communicate a key identifier to the recipient. Typically, the KeyName element contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. Common uses of the KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc.
**ManifestCount**: TBD.TBD
**ManifestID[i]**: TBD.TBD
**ManifestObjectIndex[i]**: TBD.TBD
**ManifestXML[i]**: TBD.TBD
**NormalizeNewLine**: Controls whether newline combinations should be automatically normalized.If set to true (the default value), the component will normalize any non-compliant newline characters to match those appropriate for the operating system.
**ObjectCount**: TBD.TBD
**ObjectEncoding[i]**: TBD.TBD
**ObjectID[i]**: TBD.TBD
**ObjectMimeType[i]**: TBD.TBD
**ObjectSignaturePropertiesCount**: TBD.TBD
**ObjectSignaturePropertiesID[i]**: TBD.TBD
**ObjectSignaturePropertiesObjectIndex[i]**: TBD.TBD
**ObjectSignaturePropertiesXML[i]**: TBD.TBD
**ObjectSignaturePropertyCount**: TBD.TBD
**ObjectSignaturePropertyID[i]**: TBD.TBD
**ObjectSignaturePropertyPropertiesIndex[i]**: TBD.TBD
**ObjectSignaturePropertyTarget[i]**: TBD.TBD
**ObjectSignaturePropertyXML[i]**: TBD.TBD
**ObjectXML[i]**: TBD.TBD
**PolicyDescription**: signature policy description.This property specifies the Description of the signature policy.
**PolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified.
**PolicyUNNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.
**PolicyUNOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES.
**ProductionPlace**: Identifies the place of the signature production.The signature production place in JSON format that was included or to be included into the signature.
Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'
**PromoteLongOCSPResponses**: Whether long OCSP responses are requested. Set this property to True to force the component to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.
**PSSUsed**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. This is an alias for *UsePSS*.
**QualifyingPropertiesID**: Specifies the ID for QualifyingProperties element.This property contains the identifier (ID) attribute of the xades:QualifyingProperties element.
**QualifyingPropertiesObjectID**: Specifies the ID for object with QualifyingProperties element.This property contains the identifier (ID) attribute of the ds:Object element that contains xades:QualifyingProperties element.
**QualifyingPropertiesReferenceCount**: The number of the QualifyingPropertiesReference elements.Returns the number of the xades:QualifyingPropertiesReference elements available.
**QualifyingPropertiesReferenceID[Index]**: Specifies the QualifyingPropertiesReference's ID.This property contains an identifier (ID) attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.
**QualifyingPropertiesReferenceURI[Index]**: Specifies the QualifyingPropertiesReference's URI.This property contains an URI attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.
**RefsTimestampType**: Specifies references timestamp type to include to the signature.Contains a comma-separated list of values that specifies which references timestamp type to include to the signature when signature upgraded to XAdES-X or XAdES-E-X form.
Supported values are:
| | | |
| --- | --- | --- |
| SigAndRefs | | SigAndRefs timestamp |
| RefsOnly | | RefsOnly timestamp |
**RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Default.
Supported values are case-insensitive:
| | |
| --- | --- |
| Default | Applies the AdES default freshness settings: crl:86400;50;600,ocsp:3600;50;600. This means: CRL maximum age 1 day, CRL age ratio 50%, CRL overlap 10 minutes; OCSP response maximum age 1 hour, OCSP response age ratio 50%, OCSP response overlap 10 minutes. This value is the default. |
| Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. |
| Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. |
| Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. |
| N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. |
| crl:;;,ocsp:;; | Sets the CRL and OCSP response freshness values explicitly. |
Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.
**SchemeParams**: The algorithm scheme parameters to employ.Use this property to specify the parameters of the algorithm scheme if needed.
This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: *Scheme=PSS;SaltSize=32;TrailerField=1*.
**SignatureCompliance**: SIgnature compliance with XMLDSig/EBICS.Specifies whether the signature is compliant with W3C's XMLDSig, or with EBICS (Electronic Banking Internet Communication Standard).
Supported values are:
| | | |
| --- | --- | --- |
| "" | | The same as "XML-DSig". |
| XML-DSig | | The W3C's XMLDSig-compliant signature (by default). |
| EBICS | | Electronic Banking Internet Communication Standard (EBICS) compliant signature. On signing the version is autodetected based on the document element. |
| EBICS_H3 | | Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H3. |
| EBICS_H4 | | Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H4. |
| EBICS_H5 | | Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H5. |
**SignatureID**: Specifies the ID for Signature element.This property contains the identifier (ID) attribute of the ds:Signature element.
**SignaturePrefix**: Specifies the signature prefix.Specifies the prefix for the Signature elements.
Default value is "ds". In this case "ds:" prefix will be used.
Special values:
| | |
| --- | --- |
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
**SignatureValueID**: Specifies the ID for SignatureValue element.This property contains the identifier (ID) attribute of the ds:SignatureValue element.
**SignedInfoID**: Specifies the ID for SignedInfo element.This property contains the identifier (ID) attribute of the ds:SignedInfo element.
**SignedPropertiesID**: Specifies the ID for SignedProperties element.This property contains the identifier (ID) attribute of the xades:SignedProperties element.
**SignedPropertiesReferenceCanonicalizationMethod**: Specifies the canonicalization method used in SignedProperties reference.Use this property to specify the canonicalization method for the canonicalization transform of the ds:Reference element that points to xades:SignedProperties element. Use cxcmNone value to not to include canonicalization transform in transform chain.
| | | |
| --- | --- | --- |
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 | |
**SignedPropertiesReferenceHashAlgorithm**: Specifies the hash algorithm used in SignedProperties reference.Use this property to specify the hash algorithm to be used for the ds:Reference element that points to xades:SignedProperties element.
Supported values:
| | | |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| 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_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
**SignedPropertiesReferenceID**: Specifies the ID for Reference element that points to SignedProperties element.This property contains the identifier (ID) attribute of the ds:Reference element that points to xades:SignedProperties element.
**SignedPropertiesReferenceInclusiveNamespacesPrefixList**: Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference.Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the ds:Reference element that points to xades:SignedProperties element.
**SignedPropertiesReferenceIndex**: Specifies the index of SignedProperties reference.Use this property to specify the reference's index for the ds:Reference element that points to xades:SignedProperties element.
**SignedSignaturePropertiesID**: Specifies the ID for SignedSignatureProperties element.This property contains the identifier (ID) attribute of the xades:SignedSignatureProperties element.
**SigningCertificatesChain**: Specifies which certificates from SigningChain are included in the xades:SigningCertificate element.Use this property to get or set the list of indices (relative to the SigningChain property) of the certificates to include in the xades:SigningCertificate element. The value may also be the keywords *none* (include none) or *all* (include the entire chain). The default is *all*.
**SigningCertificatesHashAlgorithm**: Specifies the hash algorithm used for SigningCertificates.Use this property to specify the hash algorithm to be used for xades:SigningCertificates element.
Supported values:
| | | |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| 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_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
**SigningTimeFormat**: Specifies the date time format for the XAdES signing time.This property contains the date time format for the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).
Supported values:
| | | |
| --- | --- | --- |
| YYYY | | Year (e.g. 1997) |
| YYYY-MM | | Year and month (e.g. 1997-07) |
| YYYY-MM-DD | | Complete date (e.g. 1997-07-16) |
| YYYY-MM-DDThh:mmTZD | | Complete date plus hours and minutes (e.g. 1997-07-16T19:20+01:00) |
| YYYY-MM-DDThh:mm:ssTZD | | Complete date plus hours, minutes and seconds (e.g. 1997-07-16T20:20:30Z) |
| YYYY-MM-DDThh:mm:ss.sTZD | | Complete date plus hours, minutes, seconds and a decimal fraction of a second (e.g. 1997-07-16T20:20:30.4Z) |
| YYYY-MM-DDThh:mm:ss.sssTZD | | Default. Complete date plus hours, minutes, seconds and a fraction of a second (e.g. 1997-07-16T20:20:30.451Z) |
**SigningTimeIsUTC**: Specifies whether the XAdES signing time is in UTC.This property controls how the value provided by [NewSigClaimedSigningTime](#XMLVerifier_p_NewSigClaimedSigningTime) is interpreted and serialized into the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).
Behavior:
| | | |
| --- | --- | --- |
| "true" | | Default. The provided time is interpreted as UTC. If [SigningTimeZoneOffset](#SigningTimeZoneOffset) is non-zero, the time is converted to the corresponding local time (UTC plus the offset) and serialized with that offset; otherwise it is serialized as UTC. |
| "false" | | The provided time is interpreted as local time. No clock-time adjustment is performed. The value is serialized as local time; if [SigningTimeZoneOffset](#SigningTimeZoneOffset) is non-zero, the specified offset is included. |
**SigningTimeZoneOffset**: Specifies the time zone offset for the XAdES signing time.This property contains the time zone offset in minutes for the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).
**SigPolicyDescription**: signature policy description.This property specifies the Description of the signature policy (an alias for PolicyDescription).
**SigPolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText);
**SigPolicyHash**: The EPES policy hash.Use this configuration setting to provide the EPES policy hash.
**SigPolicyHashAlgorithm**: The hash algorithm that was used to generate the EPES policy hash.Use this setting to provide the hash algorithm that was used to generate the policy hash.
**SigPolicyID**: The EPES policy ID.The EPES signature policy identifier, in dotted OID format (1.2.3.4.5).
**SigPolicyNoticeNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers).
**SigPolicyNoticeOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization).
**SigPolicyURI**: The EPES policy URI.Assign the EPES policy URI to this setting.
**StripWhitespace**: Controls whether excessive whitespace characters should be stripped off when loading the document.Set this property to true to have the component eliminate excessive whitespace from the document on loading.
**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.
**TimestampCanonicalizationMethod**: Specifies canonicalization method used in timestamp.Use this property to specify the canonicalization method used in timestamp.
| | | |
| --- | --- | --- |
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 | |
**TimestampResponse**: A base16-encoded timestamp response received from a TSA.When using *virtual://* timestamp endpoints, assign this property in your [Notification](#notification-event-xmlverifier-component) event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16).
**TimestampValidationDataDetails**: Specifies timestamp validation data details to include to the signature.Contains a comma-separated list of values that specifies which validation data values details to include to the signature when xades:TimeStampValidationData element added.
Supported values are:
| | | |
| --- | --- | --- |
| certificate | | Base64-encoded [X509v3] certificates |
| crl | | Base64-encoded certificate revocation lists (CRL) |
| ocsp | | OCSP responses |
**TLSChainValidationDetails**: Contains the advanced details of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to access the TLS certificate validation details.
**TLSChainValidationResult**: Contains the result of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result.
**TLSClientAuthRequested**: Indicates whether the TLS server requests client authentication.Check this property in the TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via the TLSClientChain property. Note that the component may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.
**TLSValidationLog**: Contains the log of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to retrieve the validation log of the TLS server.
**TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
**TspAttemptCount**: Specifies the number of timestamping request attempts.Use this property to specify a number of timestamping request attempts.
In case of a timestamping failure, provide new TSA and HTTP settings inside the [Notification](#notification-event-xmlverifier-component) event handler ('BeforeTimestamp' and 'TimestampError' event IDs).
**TspHashAlgorithm**: Sets a specific hash algorithm for use with the timestamping service.In default configuration component uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp.
Note: Unlike other components, [PDFSigner](PDFSigner.md#PDFSigner) component uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.
**TspReqPolicy**: Sets a request policy ID to include in the timestamping request.Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5).
**UseDefaultTrustedLists**: Enables or disables the use of the default TrustedLists.Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
**UseDefaultTSLs**: Enables or disables the use of the default TrustedLists.Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
**UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.
**UseHMACSigning**: Whether to use HMAC signing.Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography.
**UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.
**UsePSS**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations.
**UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.
**UseValidationCache**: Enables or disable the use of the product-wide certificate chain validation cache.Use this property to enable or disable the use of the global chain validation cache. If enabled, the component will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the component, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start.
**UseValidatorSettingsForTLSValidation**: Whether to employ the primary chain validator setup for auxiliary TLS chain validations.Use this property to specify whether you would like to use the primary (AdES) chain validator component to validate TLS chains for any connections involved (OCSP, CRL).
**ValidationDataRefsDetails**: Specifies validation data references details to include to the signature.Contains a comma-separated list of values that specifies which validation data references details to include to the signature when signature upgraded to XAdES-C or XAdES-E-C form.
Supported values are:
| | | |
| --- | --- | --- |
| certificate | | References to X.509 certificates |
| crl | | References to certificate revocation lists (CRL) |
| ocsp | | References to OCSP responses |
**ValidationDataRefsHashAlgorithm**: Specifies the hash algorithm used in validation data references.Use this property to specify the hash algorithm used to compute hashes for validation data references.
Supported values:
| | | |
| --- | --- | --- |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| 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_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.
**ValidationDataValuesDetails**: Specifies validation data values details to include to the signature.Contains a comma-separated list of values that specifies which validation data values details to include to the signature when signature upgraded to XAdES-X-L or XAdES-E-X-L form.
Supported values are:
| | | |
| --- | --- | --- |
| certificate | | Base64-encoded [X509v3] certificates |
| crl | | Base64-encoded certificate revocation lists (CRL) |
| ocsp | | OCSP responses |
**WriteBOM**: Specifies whether byte-order mark should be written when saving the document.Set this property to False to disable writing byte-order mark (BOM) when saving the XML document in Unicode encoding.
**XAdESPrefix**: Specifies the XAdES prefix.Specifies the prefix for the XAdES elements.
Default value is "xades". In this case "xades:" prefix will be used.
Special values:
| | |
| --- | --- |
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
**XAdESv141Prefix**: Specifies the XAdES v1.4.1 prefix.Specifies the prefix for the XAdES v1.4.1 elements.
Default value is "xadesv141". In this case "xadesv141:" prefix will be used.
Special values:
| | |
| --- | --- |
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
**XMLFormatting**: Specifies the signature XML formatting.Use this property to specify how the signature should be formatted.
Supported values:
| | | |
| --- | --- | --- |
| "" or "none" | | no formatting (by default). |
| "auto" | | enables auto-formatting, equivalent to: "indent: 1; indent-char: tab; base64-max-length: 64; starting-level: node" |
Custom values, contains a list of value pairs ("name:value") separated by comma or semicolon:
| | | |
| --- | --- | --- |
| indent | | specifies indentation level (default is 1) |
| indent-char | | specifies indentation character: "space" or "tab" (default) |
| base64-max-length | | specifies max length of base64 encoded data, such as signature value, certificate data and etc. (default is 64) |
| starting-level | | specifies starting indentation level: non-negative integer or "node" - detected based on parent node, or "root" - detected based on number of parent nodes to a document element (default is "node"). |
| indent-before-main | | specifies if whitespace characters should be inserted before a main (ds:Signature) element: "auto" (default), "yes" or "no" |
For more precise formatting use OnFormatText and OnFormatElement events.
### 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 ([XMLVerifier](#xmlverifier-component) Component)
### XMLVerifier 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)) |
| 39845889 | The input file does not exist ([SB_ERROR_XML_INPUTFILE_NOT_EXISTS](constants.md#const_SBERRORXMLINPUTFILENOTEXISTS)) |
| 39845890 | Data file does not exist ([SB_ERROR_XML_DATAFILE_NOT_EXISTS](constants.md#const_SBERRORXMLDATAFILENOTEXISTS)) |
| 39845892 | Unsupported hash algorithm ([SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM](constants.md#const_SBERRORXMLUNSUPPORTEDHASHALGORITHM)) |
| 39845893 | Unsupported key type ([SB_ERROR_XML_UNSUPPORTED_KEY_TYPE](constants.md#const_SBERRORXMLUNSUPPORTEDKEYTYPE)) |
| 39845895 | Unsupported encryption algorithm ([SB_ERROR_XML_INVALID_ENCRYPTION_METHOD](constants.md#const_SBERRORXMLINVALIDENCRYPTIONMETHOD)) |
| 39845896 | XML element not found ([SB_ERROR_XML_NOT_FOUND](constants.md#const_SBERRORXMLNOTFOUND)) |
| 39845897 | XML element has no ID ([SB_ERROR_XML_NO_ELEMENT_ID](constants.md#const_SBERRORXMLNOELEMENTID)) |