ASiCSigner Component

Properties Methods Events Config Settings Errors

The ASiCSigner class creates associated signature containers.

Syntax

secureblackbox.ASiCSigner

Remarks

ASiCSigner provides functionality for creating and updating Associated Signature Containers (ASiC). ASiC containers are used to bind together data, signed objects, and electronic signatures or timestamps, and store them in a standardized, cross-platform ZIP-compatible file.

ASiC has gained wide use across European countries (as part of eIDAS regulation) and beyond. Alongside other AdES formats (CAdES, XAdES, PAdES), it provides convenience of storing sets of heterogeneous data objects within a compatible container, providing data retention, self-sufficiency, and high interoperability options.

ASiC uses CAdES, XAdES, and RFC3161 timestamps as its building blocks, effectively allowing to expand these formats beyond their single-object limitation.

ASiCSigner supports all the ASiC capabilities as defined in the respective ETSI standards (ETSI EN 319 162), in particular:

ASiC-S (simple) and ASiC-E (extended) signature profiles.
CAdES- and XAdES-based signatures.
RFC 3161 timestamps.
All ETSI signature profiles (including B-B, B-T, B-LT, B-LTA).
Short-term, long-term, and archivable signatures.
Complete chain of trust validation process, using local, global, nation-specific (EUTL), or custom trust.
Signing with local, remote, and hardware-based private keys.
Creating new containers or updating/extending existing ones.
Online and offline modes.

The component is being actively maintained and updated to account for ongoing developments in AdES world. For more than 10 years, our engineers have been active participants of ETSI Plugtests events, to make sure that our e-Signature infrastructure is compliant and highly interoperable.

ASiCSigner supports several work modes that differ in complexity, allowing for both 'quick' and 'flexible' use. The simple mode assumes providing the SourceFiles, the OutputFile, the SigningCertificate, and calling the one-pass Sign method. In this case the component will use its intelligence to create the most appropriate signature with the given parameters over the provided files.

More complex tune-up may involve fine-grained adjustment of properties of the NewSignature object, providing custom validation material (certificates, OCSPs, CRLs), setting up customized timestamping handlers for non-standard TSAs, or using a pre-defined signature Profile. You can also choose to work with the container step-by-step, by splitting the one-pass operation into individual Open/CreateNew, Sign, and Close calls. ASiCSigner signer = new ASiCSigner(); signer.setSourceFiles("./MyFile.txt \n./MySecondFile.txt"); // set path of the file/files you want to sign signer.setOutputFile("./SignedFile.scs"); // set path where the output should be saved signer.setSigningCertificate(new Certificate("./test.pfx","test")); // set the signing certificate signer.setExtended(true); // since we are signing multiple documents we set extended to true // set the signature type signer.getNewSignature().setSignatureType(ASiCSignature.castCAdES); signer.sign();

Property List

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


AutoValidateSignatures	Specifies whether ASiCSigner should validate any present signatures when the document is opened.
BlockedCertCount	The number of records in the BlockedCert arrays.
BlockedCertBytes	Returns the raw certificate data in DER format.
BlockedCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
CertCount	The number of records in the Cert arrays.
CertBytes	Returns the raw certificate data in DER format.
CertCA	Indicates whether the certificate has a CA capability.
CertCAKeyID	A unique identifier (fingerprint) of the CA certificate's cryptographic key.
CertType	Returns the type of the entity contained in the Certificate object.
CertCRLDistributionPoints	Contains a list of locations of CRL distribution points used to check this certificate's validity.
CertCurve	Specifies the elliptic curve associated with the certificate's public key.
CertFingerprint	Contains the fingerprint (a hash imprint) of this certificate.
CertFriendlyName	Contains an associated alias (friendly name) of the certificate.
CertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
CertHashAlgorithm	Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
CertIssuer	The common name of the certificate issuer (CA), typically a company name.
CertIssuerRDN	A list of Property=Value pairs that uniquely identify the certificate issuer.
CertKeyAlgorithm	Specifies the public key algorithm of this certificate.
CertKeyBits	Returns the length of the public key in bits.
CertKeyFingerprint	Returns a SHA1 fingerprint of the public key contained in the certificate.
CertKeyUsage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
CertKeyValid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
CertOCSPLocations	Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
CertOCSPNoCheck	Accessor to the value of the certificate's ocsp-no-check extension.
CertOrigin	Returns the location that the certificate was taken or loaded from.
CertPolicyIDs	Contains identifiers (OIDs) of the applicable certificate policies.
CertPrivateKeyBytes	Returns the certificate's private key in DER-encoded format.
CertPrivateKeyExists	Indicates whether the certificate has a usable private key associated with it.
CertPrivateKeyExtractable	Indicates whether the private key is extractable (exportable).
CertPublicKeyBytes	Contains the certificate's public key in DER format.
CertQualified	Indicates whether the certificate is qualified.
CertQualifiedStatements	Returns a simplified qualified status of the certificate.
CertQualifiers	A list of qualifiers.
CertSelfSigned	Indicates whether the certificate is self-signed (root) or signed by an external CA.
CertSerialNumber	Returns the certificate's serial number.
CertSigAlgorithm	Indicates the algorithm that was used by the CA to sign this certificate.
CertSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
CertSubject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
CertSubjectAlternativeName	Returns or sets the value of the Subject Alternative Name extension of the certificate.
CertSubjectKeyID	Contains a unique identifier of the certificate's cryptographic key.
CertSubjectRDN	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
CertValid	Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
CertValidFrom	The time point at which the certificate becomes valid, in UTC.
CertValidTo	The time point at which the certificate expires, in UTC.
CheckTrustedLists	Specifies whether the class should attempt to validate chain trust via a known Trusted List.
CRLCount	The number of records in the CRL arrays.
CRLBytes	Returns the raw CRL data in DER format.
CRLCAKeyID	A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
CRLEntryCount	Returns the number of certificate status entries in the CRL.
CRLHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
CRLIssuer	The common name of the CRL issuer (CA), typically a company name.
CRLIssuerRDN	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
CRLLocation	The URL that the CRL was downloaded from.
CRLNextUpdate	The planned time and date of the next version of this CRL to be published.
CRLSigAlgorithm	The public key algorithm that was used by the CA to sign this CRL.
CRLSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
CRLTBS	The to-be-signed part of the CRL (the CRL without the signature part).
CRLThisUpdate	The date and time at which this version of the CRL was published.
Extended	Specifies the type of ASiC signature.
ExternalCryptoAsyncDocumentID	Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
ExternalCryptoCustomParams	Custom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoData	Additional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculation	Specifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithm	Specifies the request's signature hash algorithm.
ExternalCryptoKeyID	The ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecret	The pre-shared key used for DC request authentication.
ExternalCryptoMethod	Specifies the asynchronous signing method.
ExternalCryptoMode	Specifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithm	Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
FileCount	The number of records in the File arrays.
FileAction	This property contains the action to apply to the file.
FileAttributes	This property provides access to file attributes.
FileCompressedSize	This property contains the size of the file after compression.
FileDataSource	This property contains the type of data source for this entry.
FileDirectory	This property tells if the entry is a directory or a regular file.
FileEncryptionAlgorithm	This property returns the symmetric algorithm that was used to encrypt the file.
FileEncryptionKeyLength	This property returns the length, in bits, of the encryption key.
FileEncryptionType	This property contains the type of encryption applied to the file.
FileName	This property specifies the original name of the compressed file or folder.
FileFolder	This property includes the containing folder of the entry.
FileLocalPath	This property contains the local path associated with this entry.
FileMTime	This property contains the entry's last modification time.
FileNewFile	This property indicates whether the entry corresponds to a file to be added to the archive.
FilePath	This property contains the full internal path of the archived entry.
FileSignatureCount	This property includes the number of signatures covering the entry.
FileSigned	This property indicates whether the entry is signed.
FileSize	This property specifies the size of the file before compression.
FIPSMode	Reserved.
IgnoreChainValidationErrors	Makes the class tolerant to chain validation errors.
InputBytes	Use this property to pass the input to class in byte array form.
InputFile	A path to the ASiC container to process.
KnownCertCount	The number of records in the KnownCert arrays.
KnownCertBytes	Returns the raw certificate data in DER format.
KnownCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
KnownCRLCount	The number of records in the KnownCRL arrays.
KnownCRLBytes	Returns the raw CRL data in DER format.
KnownCRLHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
KnownOCSPCount	The number of records in the KnownOCSP arrays.
KnownOCSPBytes	A buffer containing the raw OCSP response data.
KnownOCSPHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
NewSigChainValidationDetails	The details of a certificate chain validation outcome.
NewSigChainValidationResult	The outcome of a certificate chain validation routine.
NewSigClaimedSigningTime	Returns or sets signature's creation time.
NewSigCompatibilityErrors	Returns compatibility errors encountered during validation.
NewSigContainsLongTermInfo	Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
NewSigContentType	The signature content type.
NewSigEntityLabel	Use this property to get the signature entity label.
NewSigFileName	The name of the ASiC signature file.
NewSigHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
NewSigHashAlgorithm	Set or returns the hash algorithm used to generate the signature.
NewSigIssuerRDN	The Relative Distinguished Name of the signing certificate's issuer.
NewSigLevel	Specifies the level according to which the inner AdES signature is to be composed CAdES and XAdES standards define a number of signature levels.
NewSigPolicyHash	The signature policy hash value.
NewSigPolicyHashAlgorithm	The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.
NewSigPolicyID	The policy ID that was included or to be included into the signature.
NewSigPolicyURI	The signature policy URI that was included in the signature.
NewSigSerialNumber	The serial number of the signing certificate.
NewSigSignatureBytes	Returns the binary representation of the ASiC signature.
NewSigSignatureType	The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.
NewSigSignatureValidationResult	The outcome of the cryptographic signature validation.
NewSigSignedFiles	Contains a comma-separated list of files that are covered by the signature.
NewSigSubjectKeyID	Contains the subject key identifier of the signing certificate.
NewSigSubjectRDN	Contains the RDN of the owner of the signing certificate.
NewSigTimestamped	Use this property to establish whether the signature contains an embedded timestamp.
NewSigValidatedSigningTime	Contains the certified signing time.
NewSigValidationLog	Contains the signing certificate's chain validation log.
OCSPCount	The number of records in the OCSP arrays.
OCSPBytes	A buffer containing the raw OCSP response data.
OCSPEntryCount	The number of SingleResponse elements contained in this OCSP response.
OCSPHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
OCSPIssuer	Indicates the issuer of this response (a CA or its authorized representative).
OCSPIssuerRDN	Indicates the RDN of the issuer of this response (a CA or its authorized representative).
OCSPLocation	The location of the OCSP responder.
OCSPProducedAt	Specifies the time when the response was produced, in UTC.
OCSPSigAlgorithm	The public key algorithm that was used by the CA to sign this OCSP response.
OCSPSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
OfflineMode	Switches the class to offline mode.
OutputBytes	Use this property to read the output the class object has produced.
OutputFile	The file where the signed data will be saved.
OutputPath	A local path to extract the files to.
Profile	Specifies a pre-defined profile to apply when creating the signature.
ProxyAddress	The IP address of the proxy server.
ProxyAuthentication	The authentication type used by the proxy server.
ProxyPassword	The password to authenticate to the proxy server.
ProxyPort	The port on the proxy server to connect to.
ProxyType	The type of the proxy server.
ProxyRequestHeaders	Contains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBody	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeaders	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6	Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUsername	Specifies the username credential for proxy authentication.
RevocationCheck	Specifies the kind(s) of revocation check to perform for all chain certificates.
SignatureCount	The number of records in the Signature arrays.
SignatureChainValidationDetails	The details of a certificate chain validation outcome.
SignatureChainValidationResult	The outcome of a certificate chain validation routine.
SignatureClaimedSigningTime	Returns or sets signature's creation time.
SignatureCompatibilityErrors	Returns compatibility errors encountered during validation.
SignatureContainsLongTermInfo	Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
SignatureContentType	The signature content type.
SignatureEntityLabel	Use this property to get the signature entity label.
SignatureFileName	The name of the ASiC signature file.
SignatureHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
SignatureHashAlgorithm	Set or returns the hash algorithm used to generate the signature.
SignatureIssuerRDN	The Relative Distinguished Name of the signing certificate's issuer.
SignatureLevel	Specifies the level according to which the inner AdES signature is to be composed CAdES and XAdES standards define a number of signature levels.
SignaturePolicyHash	The signature policy hash value.
SignaturePolicyHashAlgorithm	The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.
SignaturePolicyID	The policy ID that was included or to be included into the signature.
SignaturePolicyURI	The signature policy URI that was included in the signature.
SignatureSerialNumber	The serial number of the signing certificate.
SignatureBytes	Returns the binary representation of the ASiC signature.
SignatureType	The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.
SignatureValidationResult	The outcome of the cryptographic signature validation.
SignatureSignedFiles	Contains a comma-separated list of files that are covered by the signature.
SignatureSubjectKeyID	Contains the subject key identifier of the signing certificate.
SignatureSubjectRDN	Contains the RDN of the owner of the signing certificate.
SignatureTimestamped	Use this property to establish whether the signature contains an embedded timestamp.
SignatureValidatedSigningTime	Contains the certified signing time.
SignatureValidationLog	Contains the signing certificate's chain validation log.
SigningCertBytes	Returns the raw certificate data in DER format.
SigningCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
SigningChainCount	The number of records in the SigningChain arrays.
SigningChainBytes	Returns the raw certificate data in DER format.
SigningChainHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
SocketDNSMode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPort	Specifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeout	The timeout (in milliseconds) for each DNS query.
SocketDNSServers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeout	The timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimit	The maximum number of bytes to read from the socket, per second.
SocketLocalAddress	The local network interface to bind the socket to.
SocketLocalPort	The local port number to bind the socket to.
SocketOutgoingSpeedLimit	The maximum number of bytes to write to the socket, per second.
SocketTimeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6	Enables or disables IP protocol version 6.
SourceBytes	Use this property to pass the content to sign in the byte array form.
SourceFiles	The files to be packed into the container.
SourceName	Use this property to specify the name of the file being signed if passing it via the SourceBytes property.
TimestampCount	The number of records in the Timestamp arrays.
TimestampAccuracy	This property indicates the accuracy of the included time mark, in microseconds.
TimestampBytes	Returns the raw timestamp data in DER format.
TimestampCertificateIndex	Returns the index of the TSA certificate in the Certificates collection.
TimestampChainValidationDetails	The details of a certificate chain validation outcome.
TimestampChainValidationResult	The outcome of a certificate chain validation routine.
TimestampContainsLongTermInfo	Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
TimestampEntityLabel	Use this property to get the timestamp entity label.
TimestampHashAlgorithm	Returns the timestamp's hash algorithm.
TimestampParentEntity	Use this property to get the label of the timestamp's parent entity.
TimestampSerialNumber	Returns the timestamp's serial number.
TimestampTime	The time point incorporated into the timestamp.
TimestampType	Returns the type of the timestamp.
TimestampTSAName	This value uniquely identifies the Timestamp Authority (TSA).
TimestampValidationLog	Contains the TSA certificate chain validation log.
TimestampValidationResult	Contains the timestamp validation outcome.
TimestampServer	The address of the timestamping server.
TLSClientCertCount	The number of records in the TLSClientCert arrays.
TLSClientCertBytes	Returns the raw certificate data in DER format.
TLSClientCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertCount	The number of records in the TLSServerCert arrays.
TLSServerCertBytes	Returns the raw certificate data in DER format.
TLSServerCertFingerprint	Contains the fingerprint (a hash imprint) of this certificate.
TLSServerCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertIssuer	The common name of the certificate issuer (CA), typically a company name.
TLSServerCertIssuerRDN	A list of Property=Value pairs that uniquely identify the certificate issuer.
TLSServerCertKeyAlgorithm	Specifies the public key algorithm of this certificate.
TLSServerCertKeyBits	Returns the length of the public key in bits.
TLSServerCertKeyUsage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
TLSServerCertSelfSigned	Indicates whether the certificate is self-signed (root) or signed by an external CA.
TLSServerCertSerialNumber	Returns the certificate's serial number.
TLSServerCertSigAlgorithm	Indicates the algorithm that was used by the CA to sign this certificate.
TLSServerCertSubject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
TLSServerCertSubjectRDN	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
TLSServerCertValidFrom	The time point at which the certificate becomes valid, in UTC.
TLSServerCertValidTo	The time point at which the certificate expires, in UTC.
TLSAutoValidateCertificates	Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfiguration	Selects the base configuration for the TLS settings.
TLSCiphersuites	A list of ciphersuites separated with commas or semicolons.
TLSClientAuth	Enables or disables certificate-based client authentication.
TLSExtensions	Provides access to TLS extensions.
TLSForceResumeIfDestinationChanges	Whether to force TLS session resumption when the destination address changes.
TLSGroups	Specifies a list of key exchange groups to attempt during the TLS key exchange.
TLSPreSharedIdentity	Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKey	Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuite	Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionMode	Selects the renegotiation attack prevention mechanism.
TLSRevocationCheck	Specifies the kind(s) of revocation check to perform.
TLSSSLOptions	Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
TLSMode	Specifies the TLS mode to use.
TLSUseExtendedMasterSecret	Enables the Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumption	Enables or disables the TLS session resumption capability.
TLSVersions	The SSL/TLS versions to enable by default.
TrustedCertCount	The number of records in the TrustedCert arrays.
TrustedCertBytes	Returns the raw certificate data in DER format.
TrustedCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ValidationMoment	The time point at which signature validity is to be established.

Method List

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


AddFile	Use this method to add a file to the archive.
Close	Closes an opened container.
Config	Sets or retrieves a configuration setting.
CreateNew	Creates a new ASiC container.
DoAction	Performs an additional action.
ExtractAsyncData	Extracts user data from the DC signing service response.
ExtractFile	Extracts a file to one of the output media (bytes, stream, or disk file).
ExtractFiles	Extracts files covered by a signature to OutputPath .
Open	Opens an existing container for signing or updating.
Reset	Resets the class settings.
Revalidate	Revalidates a signature in accordance with current settings.
SelectInfo	Select signature information for a specific entity.
Sign	Signs the chosen files and packs them into an ASiC archive.
SignAsyncBegin	Initiates the asynchronous signing operation.
SignAsyncEnd	Completes the asynchronous signing operation.
SignExternal	Signs the document using an external signing facility.
Timestamp	Use this method to add timestamp.
Upgrade	Upgrades existing CAdES or XAdES signature to a new level.

Event List

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


ChainElementDownload	Fires when there is a need to download a chain element from an online source.
ChainElementNeeded	Fires when an element required to validate the chain was not located.
ChainElementStore	This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
ChainValidated	Reports the completion of a certificate chain validation.
ChainValidationProgress	This event is fired multiple times during chain validation to report various stages of the validation procedure.
ContainerLoaded	This event is fired when the container has been loaded into memory.
Error	Information about any errors that occur during signing or archiving.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
FileExtractionStart	Signifies the start of a file extraction process.
Notification	This event notifies the application about an underlying control flow event.
SignatureFound	Signifies the start of signature validation.
SignatureValidated	Marks the completion of the signature validation routine.
TimestampFound	Signifies the start of a timestamp validation routine.
TimestampRequest	Fires when the class is ready to request a timestamp from an external TSA.
TimestampValidated	Reports the completion of the timestamp validation routine.
TLSCertNeeded	Fires when a remote TLS party requests a client certificate.
TLSCertValidate	This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablished	Fires when a TLS handshake with Host successfully completes.
TLSHandshake	Fires when a new TLS handshake is initiated, before the handshake commences.
TLSShutdown	Reports the graceful closure of a TLS connection.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.


