CAdESVerifier Class
Properties Methods Events Configuration Settings Errors
The CAdESVerifier class is used to validate CAdES signatures.
Syntax
secureblackbox.cadesverifier()
Remarks
CAdESVerifier validates electronic signatures that comply with the Electronic Signatures and Infrastructures (ESI) CMS Advanced Electronic Signatures (CAdES) specification.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AllSignaturesValid | The cumulative validity of all signatures. |
BlockedCertCount | The number of records in the BlockedCert arrays. |
BlockedCertBytes | Returns raw certificate data in DER format. |
BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CertCount | The number of records in the Cert arrays. |
CertBytes | Returns raw certificate data in DER format. |
CertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
CertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CertCurve | Specifies the elliptic curve of the EC public key. |
CertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
CertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CertKeyBits | Returns the length of the public key. |
CertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CertPublicKeyBytes | Contains the certificate's public key in DER format. |
CertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CertSerialNumber | Returns the certificate's serial number. |
CertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CertValidTo | The time point at which the certificate expires, in UTC. |
ChainValidationDetails | The details of a certificate chain validation outcome. |
ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
ClaimedSigningTime | Returns a signature's claimed signing time. |
CompatibilityErrors | Returns compatibility errors encountered during validation. |
ContentType | Returns the signed message's content type. |
Countersigned | Indicates if the signature is countersigned. |
CountersigningCertBytes | Returns raw certificate data in DER format. |
CountersigningCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
CountersigningCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CountersigningCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CountersigningCertCurve | Specifies the elliptic curve of the EC public key. |
CountersigningCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CountersigningCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CountersigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CountersigningCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
CountersigningCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CountersigningCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CountersigningCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CountersigningCertKeyBits | Returns the length of the public key. |
CountersigningCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CountersigningCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CountersigningCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CountersigningCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CountersigningCertOrigin | Returns the origin of this certificate. |
CountersigningCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CountersigningCertPrivateKeyBytes | Contains the certificate's private key. |
CountersigningCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
CountersigningCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
CountersigningCertPublicKeyBytes | Contains the certificate's public key in DER format. |
CountersigningCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CountersigningCertSerialNumber | Returns the certificate's serial number. |
CountersigningCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CountersigningCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CountersigningCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CountersigningCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CountersigningCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CountersigningCertValidTo | The time point at which the certificate expires, in UTC. |
CRLCount | The number of records in the CRL arrays. |
CRLBytes | Returns raw CRL data in DER format. |
CRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CRLIssuer | The common name of the CRL issuer (CA), typically a company name. |
CRLIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
CRLLocation | The URL that the CRL was downloaded from. |
CRLNextUpdate | The planned time and date of the next version of this CRL to be published. |
CRLThisUpdate | The date and time at which this version of the CRL was published. |
DataBytes | Use this property to pass the signed data to class in the byte array form. |
DataFile | A path to the file containing the originally signed data. |
HashAlgorithm | Returns the hash algorithm that was used to calculate the signature. |
IgnoreChainValidationErrors | Makes the class tolerant to chain validation errors. |
InputBytes | Use this property to pass the input to class in the byte array form. |
InputFile | A path to the file containing the signature blob. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownCRLCount | The number of records in the KnownCRL arrays. |
KnownCRLBytes | Returns raw CRL data in DER format. |
KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownOCSPCount | The number of records in the KnownOCSP arrays. |
KnownOCSPBytes | Buffer containing raw OCSP response data. |
KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
LastArchivalTime | Indicates the most recent archival time of an archived signature. |
Level | Returns the CAdES signature level. |
MessageDigest | The binary of the signature's message digest. |
OCSPCount | The number of records in the OCSP arrays. |
OCSPBytes | Buffer containing raw OCSP response data. |
OCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
OCSPIssuer | Indicates the issuer of this response (a CA or its authorized representative). |
OCSPIssuerRDN | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
OCSPLocation | Location of the OCSP responder. |
OCSPProducedAt | Specifies the time when the response was produced, in UTC. |
OfflineMode | Switches the class to the offline mode. |
OutputBytes | Use this property to read the output the class object has produced. |
OutputFile | A path to the file to write the extracted data to. |
PolicyHash | The signature policy hash value. |
PolicyID | The policy ID that was included into the signature. |
PolicyURI | The signature policy URI that was included in the signature. |
Profile | Specifies a pre-defined profile to apply when creating the signature. |
ProxyAddress | The IP address of the proxy server. |
ProxyAuthentication | The authentication type used by the proxy server. |
ProxyPassword | The password to authenticate to the proxy server. |
ProxyPort | The port on the proxy server to connect to. |
ProxyProxyType | The type of the proxy server. |
ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
ProxyUseProxy | Enables or disables proxy-driven connection. |
ProxyUsername | Specifies the username credential for proxy authentication. |
PublicKeyAlgorithm | Returns the public key algorithm that was used to create the signature. |
Qualified | Indicates a qualified electronic signature. |
RevocationCheck | Specifies the kind(s) of revocation check to perform. |
SignatureValidationResult | The signature validation result. |
SignedAttributeCount | The number of records in the SignedAttribute arrays. |
SignedAttributeOID | The object identifier of the attribute. |
SignedAttributeValue | The value of the attribute. |
SigningCertBytes | Returns raw certificate data in DER format. |
SigningCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
SigningCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
SigningCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
SigningCertCurve | Specifies the elliptic curve of the EC public key. |
SigningCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
SigningCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
SigningCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
SigningCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
SigningCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
SigningCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
SigningCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
SigningCertKeyBits | Returns the length of the public key. |
SigningCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
SigningCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
SigningCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
SigningCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
SigningCertOrigin | Returns the origin of this certificate. |
SigningCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
SigningCertPrivateKeyBytes | Contains the certificate's private key. |
SigningCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
SigningCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
SigningCertPublicKeyBytes | Contains the certificate's public key in DER format. |
SigningCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
SigningCertSerialNumber | Returns the certificate's serial number. |
SigningCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
SigningCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
SigningCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
SigningCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
SigningCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
SigningCertValidTo | The time point at which the certificate expires, in UTC. |
SocketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
TimestampAccuracy | This property indicates the accuracy of the included time mark, in microseconds. |
TimestampBytes | Returns raw timestamp data in DER format. |
TimestampChainValidationDetails | The details of a certificate chain validation outcome. |
TimestampChainValidationResult | The outcome of a certificate chain validation routine. |
TimestampHashAlgorithm | 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 . |
TimestampSerialNumber | Returns the timestamp's serial number. |
TimestampTime | The time point incorporated into the timestamp. |
TimestampTimestampType | Returns the timestamp type. |
TimestampTSAName | This value uniquely identifies the Timestamp Authority (TSA). |
TimestampValidationLog | Contains the TSA certificate chain validation log. |
TimestampValidationResult | Contains timestamp validation outcome. |
Timestamped | Indicates whether or not the signature is timestamped. |
TLSClientCertCount | The number of records in the TLSClientCert arrays. |
TLSClientCertBytes | Returns raw certificate data in DER format. |
TLSClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSServerCertCount | The number of records in the TLSServerCert arrays. |
TLSServerCertBytes | Returns raw certificate data in DER format. |
TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | Th SSL/TLS versions to enable by default. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertBytes | Returns raw certificate data in DER format. |
TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TSACertBytes | Returns raw certificate data in DER format. |
TSACertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
TSACertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
TSACertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
TSACertCurve | Specifies the elliptic curve of the EC public key. |
TSACertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
TSACertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
TSACertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TSACertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
TSACertIssuer | The common name of the certificate issuer (CA), typically a company name. |
TSACertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
TSACertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
TSACertKeyBits | Returns the length of the public key. |
TSACertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
TSACertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
TSACertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
TSACertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
TSACertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
TSACertPublicKeyBytes | Contains the certificate's public key in DER format. |
TSACertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
TSACertSerialNumber | Returns the certificate's serial number. |
TSACertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
TSACertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
TSACertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
TSACertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
TSACertValidFrom | The time point at which the certificate becomes valid, in UTC. |
TSACertValidTo | The time point at which the certificate expires, in UTC. |
UnsignedAttributeCount | The number of records in the UnsignedAttribute arrays. |
UnsignedAttributeOID | The object identifier of the attribute. |
UnsignedAttributeValue | The value of the attribute. |
ValidatedSigningTime | Contains the certified signing time. |
ValidationLog | Contains the complete log of the certificate validation routine. |
ValidationMoment | The time point at which signature validity is to be established. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Verify | Verifies a digitally signed CAdES message. |
VerifyDetached | Verifies a detached CAdES signature. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
ChainValidated | Reports the completion of a certificate chain validation. |
CountersignatureFound | Signifies the start of countersignature validation. |
CountersignatureValidated | Reports the completion of countersignature validation. |
Error | Information about errors during CAdES verification. |
Notification | This event notifies the application about an underlying control flow event. |
SignatureFound | Signifies the start of signature validation. |
SignatureValidated | Marks the completion of the signature validation routine. |
TimestampFound | Signifies the start of a timestamp validation routine. |
TimestampValidated | Reports the completion of the timestamp validation routine. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
AddReferencesToAllUsedCertsAndRevInfo | whether to include all certificates and revocation references into the signature. |
AddReferencesToIrrevocableCerts | Whether references to irrevocable certificates should be included into the signature. |
AddReferenceToSigningCert | Whether a reference to the signing certificate should be included into the signature. |
AllowPartialValidationInfo | Whether to allow for missing validation info. |
CmsOptAnnexKArchiveTimestampV2Mode | Toggles use of Annex K method of calculating validation timestamp hashes. |
CmsOptCheckATSHashIndexElements | Enables extra checks when processing ATSHashIndex attribute. |
CmsOptCompareRDNAsStrings | Enforces comparison of RDN elements as text strings, rather than their byte encodings. |
CmsOptDigitPADSSCompatibility | Enables Digit PADSS compatibility mode. |
CmsOptForceSigningCertificateV2Usage | Enforces use of signing-certificate-v2 attribute. |
CmsOptIgnoreDERReqInArchiveTimestamps | Switches off DER encoding requirement for archival timestamps. |
CmsOptImzagerMIMCompatibility | Enables Imzager MIM compatibility mode. |
CmsOptIncludeCertToAttributes | Regulates whether to include the signing certificate to the signature as the signing-certificate attribute. |
CmsOptIncludeCertToMessage | Regulates whether to include the signing certificate and its chain to the CMS. |
CmsOptInsertContentType | Regulates whether the content-type time attribute should be included in the signature structure. |
CmsOptInsertMessageDigests | Regulates whether the message-digest signed attribute should be included in the signature structure. |
CmsOptInsertSigningTime | Regulates whether the signing-time attribute should be included in the signature structure. |
CmsOptSkipEnvContentInfoOnSigArchival | Excludes hashing of enveloped content when calculating an archival timestamp. |
CmsOptUseATSHashIndexV1 | Enables use of ATSHashIndexV1 attribute. |
CmsOptUseGeneralizedTimeFormat | Enables or disables encoding of the signing-time attribute using ASN.1 GENERALIZEDTIME type. |
CmsOptUseGenericSigAlgorithmOIDs | Enables use of generic signature algorithm OIDs in the signature. |
CmsOptUsePlainContentForTimestampHashes | Makes CAdESSigner ignore ASN.1 content formatting when calculating timestamp hashes. |
CustomTSLs | Specifies the custom TSLs. |
DeepCountersignatureValidation | Whether to validate countersignatures. |
DeepTimestampValidation | Whether to perform deep validation of all timestamps. |
ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
GracePeriod | Specifies a grace period to apply during revocation information checks. |
IgnoreChainValidationErrors | Makes the class ignore chain validation issues. |
IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
PolicyExplicitText | The explicit text of the user notice. |
PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
PSSUsed | Whether RSASSA-PSS mode was used. |
QualifiedStatus | Indicates a qualified electronic signature. |
ReportInvalidTimestamps | Whether to rise errors on invalid timestamps. |
SkipValidationTimestampedSignatures | Whether to validate signatures with validation timestamps. |
TempPath | Path for storing temporary files. |
TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
TSLDistributionPoints | Contains XML content of distribution points of the TSL used. |
TSLDistributionPoints[Idx] | Contains distribution point of the specified index of the TSL used. |
TSLHistoricalInformationPeriod | Contains historical information period of the TSL used. |
TSLLegalNotices | Contains XML content of legal notices of the TSL used. |
TSLLegalNotices[lang] | Contains legal notices for the specified language of the TSL used. |
TSLListIssueDateTime | Contains list issue date and time of the TSL used. |
TSLNextUpdate | Contains next update date and time of the TSL used. |
TSLPolicies | Contains XML content of policies of the TSL used. |
TSLPolicies[lang] | Contains policies for the specified language of the TSL used. |
TSLSchemeExtensions | Contains XML content of scheme extensions of the TSL used. |
TSLSchemeExtensions[Idx] | Contains XML content of scheme extension of the specified index of the TSL used. |
TSLSchemeInformationURI | Contains XML content of scheme information URI of the TSL used. |
TSLSchemeInformationURI[lang] | Contains scheme information URI for the specified language of the TSL used. |
TSLSchemeName | Contains XML content of scheme name of the TSL used. |
TSLSchemeName[lang] | Contains scheme name for the specified language of the TSL used. |
TSLSchemeOperatorAddress | Contains XML content of scheme operator address of the TSL used. |
TSLSchemeOperatorName | Contains XML content of scheme operator name of the TSL used. |
TSLSchemeOperatorName[lang] | Contains scheme operator name for the specified language of the TSL used. |
TSLSchemeTerritory | Contains scheme territory of the TSL used. |
TSLSchemeTypeCommunityRules | Contains XML content of scheme type/community/rules of the TSL used. |
TSLSchemeTypeCommunityRules[lang] | Contains scheme type/community/rules for the specified language of the TSL used. |
TSLSequenceNumber | Contains sequence number of the TSL used. |
TSLsRetrieveLog | Contains the complete log of the TSLs retrieve. |
TSLStatusDeterminationApproach | Contains status determination approach of the TSL used. |
TSLsValidationLog | Contains the complete log of the TSLs validation. |
TSLTSPAdditionalServiceInformation | Contains addtional service information of the TSP service used. |
TSLTSPAddress | Contains XML content of the address of the TSP used. |
TSLTSPHistoryInstance | Indicates that TSP service history instance used. |
TSLTSPHistoryInstanceAdditionalServiceInformation | Contains addtional service information of the TSP service history instance used. |
TSLTSPHistoryInstanceQualifiers | Contains list of qualifiers of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceInformationExtensions | Contains XML content of information extensions of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceName | Contains XML content of name of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceName[lang] | Contains name for the specified language of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceStatus | Contains status of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceStatusStartingTime | Contains status starting time of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceTypeIdentifier | Contains type identifier of the TSP service history instance used. |
TSLTSPHistoryInstanceXML | Contains XML content of the TSP service history instance used. |
TSLTSPInformationExtensions | Contains XML content of information extensions of the TSP used. |
TSLTSPInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP used. |
TSLTSPInformationURI | Contains XML content of information URI of the TSP used. |
TSLTSPInformationURI[lang] | Contains information URI for the specified language of the TSP used. |
TSLTSPName | Contains XML content of name of the TSP used. |
TSLTSPName[lang] | Contains name for the specified language of the TSP used. |
TSLTSPSchemeServiceDefinitionURI | Contains XML content of scheme service definition URI of the TSP service used. |
TSLTSPSchemeServiceDefinitionURI[lang] | Contains scheme service definition URI for the specified language of the TSP service used. |
TSLTSPServiceDefinitionURI | Contains XML content of definition URI of the TSP service used. |
TSLTSPServiceDefinitionURI[lang] | Contains definition URI for the specified language of the TSP service used. |
TSLTSPServiceInformationExtensions | Contains XML content of information extensions of the TSP service used. |
TSLTSPServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service used. |
TSLTSPServiceName | Contains XML content of name of the TSP service used. |
TSLTSPServiceName[lang] | Contains name for the specified language of the TSP service used. |
TSLTSPServiceQualifiers | Contains list of qualifiers of the TSP service used. |
TSLTSPServiceStatus | Contains status of the TSP service used. |
TSLTSPServiceStatusStartingTime | Contains status starting time of the TSP service used. |
TSLTSPServiceSupplyPoints | Contains XML content of the supply points of the TSP service used. |
TSLTSPServiceTypeIdentifier | Contains type identifier of the TSP service used. |
TSLTSPServiceXML | Contains XML content of the TSP service used. |
TSLTSPTradeName | Contains XML content of trade name of the TSP used. |
TSLTSPTradeName[lang] | Contains trade name for the specified language of the TSP used. |
TSLTSPXML | Contains XML content of the TSP used. |
TSLType | Contains TSL type of the TSL used. |
TSLVersionIdentifier | Contains version identifier of the TSL used. |
TSLXML | Contains XML content of the TSL used. |
UseArchivalTimestampV3 | Whether to apply archival timestamp V3. |
UseDefaultTSLs | Enables or disables the use of the default TSLs. |
UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |