AuthenticodeVerifier Component

Properties   Methods   Events   Config Settings   Errors  

The AuthenticodeVerifier class verifies digital signatures over executable files (EXE) and dynamically linked libraries (DLL).

Syntax

secureblackbox.AuthenticodeVerifier

Remarks

Use this component to verify signatures created over executable files.

Authenticode is a technology widely used in Windows-based ecosystems to provide authenticity of software executables (programs and libraries). The absolute majority of Windows-based software products and components distributed across the world today use the Authenticode digital signing technology to confirm the trustworthiness of their vendors and the integrity of their binaries.

AuthenticodeVerifier provides means for validating the integrity of such signatures. Use it to establish that a binary comes from the origin that it claims to come from, verify that it was not altered in transit, and that the vendor's trustworthiness status is up-to-date. AuthenticodeVerifier verifier = new AuthenticodeVerifier(); // Select the file which contains the executable that is timestamped verifier.setInputFile("signedExecutable.exe"); verifier.verify(); // Verify System.out.println("Validation result: " + verifier.getSignatureValidationResult() + "Signing time: " + verifier.getValidatedSigningTime() + "TSA Certificate: " + verifier.getSigningCertificate().getSubjectRDN()); // Validation result: 0 // 0 == svtValid // Signing time: 2024-05-17 12:37:24 // TSA Certificate: /CN=Test Certificate

See AuthenticodeSigner component if you need to sign binaries with Authenticode.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

ActualChecksumReturns the executable's checksum computed during signature verification.
AllSignaturesValidThe cumulative validity of all signatures.
BlockedCertCountThe number of records in the BlockedCert arrays.
BlockedCertBytesReturns the raw certificate data in DER format.
BlockedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CertCountThe number of records in the Cert arrays.
CertBytesReturns the raw certificate data in DER format.
CertCAIndicates whether the certificate has a CA capability.
CertCAKeyIDA unique identifier (fingerprint) of the CA certificate's cryptographic key.
CertTypeReturns the type of the entity contained in the Certificate object.
CertCRLDistributionPointsContains a list of locations of CRL distribution points used to check this certificate's validity.
CertCurveSpecifies the elliptic curve associated with the certificate's public key.
CertFingerprintContains the fingerprint (a hash imprint) of this certificate.
CertFriendlyNameContains an associated alias (friendly name) of the certificate.
CertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CertHashAlgorithmProvides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
CertIssuerThe common name of the certificate issuer (CA), typically a company name.
CertIssuerRDNA list of Property=Value pairs that uniquely identify the certificate issuer.
CertKeyAlgorithmSpecifies the public key algorithm of this certificate.
CertKeyBitsReturns the length of the public key in bits.
CertKeyFingerprintReturns a SHA1 fingerprint of the public key contained in the certificate.
CertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
CertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
CertOCSPLocationsLocations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
CertOCSPNoCheckAccessor to the value of the certificate's ocsp-no-check extension.
CertOriginReturns the location that the certificate was taken or loaded from.
CertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
CertPrivateKeyBytesReturns the certificate's private key in DER-encoded format.
CertPrivateKeyExistsIndicates whether the certificate has a usable private key associated with it.
CertPrivateKeyExtractableIndicates whether the private key is extractable (exportable).
CertPublicKeyBytesContains the certificate's public key in DER format.
CertQualifiedIndicates whether the certificate is qualified.
CertQualifiedStatementsReturns a simplified qualified status of the certificate.
CertQualifiersA list of qualifiers.
CertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
CertSerialNumberReturns the certificate's serial number.
CertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
CertSourceReturns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
CertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
CertSubjectAlternativeNameReturns or sets the value of the Subject Alternative Name extension of the certificate.
CertSubjectKeyIDContains a unique identifier of the certificate's cryptographic key.
CertSubjectRDNA list of Property=Value pairs that uniquely identify the certificate holder (subject).
CertValidIndicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
CertValidFromThe time point at which the certificate becomes valid, in UTC.
CertValidToThe time point at which the certificate expires, in UTC.
CRLCountThe number of records in the CRL arrays.
CRLBytesReturns the raw CRL data in DER format.
CRLCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
CRLEntryCountReturns the number of certificate status entries in the CRL.
CRLHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CRLIssuerThe common name of the CRL issuer (CA), typically a company name.
CRLIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
CRLLocationThe URL that the CRL was downloaded from.
CRLNextUpdateThe planned time and date of the next version of this CRL to be published.
CRLSigAlgorithmThe public key algorithm that was used by the CA to sign this CRL.
CRLSourceReturns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
CRLTBSThe to-be-signed part of the CRL (the CRL without the signature part).
CRLThisUpdateThe date and time at which this version of the CRL was published.
FIPSModeReserved.
IgnoreChainValidationErrorsMakes the class tolerant to chain validation errors.
InputBytesUse this property to pass the input to class in byte array form.
InputFileA path to the signed executable.
KnownCertCountThe number of records in the KnownCert arrays.
KnownCertBytesReturns the raw certificate data in DER format.
KnownCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownCRLCountThe number of records in the KnownCRL arrays.
KnownCRLBytesReturns the raw CRL data in DER format.
KnownCRLHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownOCSPCountThe number of records in the KnownOCSP arrays.
KnownOCSPBytesA buffer containing the raw OCSP response data.
KnownOCSPHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
OCSPCountThe number of records in the OCSP arrays.
OCSPBytesA buffer containing the raw OCSP response data.
OCSPEntryCountThe number of SingleResponse elements contained in this OCSP response.
OCSPHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
OCSPIssuerIndicates the issuer of this response (a CA or its authorized representative).
OCSPIssuerRDNIndicates the RDN of the issuer of this response (a CA or its authorized representative).
OCSPLocationThe location of the OCSP responder.
OCSPProducedAtSpecifies the time when the response was produced, in UTC.
OCSPSigAlgorithmThe public key algorithm that was used by the CA to sign this OCSP response.
OCSPSourceReturns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
OfflineModeSwitches the class to offline mode.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
ProxyAddressThe IP address of the proxy server.
ProxyAuthenticationThe authentication type used by the proxy server.
ProxyPasswordThe password to authenticate to the proxy server.
ProxyPortThe port on the proxy server to connect to.
ProxyTypeThe type of the proxy server.
ProxyRequestHeadersContains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBodyContains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeadersContains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUsernameSpecifies the username credential for proxy authentication.
RevocationCheckSpecifies the kind(s) of revocation check to perform for all chain certificates.
SigChainValidationDetailsThe details of a certificate chain validation outcome.
SigChainValidationResultThe outcome of a certificate chain validation routine.
SigClaimedSigningTimeReturns the signature's claimed signing time.
SigDescriptionReturns a human-readable signature description.
SigErrorCodeReturns the error code returned by the signature validation routine.
SigErrorMessageReturns the error message returned by the signature validation routine.
SigFileHashAlgorithmReturns the algorithm that was used to hash the executable.
SigHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SigHashAlgorithmReturns the hash algorithm used when generating the signature.
SignatureBytesReturns the binary representation of the inner PKCS7 signature.
SignatureValidationResultThe outcome of the cryptographic signature validation.
SigStatementTypeReturns the signature statement type.
SigURLReturns the URL included in the signature by the signer.
SigValidatedSigningTimeContains the certified signing time.
SigValidationLogContains the signing certificate's chain validation log.
SignedIndicates whether the executable is signed.
SignedAttributeCountThe number of records in the SignedAttribute arrays.
SignedAttributeOIDThe object identifier of the attribute.
SignedAttributeValueThe value of the attribute.
SigningCertBytesReturns the raw certificate data in DER format.
SigningCertCAIndicates whether the certificate has a CA capability.
SigningCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's cryptographic key.
SigningCertCRLDistributionPointsContains a list of locations of CRL distribution points used to check this certificate's validity.
SigningCertCurveSpecifies the elliptic curve associated with the certificate's public key.
SigningCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
SigningCertFriendlyNameContains an associated alias (friendly name) of the certificate.
SigningCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SigningCertHashAlgorithmProvides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
SigningCertIssuerThe common name of the certificate issuer (CA), typically a company name.
SigningCertIssuerRDNA list of Property=Value pairs that uniquely identify the certificate issuer.
SigningCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
SigningCertKeyBitsReturns the length of the public key in bits.
SigningCertKeyFingerprintReturns a SHA1 fingerprint of the public key contained in the certificate.
SigningCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
SigningCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
SigningCertOCSPLocationsLocations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
SigningCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
SigningCertPublicKeyBytesContains the certificate's public key in DER format.
SigningCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
SigningCertSerialNumberReturns the certificate's serial number.
SigningCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
SigningCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
SigningCertSubjectKeyIDContains a unique identifier of the certificate's cryptographic key.
SigningCertSubjectRDNA list of Property=Value pairs that uniquely identify the certificate holder (subject).
SigningCertValidFromThe time point at which the certificate becomes valid, in UTC.
SigningCertValidToThe time point at which the certificate expires, in UTC.
SocketDNSModeSelects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPortSpecifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeoutThe timeout (in milliseconds) for each DNS query.
SocketDNSServersThe addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeoutThe timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimitThe maximum number of bytes to read from the socket, per second.
SocketLocalAddressThe local network interface to bind the socket to.
SocketLocalPortThe local port number to bind the socket to.
SocketOutgoingSpeedLimitThe maximum number of bytes to write to the socket, per second.
SocketTimeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6Enables or disables IP protocol version 6.
SpecifiedChecksumReturns the checksum of the executable.
TimestampAccuracyThis property indicates the accuracy of the included time mark, in microseconds.
TimestampBytesReturns the raw timestamp data in DER format.
TimestampCertificateIndexReturns the index of the TSA certificate in the Certificates collection.
TimestampChainValidationDetailsThe details of a certificate chain validation outcome.
TimestampChainValidationResultThe outcome of a certificate chain validation routine.
TimestampContainsLongTermInfoReturns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
TimestampEntityLabelUse this property to get the timestamp entity label.
TimestampHashAlgorithmReturns the timestamp's hash algorithm.
TimestampParentEntityUse this property to get the label of the timestamp's parent entity.
TimestampSerialNumberReturns the timestamp's serial number.
TimestampTimeThe time point incorporated into the timestamp.
TimestampTypeReturns the type of the timestamp.
TimestampTSANameThis value uniquely identifies the Timestamp Authority (TSA).
TimestampValidationLogContains the TSA certificate chain validation log.
TimestampValidationResultContains the timestamp validation outcome.
TimestampedIndicates whether or not the signature is timestamped.
TLSClientCertCountThe number of records in the TLSClientCert arrays.
TLSClientCertBytesReturns the raw certificate data in DER format.
TLSClientCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertCountThe number of records in the TLSServerCert arrays.
TLSServerCertBytesReturns the raw certificate data in DER format.
TLSServerCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
TLSServerCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertIssuerThe common name of the certificate issuer (CA), typically a company name.
TLSServerCertIssuerRDNA list of Property=Value pairs that uniquely identify the certificate issuer.
TLSServerCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
TLSServerCertKeyBitsReturns the length of the public key in bits.
TLSServerCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
TLSServerCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
TLSServerCertSerialNumberReturns the certificate's serial number.
TLSServerCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
TLSServerCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
TLSServerCertSubjectRDNA list of Property=Value pairs that uniquely identify the certificate holder (subject).
TLSServerCertValidFromThe time point at which the certificate becomes valid, in UTC.
TLSServerCertValidToThe time point at which the certificate expires, in UTC.
TLSAutoValidateCertificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfigurationSelects the base configuration for the TLS settings.
TLSCiphersuitesA list of ciphersuites separated with commas or semicolons.
TLSClientAuthEnables or disables certificate-based client authentication.
TLSExtensionsProvides access to TLS extensions.
TLSForceResumeIfDestinationChangesWhether to force TLS session resumption when the destination address changes.
TLSGroupsSpecifies a list of key exchange groups to attempt during the TLS key exchange.
TLSPreSharedIdentityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKeyContains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionModeSelects the renegotiation attack prevention mechanism.
TLSRevocationCheckSpecifies the kind(s) of revocation check to perform.
TLSSSLOptionsVarious 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.
TLSModeSpecifies the TLS mode to use.
TLSUseExtendedMasterSecretEnables the Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumptionEnables or disables the TLS session resumption capability.
TLSVersionsThe SSL/TLS versions to enable by default.
TrustedCertCountThe number of records in the TrustedCert arrays.
TrustedCertBytesReturns the raw certificate data in DER format.
TrustedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
TSACertBytesReturns the raw certificate data in DER format.
TSACertCAIndicates whether the certificate has a CA capability.
TSACertCAKeyIDA unique identifier (fingerprint) of the CA certificate's cryptographic key.
TSACertCRLDistributionPointsContains a list of locations of CRL distribution points used to check this certificate's validity.
TSACertCurveSpecifies the elliptic curve associated with the certificate's public key.
TSACertFingerprintContains the fingerprint (a hash imprint) of this certificate.
TSACertFriendlyNameContains an associated alias (friendly name) of the certificate.
TSACertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
TSACertHashAlgorithmProvides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
TSACertIssuerThe common name of the certificate issuer (CA), typically a company name.
TSACertIssuerRDNA list of Property=Value pairs that uniquely identify the certificate issuer.
TSACertKeyAlgorithmSpecifies the public key algorithm of this certificate.
TSACertKeyBitsReturns the length of the public key in bits.
TSACertKeyFingerprintReturns a SHA1 fingerprint of the public key contained in the certificate.
TSACertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
TSACertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
TSACertOCSPLocationsLocations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
TSACertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
TSACertPublicKeyBytesContains the certificate's public key in DER format.
TSACertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
TSACertSerialNumberReturns the certificate's serial number.
TSACertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
TSACertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
TSACertSubjectKeyIDContains a unique identifier of the certificate's cryptographic key.
TSACertSubjectRDNA list of Property=Value pairs that uniquely identify the certificate holder (subject).
TSACertValidFromThe time point at which the certificate becomes valid, in UTC.
TSACertValidToThe time point at which the certificate expires, in UTC.
UnsignedAttributeCountThe number of records in the UnsignedAttribute arrays.
UnsignedAttributeOIDThe object identifier of the attribute.
UnsignedAttributeValueThe value of the attribute.
ValidationMomentThe 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.

ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
ResetResets the class settings.
VerifyVerifies a digitally signed executable.

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.