AddAllDataObjectsTimestamp	Whether to add all data objects timestamp during signing.
ASiCOptions	Specifies the ASiC options.
AsyncDocumentID	Specifies the document ID for SignAsyncEnd() call.
CachedCRLMaxAge	Specifies the maximum age of a cached CRL.
CachedCRLMaxAgeRatio	Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.
CachedCRLOverlapTime	Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.
CachedOCSPResponseMaxAge	Specifies the maximum age of a cached OCSP response.
CachedOCSPResponseMaxAgeRatio	Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.
CachedOCSPResponseOverlapTime	Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.
ChainCurrentCACert	Returns the current CA certificate.
ChainCurrentCert	Returns the certificate that is currently being validated.
ChainCurrentCRL	Returns the current CRL.
ChainCurrentCRLSize	Returns the size of the current CRL.
ChainCurrentOCSP	Returns the current OCSP response.
ChainCurrentOCSPSigner	Returns the signer of the current OCSP object.
ChainInterimDetails	Returns the current interim validation details.
ChainInterimResult	Returns the current interim validation result.
CheckValidityPeriodForTrusted	Whether to check validity period for trusted certificates.
ClaimedRolesXML	The XML content of the claimed roles.
ClaimedRoleText	The text of the claimed role.
CmsOptAnnexKArchiveTimestampV2Mode	Toggles use of Annex K method of calculating validation timestamp hashes.
CmsOptCheckATSHashIndexElements	Enables extra checks when processing ATSHashIndex attribute.
CmsOptCompareRDNAsStrings	Enforces comparison of RDN elements as text strings, rather than their byte encodings.
CmsOptDEREncodeContentForATSv2	Enables DER encoding for ATSv2 hashed content.
CmsOptDigitPADSSCompatibility	Enables Digit PADSS compatibility mode.
CmsOptForceSigningCertificateV2Usage	Enforces use of signing-certificate-v2 attribute.
CmsOptIgnoreDERReqInArchiveTimestamps	Switches off DER encoding requirement for archival timestamps.
CmsOptImzagerMIMCompatibility	Enables Imzager MIM compatibility mode.
CmsOptIncludeCertToAttributes	Regulates whether to include the signing certificate to the signature as the signing-certificate attribute.
CmsOptIncludeCertToMessage	Regulates whether to include the signing certificate and its chain to the CMS.
CmsOptInsertContentType	Regulates whether the content-type time attribute should be included in the signature structure.
CmsOptInsertMessageDigests	Regulates whether the message-digest signed attribute should be included in the signature structure.
CmsOptInsertSigningTime	Regulates whether the signing-time attribute should be included in the signature structure.
CmsOptSkipEnvContentInfoOnSigArchival	Excludes hashing of enveloped content when calculating an archival timestamp.
CmsOptUseATSHashIndexV1	Enables use of ATSHashIndexV1 attribute.
CmsOptUseATSHashIndexV3	Enables the use of the third version of archival timestamps.
CmsOptUseGeneralizedTimeFormat	Enables or disables encoding of the signing-time attribute using ASN.1 GENERALIZEDTIME type.
CmsOptUseGenericSigAlgorithmOIDs	Enables use of generic signature algorithm OIDs in the signature.
CmsOptUsePlainContentForTimestampHashes	Makes CAdESSigner ignore ASN.1 content formatting when calculating timestamp hashes.
CommitmentTypeIndicationAllSignedDataObjects[Index]	Specifies the CommitmentTypeIndication's AllSignedDataObjects.
CommitmentTypeIndicationCount	The number of the CommitmentTypeIndication elements.
CommitmentTypeIndicationIdentifier[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.
CommitmentTypeIndicationIdentifierDescription[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.
CommitmentTypeIndicationIdentifierDocumentationReferences[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.
CommitmentTypeIndicationIdentifierQualifier[Index]	Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.
CommitmentTypeIndicationObjectReference[Index]	Specifies the CommitmentTypeIndication's ObjectReference.
CommitmentTypeIndicationQualifiersXML[Index]	The XML content of the CommitmentTypeIndication's Qualifiers.
ContentType	Specifies the content-type of the container.
CustomTrustedLists	Specifies the custom TrustedLists.
CustomTSLs	Specifies the custom TrustedLists.
DataObjectFormatCount	The number of the DataObjectFormat elements.
DataObjectFormatDescription[Index]	Specifies the DataObjectFormat's Description.
DataObjectFormatEncoding[Index]	Specifies the DataObjectFormat's Encoding.
DataObjectFormatMimeType[Index]	Specifies the DataObjectFormat's MimeType.
DataObjectFormatObjectIdentifier[Index]	Specifies the DataObjectFormat's ObjectIdentifier's Identifier.
DataObjectFormatObjectIdentifierDescription[Index]	Specifies the DataObjectFormat's ObjectIdentifier's Description.
DataObjectFormatObjectIdentifierDocumentationReferences[Index]	Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences.
DataObjectFormatObjectIdentifierQualifier[Index]	Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier.
DataObjectFormatObjectReference[Index]	Specifies the DataObjectFormat's ObjectReference.
DeltaCRLPreference	Specifies whether complete or delta CRLs are preferred.
DislikeOpenEndedOCSPs	Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.
EvaluateSystemTrust	Enables or disables usage of the platform's built-in trust validation facilities.
EvaluateSystemTrustForSelfSignedCertificates	Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.
EvaluateSystemTrustForSSL	Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.
ExclusiveCanonicalizationPrefix	Specifies the exclusive canonicalization prefix.
ForceCompleteChainValidation	Whether to check the CA certificates when the signing certificate is invalid.
ForceCompleteChainValidationForTrusted	Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
GenerateMetaInfEntry	Specifies whether the directory META-INF entry should be generated.
GracePeriod	Specifies a grace period to apply during revocation information checks.
HMACKey	The key value for HMAC.
HMACOutputLength	Sets the length of the HMAC output.
HMACSigningUsed	Whether to use HMAC signing.
IgnoreChainLoops	Whether chain loops should be ignored.
IgnoreChainValidationErrors	Whether to ignore any certificate chain validation issues.
IgnoreOCSPNoCheckExtension	Whether the OCSP NoCheck extension should be ignored.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
IgnoreTimestampFailure	Whether to ignore time-stamping failure during signing.
ImplicitlyTrustSelfSignedCertificates	Whether to trust self-signed certificates.
IncludeKnownRevocationInfoToSignature	Whether to include custom revocation info to the signature.
InclusiveNamespacesPrefixList	Specifies the InclusiveNamespaces PrefixList.
KeyInfoID	Specifies the ID for KeyInfo element.
KeyName	Contains information about the key used for signing.
ManifestHandlingMode	The approach to use manifest conflict resolution.
Overwrite	Forcefully overwrite OutputFile if it exists.
PolicyDescription	signature policy description.
PolicyExplicitText	The explicit text of the user notice.
PolicyUNNumbers	The noticeNumbers part of the NoticeReference CAdES attribute.
PolicyUNOrganization	The organization part of the NoticeReference qualifier.
ProductionPlace	Identifies the place of the signature production.
PromoteLongOCSPResponses	Whether long OCSP responses are requested.
PSSUsed	Whether to use RSASSA-PSS algorithm.
QualifyingPropertiesID	Specifies the ID for QualifyingProperties element.
QualifyingPropertiesObjectID	Specifies the ID for object with QualifyingProperties element.
QualifyingPropertiesReferenceCount	The number of the QualifyingPropertiesReference elements.
QualifyingPropertiesReferenceID[Index]	Specifies the QualifyingPropertiesReference's ID.
QualifyingPropertiesReferenceURI[Index]	Specifies the QualifyingPropertiesReference's URI.
RefHashAlgorithm	Specifies the hash algorithm for references.
RefMimeType	Specifies the MIME type to apply to the processed file.
RefsTimestampType	Specifies references timestamp type to include to the signature.
RevocationCacheAgePolicy	Specifies a preset policy for cached CRL and OCSP response freshness settings.
SchemeParams	The algorithm scheme parameters to employ.
SignatureID	Specifies the ID for Signature element.
SignaturePrefix	Specifies the signature prefix.
SignatureValueID	Specifies the ID for SignatureValue element.
SignedInfoID	Specifies the ID for SignedInfo element.
SignedPropertiesID	Specifies the ID for SignedProperties element.
SignedPropertiesReferenceCanonicalizationMethod	Specifies the canonicalization method used in SignedProperties reference.
SignedPropertiesReferenceHashAlgorithm	Specifies the hash algorithm used in SignedProperties reference.
SignedPropertiesReferenceID	Specifies the ID for Reference element that points to SignedProperties element.
SignedPropertiesReferenceInclusiveNamespacesPrefixList	Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference.
SignedPropertiesReferenceIndex	Specifies the index of SignedProperties reference.
SignedSignaturePropertiesID	Specifies the ID for SignedSignatureProperties element.
SigningCertificatesChain	Specifies which certificates from SigningChain are included in the xades:SigningCertificate element.
SigningCertificatesHashAlgorithm	Specifies the hash algorithm used for SigningCertificates.
SigningTimeFormat	Specifies the date time format for the XAdES signing time.
SigningTimeIsUTC	Specifies whether the XAdES signing time is in UTC.
SigningTimeZoneOffset	Specifies the time zone offset for the XAdES signing time.
SigPolicyDescription	signature policy description.
SigPolicyExplicitText	The explicit text of the user notice.
SigPolicyHash	The EPES policy hash.
SigPolicyHashAlgorithm	The hash algorithm that was used to generate the EPES policy hash.
SigPolicyID	The EPES policy ID.
SigPolicyNoticeNumbers	The noticeNumbers part of the NoticeReference CAdES attribute.
SigPolicyNoticeOrganization	The organization part of the NoticeReference qualifier.
SigPolicyURI	The EPES policy URI.
TempPath	Path for storing temporary files.
TimestampCanonicalizationMethod	Specifies canonicalization method used in timestamp.
TimestampResponse	A base16-encoded timestamp response received from a TSA.
TimestampValidationDataDetails	Specifies timestamp validation data details to include to the signature.
TLSChainValidationDetails	Contains the advanced details of the TLS server certificate validation.
TLSChainValidationResult	Contains the result of the TLS server certificate validation.
TLSClientAuthRequested	Indicates whether the TLS server requests client authentication.
TLSValidationLog	Contains the log of the TLS server certificate validation.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
TspAttemptCount	Specifies the number of timestamping request attempts.
TspHashAlgorithm	Sets a specific hash algorithm for use with the timestamping service.
TspReqPolicy	Sets a request policy ID to include in the timestamping request.
UseArchivalTimestampV3	Use ArchivalTimestampV3 attribute for A-level CAdES signatures.
UseDefaultTrustedLists	Enables or disables the use of the default TrustedLists.
UseDefaultTSLs	Enables or disables the use of the default TrustedLists.
UseEnvStorages	Enables or disables use of the environment storages.
UseHMACSigning	Whether to use HMAC signing.
UseMicrosoftCTL	Enables or disables the automatic use of the Microsoft online certificate trust list.
UsePSS	Whether to use RSASSA-PSS algorithm.
UseSystemCertificates	Enables or disables the use of the system certificates.
UseUTF8Filenames	Specifies whether to use UTF-8 filenames.
UseValidationCache	Enables or disable the use of the product-wide certificate chain validation cache.
UseValidatorSettingsForTLSValidation	Whether to employ the primary chain validator setup for auxiliary TLS chain validations.
ValidationDataRefsDetails	Specifies validation data references details to include to the signature.
ValidationDataRefsHashAlgorithm	Specifies the hash algorithm used in validation data references.
ValidationDataValuesDetails	Specifies validation data values details to include to the signature.
XAdESPrefix	Specifies the XAdES prefix.
XAdESv141Prefix	Specifies the XAdES v1.4.1 prefix.
XmlRefID	Specifies a custom value for the ID attribute of a reference.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
EnableSSHMLKEM	Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes.
EnableTLSMLKEM	Enables support for ML-KEM and hybrid groups in TLS client and server classes.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables 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.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

AutoValidateSignatures Property (ASiCSigner Component)

Specifies whether ASiCSigner should validate any present signatures when the document is opened.

Syntax

func (obj *ASiCSigner) AutoValidateSignatures() (bool, error)
func (obj *ASiCSigner) SetAutoValidateSignatures(value bool) error

Default Value

false

Remarks

This setting is switched off by default to speed up document processing. Even if the document is loaded with this property set to false, you can validate the signatures manually on a later stage using the Revalidate method.

Data Type

bool

BlockedCertCount Property (ASiCSigner Component)

The number of records in the BlockedCert arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

BlockedCertBytes
BlockedCertHandle

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

Data Type

int32

BlockedCertBytes Property (ASiCSigner Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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 (ASiCSigner Component)

The number of records in the Cert arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

CertBytes
CertCA
CertCAKeyID
CertCRLDistributionPoints
CertCurve
CertFingerprint
CertFriendlyName
CertHandle
CertHashAlgorithm
CertIssuer
CertIssuerRDN
CertKeyAlgorithm
CertKeyBits
CertKeyFingerprint
CertKeyUsage
CertKeyValid
CertOCSPLocations
CertOCSPNoCheck
CertOrigin
CertPolicyIDs
CertPrivateKeyBytes
CertPrivateKeyExists
CertPrivateKeyExtractable
CertPublicKeyBytes
CertQualified
CertQualifiedStatements
CertQualifiers
CertSelfSigned
CertSerialNumber
CertSigAlgorithm
CertSource
CertSubject
CertSubjectAlternativeName
CertSubjectKeyID
CertSubjectRDN
CertType
CertValid
CertValidFrom
CertValidTo

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

This property is read-only.

Data Type

int32

CertBytes Property (ASiCSigner Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Indicates whether the certificate has a CA capability.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Possible Values

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

Default Value

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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

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

This property is read-only.

Data Type

string

CertFingerprint Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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 (ASiCSigner 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 *ASiCSigner) 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_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

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

This property is read-only.

Data Type

string

CertIssuer Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Specifies the public key algorithm of this certificate.

Syntax

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

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`
SB_CERT_ALGORITHM_MLDSA_44	`id-ml-dsa-44`
SB_CERT_ALGORITHM_MLDSA_65	`id-ml-dsa-65`
SB_CERT_ALGORITHM_MLDSA_87	`id-ml-dsa-87`
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512	`id-hash-ml-dsa-44-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512	`id-hash-ml-dsa-65-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512	`id-hash-ml-dsa-87-with-sha512`
SB_CERT_ALGORITHM_MLKEM_512	`id-ml-kem-512`
SB_CERT_ALGORITHM_MLKEM_768	`id-ml-kem-768`
SB_CERT_ALGORITHM_MLKEM_1024	`id-ml-kem-1024`

Use the CertKeyBits, 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 (ASiCSigner Component)

Returns the length of the public key in bits.

Syntax

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

Default Value

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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

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

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

This property is read-only.

Data Type

int32

CertKeyValid Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner 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 *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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 (ASiCSigner Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Indicates whether the private key is extractable (exportable).

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Contains the certificate's public key in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Indicates whether the certificate is qualified.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Returns a simplified qualified status of the certificate.

Syntax

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

Possible Values

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

Default Value

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 (ASiCSigner Component)

A list of qualifiers.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Returns the certificate's serial number.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Possible Values

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

Default Value

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 (ASiCSigner 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 *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner 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 *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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

CheckTrustedLists Property (ASiCSigner Component)

Specifies whether the class should attempt to validate chain trust via a known Trusted List.

Syntax

func (obj *ASiCSigner) CheckTrustedLists() (bool, error)
func (obj *ASiCSigner) SetCheckTrustedLists(value bool) error

Default Value

false

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

Data Type

bool

CRLCount Property (ASiCSigner Component)

The number of records in the CRL arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

CRLBytes
CRLCAKeyID
CRLEntryCount
CRLHandle
CRLIssuer
CRLIssuerRDN
CRLLocation
CRLNextUpdate
CRLSigAlgorithm
CRLSource
CRLTBS
CRLThisUpdate

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

This property is read-only.

Data Type

int32

CRLBytes Property (ASiCSigner Component)

Returns the raw CRL data in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Returns the number of certificate status entries in the CRL.

Syntax

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

Default Value

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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

The URL that the CRL was downloaded from.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Possible Values

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

Default Value

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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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

Extended Property (ASiCSigner Component)

Specifies the type of ASiC signature.

Syntax

func (obj *ASiCSigner) Extended() (bool, error)
func (obj *ASiCSigner) SetExtended(value bool) error

Default Value

false

Remarks

A simple signature container (ASiC-S) can only be made over a single document, and use one signature format (a CAdES signature, a XAdES signature, or a timestamp)

An extended container (ASiC-E) can cover multiple documents and contain multiple signatures of different types. Set this property to true to create an extended ASiC container.

Data Type

bool

ExternalCryptoAsyncDocumentID Property (ASiCSigner Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

func (obj *ASiCSigner) ExternalCryptoAsyncDocumentID() (string, error)
func (obj *ASiCSigner) SetExternalCryptoAsyncDocumentID(value string) error

Default Value

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

string

ExternalCryptoCustomParams Property (ASiCSigner Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

func (obj *ASiCSigner) ExternalCryptoCustomParams() (string, error)
func (obj *ASiCSigner) SetExternalCryptoCustomParams(value string) error

Default Value

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

Data Type

string

ExternalCryptoData Property (ASiCSigner Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

func (obj *ASiCSigner) ExternalCryptoData() (string, error)
func (obj *ASiCSigner) SetExternalCryptoData(value string) error

Default Value

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

Data Type

string

ExternalCryptoExternalHashCalculation Property (ASiCSigner Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

func (obj *ASiCSigner) ExternalCryptoExternalHashCalculation() (bool, error)
func (obj *ASiCSigner) SetExternalCryptoExternalHashCalculation(value bool) error

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth struct.

If set to true, the struct will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

bool

ExternalCryptoHashAlgorithm Property (ASiCSigner Component)

Specifies the request's signature hash algorithm.

Syntax

func (obj *ASiCSigner) ExternalCryptoHashAlgorithm() (string, error)
func (obj *ASiCSigner) SetExternalCryptoHashAlgorithm(value string) error

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

Data Type

string

ExternalCryptoKeyID Property (ASiCSigner Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

func (obj *ASiCSigner) ExternalCryptoKeyID() (string, error)
func (obj *ASiCSigner) SetExternalCryptoKeyID(value string) error

Default Value

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

string

ExternalCryptoKeySecret Property (ASiCSigner Component)

The pre-shared key used for DC request authentication.

Syntax

func (obj *ASiCSigner) ExternalCryptoKeySecret() (string, error)
func (obj *ASiCSigner) SetExternalCryptoKeySecret(value string) error

Default Value

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

string

ExternalCryptoMethod Property (ASiCSigner Component)

Specifies the asynchronous signing method.

Syntax

func (obj *ASiCSigner) ExternalCryptoMethod() (int32, error)
func (obj *ASiCSigner) SetExternalCryptoMethod(value int32) error

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Data Type

int32

ExternalCryptoMode Property (ASiCSigner Component)

Specifies the external cryptography mode.

Syntax

func (obj *ASiCSigner) ExternalCryptoMode() (int32, error)
func (obj *ASiCSigner) SetExternalCryptoMode(value int32) error

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

Remarks

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with the OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

Data Type

int32

ExternalCryptoPublicKeyAlgorithm Property (ASiCSigner Component)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

func (obj *ASiCSigner) ExternalCryptoPublicKeyAlgorithm() (string, error)
func (obj *ASiCSigner) SetExternalCryptoPublicKeyAlgorithm(value string) error

Default Value

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`
SB_CERT_ALGORITHM_MLDSA_44	`id-ml-dsa-44`
SB_CERT_ALGORITHM_MLDSA_65	`id-ml-dsa-65`
SB_CERT_ALGORITHM_MLDSA_87	`id-ml-dsa-87`
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512	`id-hash-ml-dsa-44-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512	`id-hash-ml-dsa-65-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512	`id-hash-ml-dsa-87-with-sha512`
SB_CERT_ALGORITHM_MLKEM_512	`id-ml-kem-512`
SB_CERT_ALGORITHM_MLKEM_768	`id-ml-kem-768`
SB_CERT_ALGORITHM_MLKEM_1024	`id-ml-kem-1024`

Data Type

string

FileCount Property (ASiCSigner Component)

The number of records in the File arrays.

Syntax

func (obj *ASiCSigner) FileCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

FileAction
FileAttributes
FileCompressedSize
FileDataSource
FileDirectory
FileEncryptionAlgorithm
FileEncryptionKeyLength
FileEncryptionType
FileFolder
FileLocalPath
FileMTime
FileName
FileNewFile
FilePath
FileSignatureCount
FileSigned
FileSize

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

This property is read-only.

Data Type

int32

FileAction Property (ASiCSigner Component)

This property contains the action to apply to the file.

Syntax

func (obj *ASiCSigner) FileAction(FileIndex int32) (int32, error)

Possible Values

0   // Add
1   // Keep
2   // Update
3   // Delete
4   // Extract
5   // Skip

Default Value

Remarks

This property contains the action to apply to the file.

Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:


atAdd (0)	Add the file to the archive.
atKeep (1)	Keep the existing file in the archive.
atUpdate (2)	Update the archived file with a fresher copy.
atDelete (3)	Delete the file from the archive.
atExtract (4)	Extract the file (extraction only).
atSkip (5)	Skip file extraction (extraction only).

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

int32

FileAttributes Property (ASiCSigner Component)

This property provides access to file attributes.

Syntax

func (obj *ASiCSigner) FileAttributes(FileIndex int32) (string, error)

Default Value

Remarks

This property provides access to file attributes.

ZIP archives support the provision of Windows (or DOS, as it is called historically) or Unix file attributes. Use this property to provide access to the attributes or to read them out of an existing archive.

Use "dos:" or "unix:" prefixes to indicate what kind of attributes you need to include, as follows:

Writer.Files[0].Attributes = "unix:-rwxr-xr-x"; Writer.Files[1].Attributes = "unix:-r--r--r--"; Writer.Files[2].Attributes = "dos:readonly"; Writer.Files[3].Attributes = "dos:readonly;hidden"; // supported values: readonly, hidden, system, volumeLabel, directory, archive

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

string

FileCompressedSize Property (ASiCSigner Component)

This property contains the size of the file after compression.

Syntax

func (obj *ASiCSigner) FileCompressedSize(FileIndex int32) (int64, error)

Default Value

Remarks

This property contains the size of the file after compression.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

int64

FileDataSource Property (ASiCSigner Component)

This property contains the type of data source for this entry.

Syntax

func (obj *ASiCSigner) FileDataSource(FileIndex int32) (int32, error)

Possible Values

0   // File
1   // Stream
2   // Buffer

Default Value

Remarks

This property contains the type of data source for this entry.

Use this property to control the data source for this entry.


fdsFile (0)	The data for this entry should be taken from the file provided by FileLocalPath.
fdsStream (1)	Data are going to be provided on-the-fly through the FileStream property.
fdsBuffer (2)	Data are going to be provided on-the-fly through the FileData property.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

int32

FileDirectory Property (ASiCSigner Component)

This property tells if the entry is a directory or a regular file.

Syntax

func (obj *ASiCSigner) FileDirectory(FileIndex int32) (bool, error)

Default Value

false

Remarks

This property tells if the entry is a directory or a regular file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

bool

FileEncryptionAlgorithm Property (ASiCSigner Component)

This property returns the symmetric algorithm that was used to encrypt the file.

Syntax

func (obj *ASiCSigner) FileEncryptionAlgorithm(FileIndex int32) (string, error)

Default Value

Remarks

This property returns the symmetric algorithm that was used to encrypt the file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

string

FileEncryptionKeyLength Property (ASiCSigner Component)

This property returns the length, in bits, of the encryption key.

Syntax

func (obj *ASiCSigner) FileEncryptionKeyLength(FileIndex int32) (int32, error)

Default Value

Remarks

This property returns the length, in bits, of the encryption key.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

int32

FileEncryptionType Property (ASiCSigner Component)

This property contains the type of encryption applied to the file.

Syntax

func (obj *ASiCSigner) FileEncryptionType(FileIndex int32) (int32, error)

Possible Values

0   // Default
1   // NoEncryption
2   // Generic
3   // WinZip
4   // Strong

Default Value

Remarks

This property contains the type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.


aetDefault (0)	Default encryption (not used for already encrypted files)
aetNoEncryption (1)	No encryption
aetGeneric (2)	Standard ZIP encryption
aetWinZip (3)	WinZIP-based encryption
aetStrong (4)	Strong encryption

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

int32

FileName Property (ASiCSigner Component)

This property specifies the original name of the compressed file or folder.

Syntax

func (obj *ASiCSigner) FileName(FileIndex int32) (string, error)

Default Value

Remarks

This property specifies the original name of the compressed file or folder.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

string

FileFolder Property (ASiCSigner Component)

This property includes the containing folder of the entry.

Syntax

func (obj *ASiCSigner) FileFolder(FileIndex int32) (string, error)

Default Value

Remarks

This property includes the containing folder of the entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

string

FileLocalPath Property (ASiCSigner Component)

This property contains the local path associated with this entry.

Syntax

func (obj *ASiCSigner) FileLocalPath(FileIndex int32) (string, error)

Default Value

Remarks

This property contains the local path associated with this entry.

It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

string

FileMTime Property (ASiCSigner Component)

This property contains the entry's last modification time.

Syntax

func (obj *ASiCSigner) FileMTime(FileIndex int32) (string, error)

Default Value

Remarks

This property contains the entry's last modification time.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

string

FileNewFile Property (ASiCSigner Component)

This property indicates whether the entry corresponds to a file to be added to the archive.

Syntax

func (obj *ASiCSigner) FileNewFile(FileIndex int32) (bool, error)

Default Value

false

Remarks

This property indicates whether the entry corresponds to a file to be added to the archive.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

bool

FilePath Property (ASiCSigner Component)

This property contains the full internal path of the archived entry.

Syntax

func (obj *ASiCSigner) FilePath(FileIndex int32) (string, error)

Default Value

Remarks

This property contains the full internal path of the archived entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

string

FileSignatureCount Property (ASiCSigner Component)

This property includes the number of signatures covering the entry.

Syntax

func (obj *ASiCSigner) FileSignatureCount(FileIndex int32) (int32, error)

Default Value

Remarks

This property includes the number of signatures covering the entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

int32

FileSigned Property (ASiCSigner Component)

This property indicates whether the entry is signed.

Syntax

func (obj *ASiCSigner) FileSigned(FileIndex int32) (bool, error)

Default Value

false

Remarks

This property indicates whether the entry is signed.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

bool

FileSize Property (ASiCSigner Component)

This property specifies the size of the file before compression.

Syntax

func (obj *ASiCSigner) FileSize(FileIndex int32) (int64, error)

Default Value

Remarks

This property specifies the size of the file before compression.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

int64

FIPSMode Property (ASiCSigner Component)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

IgnoreChainValidationErrors Property (ASiCSigner Component)

Makes the class tolerant to chain validation errors.

Syntax

func (obj *ASiCSigner) IgnoreChainValidationErrors() (bool, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Remarks

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

Data Type

[]byte

InputFile Property (ASiCSigner Component)

A path to the ASiC container to process.

Syntax

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

Default Value

Remarks

Use this property to provide a path to the ASiC container. Use InputStream to provide the container from memory rather than a disk file.

Data Type

string

KnownCertCount Property (ASiCSigner Component)

The number of records in the KnownCert arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

KnownCertBytes
KnownCertHandle

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

Data Type

int32

KnownCertBytes Property (ASiCSigner Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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 (ASiCSigner Component)

The number of records in the KnownCRL arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

KnownCRLBytes
KnownCRLHandle

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

Data Type

int32

KnownCRLBytes Property (ASiCSigner Component)

Returns the raw CRL data in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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 (ASiCSigner Component)

The number of records in the KnownOCSP arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

KnownOCSPBytes
KnownOCSPHandle

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

Data Type

int32

KnownOCSPBytes Property (ASiCSigner Component)

A buffer containing the raw OCSP response data.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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

NewSigChainValidationDetails Property (ASiCSigner Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *ASiCSigner) NewSigChainValidationDetails() (int32, error)

Default Value

Remarks

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

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

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

This property is read-only.

Data Type

int32

NewSigChainValidationResult Property (ASiCSigner Component)

The outcome of a certificate chain validation routine.

Syntax

func (obj *ASiCSigner) NewSigChainValidationResult() (int32, error)

Possible Values

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

Default Value

Remarks

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

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

This property is read-only.

Data Type

int32

NewSigClaimedSigningTime Property (ASiCSigner Component)

Returns or sets signature's creation time.

Syntax

func (obj *ASiCSigner) NewSigClaimedSigningTime() (string, error)
func (obj *ASiCSigner) SetNewSigClaimedSigningTime(value string) error

Default Value

Remarks

Returns or sets signature's creation time.

Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike NewSigValidatedSigningTime does not originate from a trusted TSA and may be forfeited or wrong.

The time is provided in UTC.

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

Data Type

string

NewSigCompatibilityErrors Property (ASiCSigner Component)

Returns compatibility errors encountered during validation.

Syntax

func (obj *ASiCSigner) NewSigCompatibilityErrors() (int32, error)

Default Value

Remarks

Returns compatibility errors encountered during validation.

Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.

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

This property is read-only.

Data Type

int32

NewSigContainsLongTermInfo Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) NewSigContainsLongTermInfo() (bool, error)

Default Value

false

Remarks

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

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

This property is read-only.

Data Type

bool

NewSigContentType Property (ASiCSigner Component)

The signature content type.

Syntax

func (obj *ASiCSigner) NewSigContentType() (string, error)
func (obj *ASiCSigner) SetNewSigContentType(value string) error

Default Value

Remarks

The signature content type.

Use this property to get or set the content type OID to be included with the signature.

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

Data Type

string

NewSigEntityLabel Property (ASiCSigner Component)

Use this property to get the signature entity label.

Syntax

func (obj *ASiCSigner) NewSigEntityLabel() (string, error)

Default Value

Remarks

Use this property to get the signature entity label.

This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

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

This property is read-only.

Data Type

string

NewSigFileName Property (ASiCSigner Component)

The name of the ASiC signature file.

Syntax

func (obj *ASiCSigner) NewSigFileName() (string, error)
func (obj *ASiCSigner) SetNewSigFileName(value string) error

Default Value

Remarks

The name of the ASiC signature file.

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

Data Type

string

NewSigHandle Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) NewSigHandle() (int64, error)
func (obj *ASiCSigner) SetNewSigHandle(value int64) error

Default Value

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.

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

Data Type

int64

NewSigHashAlgorithm Property (ASiCSigner Component)

Set or returns the hash algorithm used to generate the signature.

Syntax

func (obj *ASiCSigner) NewSigHashAlgorithm() (string, error)
func (obj *ASiCSigner) SetNewSigHashAlgorithm(value string) error

Default Value

Remarks

Set or returns the hash algorithm used to generate the signature.

Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

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

Data Type

string

NewSigIssuerRDN Property (ASiCSigner Component)

The Relative Distinguished Name of the signing certificate's issuer.

Syntax

func (obj *ASiCSigner) NewSigIssuerRDN() (string, error)

Default Value

Remarks

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.

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

This property is read-only.

Data Type

string

NewSigLevel Property (ASiCSigner Component)

Specifies the level according to which the inner AdES signature is to be composed CAdES and XAdES standards define a number of signature levels.

Syntax

func (obj *ASiCSigner) NewSigLevel() (int32, error)
func (obj *ASiCSigner) SetNewSigLevel(value int32) error

Possible Values

0   // Unknown
1   // Generic
2   // BaselineB
3   // BaselineT
4   // BaselineLT
5   // BaselineLTA
6   // BES
7   // EPES
8   // T
9   // C
10   // X
11   // XType1
12   // XType2
13   // XL
14   // XLType1
15   // XLType2
16   // A
17   // ExtendedBES
18   // ExtendedEPES
19   // ExtendedT
20   // ExtendedC
21   // ExtendedX
22   // ExtendedXType1
23   // ExtendedXType2
24   // ExtendedXLong
25   // ExtendedXL
26   // ExtendedXLType1
27   // ExtendedXLType2
28   // ExtendedA
29   // BaselineExtendedB
30   // BaselineExtendedT
31   // BaselineExtendedLT
32   // BaselineExtendedLTA

Default Value

Remarks

Specifies the level according to which the inner AdES signature is to be composed

CAdES and XAdES standards define a number of signature levels. The main differences between levels are in the scope of validation information included to the signature. BES signatures only include the most necessary information (the signing chain), whereas XL and A signatures include the complete set.

The supported levels are:


aslUnknown	`0`	Unknown signature level
aslGeneric	`1`	Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature)
aslBaselineB	`2`	Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineT	`3`	Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineLT	`4`	Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineLTA	`5`	Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBES	`6`	BES (Basic Electronic Signature)
aslEPES	`7`	EPES (Electronic Signature with an Explicit Policy)
aslT	`8`	T (Timestamped)
aslC	`9`	C (T with revocation references)
aslX	`10`	X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only)
aslXType1	`11`	X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only)
aslXType2	`12`	X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)
aslXL	`13`	X-L (X with revocation values) (this value applicable to XAdES signature only)
aslXLType1	`14`	X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only)
aslXLType2	`15`	X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)
aslA	`16`	A (archived)
aslExtendedBES	`17`	Extended BES
aslExtendedEPES	`18`	Extended EPES
aslExtendedT	`19`	Extended T
aslExtendedC	`20`	Extended C
aslExtendedX	`21`	Extended X (this value applicable to XAdES signature only)
aslExtendedXType1	`22`	Extended X (type 1) (this value applicable to CAdES signature only)
aslExtendedXType2	`23`	Extended X (type 2) (this value applicable to CAdES signature only)
aslExtendedXLong	`24`	Extended X-Long (this value applicable to XAdES signature only)
aslExtendedXL	`25`	Extended X-L (this value applicable to XAdES signature only)
aslExtendedXLType1	`26`	Extended XL (type 1) (this value applicable to CAdES signature only)
aslExtendedXLType2	`27`	Extended XL (type 2) (this value applicable to CAdES signature only)
aslExtendedA	`28`	Extended A
aslBaselineExtendedB	`29`	Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedT	`30`	Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedLT	`31`	Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedLTA	`32`	Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only)

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

