# ASiCVerifier Component The ASiCVerifier component verifies associated signature containers. ## Syntax ```text nsoftware.SecureBlackbox.ASiCVerifier ``` ## Remarks ASiCVerifier provides the functionality of verifying signatures that are part of Associated Signature Containers. ASiC containers are ZIP-compatible files that bind together signed documents, and electronic signatures or timestamps made over them. ASiC containers are widely used across Europe and many other countries, due to their high interoperability and seamless integration into existing CAdES and XAdES environments. ASiCVerifier provides a simple and powerful mechanism to verify ASiC signatures in accordance with the respective [ETSI standards](https://ec.europa.eu/digital-building-blocks/sites/display/DIGITAL/Standards+and+specifications) (ETSI EN 319 162). It supports the following features of the standard (which cover the most of it): - ASiC-S (simple) and ASiC-E (extended) signature profiles. - CAdES- and XAdES-based signatures, as well as standalone RFC 3161 timestamps. - Matching the signature to all the current and older ETSI signature profiles (including B-B, B-T, B-LT, B-LTA). - Complete chain of trust validation process, using local, global, nation-specific (EUTL), or custom trust. - Removal of existing signatures. - Online and offline modes. The component is being actively maintained and updated, following ongoing developments in AdES world. For more than 10 years, our engineers have been active participants of ETSI Plugtests events, to make sure that our e-Signature infrastructure is compliant and highly interoperable. Just like our other signature components, ASiCVerifier supports several work modes that differ in complexity, allowing for both 'quick' and 'flexible' use. The simple mode assumes providing the [InputFile](#inputfile-property-asicverifier-component) and the [OutputFile](#outputfile-property-asicverifier-component), and calling the one-pass [Verify](#verify-method-asicverifier-component) method. This approach is straightforward and would let you get ASiC verification on board quickly. More complex tune-up may involve fine-grained adjustment of validation properties, such as providing your own validation material (certificates, OCSPs, CRLs) or fine-tuning conflict/error resolution options. You can also choose to work with the container step-by-step, by splitting the one-pass operation into a sequence of individual [Open](#open-method-asicverifier-component), Validate/[Revalidate](#revalidate-method-asicverifier-component), and [Close](#close-method-asicverifier-component) calls. ```text ASiCVerifier verifier = new ASiCVerifier(); verifier.setInputFile("./SignedFile.scs"); // the path of the signed file verifier.setExtractionMode(ASiCVerifier.aemAll); // set the extraction method verifier.setOutputPath("./MyFiles"); // the path where the extracted files will be saved verifier.verify(); ``` ## 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-asicverifier-component) | The cumulative validity of all signatures. | | [AutoValidateSignatures](#autovalidatesignatures-property-asicverifier-component) | Specifies whether ASiCVerifier should validate any present signatures when the document is opened. | | [BlockedCertificates](#blockedcertificates-property-asicverifier-component) | The certificates that must be rejected as trust anchors. | | [Certificates](#certificates-property-asicverifier-component) | A collection of certificates included in the electronic signature. | | [CheckTrustedLists](#checktrustedlists-property-asicverifier-component) | Specifies whether the component should attempt to validate chain trust via a known Trusted List. | | [CRLs](#crls-property-asicverifier-component) | A collection of certificate revocation lists embedded into the signature by the signer. | | [ExtractionMode](#extractionmode-property-asicverifier-component) | Specifies which entries should be extracted from the container upon verification. | | [Files](#files-property-asicverifier-component) | Lists all files contained in the container. | | [FIPSMode](#fipsmode-property-asicverifier-component) | Reserved. | | [IgnoreChainValidationErrors](#ignorechainvalidationerrors-property-asicverifier-component) | Makes the component tolerant to chain validation errors. | | [InputBytes](#inputbytes-property-asicverifier-component) | Use this property to pass the input to component in byte array form. | | [InputFile](#inputfile-property-asicverifier-component) | A path to the ASiC container to process. | | [InputStream](#inputstream-property-asicverifier-component) | A stream containing ASiC data. | | [KnownCertificates](#knowncertificates-property-asicverifier-component) | Additional certificates for chain validation. | | [KnownCRLs](#knowncrls-property-asicverifier-component) | Additional CRLs for chain validation. | | [KnownOCSPs](#knownocsps-property-asicverifier-component) | Additional OCSP responses for chain validation. | | [OCSPs](#ocsps-property-asicverifier-component) | A collection of OCSP responses embedded into the signature. | | [OfflineMode](#offlinemode-property-asicverifier-component) | Switches the component to offline mode. | | [OutputBytes](#outputbytes-property-asicverifier-component) | Use this property to read the output the component object has produced. | | [OutputFile](#outputfile-property-asicverifier-component) | The file where the processed data will be saved. | | [OutputPath](#outputpath-property-asicverifier-component) | A local path to extract the files to. | | [OutputStream](#outputstream-property-asicverifier-component) | The stream where the file is to be extracted. | | [Profile](#profile-property-asicverifier-component) | Specifies a pre-defined profile to apply when creating the signature. | | [Proxy](#proxy-property-asicverifier-component) | The proxy server settings. | | [RevocationCheck](#revocationcheck-property-asicverifier-component) | Specifies the kind(s) of revocation check to perform for all chain certificates. | | [Signatures](#signatures-property-asicverifier-component) | Contains the list of signatures included in the ASiC container. | | [SocketSettings](#socketsettings-property-asicverifier-component) | Manages network connection settings. | | [Timestamps](#timestamps-property-asicverifier-component) | Contains a collection of timestamps for the processed document. | | [TLSClientChain](#tlsclientchain-property-asicverifier-component) | The TLS client certificate chain. | | [TLSServerChain](#tlsserverchain-property-asicverifier-component) | The TLS server's certificate chain. | | [TLSSettings](#tlssettings-property-asicverifier-component) | Manages TLS layer settings. | | [TrustedCertificates](#trustedcertificates-property-asicverifier-component) | A list of trusted certificates for chain validation. | | [ValidationMoment](#validationmoment-property-asicverifier-component) | The time point at which signature validity is to be established. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Close](#close-method-asicverifier-component) | Closes an opened container. | | [Config](#config-method-asicverifier-component) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-asicverifier-component) | Performs an additional action. | | [ExtractFile](#extractfile-method-asicverifier-component) | Extracts a file to one of the output media (bytes, stream, or disk file). | | [ExtractFiles](#extractfiles-method-asicverifier-component) | Extracts files covered by a signature to [OutputPath](#outputpath-property-asicverifier-component) . | | [Open](#open-method-asicverifier-component) | Opens an existing container for signing or updating. | | [Reset](#reset-method-asicverifier-component) | Resets the component settings. | | [Revalidate](#revalidate-method-asicverifier-component) | Revalidates a signature in accordance with current settings. | | [SelectInfo](#selectinfo-method-asicverifier-component) | Select signature information for a specific entity. | | [Unsign](#unsign-method-asicverifier-component) | Deletes a signature from the container. | | [Verify](#verify-method-asicverifier-component) | Verifies all signatures in the ASiC container. | ## 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.* | | | | --- | --- | | [ChainElementDownload](#chainelementdownload-event-asicverifier-component) | Fires when there is a need to download a chain element from an online source. | | [ChainElementNeeded](#chainelementneeded-event-asicverifier-component) | Fires when an element required to validate the chain was not located. | | [ChainElementStore](#chainelementstore-event-asicverifier-component) | This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. | | [ChainValidated](#chainvalidated-event-asicverifier-component) | Reports the completion of a certificate chain validation. | | [ChainValidationProgress](#chainvalidationprogress-event-asicverifier-component) | This event is fired multiple times during chain validation to report various stages of the validation procedure. | | [ContainerLoaded](#containerloaded-event-asicverifier-component) | This event is fired when the container has been loaded into memory. | | [Error](#error-event-asicverifier-component) | Information about errors during ASiC signature verification. | | [FileExtractionStart](#fileextractionstart-event-asicverifier-component) | Signifies the start of a file extraction process. | | [Notification](#notification-event-asicverifier-component) | This event notifies the application about an underlying control flow event. | | [SignatureFound](#signaturefound-event-asicverifier-component) | Signifies the start of signature validation. | | [SignatureValidated](#signaturevalidated-event-asicverifier-component) | Marks the completion of the signature validation routine. | | [TimestampFound](#timestampfound-event-asicverifier-component) | Signifies the start of a timestamp validation routine. | | [TimestampValidated](#timestampvalidated-event-asicverifier-component) | Reports the completion of the timestamp validation routine. | | [TLSCertNeeded](#tlscertneeded-event-asicverifier-component) | Fires when a remote TLS party requests a client certificate. | | [TLSCertValidate](#tlscertvalidate-event-asicverifier-component) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. | | [TLSEstablished](#tlsestablished-event-asicverifier-component) | Fires when a TLS handshake with Host successfully completes. | | [TLSHandshake](#tlshandshake-event-asicverifier-component) | Fires when a new TLS handshake is initiated, before the handshake commences. | | [TLSShutdown](#tlsshutdown-event-asicverifier-component) | Reports the graceful closure of a TLS connection. | ## 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. | | [CmsOptAnnexKArchiveTimestampV2Mode](#CmsOptAnnexKArchiveTimestampV2Mode) | Toggles use of Annex K method of calculating validation timestamp hashes. | | [CmsOptCheckATSHashIndexElements](#CmsOptCheckATSHashIndexElements) | Enables extra checks when processing ATSHashIndex attribute. | | [CmsOptCompareRDNAsStrings](#CmsOptCompareRDNAsStrings) | Enforces comparison of RDN elements as text strings, rather than their byte encodings. | | [CmsOptDEREncodeContentForATSv2](#CmsOptDEREncodeContentForATSv2) | Enables DER encoding for ATSv2 hashed content. | | [CmsOptDigitPADSSCompatibility](#CmsOptDigitPADSSCompatibility) | Enables Digit PADSS compatibility mode. | | [CmsOptForceSigningCertificateV2Usage](#CmsOptForceSigningCertificateV2Usage) | Enforces use of signing-certificate-v2 attribute. | | [CmsOptIgnoreDERReqInArchiveTimestamps](#CmsOptIgnoreDERReqInArchiveTimestamps) | Switches off DER encoding requirement for archival timestamps. | | [CmsOptImzagerMIMCompatibility](#CmsOptImzagerMIMCompatibility) | Enables Imzager MIM compatibility mode. | | [CmsOptIncludeCertToAttributes](#CmsOptIncludeCertToAttributes) | Regulates whether to include the signing certificate to the signature as the signing-certificate attribute. | | [CmsOptIncludeCertToMessage](#CmsOptIncludeCertToMessage) | Regulates whether to include the signing certificate and its chain to the CMS. | | [CmsOptInsertContentType](#CmsOptInsertContentType) | Regulates whether the content-type time attribute should be included in the signature structure. | | [CmsOptInsertMessageDigests](#CmsOptInsertMessageDigests) | Regulates whether the message-digest signed attribute should be included in the signature structure. | | [CmsOptInsertSigningTime](#CmsOptInsertSigningTime) | Regulates whether the signing-time attribute should be included in the signature structure. | | [CmsOptSkipEnvContentInfoOnSigArchival](#CmsOptSkipEnvContentInfoOnSigArchival) | Excludes hashing of enveloped content when calculating an archival timestamp. | | [CmsOptUseATSHashIndexV1](#CmsOptUseATSHashIndexV1) | Enables use of ATSHashIndexV1 attribute. | | [CmsOptUseATSHashIndexV3](#CmsOptUseATSHashIndexV3) | Enables the use of the third version of archival timestamps. | | [CmsOptUseGeneralizedTimeFormat](#CmsOptUseGeneralizedTimeFormat) | Enables or disables encoding of the signing-time attribute using ASN.1 GENERALIZEDTIME type. | | [CmsOptUseGenericSigAlgorithmOIDs](#CmsOptUseGenericSigAlgorithmOIDs) | Enables use of generic signature algorithm OIDs in the signature. | | [CmsOptUsePlainContentForTimestampHashes](#CmsOptUsePlainContentForTimestampHashes) | Makes CAdESSigner ignore ASN.1 content formatting when calculating timestamp hashes. | | [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. | | [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. | | [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. | | [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. | | [IncludeKnownRevocationInfoToSignature](#IncludeKnownRevocationInfoToSignature) | Whether to include custom revocation info to the signature. | | [InclusiveNamespacesPrefixList](#InclusiveNamespacesPrefixList) | Specifies the InclusiveNamespaces PrefixList. | | [KeyInfoID](#KeyInfoID) | Specifies the ID for KeyInfo element. | | [KeyName](#KeyName) | Contains information about the key used for signing. | | [Overwrite](#Overwrite) | Forcefully overwrite OutputFile if it exists. | | [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. | | [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. | | [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. | | [UseUTF8Filenames](#UseUTF8Filenames) | Specifies whether to use UTF-8 filenames. | | [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. | | [XAdESPrefix](#XAdESPrefix) | Specifies the XAdES prefix. | | [XAdESv141Prefix](#XAdESv141Prefix) | Specifies the XAdES v1.4.1 prefix. | | [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 ([ASiCVerifier](#asicverifier-component) Component) The cumulative validity of all signatures. ## Syntax ```text public bool AllSignaturesValid { get; } ``` ## 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. # AutoValidateSignatures Property ([ASiCVerifier](#asicverifier-component) Component) Specifies whether ASiCVerifier should validate any present signatures when the document is opened. ## Syntax ```text public bool AutoValidateSignatures { get; set; } ``` ## 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-asicverifier-component) method. # BlockedCertificates Property ([ASiCVerifier](#asicverifier-component) Component) The certificates that must be rejected as trust anchors. ## Syntax ```text public CertificateList BlockedCertificates { get; } ``` ## Remarks Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # Certificates Property ([ASiCVerifier](#asicverifier-component) Component) A collection of certificates included in the electronic signature. ## Syntax ```text public CertificateList Certificates { get; } ``` ## Remarks This property includes a collection of certificates of the currently selected info. This collection is indexed from 0 to count -1. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # CheckTrustedLists Property ([ASiCVerifier](#asicverifier-component) Component) Specifies whether the component should attempt to validate chain trust via a known Trusted List. ## Syntax ```text public bool CheckTrustedLists { get; set; } ``` ## Default Value False ## Remarks Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL). # CRLs Property ([ASiCVerifier](#asicverifier-component) Component) A collection of certificate revocation lists embedded into the signature by the signer. ## Syntax ```text public CRLList CRLs { get; } ``` ## Remarks Use this property to access the CRLs embedded into the signature by the signer. This property is read-only and not available at design time. Please refer to the [CRL](#crl-type) type for a complete list of fields. # ExtractionMode Property ([ASiCVerifier](#asicverifier-component) Component) Specifies which entries should be extracted from the container upon verification. ## Syntax ```text public ASiCVerifierExtractionModes ExtractionMode { get; set; } enum ASiCVerifierExtractionModes { aemNone, aemAll, aemSigned, aemSignedAndValid } ``` ## Default Value 0 ## Remarks Use this property to choose entries that should be extracted in the [Verify](#verify-method-asicverifier-component) method. Choose between extracting all files, signed-only, signed and with verified signature, and none at all (verify-only mode). | | | | --- | --- | | aemNone | 0 | | aemAll | 1 | | aemSigned | 2 | | aemSignedAndValid | 3 | # Files Property ([ASiCVerifier](#asicverifier-component) Component) Lists all files contained in the container. ## Syntax ```text public ArchivedFileList Files { get; } ``` ## Remarks Use this collection property to walk through the list of files contained in the archive. This property is read-only and not available at design time. Please refer to the [ArchivedFile](#archivedfile-type) type for a complete list of fields. # FIPSMode Property ([ASiCVerifier](#asicverifier-component) Component) Reserved. ## Syntax ```text public bool FIPSMode { get; set; } ``` ## Default Value False ## Remarks This property is reserved for future use. # IgnoreChainValidationErrors Property ([ASiCVerifier](#asicverifier-component) Component) Makes the component tolerant to chain validation errors. ## Syntax ```text public bool IgnoreChainValidationErrors { get; set; } ``` ## Default Value False ## Remarks If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain. # InputBytes Property ([ASiCVerifier](#asicverifier-component) Component) Use this property to pass the input to component in byte array form. ## Syntax ```text public byte[] InputBytes { get; set; } ``` ## Remarks Assign a byte array containing the data to be processed to this property. This property is not available at design time. # InputFile Property ([ASiCVerifier](#asicverifier-component) Component) A path to the ASiC container to process. ## Syntax ```text public string InputFile { get; set; } ``` ## Default Value "" ## Remarks Use this property to provide a path to the signature container. Use [InputStream](#inputstream-property-asicverifier-component) to provide the container from memory rather than a disk file. # InputStream Property ([ASiCVerifier](#asicverifier-component) Component) A stream containing ASiC data. ## Syntax ```text public System.IO.Stream InputStream { get; set; } ``` ## Default Value null ## Remarks Use this property to feed ASiC data to the component from a stream object. This property is not available at design time. # KnownCertificates Property ([ASiCVerifier](#asicverifier-component) Component) Additional certificates for chain validation. ## Syntax ```text public CertificateList KnownCertificates { get; } ``` ## Remarks Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually. The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows. Do not add trust anchors or root certificates to this collection: add them to [TrustedCertificates](#trustedcertificates-property-asicverifier-component) instead. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # KnownCRLs Property ([ASiCVerifier](#asicverifier-component) Component) Additional CRLs for chain validation. ## Syntax ```text public CRLList KnownCRLs { get; } ``` ## Remarks Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document. This property is not available at design time. Please refer to the [CRL](#crl-type) type for a complete list of fields. # KnownOCSPs Property ([ASiCVerifier](#asicverifier-component) Component) Additional OCSP responses for chain validation. ## Syntax ```text public OCSPResponseList KnownOCSPs { get; } ``` ## Remarks Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document. This property is not available at design time. Please refer to the [OCSPResponse](#ocspresponse-type) type for a complete list of fields. # OCSPs Property ([ASiCVerifier](#asicverifier-component) Component) A collection of OCSP responses embedded into the signature. ## Syntax ```text public OCSPResponseList OCSPs { get; } ``` ## Remarks Use this property to access the OCSP responses embedded into the signature by its creator. This property is read-only and not available at design time. Please refer to the [OCSPResponse](#ocspresponse-type) type for a complete list of fields. # OfflineMode Property ([ASiCVerifier](#asicverifier-component) Component) Switches the component to offline mode. ## Syntax ```text public bool OfflineMode { get; set; } ``` ## Default Value False ## Remarks When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders. Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via [KnownCertificates](#knowncertificates-property-asicverifier-component), [KnownCRLs](#knowncrls-property-asicverifier-component), and other related properties. # OutputBytes Property ([ASiCVerifier](#asicverifier-component) Component) Use this property to read the output the component object has produced. ## Syntax ```text public byte[] OutputBytes { get; } ``` ## 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-asicverifier-component) and [OutputStream](#outputstream-property-asicverifier-component) properties had not been assigned. This property is read-only and not available at design time. # OutputFile Property ([ASiCVerifier](#asicverifier-component) Component) The file where the processed data will be saved. ## Syntax ```text public string OutputFile { get; set; } ``` ## Default Value "" ## Remarks Provides a path to the file where the component should save the updated container. # OutputPath Property ([ASiCVerifier](#asicverifier-component) Component) A local path to extract the files to. ## Syntax ```text public string OutputPath { get; set; } ``` ## Default Value "" ## Remarks Assign this property with a path where the extracted files (selected according to [ExtractionMode](#extractionmode-property-asicverifier-component) criteria) are to be saved. # OutputStream Property ([ASiCVerifier](#asicverifier-component) Component) The stream where the file is to be extracted. ## Syntax ```text public System.IO.Stream OutputStream { get; set; } ``` ## Default Value null ## Remarks Use this property to specify the stream to take the data extracted from the container. This property is not available at design time. # Profile Property ([ASiCVerifier](#asicverifier-component) Component) Specifies a pre-defined profile to apply when creating the signature. ## Syntax ```text public string Profile { get; set; } ``` ## Default Value "" ## Remarks Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile. # Proxy Property ([ASiCVerifier](#asicverifier-component) Component) The proxy server settings. ## Syntax ```text public ProxySettings Proxy { get; } ``` ## Remarks Use this property to tune up the proxy server settings. This property is read-only. Please refer to the [ProxySettings](#proxysettings-type) type for a complete list of fields. # RevocationCheck Property ([ASiCVerifier](#asicverifier-component) Component) Specifies the kind(s) of revocation check to perform for all chain certificates. ## Syntax ```text public ASiCVerifierRevocationChecks RevocationCheck { get; set; } enum ASiCVerifierRevocationChecks { crcNone, crcAuto, crcAllCRL, crcAllOCSP, crcAllCRLAndOCSP, crcAnyCRL, crcAnyOCSP, crcAnyCRLOrOCSP, crcAnyOCSPOrCRL } ``` ## Default Value 1 ## Remarks Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. # Signatures Property ([ASiCVerifier](#asicverifier-component) Component) Contains the list of signatures included in the ASiC container. ## Syntax ```text public ASiCSignatureList Signatures { get; } ``` ## Remarks Use this property to access all signatures in the container. This property is read-only and not available at design time. Please refer to the [ASiCSignature](#asicsignature-type) type for a complete list of fields. # SocketSettings Property ([ASiCVerifier](#asicverifier-component) Component) Manages network connection settings. ## Syntax ```text public SocketSettings SocketSettings { get; } ``` ## Remarks Use this property to tune up network connection parameters. This property is read-only. Please refer to the [SocketSettings](#socketsettings-type) type for a complete list of fields. # Timestamps Property ([ASiCVerifier](#asicverifier-component) Component) Contains a collection of timestamps for the processed document. ## Syntax ```text public TimestampInfoList Timestamps { get; } ``` ## Remarks Use this property to access the timestamps included in the processed document. This property is read-only and not available at design time. Please refer to the [TimestampInfo](#timestampinfo-type) type for a complete list of fields. # TLSClientChain Property ([ASiCVerifier](#asicverifier-component) Component) The TLS client certificate chain. ## Syntax ```text public CertificateList TLSClientChain { get; } ``` ## Remarks Assign a certificate chain to this property to enable TLS client authentication in the component. Note that the client's end-entity certificate should have a private key associated with it. Use the [CertificateStorage](CertificateStorage.md#CertificateStorage) or [CertificateManager](CertificateManager.md#CertificateManager) components to import the certificate from a file, system store, or PKCS11 device. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # TLSServerChain Property ([ASiCVerifier](#asicverifier-component) Component) The TLS server's certificate chain. ## Syntax ```text public CertificateList TLSServerChain { get; } ``` ## Remarks Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the [TLSCertValidate](#tlscertvalidate-event-asicverifier-component) event is fired by the client component. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # TLSSettings Property ([ASiCVerifier](#asicverifier-component) Component) Manages TLS layer settings. ## Syntax ```text public TLSSettings TLSSettings { get; } ``` ## Remarks Use this property to tune up the TLS layer parameters. This property is read-only. Please refer to the [TLSSettings](#tlssettings-type) type for a complete list of fields. # TrustedCertificates Property ([ASiCVerifier](#asicverifier-component) Component) A list of trusted certificates for chain validation. ## Syntax ```text public CertificateList TrustedCertificates { get; } ``` ## Remarks Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually. The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store. Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # ValidationMoment Property ([ASiCVerifier](#asicverifier-component) Component) The time point at which signature validity is to be established. ## Syntax ```text public string ValidationMoment { get; set; } ``` ## Default Value "" ## Remarks Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time). The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times. # Close Method ([ASiCVerifier](#asicverifier-component) Component) Closes an opened container. ## Syntax ```text public void Close(bool saveChanges); ``` ## Remarks Use this method to close a previously opened container. Set *SaveChanges* to true to apply any changes made. # Config Method ([ASiCVerifier](#asicverifier-component) Component) Sets or retrieves a configuration setting. ## Syntax ```text public string Config(string configurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-asicverifier-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-asicverifier-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([ASiCVerifier](#asicverifier-component) Component) Performs an additional action. ## Syntax ```text public string 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. | # ExtractFile Method ([ASiCVerifier](#asicverifier-component) Component) Extracts a file to one of the output media (bytes, stream, or disk file). ## Syntax ```text public void ExtractFile(string fileName); ``` ## Remarks Use this method to extract a single archived # ExtractFiles Method ([ASiCVerifier](#asicverifier-component) Component) Extracts files covered by a signature to [OutputPath](#outputpath-property-asicverifier-component) . ## Syntax ```text public void ExtractFiles(string sigLabel); ``` ## Remarks Use this method to extract all files covered by the signature *SigLabel* to [OutputPath](#outputpath-property-asicverifier-component). Set *SigLabel* to "" to extract all the files included in the container. # Open Method ([ASiCVerifier](#asicverifier-component) Component) Opens an existing container for signing or updating. ## Syntax ```text public void Open(); ``` ## Remarks Use this method to open a container for signing or updating. When finished, call [Close](#close-method-asicverifier-component) to complete or discard the operation. # Reset Method ([ASiCVerifier](#asicverifier-component) Component) Resets the component settings. ## Syntax ```text public void Reset(); ``` ## Remarks Reset is a generic method available in every component. # Revalidate Method ([ASiCVerifier](#asicverifier-component) Component) Revalidates a signature in accordance with current settings. ## Syntax ```text public void Revalidate(string sigLabel); ``` ## Remarks Use this method to re-validate a signature in the opened ASiC document. # SelectInfo Method ([ASiCVerifier](#asicverifier-component) Component) Select signature information for a specific entity. ## Syntax ```text public void 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. # Unsign Method ([ASiCVerifier](#asicverifier-component) Component) Deletes a signature from the container. ## Syntax ```text public void Unsign(string sigLabel); ``` ## Remarks Use this method to delete an existing signature from the container. Use *SigLabel* parameter to specify the signature to be removed. # Verify Method ([ASiCVerifier](#asicverifier-component) Component) Verifies all signatures in the ASiC container. ## Syntax ```text public void Verify(); ``` ## Remarks Use this method to verify the signature and any associated signed files residing in the ASiC container. When processing the container, the verifier walks through all the signatures contained in the message, one after another. For each signature, the [SignatureFound](#signaturefound-event-asicverifier-component) event is thrown. The benefits of this are that it: - Lets you know some basic details about the signature and its creator - Allows you to tell the component whether or not you want to validate it and/or its signing certificate's chain - Gives you a chance to provide any missing certificates (CertFound indicates whether you need to do that) The control then validates the signature and the chain (if told to do so in [SignatureFound](#signaturefound-event-asicverifier-component)), reporting the validity of each via [SignatureValidated](#signaturevalidated-event-asicverifier-component) and [ChainValidated](#chainvalidated-event-asicverifier-component) events, respectively. Before these events are fired, the properties of the signature are populated in the control's properties. Two properties that may be useful to read inside the event handlers are those reporting the signature's creation time, ClaimedSigningTime and ValidatedSigningTime. The control's properties remain assigned with the last processed signature's details, and are still available after the Verify() call returns, providing a handy way to work with single-signature containers. Once the main signature's processing completes, the control proceeds to its subordinate elements (countersignatures and/or timestamps). Each timestamp is reported via [TimestampValidated](#timestampvalidated-event-asicverifier-component) event. Having reported all the countersignatures and timestamps, the control proceeds to the next main signature and any timestamps associated with it - and so on. # ChainElementDownload Event ([ASiCVerifier](#asicverifier-component) Component) Fires when there is a need to download a chain element from an online source. ## Syntax ```text public event OnChainElementDownloadHandler OnChainElementDownload; public delegate void OnChainElementDownloadHandler(object sender, ASiCVerifierChainElementDownloadEventArgs e); public class ASiCVerifierChainElementDownloadEventArgs : EventArgs { public int Kind { get; } public string CertRDN { get; } public string CACertRDN { get; } public string Location { get; } public int Action { get; set; } } ``` ## Remarks Subscribe to this event to be notified about validation element retrievals. Use the *Action* parameter to suppress the download if required. | | | | | --- | --- | --- | | veaAuto | 0 | Handle the action automatically (the default behaviour) | | veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) | | veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) | | veaAcceptNow | 3 | Accept the validated certificate immediately | | veaAbortNow | 4 | Abort the validation, reject the certificate | | | | | | --- | --- | --- | | cekUnknown | 0 | Unknown or unsupported element type | | cekCertificate | 1 | An X.509 certificate | | cekCRL | 2 | A CRL | | cekOCSP | 3 | An OCSP response | # ChainElementNeeded Event ([ASiCVerifier](#asicverifier-component) Component) Fires when an element required to validate the chain was not located. ## Syntax ```text public event OnChainElementNeededHandler OnChainElementNeeded; public delegate void OnChainElementNeededHandler(object sender, ASiCVerifierChainElementNeededEventArgs e); public class ASiCVerifierChainElementNeededEventArgs : EventArgs { public int Kind { get; } public string CertRDN { get; } public string CACertRDN { get; } } ``` ## Remarks Subscribe to this event to be notified about missing validation elements. Use the [KnownCRLs](#knowncrls-property-asicverifier-component), [KnownCertificates](#knowncertificates-property-asicverifier-component), and [KnownOCSPs](#knownocsps-property-asicverifier-component) properties in the event handler to provide the missing piece. | | | | | --- | --- | --- | | cekUnknown | 0 | Unknown or unsupported element type | | cekCertificate | 1 | An X.509 certificate | | cekCRL | 2 | A CRL | | cekOCSP | 3 | An OCSP response | # ChainElementStore Event ([ASiCVerifier](#asicverifier-component) Component) This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. ## Syntax ```text public event OnChainElementStoreHandler OnChainElementStore; public delegate void OnChainElementStoreHandler(object sender, ASiCVerifierChainElementStoreEventArgs e); public class ASiCVerifierChainElementStoreEventArgs : EventArgs { public int Kind { get; } public byte[] Body { get; } public string URI { get; set; } } ``` ## Remarks This event could occur if you are verifying XAdES-C form or higher. The *Body* parameter contains the element in binary form that should be stored along with a signature. Use the *URI* parameter to provide an URI of the stored element. | | | | | --- | --- | --- | | cekUnknown | 0 | Unknown or unsupported element type | | cekCertificate | 1 | An X.509 certificate | | cekCRL | 2 | A CRL | | cekOCSP | 3 | An OCSP response | # ChainValidated Event ([ASiCVerifier](#asicverifier-component) Component) Reports the completion of a certificate chain validation. ## Syntax ```text public event OnChainValidatedHandler OnChainValidated; public delegate void OnChainValidatedHandler(object sender, ASiCVerifierChainValidatedEventArgs e); public class ASiCVerifierChainValidatedEventArgs : EventArgs { public int Index { get; } public string EntityLabel { get; } public string SubjectRDN { get; } public int ValidationResult { get; } public int ValidationDetails { get; } public bool Cancel { get; set; } } ``` ## Remarks This event is fired when a certificate chain validation routine completes. *SubjectRDN* identifies the owner of the validated certificate. *ValidationResult* set to 0 (zero) indicates successful chain validation. | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Any other value reports a failure, and *ValidationDetails* provides more details on its reasons. | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | # ChainValidationProgress Event ([ASiCVerifier](#asicverifier-component) Component) This event is fired multiple times during chain validation to report various stages of the validation procedure. ## Syntax ```text public event OnChainValidationProgressHandler OnChainValidationProgress; public delegate void OnChainValidationProgressHandler(object sender, ASiCVerifierChainValidationProgressEventArgs e); public class ASiCVerifierChainValidationProgressEventArgs : EventArgs { public string EventKind { get; } public string CertRDN { get; } public string CACertRDN { get; } public int Action { get; set; } } ``` ## Remarks Subscribe to this event to be notified about chain validation progress. Use the *Action* parameter to alter the validation flow. The *EventKind* parameter reports the nature of the event being reported. The *CertRDN* and *CACertRDN* parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on *EventKind*). Use the *Action* parameter to adjust the validation flow. | | | | | --- | --- | --- | | veaAuto | 0 | Handle the action automatically (the default behaviour) | | veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) | | veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) | | veaAcceptNow | 3 | Accept the validated certificate immediately | | veaAbortNow | 4 | Abort the validation, reject the certificate | # ContainerLoaded Event ([ASiCVerifier](#asicverifier-component) Component) This event is fired when the container has been loaded into memory. ## Syntax ```text public event OnContainerLoadedHandler OnContainerLoaded; public delegate void OnContainerLoadedHandler(object sender, ASiCVerifierContainerLoadedEventArgs e); public class ASiCVerifierContainerLoadedEventArgs : EventArgs { public bool Cancel { get; set; } } ``` ## Remarks The handler for this event is a good place to check for any existing signatures and validate them if required. Set *Cancel* to true to terminate document processing on this stage. # Error Event ([ASiCVerifier](#asicverifier-component) Component) Information about errors during ASiC signature verification. ## Syntax ```text public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, ASiCVerifierErrorEventArgs e); public class ASiCVerifierErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } } ``` ## Remarks The event is fired in case of exceptional conditions during ASiC signature verification. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # FileExtractionStart Event ([ASiCVerifier](#asicverifier-component) Component) Signifies the start of a file extraction process. ## Syntax ```text public event OnFileExtractionStartHandler OnFileExtractionStart; public delegate void OnFileExtractionStartHandler(object sender, ASiCVerifierFileExtractionStartEventArgs e); public class ASiCVerifierFileExtractionStartEventArgs : EventArgs { public string FileName { get; } public long FileSize { get; } public string ModDate { get; } public bool Extract { get; set; } public string DestFile { get; set; } } ``` ## Remarks This event fires for every file located in the archive and matching the [ExtractionMode](#extractionmode-property-asicverifier-component) setting before it is to be extracted. *DestFile* indicates the path where the file will be saved to. You can alter the destination path here, by providing an alternative extraction path. Set *DestFile* to an empty string and provide a stream object via the [OutputStream](#outputstream-property-asicverifier-component) property if you prefer to save the data to a stream instead of file. If *DestFile* is set to an empty string and [OutputStream](#outputstream-property-asicverifier-component) is unassigned, the file will not be extracted. Alternatively, you can request the extracted content to be saved into a byte array. To do this, leave *DestFile* and [OutputStream](#outputstream-property-asicverifier-component) empty, and keep the *Extract* parameter enabled. Please take care when extracting large files into byte arrays, as those may consume large amounts of memory. Note: if *DestFile* already exists, the component will overwrite it. To prevent overwriting of existing files, subscribe to this event, and change *DestFile* when needed. # Notification Event ([ASiCVerifier](#asicverifier-component) Component) This event notifies the application about an underlying control flow event. ## Syntax ```text public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, ASiCVerifierNotificationEventArgs e); public class ASiCVerifierNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } } ``` ## 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: | | | | --- | --- | | ContainerLoaded | Notifies the application that the ASiC container has been loaded. This is a backward-compatibility-only notification: use OnContainerLoaded event instead. | | 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. | # SignatureFound Event ([ASiCVerifier](#asicverifier-component) Component) Signifies the start of signature validation. ## Syntax ```text public event OnSignatureFoundHandler OnSignatureFound; public delegate void OnSignatureFoundHandler(object sender, ASiCVerifierSignatureFoundEventArgs e); public class ASiCVerifierSignatureFoundEventArgs : EventArgs { public int Index { get; } public string EntityLabel { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public bool CertFound { get; } public bool ValidateSignature { get; set; } public bool ValidateChain { get; set; } } ``` ## 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](#knowncertificates-property-asicverifier-component) property. Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the [SignatureValidationResult](#PDFSignature_f_SignatureValidationResult) and [ChainValidationResult](#PDFSignature_f_ChainValidationResult) properties respectively. Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation. # SignatureValidated Event ([ASiCVerifier](#asicverifier-component) Component) Marks the completion of the signature validation routine. ## Syntax ```text public event OnSignatureValidatedHandler OnSignatureValidated; public delegate void OnSignatureValidatedHandler(object sender, ASiCVerifierSignatureValidatedEventArgs e); public class ASiCVerifierSignatureValidatedEventArgs : EventArgs { public int Index { get; } public string EntityLabel { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public int ValidationResult { get; } public bool Cancel { get; set; } } ``` ## 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) | # TimestampFound Event ([ASiCVerifier](#asicverifier-component) Component) Signifies the start of a timestamp validation routine. ## Syntax ```text public event OnTimestampFoundHandler OnTimestampFound; public delegate void OnTimestampFoundHandler(object sender, ASiCVerifierTimestampFoundEventArgs e); public class ASiCVerifierTimestampFoundEventArgs : EventArgs { public int Index { get; } public string EntityLabel { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public bool CertFound { get; } public bool ValidateTimestamp { get; set; } public bool ValidateChain { get; set; } } ``` ## Remarks This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its *IssuerRDN*, *SerialNumber*, and *SubjectKeyID* parameters. 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](#knowncertificates-property-asicverifier-component) property. Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the [ValidationResult](#TimestampInfo_f_ValidationResult) and [ChainValidationResult](#TimestampInfo_f_ChainValidationResult) properties respectively. Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation. # TimestampValidated Event ([ASiCVerifier](#asicverifier-component) Component) Reports the completion of the timestamp validation routine. ## Syntax ```text public event OnTimestampValidatedHandler OnTimestampValidated; public delegate void OnTimestampValidatedHandler(object sender, ASiCVerifierTimestampValidatedEventArgs e); public class ASiCVerifierTimestampValidatedEventArgs : EventArgs { public int Index { get; } public string EntityLabel { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public string Time { get; } public int ValidationResult { get; } public int ChainValidationResult { get; } public int ChainValidationDetails { get; } public bool Cancel { get; set; } } ``` ## Remarks This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result. *ValidationResult* is set to 0 if the validation has been successful, or to a non-zero value in case of a 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) | # TLSCertNeeded Event ([ASiCVerifier](#asicverifier-component) Component) Fires when a remote TLS party requests a client certificate. ## Syntax ```text public event OnTLSCertNeededHandler OnTLSCertNeeded; public delegate void OnTLSCertNeededHandler(object sender, ASiCVerifierTLSCertNeededEventArgs e); public class ASiCVerifierTLSCertNeededEventArgs : EventArgs { public string Host { get; } public string CANames { get; } } ``` ## Remarks This event fires to notify the implementation that a remote TLS server has requested a client certificate. The *Host* parameter identifies the host that makes a request, and the *CANames* parameter (optional, according to the TLS spec) advises on the accepted issuing CAs. Use the [TLSClientChain](#tlsclientchain-property-asicverifier-component) property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire. This event is preceded by the [TLSHandshake](#tlshandshake-event-asicverifier-component) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-asicverifier-component) event. # TLSCertValidate Event ([ASiCVerifier](#asicverifier-component) Component) This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. ## Syntax ```text public event OnTLSCertValidateHandler OnTLSCertValidate; public delegate void OnTLSCertValidateHandler(object sender, ASiCVerifierTLSCertValidateEventArgs e); public class ASiCVerifierTLSCertValidateEventArgs : EventArgs { public string ServerHost { get; } public string ServerIP { get; } public bool Accept { get; set; } } ``` ## Remarks This event is fired during a TLS handshake. Use the [TLSServerChain](#tlsserverchain-property-asicverifier-component) property to access the certificate chain. In general, components may contact a number of TLS endpoints during their work, depending on their configuration. *Accept* is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed. # TLSEstablished Event ([ASiCVerifier](#asicverifier-component) Component) Fires when a TLS handshake with * Host * successfully completes. ## Syntax ```text public event OnTLSEstablishedHandler OnTLSEstablished; public delegate void OnTLSEstablishedHandler(object sender, ASiCVerifierTLSEstablishedEventArgs e); public class ASiCVerifierTLSEstablishedEventArgs : EventArgs { public string Host { get; } public string Version { get; } public string Ciphersuite { get; } public byte[] ConnectionId { get; } public bool Abort { get; set; } } ``` ## Remarks The component uses this event to notify the application about a successful completion of a TLS handshake. The *Version*, *Ciphersuite*, and *ConnectionId* parameters indicate the security parameters of the new connection. Use the *Abort* parameter if you need to terminate the connection at this stage. # TLSHandshake Event ([ASiCVerifier](#asicverifier-component) Component) Fires when a new TLS handshake is initiated, before the handshake commences. ## Syntax ```text public event OnTLSHandshakeHandler OnTLSHandshake; public delegate void OnTLSHandshakeHandler(object sender, ASiCVerifierTLSHandshakeEventArgs e); public class ASiCVerifierTLSHandshakeEventArgs : EventArgs { public string Host { get; } public bool Abort { get; set; } } ``` ## Remarks The component uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [TLSEstablished](#tlsestablished-event-asicverifier-component) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-asicverifier-component) event will also be fired. # TLSShutdown Event ([ASiCVerifier](#asicverifier-component) Component) Reports the graceful closure of a TLS connection. ## Syntax ```text public event OnTLSShutdownHandler OnTLSShutdown; public delegate void OnTLSShutdownHandler(object sender, ASiCVerifierTLSShutdownEventArgs e); public class ASiCVerifierTLSShutdownEventArgs : EventArgs { public string Host { get; } } ``` ## Remarks This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported. # ArchivedFile Type Provides information about the compressed file. ## Remarks Use this type to access compressed file details. The following fields are available: - [Action](#ArchivedFile_f_Action) - [Attributes](#ArchivedFile_f_Attributes) - [CompressedSize](#ArchivedFile_f_CompressedSize) - [DataSource](#ArchivedFile_f_DataSource) - [Directory](#ArchivedFile_f_Directory) - [EncryptionAlgorithm](#ArchivedFile_f_EncryptionAlgorithm) - [EncryptionKeyLength](#ArchivedFile_f_EncryptionKeyLength) - [EncryptionType](#ArchivedFile_f_EncryptionType) - [FileName](#ArchivedFile_f_FileName) - [Folder](#ArchivedFile_f_Folder) - [LocalPath](#ArchivedFile_f_LocalPath) - [MTime](#ArchivedFile_f_MTime) - [NewFile](#ArchivedFile_f_NewFile) - [Path](#ArchivedFile_f_Path) - [SignatureCount](#ArchivedFile_f_SignatureCount) - [Signed](#ArchivedFile_f_Signed) - [Size](#ArchivedFile_f_Size) ## Fields **Action** *Actions* Default: 0 This field contains the action to apply to the file. Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported: | | | | --- | --- | | atAdd (0) | Add the file to the archive. | | atKeep (1) | Keep the existing file in the archive. | | atUpdate (2) | Update the archived file with a fresher copy. | | atDelete (3) | Delete the file from the archive. | | atExtract (4) | Extract the file (extraction only). | | atSkip (5) | Skip file extraction (extraction only). | **Attributes** *string* Default: "" This field provides access to file attributes. ZIP archives support the provision of Windows (or DOS, as it is called historically) or Unix file attributes. Use this property to provide access to the attributes or to read them out of an existing archive. Use "dos:" or "unix:" prefixes to indicate what kind of attributes you need to include, as follows: ```text Writer.Files[0].Attributes = "unix:-rwxr-xr-x"; Writer.Files[1].Attributes = "unix:-r--r--r--"; Writer.Files[2].Attributes = "dos:readonly"; Writer.Files[3].Attributes = "dos:readonly;hidden"; // supported values: readonly, hidden, system, volumeLabel, directory, archive ``` **CompressedSize** *long (read-only)* Default: 0 This field contains the size of the file after compression. **DataSource** *FileDataSources* Default: 0 This field contains the type of data source for this entry. Use this property to control the data source for this entry. | | | | --- | --- | | fdsFile (0) | The data for this entry should be taken from the file provided by [LocalPath](#ArchivedFile_f_LocalPath). | | fdsStream (1) | Data are going to be provided on-the-fly through the FileStream property. | | fdsBuffer (2) | Data are going to be provided on-the-fly through the FileData property. | **Directory** *bool (read-only)* Default: False This field tells if the entry is a directory or a regular file. **EncryptionAlgorithm** *string (read-only)* Default: "" This field returns the symmetric algorithm that was used to encrypt the file. **EncryptionKeyLength** *int (read-only)* Default: 0 This field returns the length, in bits, of the encryption key. **EncryptionType** *EncryptionTypes (read-only)* Default: 0 This field contains the type of encryption applied to the file. Use this property to find out what kind of encryption was applied to the file. | | | | --- | --- | | aetDefault (0) | Default encryption (not used for already encrypted files) | | aetNoEncryption (1) | No encryption | | aetGeneric (2) | Standard ZIP encryption | | aetWinZip (3) | WinZIP-based encryption | | aetStrong (4) | Strong encryption | **FileName** *string* Default: "" This field specifies the original name of the compressed file or folder. **Folder** *string (read-only)* Default: "" This field includes the containing folder of the entry. **LocalPath** *string* Default: "" This field contains the local path associated with this entry. It typically specifies the source path that the data should be taken from, or the destination it should be extracted to. **MTime** *string* Default: "" This field contains the entry's last modification time. **NewFile** *bool (read-only)* Default: False This field indicates whether the entry corresponds to a file to be added to the archive. **Path** *string (read-only)* Default: "" This field contains the full internal path of the archived entry. **SignatureCount** *int (read-only)* Default: 0 This field includes the number of signatures covering the entry. **Signed** *bool (read-only)* Default: False This field indicates whether the entry is signed. **Size** *long (read-only)* Default: 0 This field specifies the size of the file before compression. ## Constructors ```text public ArchivedFile(); ``` Creates a new ArchivedFile object. # ASiCSignature Type Represents a signature in the ASiC container. ## Remarks This type contains information about a signature found in ASiC container. It holds various information about the signature, including its coverage and validation results. An ASiC-S container can include one CAdES, and/or one XAdES, and/or one Timestamp. An ASiC-E container can include multiple CAdES signatures, XAdES signatures, and timestamp tokens. The following fields are available: - [ChainValidationDetails](#ASiCSignature_f_ChainValidationDetails) - [ChainValidationResult](#ASiCSignature_f_ChainValidationResult) - [ClaimedSigningTime](#ASiCSignature_f_ClaimedSigningTime) - [CompatibilityErrors](#ASiCSignature_f_CompatibilityErrors) - [ContainsLongTermInfo](#ASiCSignature_f_ContainsLongTermInfo) - [ContentType](#ASiCSignature_f_ContentType) - [EntityLabel](#ASiCSignature_f_EntityLabel) - [FileName](#ASiCSignature_f_FileName) - [HashAlgorithm](#ASiCSignature_f_HashAlgorithm) - [IssuerRDN](#ASiCSignature_f_IssuerRDN) - [Level](#ASiCSignature_f_Level) - [PolicyHash](#ASiCSignature_f_PolicyHash) - [PolicyHashAlgorithm](#ASiCSignature_f_PolicyHashAlgorithm) - [PolicyID](#ASiCSignature_f_PolicyID) - [PolicyURI](#ASiCSignature_f_PolicyURI) - [SerialNumber](#ASiCSignature_f_SerialNumber) - [SignatureBytes](#ASiCSignature_f_SignatureBytes) - [SignatureType](#ASiCSignature_f_SignatureType) - [SignatureValidationResult](#ASiCSignature_f_SignatureValidationResult) - [SignedFiles](#ASiCSignature_f_SignedFiles) - [SubjectKeyID](#ASiCSignature_f_SubjectKeyID) - [SubjectRDN](#ASiCSignature_f_SubjectRDN) - [Timestamped](#ASiCSignature_f_Timestamped) - [ValidatedSigningTime](#ASiCSignature_f_ValidatedSigningTime) - [ValidationLog](#ASiCSignature_f_ValidationLog) ## Fields **ChainValidationDetails** *int (read-only)* Default: 0 The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | **ChainValidationResult** *ChainValidities (read-only)* Default: 0 The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. **ClaimedSigningTime** *string* Default: "" Returns or sets signature's creation time. Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike [ValidatedSigningTime](#ASiCSignature_f_ValidatedSigningTime) does not originate from a trusted TSA and may be forfeited or wrong. The time is provided in UTC. **CompatibilityErrors** *int (read-only)* Default: 0 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. **ContainsLongTermInfo** *bool (read-only)* Default: False Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). **ContentType** *string* Default: "" The signature content type. Use this property to get or set the content type OID to be included with the signature. **EntityLabel** *string (read-only)* Default: "" 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. **FileName** *string* Default: "" The name of the ASiC signature file. **HashAlgorithm** *string* Default: "" Set or returns the hash algorithm used to generate the signature. Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use. | | | | | --- | --- | --- | | 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 | | **IssuerRDN** *string (read-only)* Default: "" 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. **Level** *AdESSignatureLevels* Default: 2 Specifies the level according to which the inner AdES signature is to be composed CAdES and XAdES standards define a number of signature levels. The main differences between levels are in the scope of validation information included to the signature. BES signatures only include the most necessary information (the signing chain), whereas XL and A signatures include the complete set. The supported levels are: | | | | | --- | --- | --- | | aslUnknown | 0 | Unknown signature level | | aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) | | aslBaselineB | 2 | Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) | | aslBaselineT | 3 | Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) | | aslBaselineLT | 4 | Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) | | aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) | | aslBES | 6 | BES (Basic Electronic Signature) | | aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) | | aslT | 8 | T (Timestamped) | | aslC | 9 | C (T with revocation references) | | aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) | | aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) | | aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) | | aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) | | aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) | | aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) | | aslA | 16 | A (archived) | | aslExtendedBES | 17 | Extended BES | | aslExtendedEPES | 18 | Extended EPES | | aslExtendedT | 19 | Extended T | | aslExtendedC | 20 | Extended C | | aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) | | aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) | | aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) | | aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) | | aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) | | aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) | | aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) | | aslExtendedA | 28 | Extended A | | aslBaselineExtendedB | 29 | Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only) | | aslBaselineExtendedT | 30 | Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only) | | aslBaselineExtendedLT | 31 | Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only) | | aslBaselineExtendedLTA | 32 | Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only) | **PolicyHash** *string* Default: "" The signature policy hash value. Use this property to get the signature policy hash from EPES signatures **PolicyHashAlgorithm** *string* Default: "" The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from [PolicyHash](#ASiCSignature_f_PolicyHash). | | | | | --- | --- | --- | | 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 | | **PolicyID** *string* Default: "" The policy ID that was included or to be included into the signature. Use this property to retrieve the signature policy identifier from EPES signatures. **PolicyURI** *string* Default: "" The signature policy URI that was included in the signature. Use this property to set or retrieve the URI of the signature policy from EPES signatures. **SerialNumber** *byte[] (read-only)* Default: "" The serial number of the signing certificate. **SignatureBytes** *byte[] (read-only)* Default: "" Returns the binary representation of the ASiC signature. **SignatureType** *ASiCSignatureTypes* Default: 0 The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown. | | | | --- | --- | | castUnknown | 0 | | castCAdES | 1 | | castXAdES | 2 | | castTimestamp | 3 | **SignatureValidationResult** *SignatureValidities (read-only)* Default: 0 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) | **SignedFiles** *string (read-only)* Default: "" Contains a comma-separated list of files that are covered by the signature. **SubjectKeyID** *byte[] (read-only)* Default: "" 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. **SubjectRDN** *string (read-only)* Default: "" Contains the RDN of the owner of the signing certificate. RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details. **Timestamped** *bool (read-only)* Default: False Use this property to establish whether the signature contains an embedded timestamp. **ValidatedSigningTime** *string (read-only)* Default: "" Contains the certified signing time. Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature. [ClaimedSigningTime](#ASiCSignature_f_ClaimedSigningTime) returns a non-trusted signing time from the signer's computer. Both times are in UTC. **ValidationLog** *string (read-only)* Default: "" Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures. ## Constructors ```text public ASiCSignature(); ``` Creates a new empty ASiC signature object. # Certificate Type Encapsulates an individual X.509 certificate. ## Remarks This type keeps and provides access to X.509 certificate details. The following fields are available: - [Bytes](#Certificate_f_Bytes) - [CA](#Certificate_f_CA) - [CAKeyID](#Certificate_f_CAKeyID) - [CertType](#Certificate_f_CertType) - [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints) - [Curve](#Certificate_f_Curve) - [Fingerprint](#Certificate_f_Fingerprint) - [FriendlyName](#Certificate_f_FriendlyName) - [HashAlgorithm](#Certificate_f_HashAlgorithm) - [Issuer](#Certificate_f_Issuer) - [IssuerRDN](#Certificate_f_IssuerRDN) - [KeyAlgorithm](#Certificate_f_KeyAlgorithm) - [KeyBits](#Certificate_f_KeyBits) - [KeyFingerprint](#Certificate_f_KeyFingerprint) - [KeyUsage](#Certificate_f_KeyUsage) - [KeyValid](#Certificate_f_KeyValid) - [OCSPLocations](#Certificate_f_OCSPLocations) - [OCSPNoCheck](#Certificate_f_OCSPNoCheck) - [Origin](#Certificate_f_Origin) - [PolicyIDs](#Certificate_f_PolicyIDs) - [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) - [PrivateKeyExists](#Certificate_f_PrivateKeyExists) - [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable) - [PublicKeyBytes](#Certificate_f_PublicKeyBytes) - [Qualified](#Certificate_f_Qualified) - [QualifiedStatements](#Certificate_f_QualifiedStatements) - [Qualifiers](#Certificate_f_Qualifiers) - [SelfSigned](#Certificate_f_SelfSigned) - [SerialNumber](#Certificate_f_SerialNumber) - [SigAlgorithm](#Certificate_f_SigAlgorithm) - [Source](#Certificate_f_Source) - [Subject](#Certificate_f_Subject) - [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName) - [SubjectKeyID](#Certificate_f_SubjectKeyID) - [SubjectRDN](#Certificate_f_SubjectRDN) - [Valid](#Certificate_f_Valid) - [ValidFrom](#Certificate_f_ValidFrom) - [ValidTo](#Certificate_f_ValidTo) ## Fields **Bytes** *byte[] (read-only)* Default: "" Returns the raw certificate data in DER format. **CA** *bool* Default: False 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 field when generating a new certificate to have its Basic Constraints extension generated automatically. **CAKeyID** *byte[] (read-only)* Default: "" 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.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. **CertType** *CertTypes (read-only)* Default: 0 Returns the type of the entity contained in the [Certificate](#certificate-type) object. A [Certificate](#certificate-type) 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.md#CertificateManager) component to load or create new certificate and certificate requests objects. **CRLDistributionPoints** *string* Default: "" 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 field 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. **Curve** *string* Default: "" 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 | | **Fingerprint** *string (read-only)* Default: "" 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. **FriendlyName** *string (read-only)* Default: "" 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. **HashAlgorithm** *string* Default: "" 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 [SigAlgorithm](#Certificate_f_SigAlgorithm) 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 | | **Issuer** *string (read-only)* Default: "" The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN). **IssuerRDN** *string* Default: "" A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* **KeyAlgorithm** *string* Default: "0" 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 [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains. **KeyBits** *int (read-only)* Default: 0 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 [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer. **KeyFingerprint** *string (read-only)* Default: "" 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 [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. **KeyUsage** *int* Default: 0 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 field before generating the certificate to propagate the key usage flags to the new certificate. **KeyValid** *bool (read-only)* Default: False Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. **OCSPLocations** *string* Default: "" Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this field before calling the certificate manager's [Generate](CertificateManager.md#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. **OCSPNoCheck** *bool* Default: False Accessor to the value of the certificate's ocsp-no-check extension. **Origin** *int (read-only)* Default: 0 Returns the location that the certificate was taken or loaded from. **PolicyIDs** *string* Default: "" 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 field 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. **PrivateKeyBytes** *byte[] (read-only)* Default: "" Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. **PrivateKeyExists** *bool (read-only)* Default: False 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 field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), 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. **PrivateKeyExtractable** *bool (read-only)* Default: False Indicates whether the private key is extractable (exportable). **PublicKeyBytes** *byte[] (read-only)* Default: "" 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. **Qualified** *bool (read-only)* Default: False Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. **QualifiedStatements** *QualifiedStatementsTypes* Default: 0 Returns a simplified qualified status of the certificate. **Qualifiers** *string (read-only)* Default: "" A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. **SelfSigned** *bool (read-only)* Default: False Indicates whether the certificate is self-signed (root) or signed by an external CA. **SerialNumber** *byte[]* Default: "" 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. **SigAlgorithm** *string (read-only)* Default: "" 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*. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **Subject** *string (read-only)* Default: "" 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 [SubjectRDN](#Certificate_f_SubjectRDN). **SubjectAlternativeName** *string* Default: "" 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 [SubjectRDN](#Certificate_f_SubjectRDN) 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. **SubjectKeyID** *byte[]* Default: "" 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 [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. **SubjectRDN** *string* Default: "" 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*. **Valid** *bool (read-only)* Default: False 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. **ValidFrom** *string* Default: "" The time point at which the certificate becomes valid, in UTC. **ValidTo** *string* Default: "" The time point at which the certificate expires, in UTC. ## Constructors ```text public Certificate(byte[] bytes, int startIndex, int count, string password); ``` Loads the X.509 certificate from a memory buffer. * Bytes * is a buffer containing the raw certificate data. * StartIndex * and * Count * specify the starting position and number of bytes to be read from the buffer, respectively. * Password * is a password encrypting the certificate. ```text public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password); ``` Loads the X.509 certificate from a memory buffer. * CertBytes * is a buffer containing the raw certificate data. * CertStartIndex * and * CertCount * specify the starting position and number of bytes to be read from the buffer, respectively. * KeyBytes * is a buffer containing the private key data. * KeyStartIndex * and * KeyCount * specify the starting position and number of bytes to be read from the buffer, respectively. * Password * is a password encrypting the certificate. ```text public Certificate(byte[] bytes, int startIndex, int count); ``` Loads the X.509 certificate from a memory buffer. * Bytes * is a buffer containing the raw certificate data. * StartIndex * and * Count * specify the starting position and number of bytes to be read from the buffer, respectively. ```text public Certificate(string path, string password); ``` Loads the X.509 certificate from a file. * Path * specifies the full path to the file containing the certificate data. * Password * is a password encrypting the certificate. ```text public Certificate(string certPath, string keyPath, string password); ``` Loads the X.509 certificate from a file. * CertPath * specifies the full path to the file containing the certificate data. * KeyPath * specifies the full path to the file containing the private key. * Password * is a password encrypting the certificate. ```text public Certificate(string path); ``` Loads the X.509 certificate from a file. * Path * specifies the full path to the file containing the certificate data. ```text public Certificate(System.IO.Stream stream); ``` Loads the X.509 certificate from a stream. * Stream * is a stream containing the certificate data. ```text public Certificate(System.IO.Stream stream, string password); ``` Loads the X.509 certificate from a stream. * Stream * is a stream containing the certificate data. * Password * is a password encrypting the certificate. ```text public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password); ``` Loads the X.509 certificate from a stream. * CertStream * is a stream containing the certificate data. * KeyStream * is a stream containing the private key. * Password * is a password encrypting the certificate. ```text public Certificate(); ``` Creates a new object with default field values. # CRL Type Represents a Certificate Revocation List. ## Remarks CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons. Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations. Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid. The following fields are available: - [Bytes](#CRL_f_Bytes) - [CAKeyID](#CRL_f_CAKeyID) - [EntryCount](#CRL_f_EntryCount) - [Issuer](#CRL_f_Issuer) - [IssuerRDN](#CRL_f_IssuerRDN) - [Location](#CRL_f_Location) - [NextUpdate](#CRL_f_NextUpdate) - [SigAlgorithm](#CRL_f_SigAlgorithm) - [Source](#CRL_f_Source) - [TBS](#CRL_f_TBS) - [ThisUpdate](#CRL_f_ThisUpdate) ## Fields **Bytes** *byte[] (read-only)* Default: "" Returns the raw CRL data in DER format. **CAKeyID** *byte[]* Default: "" A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. **EntryCount** *int (read-only)* Default: 0 Returns the number of certificate status entries in the CRL. **Issuer** *string (read-only)* Default: "" The common name of the CRL issuer (CA), typically a company name. **IssuerRDN** *string (read-only)* Default: "" A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. **Location** *string (read-only)* Default: "" The URL that the CRL was downloaded from. **NextUpdate** *string* Default: "" The planned time and date of the next version of this CRL to be published. **SigAlgorithm** *string* Default: "0" The public key algorithm that was used by the CA to sign this CRL. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **TBS** *byte[] (read-only)* Default: "" The to-be-signed part of the CRL (the CRL without the signature part). **ThisUpdate** *string* Default: "" The date and time at which this version of the CRL was published. ## Constructors ```text public CRL(byte[] bytes, int startIndex, int count); ``` Creates a CRL object from a memory buffer. * Bytes * is a buffer containing raw (DER) CRL data, * StartIndex * and * Count * specify the starting position and the length of the CRL data in the buffer, respectively. ```text public CRL(string location); ``` Creates a CRL object by downloading it from a remote location. ```text public CRL(System.IO.Stream stream); ``` Creates a CRL object from data contained in a stream. ```text public CRL(); ``` Creates an empty CRL object. # OCSPResponse Type Represents a single OCSP response originating from an OCSP responder. ## Remarks OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs). An OCSP response is a snapshot of the certificate status at a given time. The following fields are available: - [Bytes](#OCSPResponse_f_Bytes) - [EntryCount](#OCSPResponse_f_EntryCount) - [Issuer](#OCSPResponse_f_Issuer) - [IssuerRDN](#OCSPResponse_f_IssuerRDN) - [Location](#OCSPResponse_f_Location) - [ProducedAt](#OCSPResponse_f_ProducedAt) - [SigAlgorithm](#OCSPResponse_f_SigAlgorithm) - [Source](#OCSPResponse_f_Source) ## Fields **Bytes** *byte[] (read-only)* Default: "" A buffer containing the raw OCSP response data. **EntryCount** *int (read-only)* Default: 0 The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. **Issuer** *string (read-only)* Default: "" Indicates the issuer of this response (a CA or its authorized representative). **IssuerRDN** *string (read-only)* Default: "" Indicates the RDN of the issuer of this response (a CA or its authorized representative). **Location** *string (read-only)* Default: "" The location of the OCSP responder. **ProducedAt** *string* Default: "" Specifies the time when the response was produced, in UTC. **SigAlgorithm** *string* Default: "0" The public key algorithm that was used by the CA to sign this OCSP response. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Constructors ```text public OCSPResponse(byte[] bytes, int startIndex, int count); ``` Initializes the response from a memory buffer. * Bytes * is a buffer containing raw OCSP response data, * StartIndex * and * Count * specify the starting position and the number of bytes to be read from this buffer. ```text public OCSPResponse(string location); ``` Downloads an OCSP response from a remote location. ```text public OCSPResponse(System.IO.Stream stream); ``` Initializes the response with the data from a stream. ```text public OCSPResponse(); ``` Creates an empty OCSP response object. # ProxySettings Type A container for proxy server settings. ## Remarks This type exposes a collection of properties for tuning up the proxy server configuration. The following fields are available: - [Address](#ProxySettings_f_Address) - [Authentication](#ProxySettings_f_Authentication) - [Password](#ProxySettings_f_Password) - [Port](#ProxySettings_f_Port) - [ProxyType](#ProxySettings_f_ProxyType) - [RequestHeaders](#ProxySettings_f_RequestHeaders) - [ResponseBody](#ProxySettings_f_ResponseBody) - [ResponseHeaders](#ProxySettings_f_ResponseHeaders) - [UseIPv6](#ProxySettings_f_UseIPv6) - [Username](#ProxySettings_f_Username) ## Fields **Address** *string* Default: "" The IP address of the proxy server. **Authentication** *ProxyAuthTypes* Default: 0 The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | **Password** *string* Default: "" The password to authenticate to the proxy server. **Port** *int* Default: 0 The port on the proxy server to connect to. **ProxyType** *ProxyTypes* Default: 0 The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | **RequestHeaders** *string* Default: "" Contains HTTP request headers for WebTunnel and HTTP proxy. **ResponseBody** *string* Default: "" Contains the HTTP or HTTPS (WebTunnel) proxy response body. **ResponseHeaders** *string* Default: "" Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. **UseIPv6** *bool* Default: False Specifies whether IPv6 should be used when connecting through the proxy. **Username** *string* Default: "" Specifies the username credential for proxy authentication. ## Constructors ```text public ProxySettings(); ``` Creates a new ProxySettings object. # SocketSettings Type A container for the socket settings. ## Remarks This type is a container for socket-layer parameters. The following fields are available: - [DNSMode](#SocketSettings_f_DNSMode) - [DNSPort](#SocketSettings_f_DNSPort) - [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout) - [DNSServers](#SocketSettings_f_DNSServers) - [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout) - [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit) - [LocalAddress](#SocketSettings_f_LocalAddress) - [LocalPort](#SocketSettings_f_LocalPort) - [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit) - [Timeout](#SocketSettings_f_Timeout) - [UseIPv6](#SocketSettings_f_UseIPv6) ## Fields **DNSMode** *DNSResolveModes* Default: 0 Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | **DNSPort** *int* Default: 0 Specifies the port number to be used for sending queries to the DNS server. **DNSQueryTimeout** *int* Default: 0 The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. **DNSServers** *string* Default: "" The addresses of DNS servers to use for address resolution, separated by commas or semicolons. **DNSTotalTimeout** *int* Default: 0 The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. **IncomingSpeedLimit** *int* Default: 0 The maximum number of bytes to read from the socket, per second. **LocalAddress** *string* Default: "" The local network interface to bind the socket to. **LocalPort** *int* Default: 0 The local port number to bind the socket to. **OutgoingSpeedLimit** *int* Default: 0 The maximum number of bytes to write to the socket, per second. **Timeout** *int* Default: 60000 The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). **UseIPv6** *bool* Default: False Enables or disables IP protocol version 6. ## Constructors ```text public SocketSettings(); ``` Creates a new SocketSettings object. # TimestampInfo Type A container for timestamp information. ## Remarks The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation. The following fields are available: - [Accuracy](#TimestampInfo_f_Accuracy) - [Bytes](#TimestampInfo_f_Bytes) - [CertificateIndex](#TimestampInfo_f_CertificateIndex) - [ChainValidationDetails](#TimestampInfo_f_ChainValidationDetails) - [ChainValidationResult](#TimestampInfo_f_ChainValidationResult) - [ContainsLongTermInfo](#TimestampInfo_f_ContainsLongTermInfo) - [EntityLabel](#TimestampInfo_f_EntityLabel) - [HashAlgorithm](#TimestampInfo_f_HashAlgorithm) - [ParentEntity](#TimestampInfo_f_ParentEntity) - [SerialNumber](#TimestampInfo_f_SerialNumber) - [Time](#TimestampInfo_f_Time) - [TimestampType](#TimestampInfo_f_TimestampType) - [TSAName](#TimestampInfo_f_TSAName) - [ValidationLog](#TimestampInfo_f_ValidationLog) - [ValidationResult](#TimestampInfo_f_ValidationResult) ## Fields **Accuracy** *long (read-only)* Default: 0 This field indicates the accuracy of the included time mark, in microseconds. **Bytes** *byte[] (read-only)* Default: "" Returns the raw timestamp data in DER format. **CertificateIndex** *int (read-only)* Default: -1 Returns the index of the TSA certificate in the Certificates collection. Use this property to look up the TSA certificate in the Certificates collection. **ChainValidationDetails** *int (read-only)* Default: 0 The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | **ChainValidationResult** *ChainValidities (read-only)* Default: 0 The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. **ContainsLongTermInfo** *bool (read-only)* Default: False Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). **EntityLabel** *string (read-only)* Default: "" Use this property to get the timestamp entity label. This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method. **HashAlgorithm** *string (read-only)* Default: "" Returns the timestamp's hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | **ParentEntity** *string (read-only)* Default: "" Use this property to get the label of the timestamp's parent entity. This property references the EntityLabel of the object that the timestamp covers, typically a signature. **SerialNumber** *byte[] (read-only)* Default: "" Returns the timestamp's serial number. **Time** *string (read-only)* Default: "" The time point incorporated into the timestamp. **TimestampType** *int (read-only)* Default: 0 Returns the type of the timestamp. Available options: | | | | | --- | --- | --- | | tstUnknown | 0 | | | tstLegacy | 1 | Supported by: Authenticode components | | tstTrusted | 2 | Supported by: Authenticode components | | tstGeneric | 3 | Supported by: CAdES components | | tstESC | 4 | Supported by: CAdES components | | tstContent | 5 | Supported by: CAdES components | | tstCertsAndCRLs | 6 | Supported by: CAdES components | | tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components | | tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components | | tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components | | tstIndividualDataObjects | 10 | Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components | | tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components | | tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components | | tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components | | tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components | | tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components | | tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components | Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES). **TSAName** *string (read-only)* Default: "" This value uniquely identifies the Timestamp Authority (TSA). This property provides information about the entity that manages the TSA. **ValidationLog** *string (read-only)* Default: "" Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails. **ValidationResult** *SignatureValidities (read-only)* Default: 0 Contains the timestamp validation outcome. Use this property to check the result of the most recent timestamp validation. | | | | | --- | --- | --- | | 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) | ## Constructors ```text public TimestampInfo(); ``` Creates a new TimestampInfo object with default field values. # TLSSettings Type A container for TLS connection settings. ## Remarks The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP. The following fields are available: - [AutoValidateCertificates](#TLSSettings_f_AutoValidateCertificates) - [BaseConfiguration](#TLSSettings_f_BaseConfiguration) - [Ciphersuites](#TLSSettings_f_Ciphersuites) - [ClientAuth](#TLSSettings_f_ClientAuth) - [Extensions](#TLSSettings_f_Extensions) - [ForceResumeIfDestinationChanges](#TLSSettings_f_ForceResumeIfDestinationChanges) - [Groups](#TLSSettings_f_Groups) - [PreSharedIdentity](#TLSSettings_f_PreSharedIdentity) - [PreSharedKey](#TLSSettings_f_PreSharedKey) - [PreSharedKeyCiphersuite](#TLSSettings_f_PreSharedKeyCiphersuite) - [RenegotiationAttackPreventionMode](#TLSSettings_f_RenegotiationAttackPreventionMode) - [RevocationCheck](#TLSSettings_f_RevocationCheck) - [SSLOptions](#TLSSettings_f_SSLOptions) - [TLSMode](#TLSSettings_f_TLSMode) - [UseExtendedMasterSecret](#TLSSettings_f_UseExtendedMasterSecret) - [UseSessionResumption](#TLSSettings_f_UseSessionResumption) - [Versions](#TLSSettings_f_Versions) ## Fields **AutoValidateCertificates** *bool* Default: True Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. **BaseConfiguration** *SecureTransportPredefinedConfigurations* Default: 0 Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | **Ciphersuites** *string* Default: "" A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [BaseConfiguration](#TLSSettings_f_BaseConfiguration). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below: - NULL_NULL_NULL - RSA_NULL_MD5 - RSA_NULL_SHA - RSA_RC4_MD5 - RSA_RC4_SHA - RSA_RC2_MD5 - RSA_IDEA_MD5 - RSA_IDEA_SHA - RSA_DES_MD5 - RSA_DES_SHA - RSA_3DES_MD5 - RSA_3DES_SHA - RSA_AES128_SHA - RSA_AES256_SHA - DH_DSS_DES_SHA - DH_DSS_3DES_SHA - DH_DSS_AES128_SHA - DH_DSS_AES256_SHA - DH_RSA_DES_SHA - DH_RSA_3DES_SHA - DH_RSA_AES128_SHA - DH_RSA_AES256_SHA - DHE_DSS_DES_SHA - DHE_DSS_3DES_SHA - DHE_DSS_AES128_SHA - DHE_DSS_AES256_SHA - DHE_RSA_DES_SHA - DHE_RSA_3DES_SHA - DHE_RSA_AES128_SHA - DHE_RSA_AES256_SHA - DH_ANON_RC4_MD5 - DH_ANON_DES_SHA - DH_ANON_3DES_SHA - DH_ANON_AES128_SHA - DH_ANON_AES256_SHA - RSA_RC2_MD5_EXPORT - RSA_RC4_MD5_EXPORT - RSA_DES_SHA_EXPORT - DH_DSS_DES_SHA_EXPORT - DH_RSA_DES_SHA_EXPORT - DHE_DSS_DES_SHA_EXPORT - DHE_RSA_DES_SHA_EXPORT - DH_ANON_RC4_MD5_EXPORT - DH_ANON_DES_SHA_EXPORT - RSA_CAMELLIA128_SHA - DH_DSS_CAMELLIA128_SHA - DH_RSA_CAMELLIA128_SHA - DHE_DSS_CAMELLIA128_SHA - DHE_RSA_CAMELLIA128_SHA - DH_ANON_CAMELLIA128_SHA - RSA_CAMELLIA256_SHA - DH_DSS_CAMELLIA256_SHA - DH_RSA_CAMELLIA256_SHA - DHE_DSS_CAMELLIA256_SHA - DHE_RSA_CAMELLIA256_SHA - DH_ANON_CAMELLIA256_SHA - PSK_RC4_SHA - PSK_3DES_SHA - PSK_AES128_SHA - PSK_AES256_SHA - DHE_PSK_RC4_SHA - DHE_PSK_3DES_SHA - DHE_PSK_AES128_SHA - DHE_PSK_AES256_SHA - RSA_PSK_RC4_SHA - RSA_PSK_3DES_SHA - RSA_PSK_AES128_SHA - RSA_PSK_AES256_SHA - RSA_SEED_SHA - DH_DSS_SEED_SHA - DH_RSA_SEED_SHA - DHE_DSS_SEED_SHA - DHE_RSA_SEED_SHA - DH_ANON_SEED_SHA - SRP_SHA_3DES_SHA - SRP_SHA_RSA_3DES_SHA - SRP_SHA_DSS_3DES_SHA - SRP_SHA_AES128_SHA - SRP_SHA_RSA_AES128_SHA - SRP_SHA_DSS_AES128_SHA - SRP_SHA_AES256_SHA - SRP_SHA_RSA_AES256_SHA - SRP_SHA_DSS_AES256_SHA - ECDH_ECDSA_NULL_SHA - ECDH_ECDSA_RC4_SHA - ECDH_ECDSA_3DES_SHA - ECDH_ECDSA_AES128_SHA - ECDH_ECDSA_AES256_SHA - ECDHE_ECDSA_NULL_SHA - ECDHE_ECDSA_RC4_SHA - ECDHE_ECDSA_3DES_SHA - ECDHE_ECDSA_AES128_SHA - ECDHE_ECDSA_AES256_SHA - ECDH_RSA_NULL_SHA - ECDH_RSA_RC4_SHA - ECDH_RSA_3DES_SHA - ECDH_RSA_AES128_SHA - ECDH_RSA_AES256_SHA - ECDHE_RSA_NULL_SHA - ECDHE_RSA_RC4_SHA - ECDHE_RSA_3DES_SHA - ECDHE_RSA_AES128_SHA - ECDHE_RSA_AES256_SHA - ECDH_ANON_NULL_SHA - ECDH_ANON_RC4_SHA - ECDH_ANON_3DES_SHA - ECDH_ANON_AES128_SHA - ECDH_ANON_AES256_SHA - RSA_NULL_SHA256 - RSA_AES128_SHA256 - RSA_AES256_SHA256 - DH_DSS_AES128_SHA256 - DH_RSA_AES128_SHA256 - DHE_DSS_AES128_SHA256 - DHE_RSA_AES128_SHA256 - DH_DSS_AES256_SHA256 - DH_RSA_AES256_SHA256 - DHE_DSS_AES256_SHA256 - DHE_RSA_AES256_SHA256 - DH_ANON_AES128_SHA256 - DH_ANON_AES256_SHA256 - RSA_AES128_GCM_SHA256 - RSA_AES256_GCM_SHA384 - DHE_RSA_AES128_GCM_SHA256 - DHE_RSA_AES256_GCM_SHA384 - DH_RSA_AES128_GCM_SHA256 - DH_RSA_AES256_GCM_SHA384 - DHE_DSS_AES128_GCM_SHA256 - DHE_DSS_AES256_GCM_SHA384 - DH_DSS_AES128_GCM_SHA256 - DH_DSS_AES256_GCM_SHA384 - DH_ANON_AES128_GCM_SHA256 - DH_ANON_AES256_GCM_SHA384 - ECDHE_ECDSA_AES128_SHA256 - ECDHE_ECDSA_AES256_SHA384 - ECDH_ECDSA_AES128_SHA256 - ECDH_ECDSA_AES256_SHA384 - ECDHE_RSA_AES128_SHA256 - ECDHE_RSA_AES256_SHA384 - ECDH_RSA_AES128_SHA256 - ECDH_RSA_AES256_SHA384 - ECDHE_ECDSA_AES128_GCM_SHA256 - ECDHE_ECDSA_AES256_GCM_SHA384 - ECDH_ECDSA_AES128_GCM_SHA256 - ECDH_ECDSA_AES256_GCM_SHA384 - ECDHE_RSA_AES128_GCM_SHA256 - ECDHE_RSA_AES256_GCM_SHA384 - ECDH_RSA_AES128_GCM_SHA256 - ECDH_RSA_AES256_GCM_SHA384 - PSK_AES128_GCM_SHA256 - PSK_AES256_GCM_SHA384 - DHE_PSK_AES128_GCM_SHA256 - DHE_PSK_AES256_GCM_SHA384 - RSA_PSK_AES128_GCM_SHA256 - RSA_PSK_AES256_GCM_SHA384 - PSK_AES128_SHA256 - PSK_AES256_SHA384 - PSK_NULL_SHA256 - PSK_NULL_SHA384 - DHE_PSK_AES128_SHA256 - DHE_PSK_AES256_SHA384 - DHE_PSK_NULL_SHA256 - DHE_PSK_NULL_SHA384 - RSA_PSK_AES128_SHA256 - RSA_PSK_AES256_SHA384 - RSA_PSK_NULL_SHA256 - RSA_PSK_NULL_SHA384 - RSA_CAMELLIA128_SHA256 - DH_DSS_CAMELLIA128_SHA256 - DH_RSA_CAMELLIA128_SHA256 - DHE_DSS_CAMELLIA128_SHA256 - DHE_RSA_CAMELLIA128_SHA256 - DH_ANON_CAMELLIA128_SHA256 - RSA_CAMELLIA256_SHA256 - DH_DSS_CAMELLIA256_SHA256 - DH_RSA_CAMELLIA256_SHA256 - DHE_DSS_CAMELLIA256_SHA256 - DHE_RSA_CAMELLIA256_SHA256 - DH_ANON_CAMELLIA256_SHA256 - ECDHE_ECDSA_CAMELLIA128_SHA256 - ECDHE_ECDSA_CAMELLIA256_SHA384 - ECDH_ECDSA_CAMELLIA128_SHA256 - ECDH_ECDSA_CAMELLIA256_SHA384 - ECDHE_RSA_CAMELLIA128_SHA256 - ECDHE_RSA_CAMELLIA256_SHA384 - ECDH_RSA_CAMELLIA128_SHA256 - ECDH_RSA_CAMELLIA256_SHA384 - RSA_CAMELLIA128_GCM_SHA256 - RSA_CAMELLIA256_GCM_SHA384 - DHE_RSA_CAMELLIA128_GCM_SHA256 - DHE_RSA_CAMELLIA256_GCM_SHA384 - DH_RSA_CAMELLIA128_GCM_SHA256 - DH_RSA_CAMELLIA256_GCM_SHA384 - DHE_DSS_CAMELLIA128_GCM_SHA256 - DHE_DSS_CAMELLIA256_GCM_SHA384 - DH_DSS_CAMELLIA128_GCM_SHA256 - DH_DSS_CAMELLIA256_GCM_SHA384 - DH_anon_CAMELLIA128_GCM_SHA256 - DH_anon_CAMELLIA256_GCM_SHA384 - ECDHE_ECDSA_CAMELLIA128_GCM_SHA256 - ECDHE_ECDSA_CAMELLIA256_GCM_SHA384 - ECDH_ECDSA_CAMELLIA128_GCM_SHA256 - ECDH_ECDSA_CAMELLIA256_GCM_SHA384 - ECDHE_RSA_CAMELLIA128_GCM_SHA256 - ECDHE_RSA_CAMELLIA256_GCM_SHA384 - ECDH_RSA_CAMELLIA128_GCM_SHA256 - ECDH_RSA_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_GCM_SHA256 - PSK_CAMELLIA256_GCM_SHA384 - DHE_PSK_CAMELLIA128_GCM_SHA256 - DHE_PSK_CAMELLIA256_GCM_SHA384 - RSA_PSK_CAMELLIA128_GCM_SHA256 - RSA_PSK_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_SHA256 - PSK_CAMELLIA256_SHA384 - DHE_PSK_CAMELLIA128_SHA256 - DHE_PSK_CAMELLIA256_SHA384 - RSA_PSK_CAMELLIA128_SHA256 - RSA_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_CAMELLIA128_SHA256 - ECDHE_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_RC4_SHA - ECDHE_PSK_3DES_SHA - ECDHE_PSK_AES128_SHA - ECDHE_PSK_AES256_SHA - ECDHE_PSK_AES128_SHA256 - ECDHE_PSK_AES256_SHA384 - ECDHE_PSK_NULL_SHA - ECDHE_PSK_NULL_SHA256 - ECDHE_PSK_NULL_SHA384 - ECDHE_RSA_CHACHA20_POLY1305_SHA256 - ECDHE_ECDSA_CHACHA20_POLY1305_SHA256 - DHE_RSA_CHACHA20_POLY1305_SHA256 - PSK_CHACHA20_POLY1305_SHA256 - ECDHE_PSK_CHACHA20_POLY1305_SHA256 - DHE_PSK_CHACHA20_POLY1305_SHA256 - RSA_PSK_CHACHA20_POLY1305_SHA256 - AES128_GCM_SHA256 - AES256_GCM_SHA384 - CHACHA20_POLY1305_SHA256 - AES128_CCM_SHA256 - AES128_CCM8_SHA256 **ClientAuth** *ClientAuthTypes* Default: 0 Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | **Extensions** *string* Default: "" Provides access to TLS extensions. **ForceResumeIfDestinationChanges** *bool* Default: False Whether to force TLS session resumption when the destination address changes. **Groups** *string* Default: "" Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. **PreSharedIdentity** *string* Default: "" Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. **PreSharedKey** *string* Default: "" Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. **PreSharedKeyCiphersuite** *string* Default: "" Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. **RenegotiationAttackPreventionMode** *RenegotiationAttackPreventionModes* Default: 2 Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | **RevocationCheck** *RevocationCheckKinds* Default: 1 Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. **SSLOptions** *int* Default: 16 Various SSL (TLS) protocol options, set of | | | | | --- | --- | --- | | cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection | | cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions | | cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. | | cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. | | cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known | | cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only | | cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. | | cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled | | cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms | | cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks | | cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually | **TLSMode** *SSLModes* Default: 0 Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | **UseExtendedMasterSecret** *bool* Default: True Enables the Extended Master Secret Extension, as defined in RFC 7627. **UseSessionResumption** *bool* Default: False Enables or disables the TLS session resumption capability. **Versions** *int* Default: 48 The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | ## Constructors ```text public TLSSettings(); ``` Creates a new TLSSettings object. # Config Settings ([ASiCVerifier](#asicverifier-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-asicverifier-component) method. ### ASiCVerifier 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. **CmsOptAnnexKArchiveTimestampV2Mode**: Toggles use of Annex K method of calculating validation timestamp hashes.This CMS message option toggles the use of Annex K method of calculating validation timestamp hashes. Switch this option off to stick to RFC5126 p6.3.5 method. **CmsOptCheckATSHashIndexElements**: Enables extra checks when processing ATSHashIndex attribute.This CMS message option enables an extra check to make sure every hash in ATSHashIndex has an associated CMS element. **CmsOptCompareRDNAsStrings**: Enforces comparison of RDN elements as text strings, rather than their byte encodings.This CMS message option enforces comparison of string RDN elements as text strings rather than their original byte encodings. **CmsOptDEREncodeContentForATSv2**: Enables DER encoding for ATSv2 hashed content.This is an outdated setting, which reflects a complicated (at times) story of AdES infrastructure development. You are unlikely to need it. **CmsOptDigitPADSSCompatibility**: Enables Digit PADSS compatibility mode.This CMS message option enables compatibility mode with Digit PADSS software. **CmsOptForceSigningCertificateV2Usage**: Enforces use of signing-certificate-v2 attribute.This CMS message option enforces the use of signing-certificate-v2 attribute in favour of older signing-certificate-v1. Current regulations require that signing-certificate-v2 is used at all times. **CmsOptIgnoreDERReqInArchiveTimestamps**: Switches off DER encoding requirement for archival timestamps.This CMS message option switches off DER encoding requirement for archival timestamps (normally meaning no attribute reordering). This setting is a workaround for certain buggy CAdES products. **CmsOptImzagerMIMCompatibility**: Enables Imzager MIM compatibility mode.This CMS message option enables compatibility mode with Imzager MIM software. **CmsOptIncludeCertToAttributes**: Regulates whether to include the signing certificate to the signature as the signing-certificate attribute.This CMS message option controls inclusion of the signing certificate as the signing-certificate attribute. Current regulations require that this attribute is present. **CmsOptIncludeCertToMessage**: Regulates whether to include the signing certificate and its chain to the CMS.This CMS message option controls inclusion of the signing certificate to the CMS structure. It is recommended that the certificate is included. Note that this option has no effect if the signature level used (e.g. XL) enforces inclusion of the certificate to the message. **CmsOptInsertContentType**: Regulates whether the content-type time attribute should be included in the signature structure.This CMS message option specifies whether the content-type attribute should be included in the signature structure. **CmsOptInsertMessageDigests**: Regulates whether the message-digest signed attribute should be included in the signature structure.This CMS message option controls inclusion of the message-digest attribute in the signature structure. Current regulations require that this attribute is present at all times. **CmsOptInsertSigningTime**: Regulates whether the signing-time attribute should be included in the signature structure.This CMS message option specifies whether the signing-time attribute should be included in the signature structure. Switch it off to suppress inclusion of the signing-time attribute. **CmsOptSkipEnvContentInfoOnSigArchival**: Excludes hashing of enveloped content when calculating an archival timestamp.This CMS message option excludes hashing of enveloped content when calculating an archival timestamp. This setting is a workaround for certain buggy CAdES products. **CmsOptUseATSHashIndexV1**: Enables use of ATSHashIndexV1 attribute.This CMS message option enables use of deprecated ATSHashIndexV1 attribute when calculating archival timestamp V3 hashes. **CmsOptUseATSHashIndexV3**: Enables the use of the third version of archival timestamps.Enables the use of archival timestamp v3 objects when creating long-term and archival signatures. This is the default setting. Setting it to false tells the components to stick with archival timestamps version 2. **CmsOptUseGeneralizedTimeFormat**: Enables or disables encoding of the signing-time attribute using ASN.1 GENERALIZEDTIME type.This CMS message option controls whether the signing-time attribute should be encoded as GENERALIZEDTIME or UTCTIME. Current regulations require that the GENERALIZEDTIME type is used at all times. **CmsOptUseGenericSigAlgorithmOIDs**: Enables use of generic signature algorithm OIDs in the signature.This CMS message option enforces the use of generic public key algorithm OIDs (e.g. rsaEncryption) instead of hash algorithm-specific variants (e.g. sha256withRsaEncryption). This setting is a workaround for certain buggy CAdES products. **CmsOptUsePlainContentForTimestampHashes**: Makes CAdESSigner ignore ASN.1 content formatting when calculating timestamp hashes.This CMS message option causes CAdESSigner to ignore ASN.1 formatting when feeding content to timestamp hashes (might make a difference with split OCTETSTRINGs for extra long contents). This option is only applicable to content timestamps and ArchivalTimestampV1's. This setting is a workaround for certain buggy CAdES products. **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. **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. **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 **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](#trustedcertificates-property-asicverifier-component) 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. **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. **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. **Overwrite**: Forcefully overwrite OutputFile if it exists.Enable this setting to make the component overwrite the specified output file if it already exists on disk. This setting only applies to the ASiC output (the OutputFile property) and not to extracted archived files. Use the OnFileExtractionStart event to control overwriting behaviour for extracted files. **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*. **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 [ClaimedSigningTime](#@@ASiCVerifier_NewSignature@@_f_ClaimedSigningTime) 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. **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-asicverifier-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-asicverifier-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. **UseUTF8Filenames**: Specifies whether to use UTF-8 filenames.Set this property to False to use system encoding for filenames inside container. **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 | **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. | ### 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 ([ASiCVerifier](#asicverifier-component) Component) ### ASiCVerifier 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)) | | 16777217 | Unsupported level ([SB_ERROR_ASIC_UNSUPPORTED_LEVEL](constants.md#const_SBERRORASICUNSUPPORTEDLEVEL)) | | 16777219 | Unsupported signature type ([SB_ERROR_ASIC_UNSUPPORTED_SIGNATURE_TYPE](constants.md#const_SBERRORASICUNSUPPORTEDSIGNATURETYPE)) | | 16777220 | Unsupported extraction mode ([SB_ERROR_ASIC_UNSUPPORTED_EXTRACTION_MODE](constants.md#const_SBERRORASICUNSUPPORTEDEXTRACTIONMODE)) | | 16777221 | The input file does not exist ([SB_ERROR_ASIC_INPUTFILE_NOT_EXISTS](constants.md#const_SBERRORASICINPUTFILENOTEXISTS)) | | 16777222 | The output file with this name already exists ([SB_ERROR_ASIC_OUTPUTFILE_ALREADY_EXISTS](constants.md#const_SBERRORASICOUTPUTFILEALREADYEXISTS)) | | 16777223 | The document has already been signed once during this session ([SB_ERROR_ASIC_CONTAINER_SIGNED](constants.md#const_SBERRORASICCONTAINERSIGNED)) | | 16777224 | The document is not signed ([SB_ERROR_ASIC_CONTAINER_NOT_SIGNED](constants.md#const_SBERRORASICCONTAINERNOTSIGNED)) |