ChainElementDownloadFires when there is a need to download a chain element from an online source.
ChainElementNeededFires when an element required to validate the chain was not located.
ChainValidatedReports the completion of a certificate chain validation.
ChainValidationProgressThis event is fired multiple times during chain validation to report various stages of the validation procedure.
ErrorInformation about errors during ASiC signature verification.
NotificationThis event notifies the application about an underlying control flow event.
SignatureFoundSignifies the start of signature validation.
SignatureValidatedMarks the completion of the signature validation routine.
TimestampFoundSignifies the start of a timestamp validation routine.
TimestampValidatedReports the completion of the timestamp validation routine.
TLSCertNeededFires when a remote TLS party requests a client certificate.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablishedFires when a TLS handshake with Host successfully completes.
TLSHandshakeFires when a new TLS handshake is initiated, before the handshake commences.
TLSShutdownReports 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.

BufferSizeSpecifies buffer size in bytes.
ChainCurrentCACertReturns the current CA certificate.
ChainCurrentCertReturns the certificate that is currently being validated.
ChainCurrentCRLReturns the current CRL.
ChainCurrentCRLSizeReturns the size of the current CRL.
ChainCurrentOCSPReturns the current OCSP response.
ChainCurrentOCSPSignerReturns the signer of the current OCSP object.
ChainInterimDetailsReturns the current interim validation details.
ChainInterimResultReturns the current interim validation result.
CheckValidityPeriodForTrustedWhether to check validity period for trusted certificates.
DelayVerificationSpecifies whether signatures validation should be delayed.
DislikeOpenEndedOCSPsTells the class to discourage OCSP responses without an explicit NextUpdate parameter.
EvaluateSystemTrustEnables or disables usage of the platform's built-in trust validation facilities.
EvaluateSystemTrustForSelfSignedCertificatesEnables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.
EvaluateSystemTrustForSSLEnables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.
ForceCompleteChainValidationWhether to check the CA certificates when the signing certificate is invalid.
ForceCompleteChainValidationForTrustedWhether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
GracePeriodSpecifies a grace period to apply during revocation information checks.
IgnoreChainLoopsWhether chain loops should be ignored.
IgnoreOCSPNoCheckExtensionWhether the OCSP NoCheck extension should be ignored.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
ImplicitlyTrustSelfSignedCertificatesWhether to trust self-signed certificates.
PromoteLongOCSPResponsesWhether long OCSP responses are requested.
SignatureCountReturns the number of signatures in the executable.
TempPathPath for storing temporary files.
TLSChainValidationDetailsContains the advanced details of the TLS server certificate validation.
TLSChainValidationResultContains the result of the TLS server certificate validation.
TLSClientAuthRequestedIndicates whether the TLS server requests client authentication.
TLSValidationLogContains the log of the TLS server certificate validation.
TolerateMinorChainIssuesWhether to tolerate minor chain issues.
UseEnvStoragesEnables or disables use of the environment storages.
UseMicrosoftCTLEnables or disables the automatic use of the Microsoft online certificate trust list.
UseSystemCertificatesEnables or disables the use of the system certificates.
UseValidationCacheEnables or disable the use of the product-wide certificate chain validation cache.
UseValidatorSettingsForTLSValidationWhether to employ the primary chain validator setup for auxiliary TLS chain validations.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
EnableSSHMLKEMEnables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes.
EnableTLSMLKEMEnables support for ML-KEM and hybrid groups in TLS client and server classes.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
PKICacheSpecifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePathSpecifies the file system path where cached PKI data is stored.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCachingSpecifies whether reuse of loaded CRL objects is enabled.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOCSPResponseObjectCachingSpecifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrderSpecifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparatorSpecifies the separator used between descriptors in RDN.

ActualChecksum Property (AuthenticodeVerifier Component)

Returns the executable's checksum computed during signature verification.

Syntax

func (obj *AuthenticodeVerifier) ActualChecksum() (int32, error)

Default Value

0

Remarks

Use this property to get the actual checksum of the executable.

This property is read-only.

Data Type

int32

AllSignaturesValid Property (AuthenticodeVerifier Component)

The cumulative validity of all signatures.

Syntax

func (obj *AuthenticodeVerifier) AllSignaturesValid() (bool, error)

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.

Data Type

bool

BlockedCertCount Property (AuthenticodeVerifier Component)

The number of records in the BlockedCert arrays.

Syntax

func (obj *AuthenticodeVerifier) BlockedCertCount() (int32, error)
func (obj *AuthenticodeVerifier) SetBlockedCertCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at BlockedCertCount - 1.

Data Type

int32

BlockedCertBytes Property (AuthenticodeVerifier Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *AuthenticodeVerifier) BlockedCertBytes(BlockedCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

[]byte

BlockedCertHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) BlockedCertHandle(BlockedCertIndex int32) (int64, error)
func (obj *AuthenticodeVerifier) SetBlockedCertHandle(BlockedCertIndex int32, value int64) error

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

Data Type

int64

CertCount Property (AuthenticodeVerifier Component)

The number of records in the Cert arrays.

Syntax

func (obj *AuthenticodeVerifier) CertCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at CertCount - 1.

This property is read-only.

Data Type

int32