Data Type

int32

NewSigPolicyHash Property (ASiCSigner Component)

The signature policy hash value.

Syntax

func (obj *ASiCSigner) NewSigPolicyHash() (string, error)
func (obj *ASiCSigner) SetNewSigPolicyHash(value string) error

Default Value

Remarks

The signature policy hash value.

Use this property to get the signature policy hash from EPES signatures

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

Data Type

string

NewSigPolicyHashAlgorithm Property (ASiCSigner Component)

The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.

Syntax

func (obj *ASiCSigner) NewSigPolicyHashAlgorithm() (string, error)
func (obj *ASiCSigner) SetNewSigPolicyHashAlgorithm(value string) error

Default Value

Remarks

The algorithm that was used to calculate the signature policy hash

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from NewSigPolicyHash.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

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

Data Type

string

NewSigPolicyID Property (ASiCSigner Component)

The policy ID that was included or to be included into the signature.

Syntax

func (obj *ASiCSigner) NewSigPolicyID() (string, error)
func (obj *ASiCSigner) SetNewSigPolicyID(value string) error

Default Value

Remarks

The policy ID that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES signatures.

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

Data Type

string

NewSigPolicyURI Property (ASiCSigner Component)

The signature policy URI that was included in the signature.

Syntax

func (obj *ASiCSigner) NewSigPolicyURI() (string, error)
func (obj *ASiCSigner) SetNewSigPolicyURI(value string) error

Default Value

Remarks

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy from EPES signatures.

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

Data Type

string

NewSigSerialNumber Property (ASiCSigner Component)

The serial number of the signing certificate.

Syntax

func (obj *ASiCSigner) NewSigSerialNumber() ([]byte, error)

Remarks

The serial number of the signing certificate.

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

This property is read-only.

Data Type

[]byte

NewSigSignatureBytes Property (ASiCSigner Component)

Returns the binary representation of the ASiC signature.

Syntax

func (obj *ASiCSigner) NewSigSignatureBytes() ([]byte, error)

Remarks

Returns the binary representation of the ASiC signature.

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

This property is read-only.

Data Type

[]byte

NewSigSignatureType Property (ASiCSigner Component)

The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.

Syntax

func (obj *ASiCSigner) NewSigSignatureType() (int32, error)
func (obj *ASiCSigner) SetNewSigSignatureType(value int32) error

Possible Values

0   // Unknown
1   // CAdES
2   // XAdES
3   // Timestamp

Default Value

Remarks

The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.


castUnknown	`0`
castCAdES	`1`
castXAdES	`2`
castTimestamp	`3`

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

Data Type

int32

NewSigSignatureValidationResult Property (ASiCSigner Component)

The outcome of the cryptographic signature validation.

Syntax

func (obj *ASiCSigner) NewSigSignatureValidationResult() (int32, error)

Possible Values

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

Default Value

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

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

This property is read-only.

Data Type

int32

NewSigSignedFiles Property (ASiCSigner Component)

Contains a comma-separated list of files that are covered by the signature.

Syntax

func (obj *ASiCSigner) NewSigSignedFiles() (string, error)

Default Value

Remarks

Contains a comma-separated list of files that are covered by the signature.

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

This property is read-only.

Data Type

string

NewSigSubjectKeyID Property (ASiCSigner Component)

Contains the subject key identifier of the signing certificate.

Syntax

func (obj *ASiCSigner) NewSigSubjectKeyID() ([]byte, error)

Remarks

Contains the subject key identifier of the signing certificate.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.

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

This property is read-only.

Data Type

[]byte

NewSigSubjectRDN Property (ASiCSigner Component)

Contains the RDN of the owner of the signing certificate.

Syntax

func (obj *ASiCSigner) NewSigSubjectRDN() (string, error)

Default Value

Remarks

Contains the RDN of the owner of the signing certificate.

RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details.

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

This property is read-only.

Data Type

string

NewSigTimestamped Property (ASiCSigner Component)

Use this property to establish whether the signature contains an embedded timestamp.

Syntax

func (obj *ASiCSigner) NewSigTimestamped() (bool, error)

Default Value

false

Remarks

Use this property to establish whether the signature contains an embedded timestamp.

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

This property is read-only.

Data Type

bool

NewSigValidatedSigningTime Property (ASiCSigner Component)

Contains the certified signing time.

Syntax

func (obj *ASiCSigner) NewSigValidatedSigningTime() (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.

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

Both times are in UTC.

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

This property is read-only.

Data Type

string

NewSigValidationLog Property (ASiCSigner Component)

Contains the signing certificate's chain validation log.

Syntax

func (obj *ASiCSigner) NewSigValidationLog() (string, error)

Default Value

Remarks

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

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

This property is read-only.

Data Type

string

OCSPCount Property (ASiCSigner Component)

The number of records in the OCSP arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

OCSPBytes
OCSPEntryCount
OCSPHandle
OCSPIssuer
OCSPIssuerRDN
OCSPLocation
OCSPProducedAt
OCSPSigAlgorithm
OCSPSource

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

This property is read-only.

Data Type

int32

OCSPBytes Property (ASiCSigner Component)

A buffer containing the raw OCSP response data.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

The number of SingleResponse elements contained in this OCSP response.

Syntax

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

Default Value

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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

The location of the OCSP responder.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Possible Values

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

Default Value

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 (ASiCSigner Component)

Switches the class to offline mode.

Syntax

func (obj *ASiCSigner) OfflineMode() (bool, error)
func (obj *ASiCSigner) 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

OutputBytes Property (ASiCSigner Component)

Use this property to read the output the class object has produced.

Syntax

func (obj *ASiCSigner) OutputBytes() ([]byte, error)

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

This property is read-only.

Data Type

[]byte

OutputFile Property (ASiCSigner Component)

The file where the signed data will be saved.

Syntax

func (obj *ASiCSigner) OutputFile() (string, error)
func (obj *ASiCSigner) SetOutputFile(value string) error

Default Value

Remarks

Provides a path to the file where the struct should store the container.

ASiC is essentially a ZIP archive, but it is recommended to use ".asics" or ".scs" extension for ASiC-S files, and ".asice" or ".sce" for ASiC-E files.

Data Type

string

OutputPath Property (ASiCSigner Component)

A local path to extract the files to.

Syntax

func (obj *ASiCSigner) OutputPath() (string, error)
func (obj *ASiCSigner) SetOutputPath(value string) error

Default Value

Remarks

Assign this property with a path where the extracted files (selected according to ExtractionMode criteria) are to be saved.

Data Type

string

Profile Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) Profile() (string, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

The IP address of the proxy server.

Syntax

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

Default Value

Remarks

The IP address of the proxy server.

Data Type

string

ProxyAuthentication Property (ASiCSigner Component)

The authentication type used by the proxy server.

Syntax

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

Possible Values

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

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Data Type

int32

ProxyPassword Property (ASiCSigner Component)

The password to authenticate to the proxy server.

Syntax

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

Default Value

Remarks

The password to authenticate to the proxy server.

Data Type

string

ProxyPort Property (ASiCSigner Component)

The port on the proxy server to connect to.

Syntax

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

Default Value

Remarks

The port on the proxy server to connect to.

Data Type

int32

ProxyType Property (ASiCSigner Component)

The type of the proxy server.

Syntax

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

Possible Values

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

Default Value

Remarks

The type of the proxy server.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

Data Type

int32

ProxyRequestHeaders Property (ASiCSigner Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

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

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

string

ProxyResponseBody Property (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

string

ProxyResponseHeaders Property (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

string

ProxyUseIPv6 Property (ASiCSigner Component)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

ProxyUsername Property (ASiCSigner Component)

Specifies the username credential for proxy authentication.

Syntax

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

Default Value

Remarks

Specifies the username credential for proxy authentication.

Data Type

string

RevocationCheck Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) RevocationCheck() (int32, error)
func (obj *ASiCSigner) 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

Remarks

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

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.


crcNone	`0`	No revocation checking.
crcAuto	`1`	Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL	`2`	All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP	`3`	All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP	`4`	All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL	`5`	All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP	`6`	All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP	`7`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

int32

SignatureCount Property (ASiCSigner Component)

The number of records in the Signature arrays.

Syntax

func (obj *ASiCSigner) SignatureCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

SignatureBytes
SignatureChainValidationDetails
SignatureChainValidationResult
SignatureClaimedSigningTime
SignatureCompatibilityErrors
SignatureContainsLongTermInfo
SignatureContentType
SignatureEntityLabel
SignatureFileName
SignatureHandle
SignatureHashAlgorithm
SignatureIssuerRDN
SignatureLevel
SignaturePolicyHash
SignaturePolicyHashAlgorithm
SignaturePolicyID
SignaturePolicyURI
SignatureSerialNumber
SignatureSignedFiles
SignatureSubjectKeyID
SignatureSubjectRDN
SignatureTimestamped
SignatureType
SignatureValidatedSigningTime
SignatureValidationLog
SignatureValidationResult

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

This property is read-only.

Data Type

int32

SignatureChainValidationDetails Property (ASiCSigner Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *ASiCSigner) SignatureChainValidationDetails(SignatureIndex int32) (int32, error)

Default Value

Remarks

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

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

int32

SignatureChainValidationResult Property (ASiCSigner Component)

The outcome of a certificate chain validation routine.

Syntax

func (obj *ASiCSigner) SignatureChainValidationResult(SignatureIndex int32) (int32, error)

Possible Values

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

Default Value

Remarks

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

int32

SignatureClaimedSigningTime Property (ASiCSigner Component)

Returns or sets signature's creation time.

Syntax

func (obj *ASiCSigner) SignatureClaimedSigningTime(SignatureIndex int32) (string, error)

Default Value

Remarks

Returns or sets signature's creation time.

Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike SignatureValidatedSigningTime does not originate from a trusted TSA and may be forfeited or wrong.

The time is provided in UTC.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureCompatibilityErrors Property (ASiCSigner Component)

Returns compatibility errors encountered during validation.

Syntax

func (obj *ASiCSigner) SignatureCompatibilityErrors(SignatureIndex int32) (int32, error)

Default Value

Remarks

Returns compatibility errors encountered during validation.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

int32

SignatureContainsLongTermInfo Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) SignatureContainsLongTermInfo(SignatureIndex int32) (bool, error)

Default Value

false

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

SignatureContentType Property (ASiCSigner Component)

The signature content type.

Syntax

func (obj *ASiCSigner) SignatureContentType(SignatureIndex int32) (string, error)

Default Value

Remarks

The signature content type.

Use this property to get or set the content type OID to be included with the signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureEntityLabel Property (ASiCSigner Component)

Use this property to get the signature entity label.

Syntax

func (obj *ASiCSigner) SignatureEntityLabel(SignatureIndex int32) (string, error)

Default Value

Remarks

Use this property to get the signature entity label.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureFileName Property (ASiCSigner Component)

The name of the ASiC signature file.

Syntax

func (obj *ASiCSigner) SignatureFileName(SignatureIndex int32) (string, error)

Default Value

Remarks

The name of the ASiC signature file.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureHandle Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) SignatureHandle(SignatureIndex int32) (int64, error)

Default Value

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.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

int64

SignatureHashAlgorithm Property (ASiCSigner Component)

Set or returns the hash algorithm used to generate the signature.

Syntax

func (obj *ASiCSigner) SignatureHashAlgorithm(SignatureIndex int32) (string, error)

Default Value

Remarks

Set or returns the hash algorithm used to generate the signature.

Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureIssuerRDN Property (ASiCSigner Component)

The Relative Distinguished Name of the signing certificate's issuer.

Syntax

func (obj *ASiCSigner) SignatureIssuerRDN(SignatureIndex int32) (string, error)

Default Value

Remarks

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureLevel Property (ASiCSigner Component)

Specifies the level according to which the inner AdES signature is to be composed CAdES and XAdES standards define a number of signature levels.

Syntax

func (obj *ASiCSigner) SignatureLevel(SignatureIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // Generic
2   // BaselineB
3   // BaselineT
4   // BaselineLT
5   // BaselineLTA
6   // BES
7   // EPES
8   // T
9   // C
10   // X
11   // XType1
12   // XType2
13   // XL
14   // XLType1
15   // XLType2
16   // A
17   // ExtendedBES
18   // ExtendedEPES
19   // ExtendedT
20   // ExtendedC
21   // ExtendedX
22   // ExtendedXType1
23   // ExtendedXType2
24   // ExtendedXLong
25   // ExtendedXL
26   // ExtendedXLType1
27   // ExtendedXLType2
28   // ExtendedA
29   // BaselineExtendedB
30   // BaselineExtendedT
31   // BaselineExtendedLT
32   // BaselineExtendedLTA

Default Value

Remarks

Specifies the level according to which the inner AdES signature is to be composed

The supported levels are:


aslUnknown	`0`	Unknown signature level
aslGeneric	`1`	Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature)
aslBaselineB	`2`	Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineT	`3`	Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineLT	`4`	Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineLTA	`5`	Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBES	`6`	BES (Basic Electronic Signature)
aslEPES	`7`	EPES (Electronic Signature with an Explicit Policy)
aslT	`8`	T (Timestamped)
aslC	`9`	C (T with revocation references)
aslX	`10`	X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only)
aslXType1	`11`	X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only)
aslXType2	`12`	X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)
aslXL	`13`	X-L (X with revocation values) (this value applicable to XAdES signature only)
aslXLType1	`14`	X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only)
aslXLType2	`15`	X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)
aslA	`16`	A (archived)
aslExtendedBES	`17`	Extended BES
aslExtendedEPES	`18`	Extended EPES
aslExtendedT	`19`	Extended T
aslExtendedC	`20`	Extended C
aslExtendedX	`21`	Extended X (this value applicable to XAdES signature only)
aslExtendedXType1	`22`	Extended X (type 1) (this value applicable to CAdES signature only)
aslExtendedXType2	`23`	Extended X (type 2) (this value applicable to CAdES signature only)
aslExtendedXLong	`24`	Extended X-Long (this value applicable to XAdES signature only)
aslExtendedXL	`25`	Extended X-L (this value applicable to XAdES signature only)
aslExtendedXLType1	`26`	Extended XL (type 1) (this value applicable to CAdES signature only)
aslExtendedXLType2	`27`	Extended XL (type 2) (this value applicable to CAdES signature only)
aslExtendedA	`28`	Extended A
aslBaselineExtendedB	`29`	Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedT	`30`	Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedLT	`31`	Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedLTA	`32`	Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only)

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

int32

SignaturePolicyHash Property (ASiCSigner Component)

The signature policy hash value.

Syntax

func (obj *ASiCSigner) SignaturePolicyHash(SignatureIndex int32) (string, error)

Default Value

Remarks

The signature policy hash value.

Use this property to get the signature policy hash from EPES signatures

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignaturePolicyHashAlgorithm Property (ASiCSigner Component)

The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.

Syntax

func (obj *ASiCSigner) SignaturePolicyHashAlgorithm(SignatureIndex int32) (string, error)

Default Value

Remarks

The algorithm that was used to calculate the signature policy hash

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from SignaturePolicyHash.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignaturePolicyID Property (ASiCSigner Component)

The policy ID that was included or to be included into the signature.

Syntax

func (obj *ASiCSigner) SignaturePolicyID(SignatureIndex int32) (string, error)

Default Value

Remarks

The policy ID that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES signatures.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignaturePolicyURI Property (ASiCSigner Component)

The signature policy URI that was included in the signature.

Syntax

func (obj *ASiCSigner) SignaturePolicyURI(SignatureIndex int32) (string, error)

Default Value

Remarks

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy from EPES signatures.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureSerialNumber Property (ASiCSigner Component)

The serial number of the signing certificate.

Syntax

func (obj *ASiCSigner) SignatureSerialNumber(SignatureIndex int32) ([]byte, error)

Remarks

The serial number of the signing certificate.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

[]byte

SignatureBytes Property (ASiCSigner Component)

Returns the binary representation of the ASiC signature.

Syntax

func (obj *ASiCSigner) SignatureBytes(SignatureIndex int32) ([]byte, error)

Remarks

Returns the binary representation of the ASiC signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

[]byte

SignatureType Property (ASiCSigner Component)

The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.

Syntax

func (obj *ASiCSigner) SignatureType(SignatureIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // CAdES
2   // XAdES
3   // Timestamp

Default Value

Remarks

The type of the ASiC signature: CAdES, XAdES, timestamp, or unknown.


castUnknown	`0`
castCAdES	`1`
castXAdES	`2`
castTimestamp	`3`

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

int32

SignatureValidationResult Property (ASiCSigner Component)

The outcome of the cryptographic signature validation.

Syntax

func (obj *ASiCSigner) SignatureValidationResult(SignatureIndex int32) (int32, error)

Possible Values

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

Default Value

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

int32

SignatureSignedFiles Property (ASiCSigner Component)

Contains a comma-separated list of files that are covered by the signature.

Syntax

func (obj *ASiCSigner) SignatureSignedFiles(SignatureIndex int32) (string, error)

Default Value

Remarks

Contains a comma-separated list of files that are covered by the signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureSubjectKeyID Property (ASiCSigner Component)

Contains the subject key identifier of the signing certificate.

Syntax

func (obj *ASiCSigner) SignatureSubjectKeyID(SignatureIndex int32) ([]byte, error)

Remarks

Contains the subject key identifier of the signing certificate.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

[]byte

SignatureSubjectRDN Property (ASiCSigner Component)

Contains the RDN of the owner of the signing certificate.

Syntax

func (obj *ASiCSigner) SignatureSubjectRDN(SignatureIndex int32) (string, error)

Default Value

Remarks

Contains the RDN of the owner of the signing certificate.

RDN is a number of OID=Value pairs declared in the certificate and providing the owner's details.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureTimestamped Property (ASiCSigner Component)

Use this property to establish whether the signature contains an embedded timestamp.

Syntax

func (obj *ASiCSigner) SignatureTimestamped(SignatureIndex int32) (bool, error)

Default Value

false

Remarks

Use this property to establish whether the signature contains an embedded timestamp.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

SignatureValidatedSigningTime Property (ASiCSigner Component)

Contains the certified signing time.

Syntax

func (obj *ASiCSigner) SignatureValidatedSigningTime(SignatureIndex int32) (string, error)

Default Value

Remarks

Contains the certified signing time.

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

Both times are in UTC.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SignatureValidationLog Property (ASiCSigner Component)

Contains the signing certificate's chain validation log.

Syntax

func (obj *ASiCSigner) SignatureValidationLog(SignatureIndex int32) (string, error)

Default Value

Remarks

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

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

string

SigningCertBytes Property (ASiCSigner Component)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

SigningCertHandle Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) SigningCertHandle() (int64, error)
func (obj *ASiCSigner) SetSigningCertHandle(value int64) error

Default Value

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.

Data Type

int64

SigningChainCount Property (ASiCSigner Component)

The number of records in the SigningChain arrays.

Syntax

func (obj *ASiCSigner) SigningChainCount() (int32, error)
func (obj *ASiCSigner) SetSigningChainCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

SigningChainBytes
SigningChainHandle

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

Data Type

int32

SigningChainBytes Property (ASiCSigner Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ASiCSigner) SigningChainBytes(SigningChainIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only.

Data Type

[]byte

SigningChainHandle Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) SigningChainHandle(SigningChainIndex int32) (int64, error)
func (obj *ASiCSigner) SetSigningChainHandle(SigningChainIndex int32, value int64) error

Default Value

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.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

Data Type

int64

SocketDNSMode Property (ASiCSigner Component)

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

Syntax

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

Possible Values

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

Default Value

Remarks

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


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

Data Type

int32