CertBytes Property (AuthenticodeVerifier Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *AuthenticodeVerifier) CertBytes(CertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

[]byte

CertCA Property (AuthenticodeVerifier Component)

Indicates whether the certificate has a CA capability.

Syntax

func (obj *AuthenticodeVerifier) CertCA(CertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

CertCAKeyID Property (AuthenticodeVerifier Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

func (obj *AuthenticodeVerifier) CertCAKeyID(CertIndex int32) ([]byte, error)

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the CertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

[]byte

CertType Property (AuthenticodeVerifier Component)

Returns the type of the entity contained in the Certificate object.

Syntax

func (obj *AuthenticodeVerifier) CertType(CertIndex int32) (int32, error)

Possible Values

0   // Unknown
1 // X509Certificate
2 // X509CertificateRequest

Default Value

0

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager struct to load or create new certificate and certificate requests objects.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

int32

CertCRLDistributionPoints Property (AuthenticodeVerifier Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

func (obj *AuthenticodeVerifier) CertCRLDistributionPoints(CertIndex int32) (string, error)

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertCurve Property (AuthenticodeVerifier Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

func (obj *AuthenticodeVerifier) CertCurve(CertIndex int32) (string, error)

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertFingerprint Property (AuthenticodeVerifier Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

func (obj *AuthenticodeVerifier) CertFingerprint(CertIndex int32) (string, error)

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertFriendlyName Property (AuthenticodeVerifier Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

func (obj *AuthenticodeVerifier) CertFriendlyName(CertIndex int32) (string, error)

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) CertHandle(CertIndex int32) (int64, error)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

int64

CertHashAlgorithm Property (AuthenticodeVerifier Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

func (obj *AuthenticodeVerifier) CertHashAlgorithm(CertIndex int32) (string, error)

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use CertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertIssuer Property (AuthenticodeVerifier Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

func (obj *AuthenticodeVerifier) CertIssuer(CertIndex int32) (string, error)

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via CertIssuerRDN.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertIssuerRDN Property (AuthenticodeVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *AuthenticodeVerifier) CertIssuerRDN(CertIndex int32) (string, error)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertKeyAlgorithm Property (AuthenticodeVerifier Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *AuthenticodeVerifier) CertKeyAlgorithm(CertIndex int32) (string, error)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig
SB_CERT_ALGORITHM_MLDSA_44id-ml-dsa-44
SB_CERT_ALGORITHM_MLDSA_65id-ml-dsa-65
SB_CERT_ALGORITHM_MLDSA_87id-ml-dsa-87
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512id-hash-ml-dsa-44-with-sha512
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512id-hash-ml-dsa-65-with-sha512
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512id-hash-ml-dsa-87-with-sha512
SB_CERT_ALGORITHM_MLKEM_512id-ml-kem-512
SB_CERT_ALGORITHM_MLKEM_768id-ml-kem-768
SB_CERT_ALGORITHM_MLKEM_1024id-ml-kem-1024

Use the CertKeyBits, CertCurve, and CertPublicKeyBytes properties to get more details about the key the certificate contains.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertKeyBits Property (AuthenticodeVerifier Component)

Returns the length of the public key in bits.

Syntax

func (obj *AuthenticodeVerifier) CertKeyBits(CertIndex int32) (int32, error)

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the CertPublicKeyBytes or CertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

int32

CertKeyFingerprint Property (AuthenticodeVerifier Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

func (obj *AuthenticodeVerifier) CertKeyFingerprint(CertIndex int32) (string, error)

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the CertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertKeyUsage Property (AuthenticodeVerifier Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

func (obj *AuthenticodeVerifier) CertKeyUsage(CertIndex int32) (int32, error)

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

int32

CertKeyValid Property (AuthenticodeVerifier Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

func (obj *AuthenticodeVerifier) CertKeyValid(CertIndex int32) (bool, error)

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

CertOCSPLocations Property (AuthenticodeVerifier Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

func (obj *AuthenticodeVerifier) CertOCSPLocations(CertIndex int32) (string, error)

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertOCSPNoCheck Property (AuthenticodeVerifier Component)

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

func (obj *AuthenticodeVerifier) CertOCSPNoCheck(CertIndex int32) (bool, error)

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

CertOrigin Property (AuthenticodeVerifier Component)

Returns the location that the certificate was taken or loaded from.

Syntax

func (obj *AuthenticodeVerifier) CertOrigin(CertIndex int32) (int32, error)

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

int32

CertPolicyIDs Property (AuthenticodeVerifier Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

func (obj *AuthenticodeVerifier) CertPolicyIDs(CertIndex int32) (string, error)

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertPrivateKeyBytes Property (AuthenticodeVerifier Component)

Returns the certificate's private key in DER-encoded format.

Syntax

func (obj *AuthenticodeVerifier) CertPrivateKeyBytes(CertIndex int32) ([]byte, error)

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

[]byte

CertPrivateKeyExists Property (AuthenticodeVerifier Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

func (obj *AuthenticodeVerifier) CertPrivateKeyExists(CertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from CertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

CertPrivateKeyExtractable Property (AuthenticodeVerifier Component)

Indicates whether the private key is extractable (exportable).

Syntax

func (obj *AuthenticodeVerifier) CertPrivateKeyExtractable(CertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

CertPublicKeyBytes Property (AuthenticodeVerifier Component)

Contains the certificate's public key in DER format.

Syntax

func (obj *AuthenticodeVerifier) CertPublicKeyBytes(CertIndex int32) ([]byte, error)

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

[]byte

CertQualified Property (AuthenticodeVerifier Component)

Indicates whether the certificate is qualified.

Syntax

func (obj *AuthenticodeVerifier) CertQualified(CertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

CertQualifiedStatements Property (AuthenticodeVerifier Component)

Returns a simplified qualified status of the certificate.

Syntax

func (obj *AuthenticodeVerifier) CertQualifiedStatements(CertIndex int32) (int32, error)

Possible Values

0   // NonQualified
1 // QualifiedHardware
2 // QualifiedSoftware

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

int32

CertQualifiers Property (AuthenticodeVerifier Component)

A list of qualifiers.

Syntax

func (obj *AuthenticodeVerifier) CertQualifiers(CertIndex int32) (string, error)

Default Value

""

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertSelfSigned Property (AuthenticodeVerifier Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

func (obj *AuthenticodeVerifier) CertSelfSigned(CertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

CertSerialNumber Property (AuthenticodeVerifier Component)

Returns the certificate's serial number.

Syntax

func (obj *AuthenticodeVerifier) CertSerialNumber(CertIndex int32) ([]byte, error)

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

[]byte

CertSigAlgorithm Property (AuthenticodeVerifier Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

func (obj *AuthenticodeVerifier) CertSigAlgorithm(CertIndex int32) (string, error)

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertSource Property (AuthenticodeVerifier Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *AuthenticodeVerifier) CertSource(CertIndex int32) (int32, error)

Possible Values

0   // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

int32

CertSubject Property (AuthenticodeVerifier Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

func (obj *AuthenticodeVerifier) CertSubject(CertIndex int32) (string, error)

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via CertSubjectRDN.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertSubjectAlternativeName Property (AuthenticodeVerifier Component)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

func (obj *AuthenticodeVerifier) CertSubjectAlternativeName(CertIndex int32) (string, error)

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main CertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertSubjectKeyID Property (AuthenticodeVerifier Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

func (obj *AuthenticodeVerifier) CertSubjectKeyID(CertIndex int32) ([]byte, error)

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The CertSubjectKeyID and CertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

[]byte

CertSubjectRDN Property (AuthenticodeVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *AuthenticodeVerifier) CertSubjectRDN(CertIndex int32) (string, error)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertValid Property (AuthenticodeVerifier Component)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

func (obj *AuthenticodeVerifier) CertValid(CertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

CertValidFrom Property (AuthenticodeVerifier Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

func (obj *AuthenticodeVerifier) CertValidFrom(CertIndex int32) (string, error)

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CertValidTo Property (AuthenticodeVerifier Component)

The time point at which the certificate expires, in UTC.

Syntax

func (obj *AuthenticodeVerifier) CertValidTo(CertIndex int32) (string, error)

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

string

CRLCount Property (AuthenticodeVerifier Component)

The number of records in the CRL arrays.

Syntax

func (obj *AuthenticodeVerifier) CRLCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at CRLCount - 1.

This property is read-only.

Data Type

int32

CRLBytes Property (AuthenticodeVerifier Component)

Returns the raw CRL data in DER format.

Syntax

func (obj *AuthenticodeVerifier) CRLBytes(CRLIndex int32) ([]byte, error)

Remarks

Returns the raw CRL data in DER format.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

[]byte

CRLCAKeyID Property (AuthenticodeVerifier Component)

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

Syntax

func (obj *AuthenticodeVerifier) CRLCAKeyID(CRLIndex int32) ([]byte, error)

Remarks

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

[]byte

CRLEntryCount Property (AuthenticodeVerifier Component)

Returns the number of certificate status entries in the CRL.

Syntax

func (obj *AuthenticodeVerifier) CRLEntryCount(CRLIndex int32) (int32, error)

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

int32

CRLHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) CRLHandle(CRLIndex int32) (int64, error)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

int64

CRLIssuer Property (AuthenticodeVerifier Component)

The common name of the CRL issuer (CA), typically a company name.

Syntax

func (obj *AuthenticodeVerifier) CRLIssuer(CRLIndex int32) (string, error)

Default Value

""

Remarks

The common name of the CRL issuer (CA), typically a company name.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

string

CRLIssuerRDN Property (AuthenticodeVerifier Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

Syntax

func (obj *AuthenticodeVerifier) CRLIssuerRDN(CRLIndex int32) (string, error)

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

string

CRLLocation Property (AuthenticodeVerifier Component)

The URL that the CRL was downloaded from.

Syntax

func (obj *AuthenticodeVerifier) CRLLocation(CRLIndex int32) (string, error)

Default Value

""

Remarks

The URL that the CRL was downloaded from.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

string

CRLNextUpdate Property (AuthenticodeVerifier Component)

The planned time and date of the next version of this CRL to be published.

Syntax

func (obj *AuthenticodeVerifier) CRLNextUpdate(CRLIndex int32) (string, error)

Default Value

""

Remarks

The planned time and date of the next version of this CRL to be published.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

string

CRLSigAlgorithm Property (AuthenticodeVerifier Component)

The public key algorithm that was used by the CA to sign this CRL.

Syntax

func (obj *AuthenticodeVerifier) CRLSigAlgorithm(CRLIndex int32) (string, error)

Default Value

"0"

Remarks

The public key algorithm that was used by the CA to sign this CRL.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

string

CRLSource Property (AuthenticodeVerifier Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *AuthenticodeVerifier) CRLSource(CRLIndex int32) (int32, error)

Possible Values

0   // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

int32

CRLTBS Property (AuthenticodeVerifier Component)

The to-be-signed part of the CRL (the CRL without the signature part).

Syntax

func (obj *AuthenticodeVerifier) CRLTBS(CRLIndex int32) ([]byte, error)

Remarks

The to-be-signed part of the CRL (the CRL without the signature part).

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

[]byte

CRLThisUpdate Property (AuthenticodeVerifier Component)

The date and time at which this version of the CRL was published.

Syntax

func (obj *AuthenticodeVerifier) CRLThisUpdate(CRLIndex int32) (string, error)

Default Value

""

Remarks

The date and time at which this version of the CRL was published.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

string

FIPSMode Property (AuthenticodeVerifier Component)

Reserved.

Syntax

func (obj *AuthenticodeVerifier) FIPSMode() (bool, error)
func (obj *AuthenticodeVerifier) SetFIPSMode(value bool) error

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

IgnoreChainValidationErrors Property (AuthenticodeVerifier Component)

Makes the class tolerant to chain validation errors.

Syntax

func (obj *AuthenticodeVerifier) IgnoreChainValidationErrors() (bool, error)
func (obj *AuthenticodeVerifier) SetIgnoreChainValidationErrors(value bool) error

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.

Data Type

bool

InputBytes Property (AuthenticodeVerifier Component)

Use this property to pass the input to class in byte array form.

Syntax

func (obj *AuthenticodeVerifier) InputBytes() ([]byte, error)
func (obj *AuthenticodeVerifier) SetInputBytes(value []byte) error

Remarks

Assign a byte array containing the data to be processed to this property.

Data Type

[]byte

InputFile Property (AuthenticodeVerifier Component)

A path to the signed executable.

Syntax

func (obj *AuthenticodeVerifier) InputFile() (string, error)
func (obj *AuthenticodeVerifier) SetInputFile(value string) error

Default Value

""

Remarks

A path to the file containing the signed executable. The input can alternatively be provided via InputStream.

Data Type

string

KnownCertCount Property (AuthenticodeVerifier Component)

The number of records in the KnownCert arrays.

Syntax

func (obj *AuthenticodeVerifier) KnownCertCount() (int32, error)
func (obj *AuthenticodeVerifier) SetKnownCertCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at KnownCertCount - 1.

Data Type

int32

KnownCertBytes Property (AuthenticodeVerifier Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *AuthenticodeVerifier) KnownCertBytes(KnownCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

[]byte

KnownCertHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) KnownCertHandle(KnownCertIndex int32) (int64, error)
func (obj *AuthenticodeVerifier) SetKnownCertHandle(KnownCertIndex int32, value int64) error

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

int64

KnownCRLCount Property (AuthenticodeVerifier Component)

The number of records in the KnownCRL arrays.

Syntax

func (obj *AuthenticodeVerifier) KnownCRLCount() (int32, error)
func (obj *AuthenticodeVerifier) SetKnownCRLCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at KnownCRLCount - 1.

Data Type

int32

KnownCRLBytes Property (AuthenticodeVerifier Component)

Returns the raw CRL data in DER format.

Syntax

func (obj *AuthenticodeVerifier) KnownCRLBytes(KnownCRLIndex int32) ([]byte, error)

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only.

Data Type

[]byte

KnownCRLHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) KnownCRLHandle(KnownCRLIndex int32) (int64, error)
func (obj *AuthenticodeVerifier) SetKnownCRLHandle(KnownCRLIndex int32, value int64) error

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

Data Type

int64

KnownOCSPCount Property (AuthenticodeVerifier Component)

The number of records in the KnownOCSP arrays.

Syntax

func (obj *AuthenticodeVerifier) KnownOCSPCount() (int32, error)
func (obj *AuthenticodeVerifier) SetKnownOCSPCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at KnownOCSPCount - 1.

Data Type

int32

KnownOCSPBytes Property (AuthenticodeVerifier Component)

A buffer containing the raw OCSP response data.

Syntax

func (obj *AuthenticodeVerifier) KnownOCSPBytes(KnownOCSPIndex int32) ([]byte, error)

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only.

Data Type

[]byte

KnownOCSPHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) KnownOCSPHandle(KnownOCSPIndex int32) (int64, error)
func (obj *AuthenticodeVerifier) SetKnownOCSPHandle(KnownOCSPIndex int32, value int64) error

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

Data Type

int64

OCSPCount Property (AuthenticodeVerifier Component)

The number of records in the OCSP arrays.

Syntax

func (obj *AuthenticodeVerifier) OCSPCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at OCSPCount - 1.

This property is read-only.

Data Type

int32

OCSPBytes Property (AuthenticodeVerifier Component)

A buffer containing the raw OCSP response data.

Syntax

func (obj *AuthenticodeVerifier) OCSPBytes(OCSPIndex int32) ([]byte, error)

Remarks

A buffer containing the raw OCSP response data.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

[]byte

OCSPEntryCount Property (AuthenticodeVerifier Component)

The number of SingleResponse elements contained in this OCSP response.

Syntax

func (obj *AuthenticodeVerifier) OCSPEntryCount(OCSPIndex int32) (int32, error)

Default Value

0

Remarks

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

int32

OCSPHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) OCSPHandle(OCSPIndex int32) (int64, error)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

int64

OCSPIssuer Property (AuthenticodeVerifier Component)

Indicates the issuer of this response (a CA or its authorized representative).

Syntax

func (obj *AuthenticodeVerifier) OCSPIssuer(OCSPIndex int32) (string, error)

Default Value

""

Remarks

Indicates the issuer of this response (a CA or its authorized representative).

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

string

OCSPIssuerRDN Property (AuthenticodeVerifier Component)

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

Syntax

func (obj *AuthenticodeVerifier) OCSPIssuerRDN(OCSPIndex int32) (string, error)

Default Value

""

Remarks

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

string

OCSPLocation Property (AuthenticodeVerifier Component)

The location of the OCSP responder.

Syntax

func (obj *AuthenticodeVerifier) OCSPLocation(OCSPIndex int32) (string, error)

Default Value

""

Remarks

The location of the OCSP responder.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

string

OCSPProducedAt Property (AuthenticodeVerifier Component)

Specifies the time when the response was produced, in UTC.

Syntax

func (obj *AuthenticodeVerifier) OCSPProducedAt(OCSPIndex int32) (string, error)

Default Value

""

Remarks

Specifies the time when the response was produced, in UTC.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

string

OCSPSigAlgorithm Property (AuthenticodeVerifier Component)

The public key algorithm that was used by the CA to sign this OCSP response.

Syntax

func (obj *AuthenticodeVerifier) OCSPSigAlgorithm(OCSPIndex int32) (string, error)

Default Value

"0"

Remarks

The public key algorithm that was used by the CA to sign this OCSP response.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

string

OCSPSource Property (AuthenticodeVerifier Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *AuthenticodeVerifier) OCSPSource(OCSPIndex int32) (int32, error)

Possible Values

0   // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

int32

OfflineMode Property (AuthenticodeVerifier Component)

Switches the class to offline mode.

Syntax

func (obj *AuthenticodeVerifier) OfflineMode() (bool, error)
func (obj *AuthenticodeVerifier) SetOfflineMode(value bool) error

Default Value

false

Remarks

When working in offline mode, the struct 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, KnownCRLs, and other related properties.

Data Type

bool

Profile Property (AuthenticodeVerifier Component)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

func (obj *AuthenticodeVerifier) Profile() (string, error)
func (obj *AuthenticodeVerifier) SetProfile(value string) error

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.

Data Type

string

ProxyAddress Property (AuthenticodeVerifier Component)

The IP address of the proxy server.

Syntax

func (obj *AuthenticodeVerifier) ProxyAddress() (string, error)
func (obj *AuthenticodeVerifier) SetProxyAddress(value string) error

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

string

ProxyAuthentication Property (AuthenticodeVerifier Component)

The authentication type used by the proxy server.

Syntax

func (obj *AuthenticodeVerifier) ProxyAuthentication() (int32, error)
func (obj *AuthenticodeVerifier) SetProxyAuthentication(value int32) error

Possible Values

0   // NoAuthentication
1 // Basic
2 // Digest
3 // NTLM

Default Value

0

Remarks

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

Data Type

int32

ProxyPassword Property (AuthenticodeVerifier Component)

The password to authenticate to the proxy server.

Syntax

func (obj *AuthenticodeVerifier) ProxyPassword() (string, error)
func (obj *AuthenticodeVerifier) SetProxyPassword(value string) error

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

string

ProxyPort Property (AuthenticodeVerifier Component)

The port on the proxy server to connect to.

Syntax

func (obj *AuthenticodeVerifier) ProxyPort() (int32, error)
func (obj *AuthenticodeVerifier) SetProxyPort(value int32) error

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

int32

ProxyType Property (AuthenticodeVerifier Component)

The type of the proxy server.

Syntax

func (obj *AuthenticodeVerifier) ProxyType() (int32, error)
func (obj *AuthenticodeVerifier) SetProxyType(value int32) error

Possible Values

0   // None
1 // Socks4
2 // Socks5
3 // WebTunnel
4 // HTTP

Default Value

0

Remarks

The type of the proxy server.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

Data Type

int32

ProxyRequestHeaders Property (AuthenticodeVerifier Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

func (obj *AuthenticodeVerifier) ProxyRequestHeaders() (string, error)
func (obj *AuthenticodeVerifier) SetProxyRequestHeaders(value string) error

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

string

ProxyResponseBody Property (AuthenticodeVerifier Component)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

func (obj *AuthenticodeVerifier) ProxyResponseBody() (string, error)
func (obj *AuthenticodeVerifier) SetProxyResponseBody(value string) error

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

string

ProxyResponseHeaders Property (AuthenticodeVerifier Component)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

func (obj *AuthenticodeVerifier) ProxyResponseHeaders() (string, error)
func (obj *AuthenticodeVerifier) SetProxyResponseHeaders(value string) error

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

string

ProxyUseIPv6 Property (AuthenticodeVerifier Component)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

func (obj *AuthenticodeVerifier) ProxyUseIPv6() (bool, error)
func (obj *AuthenticodeVerifier) SetProxyUseIPv6(value bool) error

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

bool

ProxyUsername Property (AuthenticodeVerifier Component)

Specifies the username credential for proxy authentication.

Syntax

func (obj *AuthenticodeVerifier) ProxyUsername() (string, error)
func (obj *AuthenticodeVerifier) SetProxyUsername(value string) error

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

string

RevocationCheck Property (AuthenticodeVerifier Component)

Specifies the kind(s) of revocation check to perform for all chain certificates.

Syntax

func (obj *AuthenticodeVerifier) RevocationCheck() (int32, error)
func (obj *AuthenticodeVerifier) SetRevocationCheck(value int32) error

Possible Values

0   // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL

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.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All 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.

Data Type

int32

SigChainValidationDetails Property (AuthenticodeVerifier Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *AuthenticodeVerifier) SigChainValidationDetails() (int32, error)

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

This property is read-only.

Data Type

int32

SigChainValidationResult Property (AuthenticodeVerifier Component)

The outcome of a certificate chain validation routine.

Syntax

func (obj *AuthenticodeVerifier) SigChainValidationResult() (int32, error)

Possible Values

0   // Valid
1 // ValidButUntrusted
2 // Invalid
3 // CantBeEstablished

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

int32

SigClaimedSigningTime Property (AuthenticodeVerifier Component)

Returns the signature's claimed signing time.

Syntax

func (obj *AuthenticodeVerifier) SigClaimedSigningTime() (string, error)

Default Value

""

Remarks

Returns the signature's claimed signing time.

Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by a trusted timestamp and may be forfeited or wrong. Use SigValidatedSigningTime to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.

This property is read-only.

Data Type

string

SigDescription Property (AuthenticodeVerifier Component)

Returns a human-readable signature description.

Syntax

func (obj *AuthenticodeVerifier) SigDescription() (string, error)

Default Value

""

Remarks

Returns a human-readable signature description.

This property is read-only.

Data Type

string

SigErrorCode Property (AuthenticodeVerifier Component)

Returns the error code returned by the signature validation routine.

Syntax

func (obj *AuthenticodeVerifier) SigErrorCode() (int32, error)

Default Value

0

Remarks

Returns the error code returned by the signature validation routine.

This property is read-only.

Data Type

int32

SigErrorMessage Property (AuthenticodeVerifier Component)

Returns the error message returned by the signature validation routine.

Syntax

func (obj *AuthenticodeVerifier) SigErrorMessage() (string, error)

Default Value

""

Remarks

Returns the error message returned by the signature validation routine.

This property is read-only.

Data Type

string

SigFileHashAlgorithm Property (AuthenticodeVerifier Component)

Returns the algorithm that was used to hash the executable.

Syntax

func (obj *AuthenticodeVerifier) SigFileHashAlgorithm() (string, error)

Default Value

""

Remarks

Returns the algorithm that was used to hash the executable.

SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512

This property is read-only.

Data Type

string

SigHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) SigHandle() (int64, error)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is read-only.

Data Type

int64

SigHashAlgorithm Property (AuthenticodeVerifier Component)

Returns the hash algorithm used when generating the signature.

Syntax

func (obj *AuthenticodeVerifier) SigHashAlgorithm() (string, error)

Default Value

""

Remarks

Returns the hash algorithm used when generating the signature.

SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512

This property is read-only.

Data Type

string

SignatureBytes Property (AuthenticodeVerifier Component)

Returns the binary representation of the inner PKCS7 signature.

Syntax

func (obj *AuthenticodeVerifier) SignatureBytes() ([]byte, error)

Remarks

Returns the binary representation of the inner PKCS7 signature.

This property is read-only.

Data Type

[]byte

SignatureValidationResult Property (AuthenticodeVerifier Component)

The outcome of the cryptographic signature validation.

Syntax

func (obj *AuthenticodeVerifier) SignatureValidationResult() (int32, error)

Possible Values

0   // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

This property is read-only.

Data Type

int32

SigStatementType Property (AuthenticodeVerifier Component)

Returns the signature statement type.

Syntax

func (obj *AuthenticodeVerifier) SigStatementType() (int32, error)

Possible Values

0   // Unknown
1 // Individual
2 // Commercial

Default Value

0

Remarks

Returns the signature statement type.

Available options:

acsUnknown0
acsIndividual1
acsCommercial2

This property is read-only.

Data Type

int32

SigURL Property (AuthenticodeVerifier Component)

Returns the URL included in the signature by the signer.

Syntax

func (obj *AuthenticodeVerifier) SigURL() (string, error)

Default Value

""

Remarks

Returns the URL included in the signature by the signer.

This property is read-only.

Data Type

string

SigValidatedSigningTime Property (AuthenticodeVerifier Component)

Contains the certified signing time.

Syntax

func (obj *AuthenticodeVerifier) SigValidatedSigningTime() (string, error)

Default Value

""

Remarks

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.

SigClaimedSigningTime returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

This property is read-only.

Data Type

string

SigValidationLog Property (AuthenticodeVerifier Component)

Contains the signing certificate's chain validation log.

Syntax

func (obj *AuthenticodeVerifier) SigValidationLog() (string, error)

Default Value

""

Remarks

Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only.

Data Type

string

Signed Property (AuthenticodeVerifier Component)

Indicates whether the executable is signed.

Syntax

func (obj *AuthenticodeVerifier) Signed() (bool, error)

Default Value

false

Remarks

Check this property after calling Verify to find out whether or not the provided executable is signed.

This property is read-only.

Data Type

bool

SignedAttributeCount Property (AuthenticodeVerifier Component)

The number of records in the SignedAttribute arrays.

Syntax

func (obj *AuthenticodeVerifier) SignedAttributeCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SignedAttributeCount - 1.

This property is read-only.

Data Type

int32

SignedAttributeOID Property (AuthenticodeVerifier Component)

The object identifier of the attribute.

Syntax

func (obj *AuthenticodeVerifier) SignedAttributeOID(SignedAttributeIndex int32) (string, error)

Default Value

""

Remarks

The object identifier of the attribute.

The SignedAttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignedAttributeCount property.

This property is read-only.

Data Type

string

SignedAttributeValue Property (AuthenticodeVerifier Component)

The value of the attribute.

Syntax

func (obj *AuthenticodeVerifier) SignedAttributeValue(SignedAttributeIndex int32) ([]byte, error)

Remarks

The value of the attribute.

The SignedAttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignedAttributeCount property.

This property is read-only.

Data Type

[]byte

SigningCertBytes Property (AuthenticodeVerifier Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *AuthenticodeVerifier) SigningCertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

SigningCertCA Property (AuthenticodeVerifier Component)

Indicates whether the certificate has a CA capability.

Syntax

func (obj *AuthenticodeVerifier) SigningCertCA() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

This property is read-only.

Data Type

bool

SigningCertCAKeyID Property (AuthenticodeVerifier Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

func (obj *AuthenticodeVerifier) SigningCertCAKeyID() ([]byte, error)

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SigningCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

Data Type

[]byte

SigningCertCRLDistributionPoints Property (AuthenticodeVerifier Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

func (obj *AuthenticodeVerifier) SigningCertCRLDistributionPoints() (string, error)

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is read-only.

Data Type

string

SigningCertCurve Property (AuthenticodeVerifier Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

func (obj *AuthenticodeVerifier) SigningCertCurve() (string, error)

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

This property is read-only.

Data Type

string

SigningCertFingerprint Property (AuthenticodeVerifier Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

func (obj *AuthenticodeVerifier) SigningCertFingerprint() (string, error)

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

This property is read-only.

Data Type

string

SigningCertFriendlyName Property (AuthenticodeVerifier Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

func (obj *AuthenticodeVerifier) SigningCertFriendlyName() (string, error)

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

This property is read-only.

Data Type

string

SigningCertHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) SigningCertHandle() (int64, error)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is read-only.

Data Type

int64

SigningCertHashAlgorithm Property (AuthenticodeVerifier Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

func (obj *AuthenticodeVerifier) SigningCertHashAlgorithm() (string, error)

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigningCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

This property is read-only.

Data Type

string

SigningCertIssuer Property (AuthenticodeVerifier Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

func (obj *AuthenticodeVerifier) SigningCertIssuer() (string, error)

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via SigningCertIssuerRDN.

This property is read-only.

Data Type

string

SigningCertIssuerRDN Property (AuthenticodeVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *AuthenticodeVerifier) SigningCertIssuerRDN() (string, error)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

This property is read-only.

Data Type

string

SigningCertKeyAlgorithm Property (AuthenticodeVerifier Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *AuthenticodeVerifier) SigningCertKeyAlgorithm() (string, error)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig
SB_CERT_ALGORITHM_MLDSA_44id-ml-dsa-44
SB_CERT_ALGORITHM_MLDSA_65id-ml-dsa-65
SB_CERT_ALGORITHM_MLDSA_87id-ml-dsa-87
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512id-hash-ml-dsa-44-with-sha512
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512id-hash-ml-dsa-65-with-sha512
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512id-hash-ml-dsa-87-with-sha512
SB_CERT_ALGORITHM_MLKEM_512id-ml-kem-512
SB_CERT_ALGORITHM_MLKEM_768id-ml-kem-768
SB_CERT_ALGORITHM_MLKEM_1024id-ml-kem-1024

Use the SigningCertKeyBits, SigningCertCurve, and SigningCertPublicKeyBytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

string

SigningCertKeyBits Property (AuthenticodeVerifier Component)

Returns the length of the public key in bits.

Syntax

func (obj *AuthenticodeVerifier) SigningCertKeyBits() (int32, error)

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the SigningCertPublicKeyBytes or SigningCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

Data Type

int32

SigningCertKeyFingerprint Property (AuthenticodeVerifier Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

func (obj *AuthenticodeVerifier) SigningCertKeyFingerprint() (string, error)

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the SigningCertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

Data Type

string

SigningCertKeyUsage Property (AuthenticodeVerifier Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

func (obj *AuthenticodeVerifier) SigningCertKeyUsage() (int32, error)

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

This property is read-only.

Data Type

int32

SigningCertKeyValid Property (AuthenticodeVerifier Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

func (obj *AuthenticodeVerifier) SigningCertKeyValid() (bool, error)

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

This property is read-only.

Data Type

bool

SigningCertOCSPLocations Property (AuthenticodeVerifier Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

func (obj *AuthenticodeVerifier) SigningCertOCSPLocations() (string, error)

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate 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.

This property is read-only.

Data Type

string

SigningCertPolicyIDs Property (AuthenticodeVerifier Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

func (obj *AuthenticodeVerifier) SigningCertPolicyIDs() (string, error)

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

This property is read-only.

Data Type

string

SigningCertPublicKeyBytes Property (AuthenticodeVerifier Component)

Contains the certificate's public key in DER format.

Syntax

func (obj *AuthenticodeVerifier) SigningCertPublicKeyBytes() ([]byte, error)

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

This property is read-only.

Data Type

[]byte

SigningCertSelfSigned Property (AuthenticodeVerifier Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

func (obj *AuthenticodeVerifier) SigningCertSelfSigned() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

This property is read-only.

Data Type

bool

SigningCertSerialNumber Property (AuthenticodeVerifier Component)

Returns the certificate's serial number.

Syntax

func (obj *AuthenticodeVerifier) SigningCertSerialNumber() ([]byte, error)

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

This property is read-only.

Data Type

[]byte

SigningCertSigAlgorithm Property (AuthenticodeVerifier Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

func (obj *AuthenticodeVerifier) SigningCertSigAlgorithm() (string, error)

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

This property is read-only.

Data Type

string

SigningCertSubject Property (AuthenticodeVerifier Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

func (obj *AuthenticodeVerifier) SigningCertSubject() (string, error)

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SigningCertSubjectRDN.

This property is read-only.

Data Type

string

SigningCertSubjectKeyID Property (AuthenticodeVerifier Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

func (obj *AuthenticodeVerifier) SigningCertSubjectKeyID() ([]byte, error)

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The SigningCertSubjectKeyID and SigningCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only.

Data Type

[]byte

SigningCertSubjectRDN Property (AuthenticodeVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *AuthenticodeVerifier) SigningCertSubjectRDN() (string, error)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

This property is read-only.

Data Type

string

SigningCertValidFrom Property (AuthenticodeVerifier Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

func (obj *AuthenticodeVerifier) SigningCertValidFrom() (string, error)

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is read-only.

Data Type

string

SigningCertValidTo Property (AuthenticodeVerifier Component)

The time point at which the certificate expires, in UTC.

Syntax

func (obj *AuthenticodeVerifier) SigningCertValidTo() (string, error)

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only.

Data Type

string

SocketDNSMode Property (AuthenticodeVerifier Component)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Syntax

func (obj *AuthenticodeVerifier) SocketDNSMode() (int32, error)
func (obj *AuthenticodeVerifier) SetSocketDNSMode(value int32) error

Possible Values

0   // Auto
1 // Platform
2 // Own
3 // OwnSecure

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

Data Type

int32

SocketDNSPort Property (AuthenticodeVerifier Component)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

func (obj *AuthenticodeVerifier) SocketDNSPort() (int32, error)
func (obj *AuthenticodeVerifier) SetSocketDNSPort(value int32) error

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

int32

SocketDNSQueryTimeout Property (AuthenticodeVerifier Component)

The timeout (in milliseconds) for each DNS query.

Syntax

func (obj *AuthenticodeVerifier) SocketDNSQueryTimeout() (int32, error)
func (obj *AuthenticodeVerifier) SetSocketDNSQueryTimeout(value int32) error

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

int32

SocketDNSServers Property (AuthenticodeVerifier Component)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

func (obj *AuthenticodeVerifier) SocketDNSServers() (string, error)
func (obj *AuthenticodeVerifier) SetSocketDNSServers(value string) error

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

string

SocketDNSTotalTimeout Property (AuthenticodeVerifier Component)

The timeout (in milliseconds) for the whole resolution process.

Syntax

func (obj *AuthenticodeVerifier) SocketDNSTotalTimeout() (int32, error)
func (obj *AuthenticodeVerifier) SetSocketDNSTotalTimeout(value int32) error

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

int32

SocketIncomingSpeedLimit Property (AuthenticodeVerifier Component)

The maximum number of bytes to read from the socket, per second.

Syntax

func (obj *AuthenticodeVerifier) SocketIncomingSpeedLimit() (int32, error)
func (obj *AuthenticodeVerifier) SetSocketIncomingSpeedLimit(value int32) error

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

int32

SocketLocalAddress Property (AuthenticodeVerifier Component)

The local network interface to bind the socket to.

Syntax

func (obj *AuthenticodeVerifier) SocketLocalAddress() (string, error)
func (obj *AuthenticodeVerifier) SetSocketLocalAddress(value string) error

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

string

SocketLocalPort Property (AuthenticodeVerifier Component)

The local port number to bind the socket to.

Syntax

func (obj *AuthenticodeVerifier) SocketLocalPort() (int32, error)
func (obj *AuthenticodeVerifier) SetSocketLocalPort(value int32) error

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

int32

SocketOutgoingSpeedLimit Property (AuthenticodeVerifier Component)

The maximum number of bytes to write to the socket, per second.

Syntax

func (obj *AuthenticodeVerifier) SocketOutgoingSpeedLimit() (int32, error)
func (obj *AuthenticodeVerifier) SetSocketOutgoingSpeedLimit(value int32) error

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

int32

SocketTimeout Property (AuthenticodeVerifier Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

func (obj *AuthenticodeVerifier) SocketTimeout() (int32, error)
func (obj *AuthenticodeVerifier) SetSocketTimeout(value int32) error

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

int32

SocketUseIPv6 Property (AuthenticodeVerifier Component)

Enables or disables IP protocol version 6.

Syntax

func (obj *AuthenticodeVerifier) SocketUseIPv6() (bool, error)
func (obj *AuthenticodeVerifier) SetSocketUseIPv6(value bool) error

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

SpecifiedChecksum Property (AuthenticodeVerifier Component)

Returns the checksum of the executable.

Syntax

func (obj *AuthenticodeVerifier) SpecifiedChecksum() (int32, error)

Default Value

0

Remarks

Use this property to get the checksum of the executable as included by the signer.

This property is read-only.

Data Type

int32

TimestampAccuracy Property (AuthenticodeVerifier Component)

This property indicates the accuracy of the included time mark, in microseconds.

Syntax

func (obj *AuthenticodeVerifier) TimestampAccuracy() (int64, error)

Default Value

0

Remarks

This field indicates the accuracy of the included time mark, in microseconds.

This property is read-only.

Data Type

int64

TimestampBytes Property (AuthenticodeVerifier Component)

Returns the raw timestamp data in DER format.

Syntax

func (obj *AuthenticodeVerifier) TimestampBytes() ([]byte, error)

Remarks

Returns the raw timestamp data in DER format.

This property is read-only.

Data Type

[]byte

TimestampCertificateIndex Property (AuthenticodeVerifier Component)

Returns the index of the TSA certificate in the Certificates collection.

Syntax

func (obj *AuthenticodeVerifier) TimestampCertificateIndex() (int32, error)

Default Value

-1

Remarks

Returns the index of the TSA certificate in the Certificates collection.

Use this property to look up the TSA certificate in the Certificates collection.

This property is read-only.

Data Type

int32

TimestampChainValidationDetails Property (AuthenticodeVerifier Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *AuthenticodeVerifier) TimestampChainValidationDetails() (int32, error)

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

This property is read-only.

Data Type

int32

TimestampChainValidationResult Property (AuthenticodeVerifier Component)

The outcome of a certificate chain validation routine.

Syntax

func (obj *AuthenticodeVerifier) TimestampChainValidationResult() (int32, error)

Possible Values

0   // Valid
1 // ValidButUntrusted
2 // Invalid
3 // CantBeEstablished

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

int32

TimestampContainsLongTermInfo Property (AuthenticodeVerifier Component)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

Syntax

func (obj *AuthenticodeVerifier) TimestampContainsLongTermInfo() (bool, error)

Default Value

false

Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

This property is read-only.

Data Type

bool

TimestampEntityLabel Property (AuthenticodeVerifier Component)

Use this property to get the timestamp entity label.

Syntax

func (obj *AuthenticodeVerifier) TimestampEntityLabel() (string, error)

Default Value

""

Remarks

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.

This property is read-only.

Data Type

string

TimestampHashAlgorithm Property (AuthenticodeVerifier Component)

Returns the timestamp's hash algorithm.

Syntax

func (obj *AuthenticodeVerifier) TimestampHashAlgorithm() (string, error)

Default Value

""

Remarks

Returns the timestamp's hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

This property is read-only.

Data Type

string

TimestampParentEntity Property (AuthenticodeVerifier Component)

Use this property to get the label of the timestamp's parent entity.

Syntax

func (obj *AuthenticodeVerifier) TimestampParentEntity() (string, error)

Default Value

""

Remarks

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.

This property is read-only.

Data Type

string

TimestampSerialNumber Property (AuthenticodeVerifier Component)

Returns the timestamp's serial number.

Syntax

func (obj *AuthenticodeVerifier) TimestampSerialNumber() ([]byte, error)

Remarks

Returns the timestamp's serial number.

This property is read-only.

Data Type

[]byte

TimestampTime Property (AuthenticodeVerifier Component)

The time point incorporated into the timestamp.

Syntax

func (obj *AuthenticodeVerifier) TimestampTime() (string, error)

Default Value

""

Remarks

The time point incorporated into the timestamp.

This property is read-only.

Data Type

string

TimestampType Property (AuthenticodeVerifier Component)

Returns the type of the timestamp.

Syntax

func (obj *AuthenticodeVerifier) TimestampType() (int32, error)

Default Value

0

Remarks

Returns the type of the timestamp.

Available options:

tstUnknown0
tstLegacy1Supported by: Authenticode components

tstTrusted2Supported by: Authenticode components

tstGeneric3Supported by: CAdES components

tstESC4Supported by: CAdES components

tstContent5Supported by: CAdES components

tstCertsAndCRLs6Supported by: CAdES components

tstArchive7Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components

tstArchive28Archive v2 timestamp. Supported by: ASiC, CAdES components

tstArchive39Archive v3 timestamp. Supported by: ASiC, CAdES components

tstIndividualDataObjects10Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components

tstAllDataObjects11All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components

tstSignature12Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstRefsOnly13RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstSigAndRefs14SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstSignedData15SignedData timestamp. Supported by: JAdES components

tstArchive14116Archive 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).

This property is read-only.

Data Type

int32

TimestampTSAName Property (AuthenticodeVerifier Component)

This value uniquely identifies the Timestamp Authority (TSA).

Syntax

func (obj *AuthenticodeVerifier) TimestampTSAName() (string, error)

Default Value

""

Remarks

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

This property is read-only.

Data Type

string

TimestampValidationLog Property (AuthenticodeVerifier Component)

Contains the TSA certificate chain validation log.

Syntax

func (obj *AuthenticodeVerifier) TimestampValidationLog() (string, error)

Default Value

""

Remarks

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

This property is read-only.

Data Type

string

TimestampValidationResult Property (AuthenticodeVerifier Component)

Contains the timestamp validation outcome.

Syntax

func (obj *AuthenticodeVerifier) TimestampValidationResult() (int32, error)

Possible Values

0   // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted

Default Value

0

Remarks

Contains the timestamp validation outcome.

Use this property to check the result of the most recent timestamp validation.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

This property is read-only.

Data Type

int32

Timestamped Property (AuthenticodeVerifier Component)

Indicates whether or not the signature is timestamped.

Syntax

func (obj *AuthenticodeVerifier) Timestamped() (bool, error)

Default Value

false

Remarks

This property returns True if the signature is timestamped, and False otherwise.

This property is read-only.

Data Type

bool

TLSClientCertCount Property (AuthenticodeVerifier Component)

The number of records in the TLSClientCert arrays.

Syntax

func (obj *AuthenticodeVerifier) TLSClientCertCount() (int32, error)
func (obj *AuthenticodeVerifier) SetTLSClientCertCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at TLSClientCertCount - 1.

Data Type

int32

TLSClientCertBytes Property (AuthenticodeVerifier Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *AuthenticodeVerifier) TLSClientCertBytes(TLSClientCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is read-only.

Data Type

[]byte

TLSClientCertHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) TLSClientCertHandle(TLSClientCertIndex int32) (int64, error)
func (obj *AuthenticodeVerifier) SetTLSClientCertHandle(TLSClientCertIndex int32, value int64) error

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

Data Type

int64

TLSServerCertCount Property (AuthenticodeVerifier Component)

The number of records in the TLSServerCert arrays.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at TLSServerCertCount - 1.

This property is read-only.

Data Type

int32

TLSServerCertBytes Property (AuthenticodeVerifier Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertBytes(TLSServerCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

[]byte

TLSServerCertFingerprint Property (AuthenticodeVerifier Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertFingerprint(TLSServerCertIndex int32) (string, error)

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSServerCertHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertHandle(TLSServerCertIndex int32) (int64, error)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

int64

TLSServerCertIssuer Property (AuthenticodeVerifier Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertIssuer(TLSServerCertIndex int32) (string, error)

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via TLSIssuerRDN.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSServerCertIssuerRDN Property (AuthenticodeVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertIssuerRDN(TLSServerCertIndex int32) (string, error)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSServerCertKeyAlgorithm Property (AuthenticodeVerifier Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertKeyAlgorithm(TLSServerCertIndex int32) (string, error)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig
SB_CERT_ALGORITHM_MLDSA_44id-ml-dsa-44
SB_CERT_ALGORITHM_MLDSA_65id-ml-dsa-65
SB_CERT_ALGORITHM_MLDSA_87id-ml-dsa-87
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512id-hash-ml-dsa-44-with-sha512
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512id-hash-ml-dsa-65-with-sha512
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512id-hash-ml-dsa-87-with-sha512
SB_CERT_ALGORITHM_MLKEM_512id-ml-kem-512
SB_CERT_ALGORITHM_MLKEM_768id-ml-kem-768
SB_CERT_ALGORITHM_MLKEM_1024id-ml-kem-1024

Use the TLSKeyBits, TLSCurve, and TLSPublicKeyBytes properties to get more details about the key the certificate contains.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSServerCertKeyBits Property (AuthenticodeVerifier Component)

Returns the length of the public key in bits.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertKeyBits(TLSServerCertIndex int32) (int32, error)

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the TLSPublicKeyBytes or TLSPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

int32

TLSServerCertKeyUsage Property (AuthenticodeVerifier Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertKeyUsage(TLSServerCertIndex int32) (int32, error)

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

int32

TLSServerCertSelfSigned Property (AuthenticodeVerifier Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertSelfSigned(TLSServerCertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

bool

TLSServerCertSerialNumber Property (AuthenticodeVerifier Component)

Returns the certificate's serial number.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertSerialNumber(TLSServerCertIndex int32) ([]byte, error)

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

[]byte

TLSServerCertSigAlgorithm Property (AuthenticodeVerifier Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertSigAlgorithm(TLSServerCertIndex int32) (string, error)

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSServerCertSubject Property (AuthenticodeVerifier Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertSubject(TLSServerCertIndex int32) (string, error)

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via TLSSubjectRDN.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSServerCertSubjectRDN Property (AuthenticodeVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertSubjectRDN(TLSServerCertIndex int32) (string, error)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSServerCertValidFrom Property (AuthenticodeVerifier Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertValidFrom(TLSServerCertIndex int32) (string, error)

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSServerCertValidTo Property (AuthenticodeVerifier Component)

The time point at which the certificate expires, in UTC.

Syntax

func (obj *AuthenticodeVerifier) TLSServerCertValidTo(TLSServerCertIndex int32) (string, error)

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

string

TLSAutoValidateCertificates Property (AuthenticodeVerifier Component)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

func (obj *AuthenticodeVerifier) TLSAutoValidateCertificates() (bool, error)
func (obj *AuthenticodeVerifier) SetTLSAutoValidateCertificates(value bool) error

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

bool

TLSBaseConfiguration Property (AuthenticodeVerifier Component)

Selects the base configuration for the TLS settings.

Syntax

func (obj *AuthenticodeVerifier) TLSBaseConfiguration() (int32, error)
func (obj *AuthenticodeVerifier) SetTLSBaseConfiguration(value int32) error

Possible Values

0   // Default
1 // Compatible
2 // ComprehensiveInsecure
3 // HighlySecure

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Data Type

int32

TLSCiphersuites Property (AuthenticodeVerifier Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

func (obj *AuthenticodeVerifier) TLSCiphersuites() (string, error)
func (obj *AuthenticodeVerifier) SetTLSCiphersuites(value string) error

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

  • NULL_NULL_NULL
  • RSA_NULL_MD5
  • RSA_NULL_SHA
  • RSA_RC4_MD5
  • RSA_RC4_SHA
  • RSA_RC2_MD5
  • RSA_IDEA_MD5
  • RSA_IDEA_SHA
  • RSA_DES_MD5
  • RSA_DES_SHA
  • RSA_3DES_MD5
  • RSA_3DES_SHA
  • RSA_AES128_SHA
  • RSA_AES256_SHA
  • DH_DSS_DES_SHA
  • DH_DSS_3DES_SHA
  • DH_DSS_AES128_SHA
  • DH_DSS_AES256_SHA
  • DH_RSA_DES_SHA
  • DH_RSA_3DES_SHA
  • DH_RSA_AES128_SHA
  • DH_RSA_AES256_SHA
  • DHE_DSS_DES_SHA
  • DHE_DSS_3DES_SHA
  • DHE_DSS_AES128_SHA
  • DHE_DSS_AES256_SHA
  • DHE_RSA_DES_SHA
  • DHE_RSA_3DES_SHA
  • DHE_RSA_AES128_SHA
  • DHE_RSA_AES256_SHA
  • DH_ANON_RC4_MD5
  • DH_ANON_DES_SHA
  • DH_ANON_3DES_SHA
  • DH_ANON_AES128_SHA
  • DH_ANON_AES256_SHA
  • RSA_RC2_MD5_EXPORT
  • RSA_RC4_MD5_EXPORT
  • RSA_DES_SHA_EXPORT
  • DH_DSS_DES_SHA_EXPORT
  • DH_RSA_DES_SHA_EXPORT
  • DHE_DSS_DES_SHA_EXPORT
  • DHE_RSA_DES_SHA_EXPORT
  • DH_ANON_RC4_MD5_EXPORT
  • DH_ANON_DES_SHA_EXPORT
  • RSA_CAMELLIA128_SHA
  • DH_DSS_CAMELLIA128_SHA
  • DH_RSA_CAMELLIA128_SHA
  • DHE_DSS_CAMELLIA128_SHA
  • DHE_RSA_CAMELLIA128_SHA
  • DH_ANON_CAMELLIA128_SHA
  • RSA_CAMELLIA256_SHA
  • DH_DSS_CAMELLIA256_SHA
  • DH_RSA_CAMELLIA256_SHA
  • DHE_DSS_CAMELLIA256_SHA
  • DHE_RSA_CAMELLIA256_SHA
  • DH_ANON_CAMELLIA256_SHA
  • PSK_RC4_SHA
  • PSK_3DES_SHA
  • PSK_AES128_SHA
  • PSK_AES256_SHA
  • DHE_PSK_RC4_SHA
  • DHE_PSK_3DES_SHA
  • DHE_PSK_AES128_SHA
  • DHE_PSK_AES256_SHA
  • RSA_PSK_RC4_SHA
  • RSA_PSK_3DES_SHA
  • RSA_PSK_AES128_SHA
  • RSA_PSK_AES256_SHA
  • RSA_SEED_SHA
  • DH_DSS_SEED_SHA
  • DH_RSA_SEED_SHA
  • DHE_DSS_SEED_SHA
  • DHE_RSA_SEED_SHA
  • DH_ANON_SEED_SHA
  • SRP_SHA_3DES_SHA
  • SRP_SHA_RSA_3DES_SHA
  • SRP_SHA_DSS_3DES_SHA
  • SRP_SHA_AES128_SHA
  • SRP_SHA_RSA_AES128_SHA
  • SRP_SHA_DSS_AES128_SHA
  • SRP_SHA_AES256_SHA
  • SRP_SHA_RSA_AES256_SHA
  • SRP_SHA_DSS_AES256_SHA
  • ECDH_ECDSA_NULL_SHA
  • ECDH_ECDSA_RC4_SHA
  • ECDH_ECDSA_3DES_SHA
  • ECDH_ECDSA_AES128_SHA
  • ECDH_ECDSA_AES256_SHA
  • ECDHE_ECDSA_NULL_SHA
  • ECDHE_ECDSA_RC4_SHA
  • ECDHE_ECDSA_3DES_SHA
  • ECDHE_ECDSA_AES128_SHA
  • ECDHE_ECDSA_AES256_SHA
  • ECDH_RSA_NULL_SHA
  • ECDH_RSA_RC4_SHA
  • ECDH_RSA_3DES_SHA
  • ECDH_RSA_AES128_SHA
  • ECDH_RSA_AES256_SHA
  • ECDHE_RSA_NULL_SHA
  • ECDHE_RSA_RC4_SHA
  • ECDHE_RSA_3DES_SHA
  • ECDHE_RSA_AES128_SHA
  • ECDHE_RSA_AES256_SHA
  • ECDH_ANON_NULL_SHA
  • ECDH_ANON_RC4_SHA
  • ECDH_ANON_3DES_SHA
  • ECDH_ANON_AES128_SHA
  • ECDH_ANON_AES256_SHA
  • RSA_NULL_SHA256
  • RSA_AES128_SHA256
  • RSA_AES256_SHA256
  • DH_DSS_AES128_SHA256
  • DH_RSA_AES128_SHA256
  • DHE_DSS_AES128_SHA256
  • DHE_RSA_AES128_SHA256
  • DH_DSS_AES256_SHA256
  • DH_RSA_AES256_SHA256
  • DHE_DSS_AES256_SHA256
  • DHE_RSA_AES256_SHA256
  • DH_ANON_AES128_SHA256
  • DH_ANON_AES256_SHA256
  • RSA_AES128_GCM_SHA256
  • RSA_AES256_GCM_SHA384
  • DHE_RSA_AES128_GCM_SHA256
  • DHE_RSA_AES256_GCM_SHA384
  • DH_RSA_AES128_GCM_SHA256
  • DH_RSA_AES256_GCM_SHA384
  • DHE_DSS_AES128_GCM_SHA256
  • DHE_DSS_AES256_GCM_SHA384
  • DH_DSS_AES128_GCM_SHA256
  • DH_DSS_AES256_GCM_SHA384
  • DH_ANON_AES128_GCM_SHA256
  • DH_ANON_AES256_GCM_SHA384
  • ECDHE_ECDSA_AES128_SHA256
  • ECDHE_ECDSA_AES256_SHA384
  • ECDH_ECDSA_AES128_SHA256
  • ECDH_ECDSA_AES256_SHA384
  • ECDHE_RSA_AES128_SHA256
  • ECDHE_RSA_AES256_SHA384
  • ECDH_RSA_AES128_SHA256
  • ECDH_RSA_AES256_SHA384
  • ECDHE_ECDSA_AES128_GCM_SHA256
  • ECDHE_ECDSA_AES256_GCM_SHA384
  • ECDH_ECDSA_AES128_GCM_SHA256
  • ECDH_ECDSA_AES256_GCM_SHA384
  • ECDHE_RSA_AES128_GCM_SHA256
  • ECDHE_RSA_AES256_GCM_SHA384
  • ECDH_RSA_AES128_GCM_SHA256
  • ECDH_RSA_AES256_GCM_SHA384
  • PSK_AES128_GCM_SHA256
  • PSK_AES256_GCM_SHA384
  • DHE_PSK_AES128_GCM_SHA256
  • DHE_PSK_AES256_GCM_SHA384
  • RSA_PSK_AES128_GCM_SHA256
  • RSA_PSK_AES256_GCM_SHA384
  • PSK_AES128_SHA256
  • PSK_AES256_SHA384
  • PSK_NULL_SHA256
  • PSK_NULL_SHA384
  • DHE_PSK_AES128_SHA256
  • DHE_PSK_AES256_SHA384
  • DHE_PSK_NULL_SHA256
  • DHE_PSK_NULL_SHA384
  • RSA_PSK_AES128_SHA256
  • RSA_PSK_AES256_SHA384
  • RSA_PSK_NULL_SHA256
  • RSA_PSK_NULL_SHA384
  • RSA_CAMELLIA128_SHA256
  • DH_DSS_CAMELLIA128_SHA256
  • DH_RSA_CAMELLIA128_SHA256
  • DHE_DSS_CAMELLIA128_SHA256
  • DHE_RSA_CAMELLIA128_SHA256
  • DH_ANON_CAMELLIA128_SHA256
  • RSA_CAMELLIA256_SHA256
  • DH_DSS_CAMELLIA256_SHA256
  • DH_RSA_CAMELLIA256_SHA256
  • DHE_DSS_CAMELLIA256_SHA256
  • DHE_RSA_CAMELLIA256_SHA256
  • DH_ANON_CAMELLIA256_SHA256
  • ECDHE_ECDSA_CAMELLIA128_SHA256
  • ECDHE_ECDSA_CAMELLIA256_SHA384
  • ECDH_ECDSA_CAMELLIA128_SHA256
  • ECDH_ECDSA_CAMELLIA256_SHA384
  • ECDHE_RSA_CAMELLIA128_SHA256
  • ECDHE_RSA_CAMELLIA256_SHA384
  • ECDH_RSA_CAMELLIA128_SHA256
  • ECDH_RSA_CAMELLIA256_SHA384
  • RSA_CAMELLIA128_GCM_SHA256
  • RSA_CAMELLIA256_GCM_SHA384
  • DHE_RSA_CAMELLIA128_GCM_SHA256
  • DHE_RSA_CAMELLIA256_GCM_SHA384
  • DH_RSA_CAMELLIA128_GCM_SHA256
  • DH_RSA_CAMELLIA256_GCM_SHA384
  • DHE_DSS_CAMELLIA128_GCM_SHA256
  • DHE_DSS_CAMELLIA256_GCM_SHA384
  • DH_DSS_CAMELLIA128_GCM_SHA256
  • DH_DSS_CAMELLIA256_GCM_SHA384
  • DH_anon_CAMELLIA128_GCM_SHA256
  • DH_anon_CAMELLIA256_GCM_SHA384
  • ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
  • ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
  • ECDH_ECDSA_CAMELLIA128_GCM_SHA256
  • ECDH_ECDSA_CAMELLIA256_GCM_SHA384
  • ECDHE_RSA_CAMELLIA128_GCM_SHA256
  • ECDHE_RSA_CAMELLIA256_GCM_SHA384
  • ECDH_RSA_CAMELLIA128_GCM_SHA256
  • ECDH_RSA_CAMELLIA256_GCM_SHA384
  • PSK_CAMELLIA128_GCM_SHA256
  • PSK_CAMELLIA256_GCM_SHA384
  • DHE_PSK_CAMELLIA128_GCM_SHA256
  • DHE_PSK_CAMELLIA256_GCM_SHA384
  • RSA_PSK_CAMELLIA128_GCM_SHA256
  • RSA_PSK_CAMELLIA256_GCM_SHA384
  • PSK_CAMELLIA128_SHA256
  • PSK_CAMELLIA256_SHA384
  • DHE_PSK_CAMELLIA128_SHA256
  • DHE_PSK_CAMELLIA256_SHA384
  • RSA_PSK_CAMELLIA128_SHA256
  • RSA_PSK_CAMELLIA256_SHA384
  • ECDHE_PSK_CAMELLIA128_SHA256
  • ECDHE_PSK_CAMELLIA256_SHA384
  • ECDHE_PSK_RC4_SHA
  • ECDHE_PSK_3DES_SHA
  • ECDHE_PSK_AES128_SHA
  • ECDHE_PSK_AES256_SHA
  • ECDHE_PSK_AES128_SHA256
  • ECDHE_PSK_AES256_SHA384
  • ECDHE_PSK_NULL_SHA
  • ECDHE_PSK_NULL_SHA256
  • ECDHE_PSK_NULL_SHA384
  • ECDHE_RSA_CHACHA20_POLY1305_SHA256
  • ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
  • DHE_RSA_CHACHA20_POLY1305_SHA256
  • PSK_CHACHA20_POLY1305_SHA256
  • ECDHE_PSK_CHACHA20_POLY1305_SHA256
  • DHE_PSK_CHACHA20_POLY1305_SHA256
  • RSA_PSK_CHACHA20_POLY1305_SHA256
  • AES128_GCM_SHA256
  • AES256_GCM_SHA384
  • CHACHA20_POLY1305_SHA256
  • AES128_CCM_SHA256
  • AES128_CCM8_SHA256

Data Type

string

TLSClientAuth Property (AuthenticodeVerifier Component)

Enables or disables certificate-based client authentication.

Syntax

func (obj *AuthenticodeVerifier) TLSClientAuth() (int32, error)
func (obj *AuthenticodeVerifier) SetTLSClientAuth(value int32) error

Possible Values

0   // NoAuth
1 // RequestCert
2 // RequireCert

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

ccatNoAuth0
ccatRequestCert1
ccatRequireCert2

Data Type

int32

TLSExtensions Property (AuthenticodeVerifier Component)

Provides access to TLS extensions.

Syntax

func (obj *AuthenticodeVerifier) TLSExtensions() (string, error)
func (obj *AuthenticodeVerifier) SetTLSExtensions(value string) error

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

string

TLSForceResumeIfDestinationChanges Property (AuthenticodeVerifier Component)

Whether to force TLS session resumption when the destination address changes.

Syntax

func (obj *AuthenticodeVerifier) TLSForceResumeIfDestinationChanges() (bool, error)
func (obj *AuthenticodeVerifier) SetTLSForceResumeIfDestinationChanges(value bool) error

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

bool

TLSGroups Property (AuthenticodeVerifier Component)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

func (obj *AuthenticodeVerifier) TLSGroups() (string, error)
func (obj *AuthenticodeVerifier) SetTLSGroups(value string) error

Default Value

""

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

  • SECT163K1
  • SECT163R1
  • SECT163R2
  • SECT193R1
  • SECT193R2
  • SECT233K1
  • SECT233R1
  • SECT239K1
  • SECT283K1
  • SECT283R1
  • SECT409K1
  • SECT409R1
  • SECT571K1
  • SECT571R1
  • SECP160K1
  • SECP160R1
  • SECP160R2
  • SECP192K1
  • SECP192R1
  • SECP224K1
  • SECP224R1
  • SECP256K1
  • SECP256R1
  • SECP384R1
  • SECP521R1
  • BRAINPOOLP256R1
  • BRAINPOOLP384R1
  • BRAINPOOLP512R1
  • X25519
  • X448

Finite field-based groups:

  • FFDHE2048
  • FFDHE3072
  • FFDHE4096
  • FFDHE6144
  • FFDHE8192

Post-Quantum and Hybrid groups:

  • MLKEM512
  • MLKEM768
  • MLKEM1024
  • SECP256R1MLKEM768
  • X25519MLKEM768
  • SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

string

TLSPreSharedIdentity Property (AuthenticodeVerifier Component)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

func (obj *AuthenticodeVerifier) TLSPreSharedIdentity() (string, error)
func (obj *AuthenticodeVerifier) SetTLSPreSharedIdentity(value string) error

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Data Type

string

TLSPreSharedKey Property (AuthenticodeVerifier Component)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

func (obj *AuthenticodeVerifier) TLSPreSharedKey() (string, error)
func (obj *AuthenticodeVerifier) SetTLSPreSharedKey(value string) error

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Data Type

string

TLSPreSharedKeyCiphersuite Property (AuthenticodeVerifier Component)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

func (obj *AuthenticodeVerifier) TLSPreSharedKeyCiphersuite() (string, error)
func (obj *AuthenticodeVerifier) SetTLSPreSharedKeyCiphersuite(value string) error

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

string

TLSRenegotiationAttackPreventionMode Property (AuthenticodeVerifier Component)

Selects the renegotiation attack prevention mechanism.

Syntax

func (obj *AuthenticodeVerifier) TLSRenegotiationAttackPreventionMode() (int32, error)
func (obj *AuthenticodeVerifier) SetTLSRenegotiationAttackPreventionMode(value int32) error

Possible Values

0   // Compatible
1 // Strict
2 // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

Data Type

int32

TLSRevocationCheck Property (AuthenticodeVerifier Component)

Specifies the kind(s) of revocation check to perform.

Syntax

func (obj *AuthenticodeVerifier) TLSRevocationCheck() (int32, error)
func (obj *AuthenticodeVerifier) SetTLSRevocationCheck(value int32) error

Possible Values

0   // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All 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.

Data Type

int32

TLSSSLOptions Property (AuthenticodeVerifier Component)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

func (obj *AuthenticodeVerifier) TLSSSLOptions() (int32, error)
func (obj *AuthenticodeVerifier) SetTLSSSLOptions(value int32) error

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

Data Type

int32

TLSMode Property (AuthenticodeVerifier Component)

Specifies the TLS mode to use.

Syntax

func (obj *AuthenticodeVerifier) TLSMode() (int32, error)
func (obj *AuthenticodeVerifier) SetTLSMode(value int32) error

Possible Values

0   // Default
1 // NoTLS
2 // ExplicitTLS
3 // ImplicitTLS
4 // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

Data Type

int32

TLSUseExtendedMasterSecret Property (AuthenticodeVerifier Component)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

func (obj *AuthenticodeVerifier) TLSUseExtendedMasterSecret() (bool, error)
func (obj *AuthenticodeVerifier) SetTLSUseExtendedMasterSecret(value bool) error

Default Value

true

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

bool

TLSUseSessionResumption Property (AuthenticodeVerifier Component)

Enables or disables the TLS session resumption capability.

Syntax

func (obj *AuthenticodeVerifier) TLSUseSessionResumption() (bool, error)
func (obj *AuthenticodeVerifier) SetTLSUseSessionResumption(value bool) error

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

TLSVersions Property (AuthenticodeVerifier Component)

The SSL/TLS versions to enable by default.

Syntax

func (obj *AuthenticodeVerifier) TLSVersions() (int32, error)
func (obj *AuthenticodeVerifier) SetTLSVersions(value int32) error

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Data Type

int32

TrustedCertCount Property (AuthenticodeVerifier Component)

The number of records in the TrustedCert arrays.

Syntax

func (obj *AuthenticodeVerifier) TrustedCertCount() (int32, error)
func (obj *AuthenticodeVerifier) SetTrustedCertCount(value int32) error

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at TrustedCertCount - 1.

Data Type

int32

TrustedCertBytes Property (AuthenticodeVerifier Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *AuthenticodeVerifier) TrustedCertBytes(TrustedCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

[]byte

TrustedCertHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) TrustedCertHandle(TrustedCertIndex int32) (int64, error)
func (obj *AuthenticodeVerifier) SetTrustedCertHandle(TrustedCertIndex int32, value int64) error

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

int64

TSACertBytes Property (AuthenticodeVerifier Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *AuthenticodeVerifier) TSACertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

TSACertCA Property (AuthenticodeVerifier Component)

Indicates whether the certificate has a CA capability.

Syntax

func (obj *AuthenticodeVerifier) TSACertCA() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

This property is read-only.

Data Type

bool

TSACertCAKeyID Property (AuthenticodeVerifier Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

func (obj *AuthenticodeVerifier) TSACertCAKeyID() ([]byte, error)

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the TSACertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

Data Type

[]byte

TSACertCRLDistributionPoints Property (AuthenticodeVerifier Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

func (obj *AuthenticodeVerifier) TSACertCRLDistributionPoints() (string, error)

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is read-only.

Data Type

string

TSACertCurve Property (AuthenticodeVerifier Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

func (obj *AuthenticodeVerifier) TSACertCurve() (string, error)

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

This property is read-only.

Data Type

string

TSACertFingerprint Property (AuthenticodeVerifier Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

func (obj *AuthenticodeVerifier) TSACertFingerprint() (string, error)

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

This property is read-only.

Data Type

string

TSACertFriendlyName Property (AuthenticodeVerifier Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

func (obj *AuthenticodeVerifier) TSACertFriendlyName() (string, error)

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

This property is read-only.

Data Type

string

TSACertHandle Property (AuthenticodeVerifier Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *AuthenticodeVerifier) TSACertHandle() (int64, error)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is read-only.

Data Type

int64

TSACertHashAlgorithm Property (AuthenticodeVerifier Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

func (obj *AuthenticodeVerifier) TSACertHashAlgorithm() (string, error)

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use TSACertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

This property is read-only.

Data Type

string

TSACertIssuer Property (AuthenticodeVerifier Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

func (obj *AuthenticodeVerifier) TSACertIssuer() (string, error)

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via TSACertIssuerRDN.

This property is read-only.

Data Type

string

TSACertIssuerRDN Property (AuthenticodeVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *AuthenticodeVerifier) TSACertIssuerRDN() (string, error)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

This property is read-only.

Data Type

string

TSACertKeyAlgorithm Property (AuthenticodeVerifier Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *AuthenticodeVerifier) TSACertKeyAlgorithm() (string, error)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig
SB_CERT_ALGORITHM_MLDSA_44id-ml-dsa-44
SB_CERT_ALGORITHM_MLDSA_65id-ml-dsa-65
SB_CERT_ALGORITHM_MLDSA_87id-ml-dsa-87
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512id-hash-ml-dsa-44-with-sha512
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512id-hash-ml-dsa-65-with-sha512
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512id-hash-ml-dsa-87-with-sha512
SB_CERT_ALGORITHM_MLKEM_512id-ml-kem-512
SB_CERT_ALGORITHM_MLKEM_768id-ml-kem-768
SB_CERT_ALGORITHM_MLKEM_1024id-ml-kem-1024

Use the TSACertKeyBits, TSACertCurve, and TSACertPublicKeyBytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

string

TSACertKeyBits Property (AuthenticodeVerifier Component)

Returns the length of the public key in bits.

Syntax

func (obj *AuthenticodeVerifier) TSACertKeyBits() (int32, error)

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the TSACertPublicKeyBytes or TSACertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

Data Type

int32

TSACertKeyFingerprint Property (AuthenticodeVerifier Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

func (obj *AuthenticodeVerifier) TSACertKeyFingerprint() (string, error)

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the TSACertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

Data Type

string

TSACertKeyUsage Property (AuthenticodeVerifier Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

func (obj *AuthenticodeVerifier) TSACertKeyUsage() (int32, error)

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

This property is read-only.

Data Type

int32

TSACertKeyValid Property (AuthenticodeVerifier Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

func (obj *AuthenticodeVerifier) TSACertKeyValid() (bool, error)

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

This property is read-only.

Data Type

bool

TSACertOCSPLocations Property (AuthenticodeVerifier Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

func (obj *AuthenticodeVerifier) TSACertOCSPLocations() (string, error)

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate 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.

This property is read-only.

Data Type

string

TSACertPolicyIDs Property (AuthenticodeVerifier Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

func (obj *AuthenticodeVerifier) TSACertPolicyIDs() (string, error)

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

This property is read-only.

Data Type

string

TSACertPublicKeyBytes Property (AuthenticodeVerifier Component)

Contains the certificate's public key in DER format.

Syntax

func (obj *AuthenticodeVerifier) TSACertPublicKeyBytes() ([]byte, error)

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

This property is read-only.

Data Type

[]byte

TSACertSelfSigned Property (AuthenticodeVerifier Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

func (obj *AuthenticodeVerifier) TSACertSelfSigned() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

This property is read-only.

Data Type

bool

TSACertSerialNumber Property (AuthenticodeVerifier Component)

Returns the certificate's serial number.

Syntax

func (obj *AuthenticodeVerifier) TSACertSerialNumber() ([]byte, error)

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

This property is read-only.

Data Type

[]byte

TSACertSigAlgorithm Property (AuthenticodeVerifier Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

func (obj *AuthenticodeVerifier) TSACertSigAlgorithm() (string, error)

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

This property is read-only.

Data Type

string

TSACertSubject Property (AuthenticodeVerifier Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

func (obj *AuthenticodeVerifier) TSACertSubject() (string, error)

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via TSACertSubjectRDN.

This property is read-only.

Data Type

string

TSACertSubjectKeyID Property (AuthenticodeVerifier Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

func (obj *AuthenticodeVerifier) TSACertSubjectKeyID() ([]byte, error)

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The TSACertSubjectKeyID and TSACertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only.

Data Type

[]byte

TSACertSubjectRDN Property (AuthenticodeVerifier Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *AuthenticodeVerifier) TSACertSubjectRDN() (string, error)

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

This property is read-only.

Data Type

string

TSACertValidFrom Property (AuthenticodeVerifier Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

func (obj *AuthenticodeVerifier) TSACertValidFrom() (string, error)

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is read-only.

Data Type

string

TSACertValidTo Property (AuthenticodeVerifier Component)

The time point at which the certificate expires, in UTC.

Syntax

func (obj *AuthenticodeVerifier) TSACertValidTo() (string, error)

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

This property is read-only.

Data Type

string

UnsignedAttributeCount Property (AuthenticodeVerifier Component)

The number of records in the UnsignedAttribute arrays.

Syntax

func (obj *AuthenticodeVerifier) UnsignedAttributeCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at UnsignedAttributeCount - 1.

This property is read-only.

Data Type

int32

UnsignedAttributeOID Property (AuthenticodeVerifier Component)

The object identifier of the attribute.

Syntax

func (obj *AuthenticodeVerifier) UnsignedAttributeOID(UnsignedAttributeIndex int32) (string, error)

Default Value

""

Remarks

The object identifier of the attribute.

The UnsignedAttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UnsignedAttributeCount property.

This property is read-only.

Data Type

string

UnsignedAttributeValue Property (AuthenticodeVerifier Component)

The value of the attribute.

Syntax

func (obj *AuthenticodeVerifier) UnsignedAttributeValue(UnsignedAttributeIndex int32) ([]byte, error)

Remarks

The value of the attribute.

The UnsignedAttributeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UnsignedAttributeCount property.

This property is read-only.

Data Type

[]byte

ValidationMoment Property (AuthenticodeVerifier Component)

The time point at which signature validity is to be established.

Syntax

func (obj *AuthenticodeVerifier) ValidationMoment() (string, error)
func (obj *AuthenticodeVerifier) SetValidationMoment(value string) error

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.

Data Type

string

Config Method (AuthenticodeVerifier Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *AuthenticodeVerifier) Config(ConfigurationString string) (string, error)

Remarks

Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (AuthenticodeVerifier Component)

Performs an additional action.

Syntax

func (obj *AuthenticodeVerifier) DoAction(ActionID string, ActionParams string) (string, error)

Remarks

DoAction is a generic method available in every struct. 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:

ActionParametersReturned valueDescription
ResetTrustedListCachenonenoneClears the cached list of trusted lists.
ResetCertificateCachenonenoneClears the cached certificates.
ResetCRLCachenonenoneClears the cached CRLs.
ResetOCSPResponseCachenonenoneClears the cached OCSP responses.

Reset Method (AuthenticodeVerifier Component)

Resets the class settings.

Syntax

func (obj *AuthenticodeVerifier) Reset() error

Remarks

Reset is a generic method available in every struct.

Verify Method (AuthenticodeVerifier Component)

Verifies a digitally signed executable.

Syntax

func (obj *AuthenticodeVerifier) Verify() error

Remarks

Use this method to verify all signatures in the executable provided via InputFile or via InputStream.

During the verification process, the SignatureFound, SignatureValidated, TimestampFound and TimestampValidated events are fired to provide details about the signatures and timestamps.

After this method is executed, the Signature property contains information about the last verified signature.

ChainElementDownload Event (AuthenticodeVerifier Component)

Fires when there is a need to download a chain element from an online source.

Syntax

// AuthenticodeVerifierChainElementDownloadEventArgs carries the AuthenticodeVerifier ChainElementDownload event's parameters.
type AuthenticodeVerifierChainElementDownloadEventArgs struct {...}

func (args *AuthenticodeVerifierChainElementDownloadEventArgs) Kind() int32
func (args *AuthenticodeVerifierChainElementDownloadEventArgs) CertRDN() string
func (args *AuthenticodeVerifierChainElementDownloadEventArgs) CACertRDN() string
func (args *AuthenticodeVerifierChainElementDownloadEventArgs) Location() string
func (args *AuthenticodeVerifierChainElementDownloadEventArgs) Action() int32
func (args *AuthenticodeVerifierChainElementDownloadEventArgs) SetAction(value int32)

// AuthenticodeVerifierChainElementDownloadEvent defines the signature of the AuthenticodeVerifier ChainElementDownload event's handler function.
type AuthenticodeVerifierChainElementDownloadEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierChainElementDownloadEventArgs)

func (obj *AuthenticodeVerifier) GetOnChainElementDownloadHandler() AuthenticodeVerifierChainElementDownloadEvent
func (obj *AuthenticodeVerifier) SetOnChainElementDownloadHandler(handlerFunc AuthenticodeVerifierChainElementDownloadEvent)

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.

veaAuto0Handle the action automatically (the default behaviour)

veaContinue1Accept the request implied by the event (accept the certificate, allow the object retrieval)

veaReject2Reject the request implied by the event (reject the certificate, disallow the object retrieval)

veaAcceptNow3Accept the validated certificate immediately

veaAbortNow4Abort the validation, reject the certificate

cekUnknown0Unknown or unsupported element type

cekCertificate1An X.509 certificate

cekCRL2A CRL

cekOCSP3An OCSP response

ChainElementNeeded Event (AuthenticodeVerifier Component)

Fires when an element required to validate the chain was not located.

Syntax

// AuthenticodeVerifierChainElementNeededEventArgs carries the AuthenticodeVerifier ChainElementNeeded event's parameters.
type AuthenticodeVerifierChainElementNeededEventArgs struct {...}

func (args *AuthenticodeVerifierChainElementNeededEventArgs) Kind() int32
func (args *AuthenticodeVerifierChainElementNeededEventArgs) CertRDN() string
func (args *AuthenticodeVerifierChainElementNeededEventArgs) CACertRDN() string
// AuthenticodeVerifierChainElementNeededEvent defines the signature of the AuthenticodeVerifier ChainElementNeeded event's handler function.
type AuthenticodeVerifierChainElementNeededEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierChainElementNeededEventArgs)

func (obj *AuthenticodeVerifier) GetOnChainElementNeededHandler() AuthenticodeVerifierChainElementNeededEvent
func (obj *AuthenticodeVerifier) SetOnChainElementNeededHandler(handlerFunc AuthenticodeVerifierChainElementNeededEvent)

Remarks

Subscribe to this event to be notified about missing validation elements. Use the KnownCRLs, KnownCertificates, and KnownOCSPs properties in the event handler to provide the missing piece.

cekUnknown0Unknown or unsupported element type

cekCertificate1An X.509 certificate

cekCRL2A CRL

cekOCSP3An OCSP response

ChainValidated Event (AuthenticodeVerifier Component)

Reports the completion of a certificate chain validation.

Syntax

// AuthenticodeVerifierChainValidatedEventArgs carries the AuthenticodeVerifier ChainValidated event's parameters.
type AuthenticodeVerifierChainValidatedEventArgs struct {...}

func (args *AuthenticodeVerifierChainValidatedEventArgs) SubjectRDN() string
func (args *AuthenticodeVerifierChainValidatedEventArgs) ValidationResult() int32
func (args *AuthenticodeVerifierChainValidatedEventArgs) ValidationDetails() int32
// AuthenticodeVerifierChainValidatedEvent defines the signature of the AuthenticodeVerifier ChainValidated event's handler function.
type AuthenticodeVerifierChainValidatedEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierChainValidatedEventArgs)

func (obj *AuthenticodeVerifier) GetOnChainValidatedHandler() AuthenticodeVerifierChainValidatedEvent
func (obj *AuthenticodeVerifier) SetOnChainValidatedHandler(handlerFunc AuthenticodeVerifierChainValidatedEvent)

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.

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The 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.
cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

ChainValidationProgress Event (AuthenticodeVerifier Component)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Syntax

// AuthenticodeVerifierChainValidationProgressEventArgs carries the AuthenticodeVerifier ChainValidationProgress event's parameters.
type AuthenticodeVerifierChainValidationProgressEventArgs struct {...}

func (args *AuthenticodeVerifierChainValidationProgressEventArgs) EventKind() string
func (args *AuthenticodeVerifierChainValidationProgressEventArgs) CertRDN() string
func (args *AuthenticodeVerifierChainValidationProgressEventArgs) CACertRDN() string
func (args *AuthenticodeVerifierChainValidationProgressEventArgs) Action() int32
func (args *AuthenticodeVerifierChainValidationProgressEventArgs) SetAction(value int32)

// AuthenticodeVerifierChainValidationProgressEvent defines the signature of the AuthenticodeVerifier ChainValidationProgress event's handler function.
type AuthenticodeVerifierChainValidationProgressEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierChainValidationProgressEventArgs)

func (obj *AuthenticodeVerifier) GetOnChainValidationProgressHandler() AuthenticodeVerifierChainValidationProgressEvent
func (obj *AuthenticodeVerifier) SetOnChainValidationProgressHandler(handlerFunc AuthenticodeVerifierChainValidationProgressEvent)

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.

veaAuto0Handle the action automatically (the default behaviour)

veaContinue1Accept the request implied by the event (accept the certificate, allow the object retrieval)

veaReject2Reject the request implied by the event (reject the certificate, disallow the object retrieval)

veaAcceptNow3Accept the validated certificate immediately

veaAbortNow4Abort the validation, reject the certificate

Error Event (AuthenticodeVerifier Component)

Information about errors during ASiC signature verification.

Syntax

// AuthenticodeVerifierErrorEventArgs carries the AuthenticodeVerifier Error event's parameters.
type AuthenticodeVerifierErrorEventArgs struct {...}

func (args *AuthenticodeVerifierErrorEventArgs) ErrorCode() int32
func (args *AuthenticodeVerifierErrorEventArgs) Description() string
// AuthenticodeVerifierErrorEvent defines the signature of the AuthenticodeVerifier Error event's handler function.
type AuthenticodeVerifierErrorEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierErrorEventArgs)

func (obj *AuthenticodeVerifier) GetOnErrorHandler() AuthenticodeVerifierErrorEvent
func (obj *AuthenticodeVerifier) SetOnErrorHandler(handlerFunc AuthenticodeVerifierErrorEvent)

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.

Notification Event (AuthenticodeVerifier Component)

This event notifies the application about an underlying control flow event.

Syntax

// AuthenticodeVerifierNotificationEventArgs carries the AuthenticodeVerifier Notification event's parameters.
type AuthenticodeVerifierNotificationEventArgs struct {...}

func (args *AuthenticodeVerifierNotificationEventArgs) EventID() string
func (args *AuthenticodeVerifierNotificationEventArgs) EventParam() string
// AuthenticodeVerifierNotificationEvent defines the signature of the AuthenticodeVerifier Notification event's handler function.
type AuthenticodeVerifierNotificationEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierNotificationEventArgs)

func (obj *AuthenticodeVerifier) GetOnNotificationHandler() AuthenticodeVerifierNotificationEvent
func (obj *AuthenticodeVerifier) SetOnNotificationHandler(handlerFunc AuthenticodeVerifierNotificationEvent)

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.

SignatureFound Event (AuthenticodeVerifier Component)

Signifies the start of signature validation.

Syntax

// AuthenticodeVerifierSignatureFoundEventArgs carries the AuthenticodeVerifier SignatureFound event's parameters.
type AuthenticodeVerifierSignatureFoundEventArgs struct {...}

func (args *AuthenticodeVerifierSignatureFoundEventArgs) IssuerRDN() string
func (args *AuthenticodeVerifierSignatureFoundEventArgs) SerialNumber() []byte
func (args *AuthenticodeVerifierSignatureFoundEventArgs) SubjectKeyID() []byte
func (args *AuthenticodeVerifierSignatureFoundEventArgs) CertFound() bool
func (args *AuthenticodeVerifierSignatureFoundEventArgs) ValidateSignature() bool
func (args *AuthenticodeVerifierSignatureFoundEventArgs) SetValidateSignature(value bool)

func (args *AuthenticodeVerifierSignatureFoundEventArgs) ValidateChain() bool
func (args *AuthenticodeVerifierSignatureFoundEventArgs) SetValidateChain(value bool)

// AuthenticodeVerifierSignatureFoundEvent defines the signature of the AuthenticodeVerifier SignatureFound event's handler function.
type AuthenticodeVerifierSignatureFoundEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierSignatureFoundEventArgs)

func (obj *AuthenticodeVerifier) GetOnSignatureFoundHandler() AuthenticodeVerifierSignatureFoundEvent
func (obj *AuthenticodeVerifier) SetOnSignatureFoundHandler(handlerFunc AuthenticodeVerifierSignatureFoundEvent)

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 struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (AuthenticodeVerifier Component)

Marks the completion of the signature validation routine.

Syntax

// AuthenticodeVerifierSignatureValidatedEventArgs carries the AuthenticodeVerifier SignatureValidated event's parameters.
type AuthenticodeVerifierSignatureValidatedEventArgs struct {...}

func (args *AuthenticodeVerifierSignatureValidatedEventArgs) IssuerRDN() string
func (args *AuthenticodeVerifierSignatureValidatedEventArgs) SerialNumber() []byte
func (args *AuthenticodeVerifierSignatureValidatedEventArgs) SubjectKeyID() []byte
func (args *AuthenticodeVerifierSignatureValidatedEventArgs) ValidationResult() int32
// AuthenticodeVerifierSignatureValidatedEvent defines the signature of the AuthenticodeVerifier SignatureValidated event's handler function.
type AuthenticodeVerifierSignatureValidatedEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierSignatureValidatedEventArgs)

func (obj *AuthenticodeVerifier) GetOnSignatureValidatedHandler() AuthenticodeVerifierSignatureValidatedEvent
func (obj *AuthenticodeVerifier) SetOnSignatureValidatedHandler(handlerFunc AuthenticodeVerifierSignatureValidatedEvent)

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.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

TimestampFound Event (AuthenticodeVerifier Component)

Signifies the start of a timestamp validation routine.

Syntax

// AuthenticodeVerifierTimestampFoundEventArgs carries the AuthenticodeVerifier TimestampFound event's parameters.
type AuthenticodeVerifierTimestampFoundEventArgs struct {...}

func (args *AuthenticodeVerifierTimestampFoundEventArgs) IssuerRDN() string
func (args *AuthenticodeVerifierTimestampFoundEventArgs) SerialNumber() []byte
func (args *AuthenticodeVerifierTimestampFoundEventArgs) SubjectKeyID() []byte
func (args *AuthenticodeVerifierTimestampFoundEventArgs) CertFound() bool
func (args *AuthenticodeVerifierTimestampFoundEventArgs) ValidateTimestamp() bool
func (args *AuthenticodeVerifierTimestampFoundEventArgs) SetValidateTimestamp(value bool)

func (args *AuthenticodeVerifierTimestampFoundEventArgs) ValidateChain() bool
func (args *AuthenticodeVerifierTimestampFoundEventArgs) SetValidateChain(value bool)

// AuthenticodeVerifierTimestampFoundEvent defines the signature of the AuthenticodeVerifier TimestampFound event's handler function.
type AuthenticodeVerifierTimestampFoundEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierTimestampFoundEventArgs)

func (obj *AuthenticodeVerifier) GetOnTimestampFoundHandler() AuthenticodeVerifierTimestampFoundEvent
func (obj *AuthenticodeVerifier) SetOnTimestampFoundHandler(handlerFunc AuthenticodeVerifierTimestampFoundEvent)

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 struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property.

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 and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

TimestampValidated Event (AuthenticodeVerifier Component)

Reports the completion of the timestamp validation routine.

Syntax

// AuthenticodeVerifierTimestampValidatedEventArgs carries the AuthenticodeVerifier TimestampValidated event's parameters.
type AuthenticodeVerifierTimestampValidatedEventArgs struct {...}

func (args *AuthenticodeVerifierTimestampValidatedEventArgs) IssuerRDN() string
func (args *AuthenticodeVerifierTimestampValidatedEventArgs) SerialNumber() []byte
func (args *AuthenticodeVerifierTimestampValidatedEventArgs) SubjectKeyID() []byte
func (args *AuthenticodeVerifierTimestampValidatedEventArgs) Time() string
func (args *AuthenticodeVerifierTimestampValidatedEventArgs) ValidationResult() int32
func (args *AuthenticodeVerifierTimestampValidatedEventArgs) ChainValidationResult() int32
func (args *AuthenticodeVerifierTimestampValidatedEventArgs) ChainValidationDetails() int32
// AuthenticodeVerifierTimestampValidatedEvent defines the signature of the AuthenticodeVerifier TimestampValidated event's handler function.
type AuthenticodeVerifierTimestampValidatedEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierTimestampValidatedEventArgs)

func (obj *AuthenticodeVerifier) GetOnTimestampValidatedHandler() AuthenticodeVerifierTimestampValidatedEvent
func (obj *AuthenticodeVerifier) SetOnTimestampValidatedHandler(handlerFunc AuthenticodeVerifierTimestampValidatedEvent)

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.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

svtReferenceCorrupted5Reference corrupted (XML-based signatures only)

TLSCertNeeded Event (AuthenticodeVerifier Component)

Fires when a remote TLS party requests a client certificate.

Syntax

// AuthenticodeVerifierTLSCertNeededEventArgs carries the AuthenticodeVerifier TLSCertNeeded event's parameters.
type AuthenticodeVerifierTLSCertNeededEventArgs struct {...}

func (args *AuthenticodeVerifierTLSCertNeededEventArgs) Host() string
func (args *AuthenticodeVerifierTLSCertNeededEventArgs) CANames() string
// AuthenticodeVerifierTLSCertNeededEvent defines the signature of the AuthenticodeVerifier TLSCertNeeded event's handler function.
type AuthenticodeVerifierTLSCertNeededEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierTLSCertNeededEventArgs)

func (obj *AuthenticodeVerifier) GetOnTLSCertNeededHandler() AuthenticodeVerifierTLSCertNeededEvent
func (obj *AuthenticodeVerifier) SetOnTLSCertNeededHandler(handlerFunc AuthenticodeVerifierTLSCertNeededEvent)

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 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 event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (AuthenticodeVerifier Component)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

// AuthenticodeVerifierTLSCertValidateEventArgs carries the AuthenticodeVerifier TLSCertValidate event's parameters.
type AuthenticodeVerifierTLSCertValidateEventArgs struct {...}

func (args *AuthenticodeVerifierTLSCertValidateEventArgs) ServerHost() string
func (args *AuthenticodeVerifierTLSCertValidateEventArgs) ServerIP() string
func (args *AuthenticodeVerifierTLSCertValidateEventArgs) Accept() bool
func (args *AuthenticodeVerifierTLSCertValidateEventArgs) SetAccept(value bool)

// AuthenticodeVerifierTLSCertValidateEvent defines the signature of the AuthenticodeVerifier TLSCertValidate event's handler function.
type AuthenticodeVerifierTLSCertValidateEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierTLSCertValidateEventArgs)

func (obj *AuthenticodeVerifier) GetOnTLSCertValidateHandler() AuthenticodeVerifierTLSCertValidateEvent
func (obj *AuthenticodeVerifier) SetOnTLSCertValidateHandler(handlerFunc AuthenticodeVerifierTLSCertValidateEvent)

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, structs 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 struct, and can be adjusted if needed.

TLSEstablished Event (AuthenticodeVerifier Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

// AuthenticodeVerifierTLSEstablishedEventArgs carries the AuthenticodeVerifier TLSEstablished event's parameters.
type AuthenticodeVerifierTLSEstablishedEventArgs struct {...}

func (args *AuthenticodeVerifierTLSEstablishedEventArgs) Host() string
func (args *AuthenticodeVerifierTLSEstablishedEventArgs) Version() string
func (args *AuthenticodeVerifierTLSEstablishedEventArgs) Ciphersuite() string
func (args *AuthenticodeVerifierTLSEstablishedEventArgs) ConnectionId() []byte
func (args *AuthenticodeVerifierTLSEstablishedEventArgs) Abort() bool
func (args *AuthenticodeVerifierTLSEstablishedEventArgs) SetAbort(value bool)

// AuthenticodeVerifierTLSEstablishedEvent defines the signature of the AuthenticodeVerifier TLSEstablished event's handler function.
type AuthenticodeVerifierTLSEstablishedEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierTLSEstablishedEventArgs)

func (obj *AuthenticodeVerifier) GetOnTLSEstablishedHandler() AuthenticodeVerifierTLSEstablishedEvent
func (obj *AuthenticodeVerifier) SetOnTLSEstablishedHandler(handlerFunc AuthenticodeVerifierTLSEstablishedEvent)

Remarks

The struct 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 (AuthenticodeVerifier Component)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

// AuthenticodeVerifierTLSHandshakeEventArgs carries the AuthenticodeVerifier TLSHandshake event's parameters.
type AuthenticodeVerifierTLSHandshakeEventArgs struct {...}

func (args *AuthenticodeVerifierTLSHandshakeEventArgs) Host() string
func (args *AuthenticodeVerifierTLSHandshakeEventArgs) Abort() bool
func (args *AuthenticodeVerifierTLSHandshakeEventArgs) SetAbort(value bool)

// AuthenticodeVerifierTLSHandshakeEvent defines the signature of the AuthenticodeVerifier TLSHandshake event's handler function.
type AuthenticodeVerifierTLSHandshakeEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierTLSHandshakeEventArgs)

func (obj *AuthenticodeVerifier) GetOnTLSHandshakeHandler() AuthenticodeVerifierTLSHandshakeEvent
func (obj *AuthenticodeVerifier) SetOnTLSHandshakeHandler(handlerFunc AuthenticodeVerifierTLSHandshakeEvent)

Remarks

The struct 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 event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSShutdown Event (AuthenticodeVerifier Component)

Reports the graceful closure of a TLS connection.

Syntax

// AuthenticodeVerifierTLSShutdownEventArgs carries the AuthenticodeVerifier TLSShutdown event's parameters.
type AuthenticodeVerifierTLSShutdownEventArgs struct {...}

func (args *AuthenticodeVerifierTLSShutdownEventArgs) Host() string
// AuthenticodeVerifierTLSShutdownEvent defines the signature of the AuthenticodeVerifier TLSShutdown event's handler function.
type AuthenticodeVerifierTLSShutdownEvent func(sender *AuthenticodeVerifier, args *AuthenticodeVerifierTLSShutdownEventArgs)

func (obj *AuthenticodeVerifier) GetOnTLSShutdownHandler() AuthenticodeVerifierTLSShutdownEvent
func (obj *AuthenticodeVerifier) SetOnTLSShutdownHandler(handlerFunc AuthenticodeVerifierTLSShutdownEvent)

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (AuthenticodeVerifier Component)

The struct 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 struct, access to these internal properties is provided through the Config method.

AuthenticodeVerifier Config Settings

BufferSize:   Specifies buffer size in bytes.

Use this property to set the buffer size (in bytes) that should be used when processing binaries. The default value is 1048576 (1 MB).

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.

DelayVerification:   Specifies whether signatures validation should be delayed.

Use this property to delay signatures validation until SignatureFound is called. The default value is false.

This is useful to speedup getting the signature(s) information. Set this property to true and then return false from the SignatureFound event in the ValidateSignature parameter. In this case, the struct will not calculate file digests and its checksum until at least one signature is validated.

DislikeOpenEndedOCSPs:   Tells the struct 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 struct 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.

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.

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.

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 struct should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the struct should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.

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.

PromoteLongOCSPResponses:   Whether long OCSP responses are requested.

Set this property to True to force the struct to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

SignatureCount:   Returns the number of signatures in the executable.

Use this configuration setting to retrieve the number of signatures in the executable.

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, where this limitation does not apply.

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 struct 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
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.

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.

UseSystemCertificates:   Enables or disables the use of the system certificates.

Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

UseValidationCache:   Enables or disable the use of the product-wide certificate chain validation cache.

Use this property to enable or disable the use of the global chain validation cache. If enabled, the struct will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the struct, 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).

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 struct.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the struct.

Use this property to get cookies from the internal cookie storage of the struct 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 structs 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).
enableAlways attempt to use hardware cryptography. If unavailable, exception will be thrown.
disableDo 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 structs.

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:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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:

certificateEnables caching of certificates.
crlEnables caching of Certificate Revocation Lists (CRLs).
ocspEnables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): 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: 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 struct. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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 struct) 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 struct is set to "local", the property returns/restores the rules from/to the internal storage of the struct. If StaticDNS of the struct 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 structs.

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: 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: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: 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 (AuthenticodeVerifier Component)

AuthenticodeSigner Errors

1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
1048579   Invalid state (SB_ERROR_INVALID_STATE)
1048580   Invalid value (SB_ERROR_INVALID_VALUE)
1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
1048585   General error (SB_ERROR_GENERAL_ERROR)