SocketDNSPort Property (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

int32

SocketDNSQueryTimeout Property (ASiCSigner Component)

The timeout (in milliseconds) for each DNS query.

Syntax

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

Default Value

Remarks

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

Data Type

int32

SocketDNSServers Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) SocketDNSServers() (string, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

int32

SocketIncomingSpeedLimit Property (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

int32

SocketLocalAddress Property (ASiCSigner Component)

The local network interface to bind the socket to.

Syntax

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

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

string

SocketLocalPort Property (ASiCSigner Component)

The local port number to bind the socket to.

Syntax

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

Default Value

Remarks

The local port number to bind the socket to.

Data Type

int32

SocketOutgoingSpeedLimit Property (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

int32

SocketTimeout Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) SocketTimeout() (int32, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

Enables or disables IP protocol version 6.

Syntax

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

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

SourceBytes Property (ASiCSigner Component)

Use this property to pass the content to sign in the byte array form.

Syntax

func (obj *ASiCSigner) SourceBytes() ([]byte, error)
func (obj *ASiCSigner) SetSourceBytes(value []byte) error

Remarks

Assign a byte array containing the source file to be signed to this property.

Data Type

[]byte

SourceFiles Property (ASiCSigner Component)

The files to be packed into the container.

Syntax

func (obj *ASiCSigner) SourceFiles() (string, error)
func (obj *ASiCSigner) SetSourceFiles(value string) error

Default Value

Remarks

Assign this property with a CRLF-separated list of paths to the files to be included in the container. Remember to enable the extended ASiC mode (set Extended to true) if signing more than one file.

Data Type

string

SourceName Property (ASiCSigner Component)

Use this property to specify the name of the file being signed if passing it via the SourceBytes property.

Syntax

func (obj *ASiCSigner) SourceName() (string, error)
func (obj *ASiCSigner) SetSourceName(value string) error

Default Value

Remarks

Provide the name of the file to be included in the ASiC container if passing the file in the byte array form.

Data Type

string

TimestampCount Property (ASiCSigner Component)

The number of records in the Timestamp arrays.

Syntax

func (obj *ASiCSigner) TimestampCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

TimestampAccuracy
TimestampBytes
TimestampCertificateIndex
TimestampChainValidationDetails
TimestampChainValidationResult
TimestampContainsLongTermInfo
TimestampEntityLabel
TimestampHashAlgorithm
TimestampParentEntity
TimestampSerialNumber
TimestampTime
TimestampTSAName
TimestampType
TimestampValidationLog
TimestampValidationResult

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

This property is read-only.

Data Type

int32

TimestampAccuracy Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TimestampAccuracy(TimestampIndex int32) (int64, error)

Default Value

Remarks

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

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

int64

TimestampBytes Property (ASiCSigner Component)

Returns the raw timestamp data in DER format.

Syntax

func (obj *ASiCSigner) TimestampBytes(TimestampIndex int32) ([]byte, error)

Remarks

Returns the raw timestamp data in DER format.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

[]byte

TimestampCertificateIndex Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TimestampCertificateIndex(TimestampIndex int32) (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.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

int32

TimestampChainValidationDetails Property (ASiCSigner Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *ASiCSigner) TimestampChainValidationDetails(TimestampIndex int32) (int32, error)

Default Value

Remarks

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

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

int32

TimestampChainValidationResult Property (ASiCSigner Component)

The outcome of a certificate chain validation routine.

Syntax

func (obj *ASiCSigner) TimestampChainValidationResult(TimestampIndex int32) (int32, error)

Possible Values

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

Default Value

Remarks

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

int32

TimestampContainsLongTermInfo Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TimestampContainsLongTermInfo(TimestampIndex int32) (bool, error)

Default Value

false

Remarks

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

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

bool

TimestampEntityLabel Property (ASiCSigner Component)

Use this property to get the timestamp entity label.

Syntax

func (obj *ASiCSigner) TimestampEntityLabel(TimestampIndex int32) (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.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

string

TimestampHashAlgorithm Property (ASiCSigner Component)

Returns the timestamp's hash algorithm.

Syntax

func (obj *ASiCSigner) TimestampHashAlgorithm(TimestampIndex int32) (string, error)

Default Value

Remarks

Returns the timestamp's hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

string

TimestampParentEntity Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TimestampParentEntity(TimestampIndex int32) (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.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

string

TimestampSerialNumber Property (ASiCSigner Component)

Returns the timestamp's serial number.

Syntax

func (obj *ASiCSigner) TimestampSerialNumber(TimestampIndex int32) ([]byte, error)

Remarks

Returns the timestamp's serial number.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

[]byte

TimestampTime Property (ASiCSigner Component)

The time point incorporated into the timestamp.

Syntax

func (obj *ASiCSigner) TimestampTime(TimestampIndex int32) (string, error)

Default Value

Remarks

The time point incorporated into the timestamp.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

string

TimestampType Property (ASiCSigner Component)

Returns the type of the timestamp.

Syntax

func (obj *ASiCSigner) TimestampType(TimestampIndex int32) (int32, error)

Default Value

Remarks

Returns the type of the timestamp.

Available options:


tstUnknown	`0`
tstLegacy	`1`	Supported by: Authenticode components
tstTrusted	`2`	Supported by: Authenticode components
tstGeneric	`3`	Supported by: CAdES components
tstESC	`4`	Supported by: CAdES components
tstContent	`5`	Supported by: CAdES components
tstCertsAndCRLs	`6`	Supported by: CAdES components
tstArchive	`7`	Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components
tstArchive2	`8`	Archive v2 timestamp. Supported by: ASiC, CAdES components
tstArchive3	`9`	Archive v3 timestamp. Supported by: ASiC, CAdES components
tstIndividualDataObjects	`10`	Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components
tstAllDataObjects	`11`	All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components
tstSignature	`12`	Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstRefsOnly	`13`	RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstSigAndRefs	`14`	SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstSignedData	`15`	SignedData timestamp. Supported by: JAdES components
tstArchive141	`16`	Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

int32

TimestampTSAName Property (ASiCSigner Component)

This value uniquely identifies the Timestamp Authority (TSA).

Syntax

func (obj *ASiCSigner) TimestampTSAName(TimestampIndex int32) (string, error)

Default Value

Remarks

This value uniquely identifies the Timestamp Authority (TSA).

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

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

string

TimestampValidationLog Property (ASiCSigner Component)

Contains the TSA certificate chain validation log.

Syntax

func (obj *ASiCSigner) TimestampValidationLog(TimestampIndex int32) (string, error)

Default Value

Remarks

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

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

string

TimestampValidationResult Property (ASiCSigner Component)

Contains the timestamp validation outcome.

Syntax

func (obj *ASiCSigner) TimestampValidationResult(TimestampIndex int32) (int32, error)

Possible Values

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

Default Value

Remarks

Contains the timestamp validation outcome.

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


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

int32

TimestampServer Property (ASiCSigner Component)

The address of the timestamping server.

Syntax

func (obj *ASiCSigner) TimestampServer() (string, error)
func (obj *ASiCSigner) SetTimestampServer(value string) error

Default Value

Remarks

Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.

SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.

If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:

http://user:password@timestamp.server.com/TsaService

For TSAs using certificate-based TLS authentication, provide the client certificate via the TLSClientChain property.

If this property is left empty, no timestamp will be added to the signature.

Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.

To employ the virtual service, assign an URI of the following format to this property:

virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true

Subscribe to Notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:

component.Config("TimestampResponse=308208ab...");

Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.

The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.

The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.

The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.

The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

Data Type

string

TLSClientCertCount Property (ASiCSigner Component)

The number of records in the TLSClientCert arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

TLSClientCertBytes
TLSClientCertHandle

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

Data Type

int32

TLSClientCertBytes Property (ASiCSigner Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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 (ASiCSigner Component)

The number of records in the TLSServerCert arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

TLSServerCertBytes
TLSServerCertFingerprint
TLSServerCertHandle
TLSServerCertIssuer
TLSServerCertIssuerRDN
TLSServerCertKeyAlgorithm
TLSServerCertKeyBits
TLSServerCertKeyUsage
TLSServerCertSelfSigned
TLSServerCertSerialNumber
TLSServerCertSigAlgorithm
TLSServerCertSubject
TLSServerCertSubjectRDN
TLSServerCertValidFrom
TLSServerCertValidTo

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

This property is read-only.

Data Type

int32

TLSServerCertBytes Property (ASiCSigner Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Specifies the public key algorithm of this certificate.

Syntax

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

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`
SB_CERT_ALGORITHM_MLDSA_44	`id-ml-dsa-44`
SB_CERT_ALGORITHM_MLDSA_65	`id-ml-dsa-65`
SB_CERT_ALGORITHM_MLDSA_87	`id-ml-dsa-87`
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512	`id-hash-ml-dsa-44-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512	`id-hash-ml-dsa-65-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512	`id-hash-ml-dsa-87-with-sha512`
SB_CERT_ALGORITHM_MLKEM_512	`id-ml-kem-512`
SB_CERT_ALGORITHM_MLKEM_768	`id-ml-kem-768`
SB_CERT_ALGORITHM_MLKEM_1024	`id-ml-kem-1024`

Use the 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 (ASiCSigner Component)

Returns the length of the public key in bits.

Syntax

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

Default Value

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 (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

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

The 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

Returns the certificate's serial number.

Syntax

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

Remarks

Returns the certificate's serial number.

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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner 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 *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TLSAutoValidateCertificates() (bool, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

Selects the base configuration for the TLS settings.

Syntax

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

Possible Values

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

Default Value

Remarks

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


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

Data Type

int32

TLSCiphersuites Property (ASiCSigner Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

func (obj *ASiCSigner) TLSCiphersuites() (string, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

Enables or disables certificate-based client authentication.

Syntax

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

Possible Values

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

Default Value

Remarks

Enables or disables certificate-based client authentication.

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


ccatNoAuth	`0`
ccatRequestCert	`1`
ccatRequireCert	`2`

Data Type

int32

TLSExtensions Property (ASiCSigner Component)

Provides access to TLS extensions.

Syntax

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

Default Value

Remarks

Provides access to TLS extensions.

Data Type

string

TLSForceResumeIfDestinationChanges Property (ASiCSigner Component)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

TLSGroups Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TLSGroups() (string, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TLSPreSharedIdentity() (string, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TLSPreSharedKey() (string, error)
func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

string

TLSRenegotiationAttackPreventionMode Property (ASiCSigner Component)

Selects the renegotiation attack prevention mechanism.

Syntax

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

Possible Values

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

Default Value

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:


crapmCompatible	`0`	TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict	`1`	Renegotiation attack prevention is enabled and enforced.
crapmAuto	`2`	Automatically choose whether to enable or disable renegotiation attack prevention.

Data Type

int32

TLSRevocationCheck Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) TLSRevocationCheck() (int32, error)
func (obj *ASiCSigner) 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

Remarks

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

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


crcNone	`0`	No revocation checking.
crcAuto	`1`	Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL	`2`	All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP	`3`	All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP	`4`	All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL	`5`	All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP	`6`	All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP	`7`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL	`8`	All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

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 (ASiCSigner 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 *ASiCSigner) TLSSSLOptions() (int32, error)
func (obj *ASiCSigner) SetTLSSSLOptions(value int32) error

Default Value

Remarks

Various SSL (TLS) protocol options, set of


cssloExpectShutdownMessage	`0x001`	Wait for the close-notify message when shutting down the connection
cssloOpenSSLDTLSWorkaround	`0x002`	(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions
cssloDisableKexLengthAlignment	`0x004`	Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.
cssloForceUseOfClientCertHashAlg	`0x008`	Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add the server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.
cssloIntolerateHigherProtocolVersions	`0x080`	(server option) Do not allow fallback from TLS versions higher than currently enabled
cssloStickToPrefCertHashAlg	`0x100`	Stick to preferred certificate hash algorithms
cssloNoImplicitTLS12Fallback	`0x200`	Disable implicit TLS 1.3 to 1.2 fallbacks
cssloUseHandshakeBatches	`0x400`	Send the handshake message as large batches rather than individually

Data Type

int32

TLSMode Property (ASiCSigner Component)

Specifies the TLS mode to use.

Syntax

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

Possible Values

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

Default Value

Remarks

Specifies the TLS mode to use.


smDefault	`0`
smNoTLS	`1`	Do not use TLS
smExplicitTLS	`2`	Connect to the server without any encryption and then request an SSL session.
smImplicitTLS	`3`	Connect to the specified port, and establish the SSL session at once.
smMixedTLS	`4`	Connect to the specified port, and establish the SSL session at once, but allow plain data.

Data Type

int32

TLSUseExtendedMasterSecret Property (ASiCSigner Component)

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

Syntax

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

Default Value

true

Remarks

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

Data Type

bool

TLSUseSessionResumption Property (ASiCSigner Component)

Enables or disables the TLS session resumption capability.

Syntax

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

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

TLSVersions Property (ASiCSigner Component)

The SSL/TLS versions to enable by default.

Syntax

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

Default Value

Remarks

The SSL/TLS versions to enable by default.


csbSSL2	`0x01`	SSL 2
csbSSL3	`0x02`	SSL 3
csbTLS1	`0x04`	TLS 1.0
csbTLS11	`0x08`	TLS 1.1
csbTLS12	`0x10`	TLS 1.2
csbTLS13	`0x20`	TLS 1.3

Data Type

int32

TrustedCertCount Property (ASiCSigner Component)

The number of records in the TrustedCert arrays.

Syntax

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

Default Value

Remarks

This property controls the size of the following arrays:

TrustedCertBytes
TrustedCertHandle

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

Data Type

int32

TrustedCertBytes Property (ASiCSigner Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *ASiCSigner) 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 (ASiCSigner Component)

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

Syntax

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

Default Value

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.

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

ValidationMoment Property (ASiCSigner Component)

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

Syntax

func (obj *ASiCSigner) ValidationMoment() (string, error)
func (obj *ASiCSigner) 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

AddFile Method (ASiCSigner Component)

Use this method to add a file to the archive.

Syntax

func (obj *ASiCSigner) AddFile() error

Remarks

This method allows you to add multiple files to the archive.

There are several ways in which you can provide files to ASiCSigner:

Assign a file list to SourceFiles property.
Assign the file name to SourceName, and the file body to SourceBytes or SourceStream.

All files assigned to the above properties will be added to the archive automatically: you don't need to call AddFile to add them.

If, however, you need to add more than one in-memory file, or add more than one bunch of files using SourceFiles, AddFile may be of good use. Effectively, it saves the file data provided through the above properties in ASiCSigner, releasing these properties for the next file(s). For example: signer.SourceName = "file1.txt"; signer.SourceBytes = Encoding.UTF8.GetBytes("Human progress is not measured by industry."); signer.AddFile(); // this saves the above data in the component, allowing you to add the next file signer.SourceName = "file2.txt"; signer.SourceBytes = Encoding.UTF8.GetBytes("It is measured by the value you place on a life."); signer.AddFile(); // this adds the second file signer.SourceName = "file3.txt"; signer.SourceBytes = Encoding.UTF8.GetBytes("An unimportant life. A life without privilege."); // You don't need to AddFile() the final file: this will be picked by ASiCSigner from the properties automatically

Close Method (ASiCSigner Component)

Closes an opened container.

Syntax

func (obj *ASiCSigner) Close(SaveChanges bool) error

Remarks

Use this method to close a previously opened container. Set SaveChanges to true to apply any changes made.

Config Method (ASiCSigner Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *ASiCSigner) 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.

CreateNew Method (ASiCSigner Component)

Creates a new ASiC container.

Syntax

func (obj *ASiCSigner) CreateNew() error

Remarks

Use this method to create a new container file.

The container will be kept in memory until written down with Close method.

DoAction Method (ASiCSigner Component)

Performs an additional action.

Syntax

func (obj *ASiCSigner) 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:


Action	Parameters	Returned value	Description
ResetTrustedListCache	none	none	Clears the cached list of trusted lists.
ResetCertificateCache	none	none	Clears the cached certificates.
ResetCRLCache	none	none	Clears the cached CRLs.
ResetOCSPResponseCache	none	none	Clears the cached OCSP responses.

ExtractAsyncData Method (ASiCSigner Component)

Extracts user data from the DC signing service response.

Syntax

func (obj *ASiCSigner) ExtractAsyncData(AsyncReply string) (string, error)

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

ExtractFile Method (ASiCSigner Component)

Extracts a file to one of the output media (bytes, stream, or disk file).

Syntax

func (obj *ASiCSigner) ExtractFile(FileName string) error

Remarks

Use this method to extract a single archived

ExtractFiles Method (ASiCSigner Component)

Extracts files covered by a signature to OutputPath .

Syntax

func (obj *ASiCSigner) ExtractFiles(SigLabel string) error

Remarks

Use this method to extract all files covered by the signature SigLabel to OutputPath. Set SigLabel to "" to extract all the files included in the container.

Open Method (ASiCSigner Component)

Opens an existing container for signing or updating.

Syntax

func (obj *ASiCSigner) Open() error

Remarks

Use this method to open a container for signing or updating. When finished, call Close to complete or discard the operation.

Reset Method (ASiCSigner Component)

Resets the class settings.

Syntax

func (obj *ASiCSigner) Reset() error

Remarks

Reset is a generic method available in every struct.

Revalidate Method (ASiCSigner Component)

Revalidates a signature in accordance with current settings.

Syntax

func (obj *ASiCSigner) Revalidate(SigLabel string) error

Remarks

Use this method to re-validate a signature in the opened ASiC document.

SelectInfo Method (ASiCSigner Component)

Select signature information for a specific entity.

Syntax

func (obj *ASiCSigner) SelectInfo(EntityLabel string, InfoType int32, ClearSelection bool) error

Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:


sitEntity	`1`	Select the current entity
sitParentEntity	`2`	Select the parent entity of the current entity
sitTimestamps	`4`	Select all timestamps covering the current entity
sitSignatures	`8`	Select all signatures covering the current entity
sitSigningChain	`16`	Select the signing chain of the current entity
sitEmbeddedCertificates	`256`	Select all certificates embedded in the current entity
sitEmbeddedCRLs	`512`	Select all CRLs embedded in the current entity
sitEmbeddedOCSPs	`1024`	Select all OCSP responses embedded in the current entity
sitEmbeddedRevInfo	`1792`	Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs)
sitUsedCertificates	`4096`	Select all the certificates used to validate this entity's chain
sitUsedCRLs	`8192`	Select all the CRLs used to validate this entity's chain
sitUsedOCSPs	`16384`	Select all the OCSP responses used to validate this entity's chain
sitUsedRevInfo	`28672`	Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses)
sitAttributes	`65536`	Select this entity's CMS attributes
sitReferences	`131072`	Select this entity's XML references
sitSignedParts	`262144`	Select this entity's signed parts

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping ClearSelection set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

Sign Method (ASiCSigner Component)

Signs the chosen files and packs them into an ASiC archive.

Syntax

func (obj *ASiCSigner) Sign() error

Remarks

Use this method to create a new ASiC signature container in accordance with the component setup.

SignAsyncBegin Method (ASiCSigner Component)

Initiates the asynchronous signing operation.

Syntax

func (obj *ASiCSigner) SignAsyncBegin() (string, error)

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in OutputFile (or OutputStream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to InputFile (or InputStream), and call SignAsyncEnd to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to SignAsyncEnd and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth struct), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignAsyncEnd Method (ASiCSigner Component)

Completes the asynchronous signing operation.

Syntax

func (obj *ASiCSigner) SignAsyncEnd(AsyncReply string) error

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior SignAsyncBegin call to InputFile (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to OutputFile (or OutputStream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (SignAsyncBegin) stage.

SignExternal Method (ASiCSigner Component)

Signs the document using an external signing facility.

Syntax

func (obj *ASiCSigner) SignExternal() error

Remarks

Use this method to create an ASiC signature using an external signing facility for the cryptographic computations. SignExternal delegates the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

When all preparations are done and hash is computed, the struct fires ExternalSign event which allows to pass the hash value for signing.

Timestamp Method (ASiCSigner Component)

Use this method to add timestamp.

Syntax

func (obj *ASiCSigner) Timestamp(SigLabel string, TimestampType int32) error

Remarks

Call this method to timestamp the signature. Use the TimestampServer property to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. Use the TimestampType parameter to specify the type of timestamp to create Available options:


tstUnknown	`0`
tstLegacy	`1`	Supported by: Authenticode components
tstTrusted	`2`	Supported by: Authenticode components
tstGeneric	`3`	Supported by: CAdES components
tstESC	`4`	Supported by: CAdES components
tstContent	`5`	Supported by: CAdES components
tstCertsAndCRLs	`6`	Supported by: CAdES components
tstArchive	`7`	Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components
tstArchive2	`8`	Archive v2 timestamp. Supported by: ASiC, CAdES components
tstArchive3	`9`	Archive v3 timestamp. Supported by: ASiC, CAdES components
tstIndividualDataObjects	`10`	Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components
tstAllDataObjects	`11`	All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components
tstSignature	`12`	Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstRefsOnly	`13`	RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstSigAndRefs	`14`	SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components
tstSignedData	`15`	SignedData timestamp. Supported by: JAdES components
tstArchive141	`16`	Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components

Upgrade Method (ASiCSigner Component)

Upgrades existing CAdES or XAdES signature to a new level.

Syntax

func (obj *ASiCSigner) Upgrade(SigLabel string, UpgradeKind int32) error

Remarks

CAdES and XAdES standard defines a number of different 'levels' or 'forms' of signatures which can be used for different purposes. Use this method to upgrade CAdES or XAdES signature to a new form or level specified by UpgradeKind. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, XL, A).

The supported levels are:


aslUnknown	`0`	Unknown signature level
aslGeneric	`1`	Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature)
aslBaselineB	`2`	Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineT	`3`	Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineLT	`4`	Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBaselineLTA	`5`	Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122)
aslBES	`6`	BES (Basic Electronic Signature)
aslEPES	`7`	EPES (Electronic Signature with an Explicit Policy)
aslT	`8`	T (Timestamped)
aslC	`9`	C (T with revocation references)
aslX	`10`	X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only)
aslXType1	`11`	X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only)
aslXType2	`12`	X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)
aslXL	`13`	X-L (X with revocation values) (this value applicable to XAdES signature only)
aslXLType1	`14`	X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only)
aslXLType2	`15`	X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only)
aslA	`16`	A (archived)
aslExtendedBES	`17`	Extended BES
aslExtendedEPES	`18`	Extended EPES
aslExtendedT	`19`	Extended T
aslExtendedC	`20`	Extended C
aslExtendedX	`21`	Extended X (this value applicable to XAdES signature only)
aslExtendedXType1	`22`	Extended X (type 1) (this value applicable to CAdES signature only)
aslExtendedXType2	`23`	Extended X (type 2) (this value applicable to CAdES signature only)
aslExtendedXLong	`24`	Extended X-Long (this value applicable to XAdES signature only)
aslExtendedXL	`25`	Extended X-L (this value applicable to XAdES signature only)
aslExtendedXLType1	`26`	Extended XL (type 1) (this value applicable to CAdES signature only)
aslExtendedXLType2	`27`	Extended XL (type 2) (this value applicable to CAdES signature only)
aslExtendedA	`28`	Extended A
aslBaselineExtendedB	`29`	Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedT	`30`	Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedLT	`31`	Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only)
aslBaselineExtendedLTA	`32`	Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only)

ChainElementDownload Event (ASiCSigner Component)

Fires when there is a need to download a chain element from an online source.

Syntax

// ASiCSignerChainElementDownloadEventArgs carries the ASiCSigner ChainElementDownload event's parameters.
type ASiCSignerChainElementDownloadEventArgs struct {...}

func (args *ASiCSignerChainElementDownloadEventArgs) Kind() int32
func (args *ASiCSignerChainElementDownloadEventArgs) CertRDN() string
func (args *ASiCSignerChainElementDownloadEventArgs) CACertRDN() string
func (args *ASiCSignerChainElementDownloadEventArgs) Location() string
func (args *ASiCSignerChainElementDownloadEventArgs) Action() int32
func (args *ASiCSignerChainElementDownloadEventArgs) SetAction(value int32)

// ASiCSignerChainElementDownloadEvent defines the signature of the ASiCSigner ChainElementDownload event's handler function.
type ASiCSignerChainElementDownloadEvent func(sender *ASiCSigner, args *ASiCSignerChainElementDownloadEventArgs)

func (obj *ASiCSigner) GetOnChainElementDownloadHandler() ASiCSignerChainElementDownloadEvent
func (obj *ASiCSigner) SetOnChainElementDownloadHandler(handlerFunc ASiCSignerChainElementDownloadEvent)

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.


veaAuto	`0`	Handle the action automatically (the default behaviour)
veaContinue	`1`	Accept the request implied by the event (accept the certificate, allow the object retrieval)
veaReject	`2`	Reject the request implied by the event (reject the certificate, disallow the object retrieval)
veaAcceptNow	`3`	Accept the validated certificate immediately
veaAbortNow	`4`	Abort the validation, reject the certificate


cekUnknown	`0`	Unknown or unsupported element type
cekCertificate	`1`	An X.509 certificate
cekCRL	`2`	A CRL
cekOCSP	`3`	An OCSP response

ChainElementNeeded Event (ASiCSigner Component)

Fires when an element required to validate the chain was not located.

Syntax

// ASiCSignerChainElementNeededEventArgs carries the ASiCSigner ChainElementNeeded event's parameters.
type ASiCSignerChainElementNeededEventArgs struct {...}

func (args *ASiCSignerChainElementNeededEventArgs) Kind() int32
func (args *ASiCSignerChainElementNeededEventArgs) CertRDN() string
func (args *ASiCSignerChainElementNeededEventArgs) CACertRDN() string
// ASiCSignerChainElementNeededEvent defines the signature of the ASiCSigner ChainElementNeeded event's handler function.
type ASiCSignerChainElementNeededEvent func(sender *ASiCSigner, args *ASiCSignerChainElementNeededEventArgs)

func (obj *ASiCSigner) GetOnChainElementNeededHandler() ASiCSignerChainElementNeededEvent
func (obj *ASiCSigner) SetOnChainElementNeededHandler(handlerFunc ASiCSignerChainElementNeededEvent)

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.


cekUnknown	`0`	Unknown or unsupported element type
cekCertificate	`1`	An X.509 certificate
cekCRL	`2`	A CRL
cekOCSP	`3`	An OCSP response

ChainElementStore Event (ASiCSigner Component)

This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.

Syntax

// ASiCSignerChainElementStoreEventArgs carries the ASiCSigner ChainElementStore event's parameters.
type ASiCSignerChainElementStoreEventArgs struct {...}

func (args *ASiCSignerChainElementStoreEventArgs) Kind() int32
func (args *ASiCSignerChainElementStoreEventArgs) Body() []byte
func (args *ASiCSignerChainElementStoreEventArgs) URI() string
func (args *ASiCSignerChainElementStoreEventArgs) SetURI(value string)

// ASiCSignerChainElementStoreEvent defines the signature of the ASiCSigner ChainElementStore event's handler function.
type ASiCSignerChainElementStoreEvent func(sender *ASiCSigner, args *ASiCSignerChainElementStoreEventArgs)

func (obj *ASiCSigner) GetOnChainElementStoreHandler() ASiCSignerChainElementStoreEvent
func (obj *ASiCSigner) SetOnChainElementStoreHandler(handlerFunc ASiCSignerChainElementStoreEvent)

Remarks

This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.


cekUnknown	`0`	Unknown or unsupported element type
cekCertificate	`1`	An X.509 certificate
cekCRL	`2`	A CRL
cekOCSP	`3`	An OCSP response

ChainValidated Event (ASiCSigner Component)

Reports the completion of a certificate chain validation.

Syntax

// ASiCSignerChainValidatedEventArgs carries the ASiCSigner ChainValidated event's parameters.
type ASiCSignerChainValidatedEventArgs struct {...}

func (args *ASiCSignerChainValidatedEventArgs) Index() int32
func (args *ASiCSignerChainValidatedEventArgs) EntityLabel() string
func (args *ASiCSignerChainValidatedEventArgs) SubjectRDN() string
func (args *ASiCSignerChainValidatedEventArgs) ValidationResult() int32
func (args *ASiCSignerChainValidatedEventArgs) ValidationDetails() int32
func (args *ASiCSignerChainValidatedEventArgs) Cancel() bool
func (args *ASiCSignerChainValidatedEventArgs) SetCancel(value bool)

// ASiCSignerChainValidatedEvent defines the signature of the ASiCSigner ChainValidated event's handler function.
type ASiCSignerChainValidatedEvent func(sender *ASiCSigner, args *ASiCSignerChainValidatedEventArgs)

func (obj *ASiCSigner) GetOnChainValidatedHandler() ASiCSignerChainValidatedEvent
func (obj *ASiCSigner) SetOnChainValidatedHandler(handlerFunc ASiCSignerChainValidatedEvent)

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Any other value reports a failure, and ValidationDetails provides more details on its reasons.


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

ChainValidationProgress Event (ASiCSigner Component)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Syntax

// ASiCSignerChainValidationProgressEventArgs carries the ASiCSigner ChainValidationProgress event's parameters.
type ASiCSignerChainValidationProgressEventArgs struct {...}

func (args *ASiCSignerChainValidationProgressEventArgs) EventKind() string
func (args *ASiCSignerChainValidationProgressEventArgs) CertRDN() string
func (args *ASiCSignerChainValidationProgressEventArgs) CACertRDN() string
func (args *ASiCSignerChainValidationProgressEventArgs) Action() int32
func (args *ASiCSignerChainValidationProgressEventArgs) SetAction(value int32)

// ASiCSignerChainValidationProgressEvent defines the signature of the ASiCSigner ChainValidationProgress event's handler function.
type ASiCSignerChainValidationProgressEvent func(sender *ASiCSigner, args *ASiCSignerChainValidationProgressEventArgs)

func (obj *ASiCSigner) GetOnChainValidationProgressHandler() ASiCSignerChainValidationProgressEvent
func (obj *ASiCSigner) SetOnChainValidationProgressHandler(handlerFunc ASiCSignerChainValidationProgressEvent)

Remarks

Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.


veaAuto	`0`	Handle the action automatically (the default behaviour)
veaContinue	`1`	Accept the request implied by the event (accept the certificate, allow the object retrieval)
veaReject	`2`	Reject the request implied by the event (reject the certificate, disallow the object retrieval)
veaAcceptNow	`3`	Accept the validated certificate immediately
veaAbortNow	`4`	Abort the validation, reject the certificate

ContainerLoaded Event (ASiCSigner Component)

This event is fired when the container has been loaded into memory.

Syntax

// ASiCSignerContainerLoadedEventArgs carries the ASiCSigner ContainerLoaded event's parameters.
type ASiCSignerContainerLoadedEventArgs struct {...}

func (args *ASiCSignerContainerLoadedEventArgs) Cancel() bool
func (args *ASiCSignerContainerLoadedEventArgs) SetCancel(value bool)

// ASiCSignerContainerLoadedEvent defines the signature of the ASiCSigner ContainerLoaded event's handler function.
type ASiCSignerContainerLoadedEvent func(sender *ASiCSigner, args *ASiCSignerContainerLoadedEventArgs)

func (obj *ASiCSigner) GetOnContainerLoadedHandler() ASiCSignerContainerLoadedEvent
func (obj *ASiCSigner) SetOnContainerLoadedHandler(handlerFunc ASiCSignerContainerLoadedEvent)

Remarks

The handler for this event is a good place to check for any existing signatures and validate them if required.

Set Cancel to true to terminate document processing on this stage.

Error Event (ASiCSigner Component)

Information about any errors that occur during signing or archiving.

Syntax

// ASiCSignerErrorEventArgs carries the ASiCSigner Error event's parameters.
type ASiCSignerErrorEventArgs struct {...}

func (args *ASiCSignerErrorEventArgs) ErrorCode() int32
func (args *ASiCSignerErrorEventArgs) Description() string
// ASiCSignerErrorEvent defines the signature of the ASiCSigner Error event's handler function.
type ASiCSignerErrorEvent func(sender *ASiCSigner, args *ASiCSignerErrorEventArgs)

func (obj *ASiCSigner) GetOnErrorHandler() ASiCSignerErrorEvent
func (obj *ASiCSigner) SetOnErrorHandler(handlerFunc ASiCSignerErrorEvent)

Remarks

The event is fired in case of exceptional conditions which occur during signing or archiving of data.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalSign Event (ASiCSigner Component)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

// ASiCSignerExternalSignEventArgs carries the ASiCSigner ExternalSign event's parameters.
type ASiCSignerExternalSignEventArgs struct {...}

func (args *ASiCSignerExternalSignEventArgs) OperationId() string
func (args *ASiCSignerExternalSignEventArgs) HashAlgorithm() string
func (args *ASiCSignerExternalSignEventArgs) Pars() string
func (args *ASiCSignerExternalSignEventArgs) Data() string
func (args *ASiCSignerExternalSignEventArgs) SignedData() string
func (args *ASiCSignerExternalSignEventArgs) SetSignedData(value string)

// ASiCSignerExternalSignEvent defines the signature of the ASiCSigner ExternalSign event's handler function.
type ASiCSignerExternalSignEvent func(sender *ASiCSigner, args *ASiCSignerExternalSignEventArgs)

func (obj *ASiCSigner) GetOnExternalSignHandler() ASiCSignerExternalSignEvent
func (obj *ASiCSigner) SetOnExternalSignHandler(handlerFunc ASiCSignerExternalSignEvent)

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the struct via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The struct uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FileExtractionStart Event (ASiCSigner Component)

Signifies the start of a file extraction process.

Syntax

// ASiCSignerFileExtractionStartEventArgs carries the ASiCSigner FileExtractionStart event's parameters.
type ASiCSignerFileExtractionStartEventArgs struct {...}

func (args *ASiCSignerFileExtractionStartEventArgs) FileName() string
func (args *ASiCSignerFileExtractionStartEventArgs) FileSize() int64
func (args *ASiCSignerFileExtractionStartEventArgs) ModDate() string
func (args *ASiCSignerFileExtractionStartEventArgs) Extract() bool
func (args *ASiCSignerFileExtractionStartEventArgs) SetExtract(value bool)

func (args *ASiCSignerFileExtractionStartEventArgs) DestFile() string
func (args *ASiCSignerFileExtractionStartEventArgs) SetDestFile(value string)

// ASiCSignerFileExtractionStartEvent defines the signature of the ASiCSigner FileExtractionStart event's handler function.
type ASiCSignerFileExtractionStartEvent func(sender *ASiCSigner, args *ASiCSignerFileExtractionStartEventArgs)

func (obj *ASiCSigner) GetOnFileExtractionStartHandler() ASiCSignerFileExtractionStartEvent
func (obj *ASiCSigner) SetOnFileExtractionStartHandler(handlerFunc ASiCSignerFileExtractionStartEvent)

Remarks

This event fires for every file located in the archive and matching the ExtractionMode setting before it is to be extracted.

DestFile indicates the path where the file will be saved to. You can alter the destination path here, by providing an alternative extraction path.

Set DestFile to an empty string and provide a stream object via the OutputStream property if you prefer to save the data to a stream instead of file.

If DestFile is set to an empty string and OutputStream is unassigned, the file will not be extracted.

Alternatively, you can request the extracted content to be saved into a byte array. To do this, leave DestFile and OutputStream empty, and keep the Extract parameter enabled.

Please take care when extracting large files into byte arrays, as those may consume large amounts of memory.

Note: if DestFile already exists, the struct will overwrite it. To prevent overwriting of existing files, subscribe to this event, and change DestFile when needed.

Notification Event (ASiCSigner Component)

This event notifies the application about an underlying control flow event.

Syntax

// ASiCSignerNotificationEventArgs carries the ASiCSigner Notification event's parameters.
type ASiCSignerNotificationEventArgs struct {...}

func (args *ASiCSignerNotificationEventArgs) EventID() string
func (args *ASiCSignerNotificationEventArgs) EventParam() string
// ASiCSignerNotificationEvent defines the signature of the ASiCSigner Notification event's handler function.
type ASiCSignerNotificationEvent func(sender *ASiCSigner, args *ASiCSignerNotificationEventArgs)

func (obj *ASiCSigner) GetOnNotificationHandler() ASiCSignerNotificationEvent
func (obj *ASiCSigner) SetOnNotificationHandler(handlerFunc ASiCSignerNotificationEvent)

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.

This struct can fire this event with the following EventID values:


AddReference	A reference is being added to the archive. The EventParam parameter contains the path. Use the event handler to tune-up the reference parameters. One such parameter, represented by the RefMimeType config property, is the MIME type of the referenced file object.
AddDataObjectFormat	TBD
AddXMLReference	TBD
ContainerLoaded	Notifies the application that the ASiC container has been loaded. This is a backward-compatibility-only notification: use OnContainerLoaded event instead.
RetrieveQualifyingProperties	TBD
BeforeTimestamp	This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings.
TimestampError	This event is only fired if the struct failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info.
TimestampRequest	A timestamp is requested from the custom timestamping authority. This event is only fired if TimestampServer was set to a virtual:// URI. The EventParam parameter contains the TSP request (or the plain hash, depending on the value provided to TimestampServer), in base16, that needs to be sent to the TSA. Use the event handler to send the request to the TSA. Upon receiving the response, assign it, in base16, to the TimestampResponse configuration property.

SignatureFound Event (ASiCSigner Component)

Signifies the start of signature validation.

Syntax

// ASiCSignerSignatureFoundEventArgs carries the ASiCSigner SignatureFound event's parameters.
type ASiCSignerSignatureFoundEventArgs struct {...}

func (args *ASiCSignerSignatureFoundEventArgs) Index() int32
func (args *ASiCSignerSignatureFoundEventArgs) EntityLabel() string
func (args *ASiCSignerSignatureFoundEventArgs) IssuerRDN() string
func (args *ASiCSignerSignatureFoundEventArgs) SerialNumber() []byte
func (args *ASiCSignerSignatureFoundEventArgs) SubjectKeyID() []byte
func (args *ASiCSignerSignatureFoundEventArgs) CertFound() bool
func (args *ASiCSignerSignatureFoundEventArgs) ValidateSignature() bool
func (args *ASiCSignerSignatureFoundEventArgs) SetValidateSignature(value bool)

func (args *ASiCSignerSignatureFoundEventArgs) ValidateChain() bool
func (args *ASiCSignerSignatureFoundEventArgs) SetValidateChain(value bool)

// ASiCSignerSignatureFoundEvent defines the signature of the ASiCSigner SignatureFound event's handler function.
type ASiCSignerSignatureFoundEvent func(sender *ASiCSigner, args *ASiCSignerSignatureFoundEventArgs)

func (obj *ASiCSigner) GetOnSignatureFoundHandler() ASiCSignerSignatureFoundEvent
func (obj *ASiCSigner) SetOnSignatureFoundHandler(handlerFunc ASiCSignerSignatureFoundEvent)

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 (ASiCSigner Component)

Marks the completion of the signature validation routine.

Syntax

// ASiCSignerSignatureValidatedEventArgs carries the ASiCSigner SignatureValidated event's parameters.
type ASiCSignerSignatureValidatedEventArgs struct {...}

func (args *ASiCSignerSignatureValidatedEventArgs) Index() int32
func (args *ASiCSignerSignatureValidatedEventArgs) EntityLabel() string
func (args *ASiCSignerSignatureValidatedEventArgs) IssuerRDN() string
func (args *ASiCSignerSignatureValidatedEventArgs) SerialNumber() []byte
func (args *ASiCSignerSignatureValidatedEventArgs) SubjectKeyID() []byte
func (args *ASiCSignerSignatureValidatedEventArgs) ValidationResult() int32
func (args *ASiCSignerSignatureValidatedEventArgs) Cancel() bool
func (args *ASiCSignerSignatureValidatedEventArgs) SetCancel(value bool)

// ASiCSignerSignatureValidatedEvent defines the signature of the ASiCSigner SignatureValidated event's handler function.
type ASiCSignerSignatureValidatedEvent func(sender *ASiCSigner, args *ASiCSignerSignatureValidatedEventArgs)

func (obj *ASiCSigner) GetOnSignatureValidatedHandler() ASiCSignerSignatureValidatedEvent
func (obj *ASiCSigner) SetOnSignatureValidatedHandler(handlerFunc ASiCSignerSignatureValidatedEvent)

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

TimestampFound Event (ASiCSigner Component)

Signifies the start of a timestamp validation routine.

Syntax

// ASiCSignerTimestampFoundEventArgs carries the ASiCSigner TimestampFound event's parameters.
type ASiCSignerTimestampFoundEventArgs struct {...}

func (args *ASiCSignerTimestampFoundEventArgs) Index() int32
func (args *ASiCSignerTimestampFoundEventArgs) EntityLabel() string
func (args *ASiCSignerTimestampFoundEventArgs) IssuerRDN() string
func (args *ASiCSignerTimestampFoundEventArgs) SerialNumber() []byte
func (args *ASiCSignerTimestampFoundEventArgs) SubjectKeyID() []byte
func (args *ASiCSignerTimestampFoundEventArgs) CertFound() bool
func (args *ASiCSignerTimestampFoundEventArgs) ValidateTimestamp() bool
func (args *ASiCSignerTimestampFoundEventArgs) SetValidateTimestamp(value bool)

func (args *ASiCSignerTimestampFoundEventArgs) ValidateChain() bool
func (args *ASiCSignerTimestampFoundEventArgs) SetValidateChain(value bool)

// ASiCSignerTimestampFoundEvent defines the signature of the ASiCSigner TimestampFound event's handler function.
type ASiCSignerTimestampFoundEvent func(sender *ASiCSigner, args *ASiCSignerTimestampFoundEventArgs)

func (obj *ASiCSigner) GetOnTimestampFoundHandler() ASiCSignerTimestampFoundEvent
func (obj *ASiCSigner) SetOnTimestampFoundHandler(handlerFunc ASiCSignerTimestampFoundEvent)

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.

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.

TimestampRequest Event (ASiCSigner Component)

Fires when the class is ready to request a timestamp from an external TSA.

Syntax

// ASiCSignerTimestampRequestEventArgs carries the ASiCSigner TimestampRequest event's parameters.
type ASiCSignerTimestampRequestEventArgs struct {...}

func (args *ASiCSignerTimestampRequestEventArgs) TSA() string
func (args *ASiCSignerTimestampRequestEventArgs) TimestampRequest() string
func (args *ASiCSignerTimestampRequestEventArgs) TimestampResponse() string
func (args *ASiCSignerTimestampRequestEventArgs) SetTimestampResponse(value string)

func (args *ASiCSignerTimestampRequestEventArgs) SuppressDefault() bool
func (args *ASiCSignerTimestampRequestEventArgs) SetSuppressDefault(value bool)

// ASiCSignerTimestampRequestEvent defines the signature of the ASiCSigner TimestampRequest event's handler function.
type ASiCSignerTimestampRequestEvent func(sender *ASiCSigner, args *ASiCSignerTimestampRequestEventArgs)

func (obj *ASiCSigner) GetOnTimestampRequestHandler() ASiCSignerTimestampRequestEvent
func (obj *ASiCSigner) SetOnTimestampRequestHandler(handlerFunc ASiCSignerTimestampRequestEvent)

Remarks

Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The TSA parameter indicates the timestamping service being used. It matches the value passed to the TimestampServer property. Set the SuppressDefault parameter to true if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.

TimestampValidated Event (ASiCSigner Component)

Reports the completion of the timestamp validation routine.

Syntax

// ASiCSignerTimestampValidatedEventArgs carries the ASiCSigner TimestampValidated event's parameters.
type ASiCSignerTimestampValidatedEventArgs struct {...}

func (args *ASiCSignerTimestampValidatedEventArgs) Index() int32
func (args *ASiCSignerTimestampValidatedEventArgs) EntityLabel() string
func (args *ASiCSignerTimestampValidatedEventArgs) IssuerRDN() string
func (args *ASiCSignerTimestampValidatedEventArgs) SerialNumber() []byte
func (args *ASiCSignerTimestampValidatedEventArgs) SubjectKeyID() []byte
func (args *ASiCSignerTimestampValidatedEventArgs) Time() string
func (args *ASiCSignerTimestampValidatedEventArgs) ValidationResult() int32
func (args *ASiCSignerTimestampValidatedEventArgs) ChainValidationResult() int32
func (args *ASiCSignerTimestampValidatedEventArgs) ChainValidationDetails() int32
func (args *ASiCSignerTimestampValidatedEventArgs) Cancel() bool
func (args *ASiCSignerTimestampValidatedEventArgs) SetCancel(value bool)

// ASiCSignerTimestampValidatedEvent defines the signature of the ASiCSigner TimestampValidated event's handler function.
type ASiCSignerTimestampValidatedEvent func(sender *ASiCSigner, args *ASiCSignerTimestampValidatedEventArgs)

func (obj *ASiCSigner) GetOnTimestampValidatedHandler() ASiCSignerTimestampValidatedEvent
func (obj *ASiCSigner) SetOnTimestampValidatedHandler(handlerFunc ASiCSignerTimestampValidatedEvent)

Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.


svtValid	`0`	The signature is valid
svtUnknown	`1`	Signature validity is unknown
svtCorrupted	`2`	The signature is corrupted
svtSignerNotFound	`3`	Failed to acquire the signing certificate. The signature cannot be validated.
svtFailure	`4`	General failure
svtReferenceCorrupted	`5`	Reference corrupted (XML-based signatures only)

TLSCertNeeded Event (ASiCSigner Component)

Fires when a remote TLS party requests a client certificate.

Syntax

// ASiCSignerTLSCertNeededEventArgs carries the ASiCSigner TLSCertNeeded event's parameters.
type ASiCSignerTLSCertNeededEventArgs struct {...}

func (args *ASiCSignerTLSCertNeededEventArgs) Host() string
func (args *ASiCSignerTLSCertNeededEventArgs) CANames() string
// ASiCSignerTLSCertNeededEvent defines the signature of the ASiCSigner TLSCertNeeded event's handler function.
type ASiCSignerTLSCertNeededEvent func(sender *ASiCSigner, args *ASiCSignerTLSCertNeededEventArgs)

func (obj *ASiCSigner) GetOnTLSCertNeededHandler() ASiCSignerTLSCertNeededEvent
func (obj *ASiCSigner) SetOnTLSCertNeededHandler(handlerFunc ASiCSignerTLSCertNeededEvent)

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 (ASiCSigner Component)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

// ASiCSignerTLSCertValidateEventArgs carries the ASiCSigner TLSCertValidate event's parameters.
type ASiCSignerTLSCertValidateEventArgs struct {...}

func (args *ASiCSignerTLSCertValidateEventArgs) ServerHost() string
func (args *ASiCSignerTLSCertValidateEventArgs) ServerIP() string
func (args *ASiCSignerTLSCertValidateEventArgs) Accept() bool
func (args *ASiCSignerTLSCertValidateEventArgs) SetAccept(value bool)

// ASiCSignerTLSCertValidateEvent defines the signature of the ASiCSigner TLSCertValidate event's handler function.
type ASiCSignerTLSCertValidateEvent func(sender *ASiCSigner, args *ASiCSignerTLSCertValidateEventArgs)

func (obj *ASiCSigner) GetOnTLSCertValidateHandler() ASiCSignerTLSCertValidateEvent
func (obj *ASiCSigner) SetOnTLSCertValidateHandler(handlerFunc ASiCSignerTLSCertValidateEvent)

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 (ASiCSigner Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

// ASiCSignerTLSEstablishedEventArgs carries the ASiCSigner TLSEstablished event's parameters.
type ASiCSignerTLSEstablishedEventArgs struct {...}

func (args *ASiCSignerTLSEstablishedEventArgs) Host() string
func (args *ASiCSignerTLSEstablishedEventArgs) Version() string
func (args *ASiCSignerTLSEstablishedEventArgs) Ciphersuite() string
func (args *ASiCSignerTLSEstablishedEventArgs) ConnectionId() []byte
func (args *ASiCSignerTLSEstablishedEventArgs) Abort() bool
func (args *ASiCSignerTLSEstablishedEventArgs) SetAbort(value bool)

// ASiCSignerTLSEstablishedEvent defines the signature of the ASiCSigner TLSEstablished event's handler function.
type ASiCSignerTLSEstablishedEvent func(sender *ASiCSigner, args *ASiCSignerTLSEstablishedEventArgs)

func (obj *ASiCSigner) GetOnTLSEstablishedHandler() ASiCSignerTLSEstablishedEvent
func (obj *ASiCSigner) SetOnTLSEstablishedHandler(handlerFunc ASiCSignerTLSEstablishedEvent)

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 (ASiCSigner Component)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

// ASiCSignerTLSHandshakeEventArgs carries the ASiCSigner TLSHandshake event's parameters.
type ASiCSignerTLSHandshakeEventArgs struct {...}

func (args *ASiCSignerTLSHandshakeEventArgs) Host() string
func (args *ASiCSignerTLSHandshakeEventArgs) Abort() bool
func (args *ASiCSignerTLSHandshakeEventArgs) SetAbort(value bool)

// ASiCSignerTLSHandshakeEvent defines the signature of the ASiCSigner TLSHandshake event's handler function.
type ASiCSignerTLSHandshakeEvent func(sender *ASiCSigner, args *ASiCSignerTLSHandshakeEventArgs)

func (obj *ASiCSigner) GetOnTLSHandshakeHandler() ASiCSignerTLSHandshakeEvent
func (obj *ASiCSigner) SetOnTLSHandshakeHandler(handlerFunc ASiCSignerTLSHandshakeEvent)

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 (ASiCSigner Component)

Reports the graceful closure of a TLS connection.

Syntax

// ASiCSignerTLSShutdownEventArgs carries the ASiCSigner TLSShutdown event's parameters.
type ASiCSignerTLSShutdownEventArgs struct {...}

func (args *ASiCSignerTLSShutdownEventArgs) Host() string
// ASiCSignerTLSShutdownEvent defines the signature of the ASiCSigner TLSShutdown event's handler function.
type ASiCSignerTLSShutdownEvent func(sender *ASiCSigner, args *ASiCSignerTLSShutdownEventArgs)

func (obj *ASiCSigner) GetOnTLSShutdownHandler() ASiCSignerTLSShutdownEvent
func (obj *ASiCSigner) SetOnTLSShutdownHandler(handlerFunc ASiCSignerTLSShutdownEvent)

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 (ASiCSigner 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.

ASiCSigner Config Settings

AddAllDataObjectsTimestamp: Whether to add all data objects timestamp during signing.

If this property is set to True, the all data objects timestamp (xades:AllDataObjectsTimeStamp element) will be added.

ASiCOptions: Specifies the ASiC options.

Contains a comma-separated list of values that specifies ASiC options.

Supported values are:


UseP7MExtensionForExtendedCAdES		When this flag is set, the .p7m extension is used for extended CAdES signatures inside the container. Otherwise, the .p7s extension is used.
EncodeIRI		When this flag is set, non-ASCII characters in filenames are encoded as defined in RFC 3987 when used in XML signature or manifest.

AsyncDocumentID: Specifies the document ID for SignAsyncEnd() call.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

CachedCRLMaxAge: Specifies the maximum age of a cached CRL.

Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.

The default value is 1 day (86400 seconds). A value of 0 disables the absolute CRL age check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedCRLMaxAgeRatio: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.

Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.

The default value is 50 percent. Values are interpreted in the 0..100 range. A value of 0 disables the CRL ratio check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedCRLOverlapTime: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.

Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

The default value is 10 minutes (600 seconds). A value of 0 disables the CRL overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from CachedCRLMaxAge and CachedCRLMaxAgeRatio. If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.

CachedOCSPResponseMaxAge: Specifies the maximum age of a cached OCSP response.

Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.

The default value is 1 hour (3600 seconds). A value of 0 disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedOCSPResponseMaxAgeRatio: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.

Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.

The default value is 50 percent. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use CachedOCSPResponseMaxAge to limit their age. A value of 0 disables the OCSP response ratio check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedOCSPResponseOverlapTime: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.

Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.

The default value is 10 minutes (600 seconds). A value of 0 disables the OCSP response overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from CachedOCSPResponseMaxAge and CachedOCSPResponseMaxAgeRatio. If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.

ChainCurrentCACert: Returns the current CA certificate.

This property returns the CA certificate that is used on the current step.

ChainCurrentCert: Returns the certificate that is currently being validated.

Use this property to obtain the body of the certificate that is currently being validated.

ChainCurrentCRL: Returns the current CRL.

Returns the CRL object that is currently being processed.

ChainCurrentCRLSize: Returns the size of the current CRL.

This property returns the size of the CRL object that is currently being processed.

ChainCurrentOCSP: Returns the current OCSP response.

Returns the OCSP object that is currently being processed.

ChainCurrentOCSPSigner: Returns the signer of the current OCSP object.

Returns the signer/CA that has issued the OCSP response that is currently being processed.

ChainInterimDetails: Returns the current interim validation details.

This property returns the interim chain validation details.

ChainInterimResult: Returns the current interim validation result.

Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes.

CheckValidityPeriodForTrusted: Whether to check validity period for trusted certificates.

Whether to check validity period for trusted certificates.

ClaimedRolesXML: The XML content of the claimed roles.

Use this property to get/specify the XML content of the claimed roles element.

ClaimedRoleText: The text of the claimed role.

Use this property to get/specify the text of the first claimed role.

CmsOptAnnexKArchiveTimestampV2Mode: Toggles use of Annex K method of calculating validation timestamp hashes.

This CMS message option toggles the use of Annex K method of calculating validation timestamp hashes. Switch this option off to stick to RFC5126 p6.3.5 method.

CmsOptCheckATSHashIndexElements: Enables extra checks when processing ATSHashIndex attribute.

This CMS message option enables an extra check to make sure every hash in ATSHashIndex has an associated CMS element.

CmsOptCompareRDNAsStrings: Enforces comparison of RDN elements as text strings, rather than their byte encodings.

This CMS message option enforces comparison of string RDN elements as text strings rather than their original byte encodings.

CmsOptDEREncodeContentForATSv2: Enables DER encoding for ATSv2 hashed content.

This is an outdated setting, which reflects a complicated (at times) story of AdES infrastructure development. You are unlikely to need it.

CmsOptDigitPADSSCompatibility: Enables Digit PADSS compatibility mode.

This CMS message option enables compatibility mode with Digit PADSS software.

CmsOptForceSigningCertificateV2Usage: Enforces use of signing-certificate-v2 attribute.

This CMS message option enforces the use of signing-certificate-v2 attribute in favour of older signing-certificate-v1. Current regulations require that signing-certificate-v2 is used at all times.

CmsOptIgnoreDERReqInArchiveTimestamps: Switches off DER encoding requirement for archival timestamps.

This CMS message option switches off DER encoding requirement for archival timestamps (normally meaning no attribute reordering). This setting is a workaround for certain buggy CAdES products.

CmsOptImzagerMIMCompatibility: Enables Imzager MIM compatibility mode.

This CMS message option enables compatibility mode with Imzager MIM software.

CmsOptIncludeCertToAttributes: Regulates whether to include the signing certificate to the signature as the signing-certificate attribute.

This CMS message option controls inclusion of the signing certificate as the signing-certificate attribute. Current regulations require that this attribute is present.

CmsOptIncludeCertToMessage: Regulates whether to include the signing certificate and its chain to the CMS.

This CMS message option controls inclusion of the signing certificate to the CMS structure. It is recommended that the certificate is included. Note that this option has no effect if the signature level used (e.g. XL) enforces inclusion of the certificate to the message.

CmsOptInsertContentType: Regulates whether the content-type time attribute should be included in the signature structure.

This CMS message option specifies whether the content-type attribute should be included in the signature structure.

CmsOptInsertMessageDigests: Regulates whether the message-digest signed attribute should be included in the signature structure.

This CMS message option controls inclusion of the message-digest attribute in the signature structure. Current regulations require that this attribute is present at all times.

CmsOptInsertSigningTime: Regulates whether the signing-time attribute should be included in the signature structure.

This CMS message option specifies whether the signing-time attribute should be included in the signature structure. Switch it off to suppress inclusion of the signing-time attribute.

CmsOptSkipEnvContentInfoOnSigArchival: Excludes hashing of enveloped content when calculating an archival timestamp.

This CMS message option excludes hashing of enveloped content when calculating an archival timestamp. This setting is a workaround for certain buggy CAdES products.

CmsOptUseATSHashIndexV1: Enables use of ATSHashIndexV1 attribute.

This CMS message option enables use of deprecated ATSHashIndexV1 attribute when calculating archival timestamp V3 hashes.

CmsOptUseATSHashIndexV3: Enables the use of the third version of archival timestamps.

Enables the use of archival timestamp v3 objects when creating long-term and archival signatures. This is the default setting. Setting it to false tells the components to stick with archival timestamps version 2.

CmsOptUseGeneralizedTimeFormat: Enables or disables encoding of the signing-time attribute using ASN.1 GENERALIZEDTIME type.

This CMS message option controls whether the signing-time attribute should be encoded as GENERALIZEDTIME or UTCTIME. Current regulations require that the GENERALIZEDTIME type is used at all times.

CmsOptUseGenericSigAlgorithmOIDs: Enables use of generic signature algorithm OIDs in the signature.

This CMS message option enforces the use of generic public key algorithm OIDs (e.g. rsaEncryption) instead of hash algorithm-specific variants (e.g. sha256withRsaEncryption). This setting is a workaround for certain buggy CAdES products.

CmsOptUsePlainContentForTimestampHashes: Makes CAdESSigner ignore ASN.1 content formatting when calculating timestamp hashes.

This CMS message option causes CAdESSigner to ignore ASN.1 formatting when feeding content to timestamp hashes (might make a difference with split OCTETSTRINGs for extra long contents). This option is only applicable to content timestamps and ArchivalTimestampV1's. This setting is a workaround for certain buggy CAdES products.

CommitmentTypeIndicationAllSignedDataObjects[Index]: Specifies the CommitmentTypeIndication's AllSignedDataObjects.

This property contains if the CommitmentTypeIndication's AllSignedDataObjects element is present that indicates that all the signed data objects share the same commitment. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationCount: The number of the CommitmentTypeIndication elements.

Returns the number of the xades:CommitmentTypeIndication elements available.

CommitmentTypeIndicationIdentifier[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier.

This property contains an identifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Identifier element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierDescription[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's Description.

This property contains an identifier's description indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's Description element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierDocumentationReferences[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences.

This property contains an identifier's documentation references indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationIdentifierQualifier[Index]: Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier.

This property contains an identifier qualifier indicating the type of commitment made by the signer in the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier element. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationObjectReference[Index]: Specifies the CommitmentTypeIndication's ObjectReference.

This property contains the CommitmentTypeIndication's ObjectReference elements that refer to one or several ds:Reference elements of the ds:SignedInfo corresponding with one data object qualified by this property. Index value could be omitted for the first CommitmentTypeIndication element.

CommitmentTypeIndicationQualifiersXML[Index]: The XML content of the CommitmentTypeIndication's Qualifiers.

This property contains the CommitmentTypeIndication's Qualifiers elements XML content. Index value could be omitted for the first CommitmentTypeIndication element.

ContentType: Specifies the content-type of the container.

This property represents the "/mimetype" service entry of the container. For ASiC-S the "application/vnd.etsi.asic-s+zip" content-type or the original content-type of the archived document are allowed. For ASiC-E, only the "application/vnd.etsi.asic-e+zip" is allowed.

CustomTrustedLists: Specifies the custom TrustedLists.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

CustomTSLs: Specifies the custom TrustedLists.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

DataObjectFormatCount: The number of the DataObjectFormat elements.

Returns the number of the xades:DataObjectFormat elements available.

DataObjectFormatDescription[Index]: Specifies the DataObjectFormat's Description.

This property contains textual information related to the signed data object in the DataObjectFormat's Description element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatEncoding[Index]: Specifies the DataObjectFormat's Encoding.

This property contains an indication of the encoding format of the signed data object in the DataObjectFormat's Encoding element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatMimeType[Index]: Specifies the DataObjectFormat's MimeType.

This property contains an indication of the MIME type of the signed data object in the DataObjectFormat's MimeType element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectIdentifier[Index]: Specifies the DataObjectFormat's ObjectIdentifier's Identifier.

This property contains an identifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Identifier element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectIdentifierDescription[Index]: Specifies the DataObjectFormat's ObjectIdentifier's Description.

This property contains an identifier's description indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's Description element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectIdentifierDocumentationReferences[Index]: Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences.

This property contains an identifier's documentation references indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's DocumentationReferences element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectIdentifierQualifier[Index]: Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier.

This property contains an identifier qualifier indicating the type of the signed data object in the DataObjectFormat's ObjectIdentifier's IdentifierQualifier element. Index value could be omitted for the first DataObjectFormat element.

DataObjectFormatObjectReference[Index]: Specifies the DataObjectFormat's ObjectReference.

This property contains the DataObjectFormat's ObjectReference element that reference the ds:Reference element of the ds:Signature corresponding with the data object qualified by this property.

For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value.

Index value could be omitted for the first DataObjectFormat element.

DeltaCRLPreference: Specifies whether complete or delta CRLs are preferred.

Use this setting to specify which CRL type should be preferred during revocation checks performed by the AdES component.

The default value is dcrlpPreferComplete (1).

Supported values:

dcrlpPreferDelta (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
dcrlpPreferComplete (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.

DislikeOpenEndedOCSPs: Tells the 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.

ExclusiveCanonicalizationPrefix: Specifies the exclusive canonicalization prefix.

Specifies the prefix for the ec:InclusiveNamespaces element for the exclusive canonicalization.

Default value is "ec". In this case "ec:" prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

ForceCompleteChainValidation: Whether to check the CA certificates when the signing certificate is invalid.

Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid.

ForceCompleteChainValidationForTrusted: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.

Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

GenerateMetaInfEntry: Specifies whether the directory META-INF entry should be generated.

Set this property to False to suppress generation of the directory META-INF entry in the container/archive.

Note: ETSI ASiC Conformance Checker dislikes archives with the directory META-INF entry.

GracePeriod: Specifies a grace period to apply during revocation information checks.

Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.

HMACKey: The key value for HMAC.

Use this property to set the HMAC key. The component uses base16 (hex) encoding for this configuration value.

HMACOutputLength: Sets the length of the HMAC output.

Use this property to configure the length of the HMAC output, in bytes.

HMACSigningUsed: Whether to use HMAC signing.

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography. TBD

IgnoreChainLoops: Whether chain loops should be ignored.

Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.

IgnoreChainValidationErrors: Whether to ignore any certificate chain validation issues.

Enable this property to ignore any chain validation errors when creating a signature. This may be useful if the signature is created in an environment which uses different trust settings to the validation environment.

IgnoreOCSPNoCheckExtension: Whether the OCSP NoCheck extension should be ignored.

Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

IgnoreSystemTrust: Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the 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.

IgnoreTimestampFailure: Whether to ignore time-stamping failure during signing.

If this property is set to True, any failure during time-stamping process will be ignored.

ImplicitlyTrustSelfSignedCertificates: Whether to trust self-signed certificates.

Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows emulating the verifying environment without actually changing its security settings.

IncludeKnownRevocationInfoToSignature: Whether to include custom revocation info to the signature.

This property specifies whether revocation pieces provided via KnownCertificates, KnownCRLs, and KnownOCSPs properties should be included into the signature. This property lets you include custom validation elements to the signature in addition to the ones comprising the signing chain.

InclusiveNamespacesPrefixList: Specifies the InclusiveNamespaces PrefixList.

Use this property to read/specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details.

KeyInfoID: Specifies the ID for KeyInfo element.

This property contains the identifier (ID) attribute of the ds:KeyInfo element.

KeyName: Contains information about the key used for signing.

The KeyName element contains a string value (with significant whitespaces) which may be used by the signer to communicate a key identifier to the recipient. Typically, the KeyName element contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. Common uses of the KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc.

ManifestHandlingMode: The approach to use manifest conflict resolution.

This setting specifies the conflict resolution approach to use when generating or updating manifests when re-signing containers. The following options are available:

always: always generate a new manifest
never: never generate a new manifest
diff: a manifest is only added if the existing manifest does not referenced all the files covered by the new signature (i.e. if new files were added during re-signing).
auto or an empty string: the default behavior, which currently maps to always

Overwrite: Forcefully overwrite OutputFile if it exists.

Enable this setting to make the component overwrite the specified output file if it already exists on disk. This setting only applies to the ASiC output (the OutputFile property) and not to extracted archived files. Use the OnFileExtractionStart event to control overwriting behaviour for extracted files.

PolicyDescription: signature policy description.

This property specifies the Description of the signature policy.

PolicyExplicitText: The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified.

PolicyUNNumbers: The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES.

PolicyUNOrganization: The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES.

ProductionPlace: Identifies the place of the signature production.

The signature production place in JSON format that was included or to be included into the signature.

Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'

PromoteLongOCSPResponses: Whether long OCSP responses are requested.

Set this property to True to force the struct to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

PSSUsed: Whether to use RSASSA-PSS algorithm.

Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. This is an alias for UsePSS.

QualifyingPropertiesID: Specifies the ID for QualifyingProperties element.

This property contains the identifier (ID) attribute of the xades:QualifyingProperties element.

QualifyingPropertiesObjectID: Specifies the ID for object with QualifyingProperties element.

This property contains the identifier (ID) attribute of the ds:Object element that contains xades:QualifyingProperties element.

QualifyingPropertiesReferenceCount: The number of the QualifyingPropertiesReference elements.

Returns the number of the xades:QualifyingPropertiesReference elements available.

QualifyingPropertiesReferenceID[Index]: Specifies the QualifyingPropertiesReference's ID.

This property contains an identifier (ID) attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.

QualifyingPropertiesReferenceURI[Index]: Specifies the QualifyingPropertiesReference's URI.

This property contains an URI attribute of the xades:QualifyingPropertiesReference element. Index value could be omitted for the first QualifyingPropertiesReference element.

RefHashAlgorithm: Specifies the hash algorithm for references.

Use this property to specify the reference's hash algorithm.

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

RefMimeType: Specifies the MIME type to apply to the processed file.

Assign this property with the MIME type to apply to the processed file reference, for example application/vnd.openxmlformats-officedocument.wordprocessingml.document.

To set different mime types for more than one file, subscribe to Notification event and handle the AddReference event, where you can provide a separate MIME type for every reference.

RefsTimestampType: Specifies references timestamp type to include to the signature.

Contains a comma-separated list of values that specifies which references timestamp type to include to the signature when signature upgraded to XAdES-X or XAdES-E-X form.

Supported values are:


SigAndRefs		SigAndRefs timestamp
RefsOnly		RefsOnly timestamp

RevocationCacheAgePolicy: Specifies a preset policy for cached CRL and OCSP response freshness settings.

Use this setting to configure all cached revocation freshness settings at once. The default value is Default.

Supported values are case-insensitive:


Default	Applies the AdES default freshness settings: crl:86400;50;600,ocsp:3600;50;600. This means: CRL maximum age 1 day, CRL age ratio 50%, CRL overlap 10 minutes; OCSP response maximum age 1 hour, OCSP response age ratio 50%, OCSP response overlap 10 minutes. This value is the default.
Disabled	Sets CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio to 0. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache.
Short	Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes.
Long	Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour.
N	Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50.
crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap>	Sets the CRL and OCSP response freshness values explicitly.

Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.

SchemeParams: The algorithm scheme parameters to employ.

Use this property to specify the parameters of the algorithm scheme if needed.

This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.

SignatureID: Specifies the ID for Signature element.

This property contains the identifier (ID) attribute of the ds:Signature element.

SignaturePrefix: Specifies the signature prefix.

Specifies the prefix for the Signature elements.

Default value is "ds". In this case "ds:" prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

SignatureValueID: Specifies the ID for SignatureValue element.

This property contains the identifier (ID) attribute of the ds:SignatureValue element.

SignedInfoID: Specifies the ID for SignedInfo element.

This property contains the identifier (ID) attribute of the ds:SignedInfo element.

SignedPropertiesID: Specifies the ID for SignedProperties element.

This property contains the identifier (ID) attribute of the xades:SignedProperties element.

SignedPropertiesReferenceCanonicalizationMethod: Specifies the canonicalization method used in SignedProperties reference.

Use this property to specify the canonicalization method for the canonicalization transform of the ds:Reference element that points to xades:SignedProperties element. Use cxcmNone value to not to include canonicalization transform in transform chain.


cxcmNone	`0`
cxcmCanon	`1`
cxcmCanonComment	`2`
cxcmExclCanon	`3`
cxcmExclCanonComment	`4`
cxcmMinCanon	`5`
cxcmCanon_v1_1	`6`
cxcmCanonComment_v1_1	`7`

SignedPropertiesReferenceHashAlgorithm: Specifies the hash algorithm used in SignedProperties reference.

Use this property to specify the hash algorithm to be used for the ds:Reference element that points to xades:SignedProperties element.

Supported values:


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

SignedPropertiesReferenceID: Specifies the ID for Reference element that points to SignedProperties element.

This property contains the identifier (ID) attribute of the ds:Reference element that points to xades:SignedProperties element.

SignedPropertiesReferenceInclusiveNamespacesPrefixList: Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference.

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the ds:Reference element that points to xades:SignedProperties element.

SignedPropertiesReferenceIndex: Specifies the index of SignedProperties reference.

Use this property to specify the reference's index for the ds:Reference element that points to xades:SignedProperties element.

SignedSignaturePropertiesID: Specifies the ID for SignedSignatureProperties element.

This property contains the identifier (ID) attribute of the xades:SignedSignatureProperties element.

SigningCertificatesChain: Specifies which certificates from SigningChain are included in the xades:SigningCertificate element.

Use this property to get or set the list of indices (relative to the SigningChain property) of the certificates to include in the xades:SigningCertificate element. The value may also be the keywords none (include none) or all (include the entire chain). The default is all.

SigningCertificatesHashAlgorithm: Specifies the hash algorithm used for SigningCertificates.

Use this property to specify the hash algorithm to be used for xades:SigningCertificates element.

Supported values:


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

SigningTimeFormat: Specifies the date time format for the XAdES signing time.

This property contains the date time format for the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).

Supported values:


YYYY		Year (e.g. 1997)
YYYY-MM		Year and month (e.g. 1997-07)
YYYY-MM-DD		Complete date (e.g. 1997-07-16)
YYYY-MM-DDThh:mmTZD		Complete date plus hours and minutes (e.g. 1997-07-16T19:20+01:00)
YYYY-MM-DDThh:mm:ssTZD		Complete date plus hours, minutes and seconds (e.g. 1997-07-16T20:20:30Z)
YYYY-MM-DDThh:mm:ss.sTZD		Complete date plus hours, minutes, seconds and a decimal fraction of a second (e.g. 1997-07-16T20:20:30.4Z)
YYYY-MM-DDThh:mm:ss.sssTZD		Default. Complete date plus hours, minutes, seconds and a fraction of a second (e.g. 1997-07-16T20:20:30.451Z)

SigningTimeIsUTC: Specifies whether the XAdES signing time is in UTC.

This property controls how the value provided by NewSigClaimedSigningTime is interpreted and serialized into the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).

Behavior:


"true"		Default. The provided time is interpreted as UTC. If SigningTimeZoneOffset is non-zero, the time is converted to the corresponding local time (UTC plus the offset) and serialized with that offset; otherwise it is serialized as UTC.
"false"		The provided time is interpreted as local time. No clock-time adjustment is performed. The value is serialized as local time; if SigningTimeZoneOffset is non-zero, the specified offset is included.

SigningTimeZoneOffset: Specifies the time zone offset for the XAdES signing time.

This property contains the time zone offset in minutes for the XAdES signing time (xades:SigningTime element under xades:SignedSignatureProperties).

SigPolicyDescription: signature policy description.

This property specifies the Description of the signature policy (an alias for PolicyDescription).

SigPolicyExplicitText: The explicit text of the user notice.

Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText);

SigPolicyHash: The EPES policy hash.

Use this configuration setting to provide the EPES policy hash.

SigPolicyHashAlgorithm: The hash algorithm that was used to generate the EPES policy hash.

Use this setting to provide the hash algorithm that was used to generate the policy hash.

SigPolicyID: The EPES policy ID.

The EPES signature policy identifier, in dotted OID format (1.2.3.4.5).

SigPolicyNoticeNumbers: The noticeNumbers part of the NoticeReference CAdES attribute.

Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers).

SigPolicyNoticeOrganization: The organization part of the NoticeReference qualifier.

Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization).

SigPolicyURI: The EPES policy URI.

Assign the EPES policy URI to this setting.

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except PDFSigner, where this limitation does not apply.

TimestampCanonicalizationMethod: Specifies canonicalization method used in timestamp.

Use this property to specify the canonicalization method used in timestamp.


cxcmNone	`0`
cxcmCanon	`1`
cxcmCanonComment	`2`
cxcmExclCanon	`3`
cxcmExclCanonComment	`4`
cxcmMinCanon	`5`
cxcmCanon_v1_1	`6`
cxcmCanonComment_v1_1	`7`

TimestampResponse: A base16-encoded timestamp response received from a TSA.

When using virtual:// timestamp endpoints, assign this property in your Notification event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16).

TimestampValidationDataDetails: Specifies timestamp validation data details to include to the signature.

Contains a comma-separated list of values that specifies which validation data values details to include to the signature when xades:TimeStampValidationData element added.

Supported values are:


certificate		Base64-encoded [X509v3] certificates
crl		Base64-encoded certificate revocation lists (CRL)
ocsp		OCSP responses

TLSChainValidationDetails: Contains the advanced details of the TLS server certificate validation.

Check this property in the TLSCertValidate event handler to access the TLS certificate validation details.

TLSChainValidationResult: Contains the result of the TLS server certificate validation.

Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result.

TLSClientAuthRequested: Indicates whether the TLS server requests client authentication.

Check this property in the TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via the TLSClientChain property. Note that the 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

TspAttemptCount: Specifies the number of timestamping request attempts.

Use this property to specify a number of timestamping request attempts.

In case of a timestamping failure, provide new TSA and HTTP settings inside the Notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).

TspHashAlgorithm: Sets a specific hash algorithm for use with the timestamping service.

In default configuration struct uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp.

Note: Unlike other structs, PDFSigner struct uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.

TspReqPolicy: Sets a request policy ID to include in the timestamping request.

Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5).

UseArchivalTimestampV3: Use ArchivalTimestampV3 attribute for A-level CAdES signatures.

Allows to downgrade the created A signatures to ArchivalTimestampV2 if required (the standard requires that ATSv3 timestamps are used for all new containers).

UseDefaultTrustedLists: Enables or disables the use of the default TrustedLists.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).

UseDefaultTSLs: Enables or disables the use of the default TrustedLists.

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).

UseEnvStorages: Enables or disables use of the environment storages.

Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.

UseHMACSigning: Whether to use HMAC signing.

Set this property to true to make the component perform signing using HMAC method, rather than asymmetric cryptography.

UseMicrosoftCTL: Enables or disables the automatic use of the Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UsePSS: Whether to use RSASSA-PSS algorithm.

UseSystemCertificates: Enables or disables the use of the system certificates.

Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

UseUTF8Filenames: Specifies whether to use UTF-8 filenames.

Set this property to False to use system encoding for filenames inside container.

UseValidationCache: Enables or disable the use of the product-wide certificate chain validation cache.

Use this property to enable or disable the use of the global chain validation cache. If enabled, the 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).

ValidationDataRefsDetails: Specifies validation data references details to include to the signature.

Contains a comma-separated list of values that specifies which validation data references details to include to the signature when signature upgraded to XAdES-C or XAdES-E-C form.

Supported values are:


certificate		References to X.509 certificates
crl		References to certificate revocation lists (CRL)
ocsp		References to OCSP responses

ValidationDataRefsHashAlgorithm: Specifies the hash algorithm used in validation data references.

Use this property to specify the hash algorithm used to compute hashes for validation data references.

Supported values:


SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

The default value is empty string, in this case, the hash algorithm specified in HashAlgorithm property is used.

ValidationDataValuesDetails: Specifies validation data values details to include to the signature.

Contains a comma-separated list of values that specifies which validation data values details to include to the signature when signature upgraded to XAdES-X-L or XAdES-E-X-L form.

Supported values are:


certificate		Base64-encoded [X509v3] certificates
crl		Base64-encoded certificate revocation lists (CRL)
ocsp		OCSP responses

XAdESPrefix: Specifies the XAdES prefix.

Specifies the prefix for the XAdES elements.

Default value is "xades". In this case "xades:" prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

XAdESv141Prefix: Specifies the XAdES v1.4.1 prefix.

Specifies the prefix for the XAdES v1.4.1 elements.

Default value is "xadesv141". In this case "xadesv141:" prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

XmlRefID: Specifies a custom value for the ID attribute of a reference.

Use this property to override the default value for the id attribute of an XAdES signature reference. For signatures with multiple reference, subscribe to OnNotification event and listen to AddXMLReference calls. Set the configuration property for each reference independently from the event handler.

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:


off		No caching (default)
local		Local caching
global		Global 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).
enable	Always attempt to use hardware cryptography. If unavailable, exception will be thrown.
disable	Do not use hardware cryptography.

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other 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:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:


certificate	Enables caching of certificates.
crl	Enables caching of Certificate Revocation Lists (CRLs).
ocsp	Enables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): 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:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the 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 (ASiCSigner Component)

ASiCSigner 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`)
16777217	Unsupported level (`SB_ERROR_ASIC_UNSUPPORTED_LEVEL`)
16777219	Unsupported signature type (`SB_ERROR_ASIC_UNSUPPORTED_SIGNATURE_TYPE`)
16777220	Unsupported extraction mode (`SB_ERROR_ASIC_UNSUPPORTED_EXTRACTION_MODE`)
16777221	The input file does not exist (`SB_ERROR_ASIC_INPUTFILE_NOT_EXISTS`)
16777222	The output file with this name already exists (`SB_ERROR_ASIC_OUTPUTFILE_ALREADY_EXISTS`)
16777223	The document has already been signed once during this session (`SB_ERROR_ASIC_CONTAINER_SIGNED`)
16777224	The document is not signed (`SB_ERROR_ASIC_CONTAINER_NOT_SIGNED`)