# JAdESSigner Component The JAdESSigner class signs Javascript content electronically. ## Syntax ```text secureblackbox.JAdESSigner ``` ## Remarks JAdESSigner supports a range of digital signature formats over Javascript content, including JSON Web Signatures (JWS) and ETSI JSON Advanced Electronic Signatures (JAdES). ```text JAdESSigner signer = new JAdESSigner(); signer.getNewSignature().setHashAlgorithm("SHA512"); // Default hashing algorithm SHA256 // Select the file which will be signed signer.setDataFile("MyExe.exe"); // Select the path where the signed file will be saved signer.setOutputFile("SignedFile.scs"); // Specify the certificate that shall be used for signing signer.setSigningCertificate(new Certificate("cert.pfx","password")); signer.getNewSignature().setLevel(JAdESSignature.jaslBaselineT); // Set the level of the signature // Provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature signer.setTimestampServer("http://freetsa.org/tsr"); signer.sign(); // Sign ``` ### Standards and technologies supported JAdESSigner can create signatures that match the following standards: - Generic JSON Web Signatures (JWS) (RFC7515) - JAdES: all profiles are supported (BES, EPES, T, LTV, B-B, B-T, and others) (ETSI TS 119 182-1) - Timestamps using external TSAs. - All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others). ### Configuring the signature spec JWS and JAdES signatures can come in all sorts of flavours, with the primary factors being the signature format (how exactly the signed data is represented in bytes) and completeness (the extent of the trust information that is included in the signature). You can use the properties of your JAdESSigner object to configure these and other parameters. Typically, the service or software that you need to communicate with will provide you with a list of requirements that your JSON signature needs to satisfy. In some cases, they will also send you an example signature that you may use as a guide. Typically, you will need to adjust the following categories of settings: - Level (plain JWS, B, T, LT, or LTA). This can be adjusted with the property. - Timestamp requirement: provide the address of your online TSA service via [TimestampServer](#timestampserver-property-jadessigner-component) property. - When creating LT/LTA signatures, tune up validation parameters via [RevocationCheck](#revocationcheck-property-jadessigner-component), [OfflineMode](#offlinemode-property-jadessigner-component), and [IgnoreChainValidationErrors](#ignorechainvalidationerrors-property-jadessigner-component) properties. - Configure the signature representation parameters such as [CompactForm](#compactform-property-jadessigner-component), [Detached](#detached-property-jadessigner-component) or [FlattenedSignature](#flattenedsignature-property-jadessigner-component). The above are the most important settings from each category; you may need to adjust more specific settings, such as EPES policy parameters (such as ) or [ContentType](#contenttype-property-jadessigner-component), to fine-tune your signature. ### Signing certificates JAdESSigner can use certificates residing on different media. Besides generic certificates stored in PFX or PEM files (A1), it can operate with non-exportable certificates residing on hardware media (A3), system stores/keychains, or in the cloud. Non-exportable certificates can be accessed transparently via a Windows CSP or a PKCS#11 driver, if supplied by the certificate issuer. Proprietary or less interoperable media can be communicated with the *external signing* feature (see below). Use [CertificateManager](CertificateManager.md#CertificateManager) and [CertificateStorage](CertificateStorage.md#CertificateStorage) components to load the signing certificate. Assign the certificate to SigningCertificate property, and optionally provide the remainder of its chain via the SigningChain property. In the default configuration, JAdESSigner will do its best to collect the trust elements (certificates, CRLs, OCSP responses) required by the chosen signature level automatically. It will use all available sources, including the system stores, the chain validation cache, and the signature itself (when upgrading an existing signature). However, there can be situations where only some (or even none) of the trust elements are available in the public locations. This is particularly the case for internal, experimental, or test PKI environments. In such cases you might need to locate the missing elements manually and provide them to JAdESSigner via the KnownCertificates, KnownCRLs, and KnownOCSPs properties. You can also provide any trust anchors not included in the public Trusted Root directory via the TrustedCertificates collection. **Note**: If signing with a non-exportable key (such as residing on a hardware device or in the cloud), please make sure you keep the original CertificateStorage object open until the signing is completed. This is because the storage component provides a 'bridge' to the private key. If the storage is closed prematurely, this bridge is destroyed, and the private key can't be used. ### Signing the JSON Now that you have configured the signature and certificate settings, you can proceed to signing. You can provide the JSON input in one of the following forms: as a file (assign the path to [InputFile](#inputfile-property-jadessigner-component) property), as a stream (assign to InputStream property), as a string ([InputString](#inputstring-property-jadessigner-component)), or as a byte array (assign to [InputBytes](#inputbytes-property-jadessigner-component)). Similarly, the output can be collected in one of the same forms, either by passing the destination path or stream via [OutputFile](#outputfile-property-jadessigner-component) and OutputStream respectively, or by reading the resulting document bytes from the [OutputBytes](#outputbytes-property-jadessigner-component) or [OutputString](#outputstring-property-jadessigner-component) property after the signing. Having set up the input and output, call the component's [Sign](#sign-method-jadessigner-component) method. This will initiate the signing process. Depending on the settings, the signing may be as straightforward as calculating the document hash and signing it with the private key (e.g. when creating a B-level signature), or it may involve advanced chain validation routines (LT or LTA). During the latter the component contacts a number of external trust information sources (CA, CRL, and OCSP servers) to establish the validity of the signing certificate. If a TSA server was provided via the [TimestampServer](#timestampserver-property-jadessigner-component) property, the component will contact it too to timestamp the new signature. During the signing JAdESSigner may fire events to let your code know of certain conditions. It may fire [TLSCertValidate](#tlscertvalidate-event-jadessigner-component) if one of the HTTP endpoints involved during the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate chain to be validated. ### External signing and DCAuth JAdESSigner, like many other components included in the product, supports two methods of signing with external keys. These methods are fully independent of each other: you can choose the one that suits your scenario best. **Synchronous method: ExternalSign** This is a simpler method that basically lets you infiltrate into the signing routine by taking care of the hash signing operation. The component does the rest of the job (hash calculation, preparation of signature objects, CRL/OCSP retrieval). To initiate this method, call [SignExternal](#signexternal-method-jadessigner-component) instead of [Sign](#sign-method-jadessigner-component). When the hash is ready, it will be passed back to your code with [ExternalSign](#externalsign-event-jadessigner-component) event. Your event handler needs to sign the hash with the private key and return the created signature back to the component - which will embed it into the document. You don't need your signing certificate to contain an associated private key when using this method. The certificate itself (its public copy) may be needed though, as it is included in the hash calculation. This method is synchronous, meaning [SignExternal](#signexternal-method-jadessigner-component) provides you the results immediately upon its completion. **Asynchronous method: DCAuth** DCAuth is a SecureBlackbox know-how technology. This protocol was designed to allow sharing of private keys across environments, allowing the signer and the private key to reside on different systems. It works in the following way: - The signing party - such as JAdESSigner - initiates the operation using [SignAsyncBegin](#signasyncbegin-method-jadessigner-component) call. This produces two outcomes: a *pre-signed content* (a JSON body with a blank signature placeholder), and a *request state* (an object containing a hash that needs to be signed). At this point the JAdESSigner instance can be released, and the process itself terminated (which may be useful when run as part of a web page). - The *request state* is passed to the private key holder party. The private key holder passes the request state to a DCAuth object, which parses the request state, extracts the hash, and signs it. The output of DCAuth processing is another object, *response state*, which contains the signature. The private key holder then sends the *response state* back to the signing party. - The signing party re-creates the signing controls, and passes the *response state*, together with the pre-signed content, to the signer's [SignAsyncEnd](#signasyncend-method-jadessigner-component) method. [SignAsyncEnd](#signasyncend-method-jadessigner-component) extracts the signature from the *response state* and incorporates it into the pre-signed object, hereby completing the signature. This method is asynchronous in that sense that, from the signing party's viewpoint, it splits the signing operation into the *pre-signing* and *completion* stages which can be performed independently from each other and in different execution contexts. This makes this method particularly helpful for use in web pages and other scenarios where the signing key is not available in real time. ### Fine-grained chain validation setup Chain validation is a sophisticated, multi-faceted procedure that involves a lot of variables. Depending on the configuration of your operating environment, the specifics of the PKI framework being used, and the validation policy you need to follow, you may want to tune up your chain validation parameters so they fit them best. A summary of such parameters is given below. - [RevocationCheck](#revocationcheck-property-jadessigner-component) lets you choose between and/or prioritize revocation origins. OCSP sources are often preferred to CRL because of their real-time capability and the smaller size of validation tokens they produce. - [OfflineMode](#offlinemode-property-jadessigner-component) is a master switch that stops the struct from looking for any validation tokens online. If this property is switched on, the struct will only use the KnownCertificates, TrustedCertificates, KnownCRLs, and KnownOCSPs collections to look for the missing validation material. - [IgnoreChainValidationErrors](#ignorechainvalidationerrors-property-jadessigner-component) makes the struct ignore any major validation issues it encounters (such us an untrusted chain or missing CRL). This option is handy for debugging and for creating signatures in the environments where the signing certificate is not trusted. - KnownCertificates, KnownCRLs, and KnownOCSPs let you provide your own validation material. This may be useful when working in [OfflineMode](#offlinemode-property-jadessigner-component), where the signer has no access to the validation sources, or where the validation material has already been collected. - TrustedCertificates lets you provide a list of trust anchors, either as a complement to the system's or as an alternative to it. - BlockedCertificates lets you provide a list of blocked/distrusted certificates. Any CA certificate contained in it will be deemed untrusted/invalid. The following parameters are not directly related to chain validation, but may have an implicit effect on it. - Proxy, SocketSettings, and TLSSettings let you tune up the connectivity and TLS options in accordance with local preferences. - TLSClientChain lets you provide the client certificate and its chain for TLS client authentication. - Subscribe to [TLSCertValidate](#tlscertvalidate-event-jadessigner-component) to validate any TLS certificates of the services involved in chain validation. The results of the chain validation procedure, upon its completion, are published in the following properties: - ChainValidationResult contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined. - ChainValidationDetails provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate. - ValidationLog contains the detailed chain validation log. The log can often be very helpful in nailing down various validation issues. ## 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](#autovalidatesignatures-property-jadessigner-component) | Specifies whether class should validate any present signatures when the JSON opened. | | [BlockedCertCount](#blockedcertcount-property-jadessigner-component) | The number of records in the BlockedCert arrays. | | [BlockedCertBytes](#blockedcertbytes-property-jadessigner-component) | Returns the raw certificate data in DER format. | | [BlockedCertHandle](#blockedcerthandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [CertCount](#certcount-property-jadessigner-component) | The number of records in the Cert arrays. | | [CertBytes](#certbytes-property-jadessigner-component) | Returns the raw certificate data in DER format. | | [CertCA](#certca-property-jadessigner-component) | Indicates whether the certificate has a CA capability. | | [CertCAKeyID](#certcakeyid-property-jadessigner-component) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [CertType](#certtype-property-jadessigner-component) | Returns the type of the entity contained in the Certificate object. | | [CertCRLDistributionPoints](#certcrldistributionpoints-property-jadessigner-component) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [CertCurve](#certcurve-property-jadessigner-component) | Specifies the elliptic curve associated with the certificate's public key. | | [CertFingerprint](#certfingerprint-property-jadessigner-component) | Contains the fingerprint (a hash imprint) of this certificate. | | [CertFriendlyName](#certfriendlyname-property-jadessigner-component) | Contains an associated alias (friendly name) of the certificate. | | [CertHandle](#certhandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [CertHashAlgorithm](#certhashalgorithm-property-jadessigner-component) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [CertIssuer](#certissuer-property-jadessigner-component) | The common name of the certificate issuer (CA), typically a company name. | | [CertIssuerRDN](#certissuerrdn-property-jadessigner-component) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [CertKeyAlgorithm](#certkeyalgorithm-property-jadessigner-component) | Specifies the public key algorithm of this certificate. | | [CertKeyBits](#certkeybits-property-jadessigner-component) | Returns the length of the public key in bits. | | [CertKeyFingerprint](#certkeyfingerprint-property-jadessigner-component) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [CertKeyUsage](#certkeyusage-property-jadessigner-component) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [CertKeyValid](#certkeyvalid-property-jadessigner-component) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [CertOCSPLocations](#certocsplocations-property-jadessigner-component) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [CertOCSPNoCheck](#certocspnocheck-property-jadessigner-component) | Accessor to the value of the certificate's ocsp-no-check extension. | | [CertOrigin](#certorigin-property-jadessigner-component) | Returns the location that the certificate was taken or loaded from. | | [CertPolicyIDs](#certpolicyids-property-jadessigner-component) | Contains identifiers (OIDs) of the applicable certificate policies. | | [CertPrivateKeyBytes](#certprivatekeybytes-property-jadessigner-component) | Returns the certificate's private key in DER-encoded format. | | [CertPrivateKeyExists](#certprivatekeyexists-property-jadessigner-component) | Indicates whether the certificate has a usable private key associated with it. | | [CertPrivateKeyExtractable](#certprivatekeyextractable-property-jadessigner-component) | Indicates whether the private key is extractable (exportable). | | [CertPublicKeyBytes](#certpublickeybytes-property-jadessigner-component) | Contains the certificate's public key in DER format. | | [CertQualified](#certqualified-property-jadessigner-component) | Indicates whether the certificate is qualified. | | [CertQualifiedStatements](#certqualifiedstatements-property-jadessigner-component) | Returns a simplified qualified status of the certificate. | | [CertQualifiers](#certqualifiers-property-jadessigner-component) | A list of qualifiers. | | [CertSelfSigned](#certselfsigned-property-jadessigner-component) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [CertSerialNumber](#certserialnumber-property-jadessigner-component) | Returns the certificate's serial number. | | [CertSigAlgorithm](#certsigalgorithm-property-jadessigner-component) | Indicates the algorithm that was used by the CA to sign this certificate. | | [CertSource](#certsource-property-jadessigner-component) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [CertSubject](#certsubject-property-jadessigner-component) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [CertSubjectAlternativeName](#certsubjectalternativename-property-jadessigner-component) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [CertSubjectKeyID](#certsubjectkeyid-property-jadessigner-component) | Contains a unique identifier of the certificate's cryptographic key. | | [CertSubjectRDN](#certsubjectrdn-property-jadessigner-component) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [CertValid](#certvalid-property-jadessigner-component) | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. | | [CertValidFrom](#certvalidfrom-property-jadessigner-component) | The time point at which the certificate becomes valid, in UTC. | | [CertValidTo](#certvalidto-property-jadessigner-component) | The time point at which the certificate expires, in UTC. | | [CheckTrustedLists](#checktrustedlists-property-jadessigner-component) | Specifies whether the class should attempt to validate chain trust via a known Trusted List. | | [CompactForm](#compactform-property-jadessigner-component) | Specifies if the JWS compact serialization to be used. | | [ContentType](#contenttype-property-jadessigner-component) | Specifies payload content type. | | [CRLCount](#crlcount-property-jadessigner-component) | The number of records in the CRL arrays. | | [CRLBytes](#crlbytes-property-jadessigner-component) | Returns the raw CRL data in DER format. | | [CRLCAKeyID](#crlcakeyid-property-jadessigner-component) | A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. | | [CRLEntryCount](#crlentrycount-property-jadessigner-component) | Returns the number of certificate status entries in the CRL. | | [CRLHandle](#crlhandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [CRLIssuer](#crlissuer-property-jadessigner-component) | The common name of the CRL issuer (CA), typically a company name. | | [CRLIssuerRDN](#crlissuerrdn-property-jadessigner-component) | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. | | [CRLLocation](#crllocation-property-jadessigner-component) | The URL that the CRL was downloaded from. | | [CRLNextUpdate](#crlnextupdate-property-jadessigner-component) | The planned time and date of the next version of this CRL to be published. | | [CRLSigAlgorithm](#crlsigalgorithm-property-jadessigner-component) | The public key algorithm that was used by the CA to sign this CRL. | | [CRLSource](#crlsource-property-jadessigner-component) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [CRLTBS](#crltbs-property-jadessigner-component) | The to-be-signed part of the CRL (the CRL without the signature part). | | [CRLThisUpdate](#crlthisupdate-property-jadessigner-component) | The date and time at which this version of the CRL was published. | | [DataBytes](#databytes-property-jadessigner-component) | Use this property to pass a payload or an object data to class in the byte array form. | | [DataFile](#datafile-property-jadessigner-component) | A path to a file containing a payload or an object data. | | [DataString](#datastring-property-jadessigner-component) | Use this property to pass a payload or an object data to class in the string form. | | [Detached](#detached-property-jadessigner-component) | Specifies whether a detached signature should be produced or verified. | | [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-jadessigner-component) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [ExternalCryptoCustomParams](#externalcryptocustomparams-property-jadessigner-component) | Custom parameters to be passed to the signing service (uninterpreted). | | [ExternalCryptoData](#externalcryptodata-property-jadessigner-component) | Additional data to be included in the async state and mirrored back by the requestor. | | [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-jadessigner-component) | Specifies whether the message hash is to be calculated at the external endpoint. | | [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-jadessigner-component) | Specifies the request's signature hash algorithm. | | [ExternalCryptoKeyID](#externalcryptokeyid-property-jadessigner-component) | The ID of the pre-shared key used for DC request authentication. | | [ExternalCryptoKeySecret](#externalcryptokeysecret-property-jadessigner-component) | The pre-shared key used for DC request authentication. | | [ExternalCryptoMethod](#externalcryptomethod-property-jadessigner-component) | Specifies the asynchronous signing method. | | [ExternalCryptoMode](#externalcryptomode-property-jadessigner-component) | Specifies the external cryptography mode. | | [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-jadessigner-component) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [ExtractPayload](#extractpayload-property-jadessigner-component) | Specifies whether a payload should be extracted. | | [FIPSMode](#fipsmode-property-jadessigner-component) | Reserved. | | [FlattenedSignature](#flattenedsignature-property-jadessigner-component) | Specifies if the flattened signature to be used. | | [IgnoreChainValidationErrors](#ignorechainvalidationerrors-property-jadessigner-component) | Makes the class tolerant to chain validation errors. | | [InputBytes](#inputbytes-property-jadessigner-component) | Use this property to pass the input to class in byte array form. | | [InputFile](#inputfile-property-jadessigner-component) | The file to be signed. | | [InputString](#inputstring-property-jadessigner-component) | Use this property to pass the input to class in the string form. | | [KnownCertCount](#knowncertcount-property-jadessigner-component) | The number of records in the KnownCert arrays. | | [KnownCertBytes](#knowncertbytes-property-jadessigner-component) | Returns the raw certificate data in DER format. | | [KnownCertHandle](#knowncerthandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [KnownCRLCount](#knowncrlcount-property-jadessigner-component) | The number of records in the KnownCRL arrays. | | [KnownCRLBytes](#knowncrlbytes-property-jadessigner-component) | Returns the raw CRL data in DER format. | | [KnownCRLHandle](#knowncrlhandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [KnownOCSPCount](#knownocspcount-property-jadessigner-component) | The number of records in the KnownOCSP arrays. | | [KnownOCSPBytes](#knownocspbytes-property-jadessigner-component) | A buffer containing the raw OCSP response data. | | [KnownOCSPHandle](#knownocsphandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [NewSigChainValidationDetails](#newsigchainvalidationdetails-property-jadessigner-component) | The details of a certificate chain validation outcome. | | [NewSigChainValidationResult](#newsigchainvalidationresult-property-jadessigner-component) | The outcome of a certificate chain validation routine. | | [NewSigClaimedSigningTime](#newsigclaimedsigningtime-property-jadessigner-component) | The signing time from the signer's computer. | | [NewSigCompatibilityErrors](#newsigcompatibilityerrors-property-jadessigner-component) | Returns compatibility errors encountered during validation. | | [NewSigContainsLongTermInfo](#newsigcontainslongterminfo-property-jadessigner-component) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). | | [NewSigContentType](#newsigcontenttype-property-jadessigner-component) | Specifies payload content type. | | [NewSigCountersigned](#newsigcountersigned-property-jadessigner-component) | Indicates if the signature is countersigned. | | [NewSigEntityLabel](#newsigentitylabel-property-jadessigner-component) | Use this property to get the signature entity label. | | [NewSigHandle](#newsighandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [NewSigHashAlgorithm](#newsighashalgorithm-property-jadessigner-component) | Specifies the hash algorithm to be used. | | [NewSigIssuerRDN](#newsigissuerrdn-property-jadessigner-component) | The Relative Distinguished Name of the signing certificate's issuer. | | [NewSigJAdESVersion](#newsigjadesversion-property-jadessigner-component) | Specifies JAdES version. | | [NewSigLastArchivalTime](#newsiglastarchivaltime-property-jadessigner-component) | Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. | | [NewSigLevel](#newsiglevel-property-jadessigner-component) | Specifies the signature kind and level. | | [NewSigObjectType](#newsigobjecttype-property-jadessigner-component) | Specifies signature object content type. | | [NewSigParentEntity](#newsigparententity-property-jadessigner-component) | Use this property to get the parent signature label. | | [NewSigPolicyHash](#newsigpolicyhash-property-jadessigner-component) | The signature policy hash value. | | [NewSigPolicyHashAlgorithm](#newsigpolicyhashalgorithm-property-jadessigner-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. | | [NewSigPolicyID](#newsigpolicyid-property-jadessigner-component) | The policy ID that was included or to be included into the signature. | | [NewSigPolicyURI](#newsigpolicyuri-property-jadessigner-component) | The signature policy URI that was included in the signature. | | [NewSigSerialNumber](#newsigserialnumber-property-jadessigner-component) | The serial number of the signing certificate. | | [NewSigSignatureBytes](#newsigsignaturebytes-property-jadessigner-component) | Returns the binary representation of the JSON/JAdES signature. | | [NewSigSignatureValidationResult](#newsigsignaturevalidationresult-property-jadessigner-component) | The outcome of the cryptographic signature validation. | | [NewSigSignedData](#newsigsigneddata-property-jadessigner-component) | The sigD header parameter in JSON format that was included or to be included into the signature. | | [NewSigSignedDataType](#newsigsigneddatatype-property-jadessigner-component) | Specifies the type of signed data. | | [NewSigSubjectKeyID](#newsigsubjectkeyid-property-jadessigner-component) | Contains the subject key identifier of the signing certificate. | | [NewSigSubjectRDN](#newsigsubjectrdn-property-jadessigner-component) | Contains information about the person owning the signing certificate. | | [NewSigTimestamped](#newsigtimestamped-property-jadessigner-component) | Use this property to establish whether the signature contains an embedded timestamp. | | [NewSigValidatedSigningTime](#newsigvalidatedsigningtime-property-jadessigner-component) | Contains the certified signing time. | | [NewSigValidationLog](#newsigvalidationlog-property-jadessigner-component) | Contains the complete log of the certificate validation routine. | | [OCSPCount](#ocspcount-property-jadessigner-component) | The number of records in the OCSP arrays. | | [OCSPBytes](#ocspbytes-property-jadessigner-component) | A buffer containing the raw OCSP response data. | | [OCSPEntryCount](#ocspentrycount-property-jadessigner-component) | The number of SingleResponse elements contained in this OCSP response. | | [OCSPHandle](#ocsphandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [OCSPIssuer](#ocspissuer-property-jadessigner-component) | Indicates the issuer of this response (a CA or its authorized representative). | | [OCSPIssuerRDN](#ocspissuerrdn-property-jadessigner-component) | Indicates the RDN of the issuer of this response (a CA or its authorized representative). | | [OCSPLocation](#ocsplocation-property-jadessigner-component) | The location of the OCSP responder. | | [OCSPProducedAt](#ocspproducedat-property-jadessigner-component) | Specifies the time when the response was produced, in UTC. | | [OCSPSigAlgorithm](#ocspsigalgorithm-property-jadessigner-component) | The public key algorithm that was used by the CA to sign this OCSP response. | | [OCSPSource](#ocspsource-property-jadessigner-component) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [OfflineMode](#offlinemode-property-jadessigner-component) | Switches the class to offline mode. | | [OutputBytes](#outputbytes-property-jadessigner-component) | Use this property to read the output the class object has produced. | | [OutputFile](#outputfile-property-jadessigner-component) | Defines where to save the signature. | | [OutputString](#outputstring-property-jadessigner-component) | Use this property to read the output the class object has produced. | | [Profile](#profile-property-jadessigner-component) | Specifies a pre-defined profile to apply when creating the signature. | | [ProxyAddress](#proxyaddress-property-jadessigner-component) | The IP address of the proxy server. | | [ProxyAuthentication](#proxyauthentication-property-jadessigner-component) | The authentication type used by the proxy server. | | [ProxyPassword](#proxypassword-property-jadessigner-component) | The password to authenticate to the proxy server. | | [ProxyPort](#proxyport-property-jadessigner-component) | The port on the proxy server to connect to. | | [ProxyType](#proxytype-property-jadessigner-component) | The type of the proxy server. | | [ProxyRequestHeaders](#proxyrequestheaders-property-jadessigner-component) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [ProxyResponseBody](#proxyresponsebody-property-jadessigner-component) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [ProxyResponseHeaders](#proxyresponseheaders-property-jadessigner-component) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [ProxyUseIPv6](#proxyuseipv6-property-jadessigner-component) | Specifies whether IPv6 should be used when connecting through the proxy. | | [ProxyUsername](#proxyusername-property-jadessigner-component) | Specifies the username credential for proxy authentication. | | [RevocationCheck](#revocationcheck-property-jadessigner-component) | Specifies the kind(s) of revocation check to perform for all chain certificates. | | [SignatureCount](#signaturecount-property-jadessigner-component) | The number of records in the Signature arrays. | | [SignatureChainValidationDetails](#signaturechainvalidationdetails-property-jadessigner-component) | The details of a certificate chain validation outcome. | | [SignatureChainValidationResult](#signaturechainvalidationresult-property-jadessigner-component) | The outcome of a certificate chain validation routine. | | [SignatureClaimedSigningTime](#signatureclaimedsigningtime-property-jadessigner-component) | The signing time from the signer's computer. | | [SignatureCompatibilityErrors](#signaturecompatibilityerrors-property-jadessigner-component) | Returns compatibility errors encountered during validation. | | [SignatureContainsLongTermInfo](#signaturecontainslongterminfo-property-jadessigner-component) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). | | [SignatureContentType](#signaturecontenttype-property-jadessigner-component) | Specifies payload content type. | | [SignatureCountersigned](#signaturecountersigned-property-jadessigner-component) | Indicates if the signature is countersigned. | | [SignatureEntityLabel](#signatureentitylabel-property-jadessigner-component) | Use this property to get the signature entity label. | | [SignatureHandle](#signaturehandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SignatureHashAlgorithm](#signaturehashalgorithm-property-jadessigner-component) | Specifies the hash algorithm to be used. | | [SignatureIssuerRDN](#signatureissuerrdn-property-jadessigner-component) | The Relative Distinguished Name of the signing certificate's issuer. | | [SignatureJAdESVersion](#signaturejadesversion-property-jadessigner-component) | Specifies JAdES version. | | [SignatureLastArchivalTime](#signaturelastarchivaltime-property-jadessigner-component) | Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. | | [SignatureLevel](#signaturelevel-property-jadessigner-component) | Specifies the signature kind and level. | | [SignatureObjectType](#signatureobjecttype-property-jadessigner-component) | Specifies signature object content type. | | [SignatureParentEntity](#signatureparententity-property-jadessigner-component) | Use this property to get the parent signature label. | | [SignaturePolicyHash](#signaturepolicyhash-property-jadessigner-component) | The signature policy hash value. | | [SignaturePolicyHashAlgorithm](#signaturepolicyhashalgorithm-property-jadessigner-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. | | [SignaturePolicyID](#signaturepolicyid-property-jadessigner-component) | The policy ID that was included or to be included into the signature. | | [SignaturePolicyURI](#signaturepolicyuri-property-jadessigner-component) | The signature policy URI that was included in the signature. | | [SignatureSerialNumber](#signatureserialnumber-property-jadessigner-component) | The serial number of the signing certificate. | | [SignatureBytes](#signaturebytes-property-jadessigner-component) | Returns the binary representation of the JSON/JAdES signature. | | [SignatureValidationResult](#signaturevalidationresult-property-jadessigner-component) | The outcome of the cryptographic signature validation. | | [SignatureSignedData](#signaturesigneddata-property-jadessigner-component) | The sigD header parameter in JSON format that was included or to be included into the signature. | | [SignatureSignedDataType](#signaturesigneddatatype-property-jadessigner-component) | Specifies the type of signed data. | | [SignatureSubjectKeyID](#signaturesubjectkeyid-property-jadessigner-component) | Contains the subject key identifier of the signing certificate. | | [SignatureSubjectRDN](#signaturesubjectrdn-property-jadessigner-component) | Contains information about the person owning the signing certificate. | | [SignatureTimestamped](#signaturetimestamped-property-jadessigner-component) | Use this property to establish whether the signature contains an embedded timestamp. | | [SignatureValidatedSigningTime](#signaturevalidatedsigningtime-property-jadessigner-component) | Contains the certified signing time. | | [SignatureValidationLog](#signaturevalidationlog-property-jadessigner-component) | Contains the complete log of the certificate validation routine. | | [SigningCertBytes](#signingcertbytes-property-jadessigner-component) | Returns the raw certificate data in DER format. | | [SigningCertHandle](#signingcerthandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SigningChainCount](#signingchaincount-property-jadessigner-component) | The number of records in the SigningChain arrays. | | [SigningChainBytes](#signingchainbytes-property-jadessigner-component) | Returns the raw certificate data in DER format. | | [SigningChainHandle](#signingchainhandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SocketDNSMode](#socketdnsmode-property-jadessigner-component) | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. | | [SocketDNSPort](#socketdnsport-property-jadessigner-component) | Specifies the port number to be used for sending queries to the DNS server. | | [SocketDNSQueryTimeout](#socketdnsquerytimeout-property-jadessigner-component) | The timeout (in milliseconds) for each DNS query. | | [SocketDNSServers](#socketdnsservers-property-jadessigner-component) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [SocketDNSTotalTimeout](#socketdnstotaltimeout-property-jadessigner-component) | The timeout (in milliseconds) for the whole resolution process. | | [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-jadessigner-component) | The maximum number of bytes to read from the socket, per second. | | [SocketLocalAddress](#socketlocaladdress-property-jadessigner-component) | The local network interface to bind the socket to. | | [SocketLocalPort](#socketlocalport-property-jadessigner-component) | The local port number to bind the socket to. | | [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-jadessigner-component) | The maximum number of bytes to write to the socket, per second. | | [SocketTimeout](#sockettimeout-property-jadessigner-component) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [SocketUseIPv6](#socketuseipv6-property-jadessigner-component) | Enables or disables IP protocol version 6. | | [TimestampCount](#timestampcount-property-jadessigner-component) | The number of records in the Timestamp arrays. | | [TimestampAccuracy](#timestampaccuracy-property-jadessigner-component) | This property indicates the accuracy of the included time mark, in microseconds. | | [TimestampBytes](#timestampbytes-property-jadessigner-component) | Returns the raw timestamp data in DER format. | | [TimestampCertificateIndex](#timestampcertificateindex-property-jadessigner-component) | Returns the index of the TSA certificate in the Certificates collection. | | [TimestampChainValidationDetails](#timestampchainvalidationdetails-property-jadessigner-component) | The details of a certificate chain validation outcome. | | [TimestampChainValidationResult](#timestampchainvalidationresult-property-jadessigner-component) | The outcome of a certificate chain validation routine. | | [TimestampContainsLongTermInfo](#timestampcontainslongterminfo-property-jadessigner-component) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). | | [TimestampEntityLabel](#timestampentitylabel-property-jadessigner-component) | Use this property to get the timestamp entity label. | | [TimestampHashAlgorithm](#timestamphashalgorithm-property-jadessigner-component) | Returns the timestamp's hash algorithm. | | [TimestampParentEntity](#timestampparententity-property-jadessigner-component) | Use this property to get the label of the timestamp's parent entity. | | [TimestampSerialNumber](#timestampserialnumber-property-jadessigner-component) | Returns the timestamp's serial number. | | [TimestampTime](#timestamptime-property-jadessigner-component) | The time point incorporated into the timestamp. | | [TimestampType](#timestamptype-property-jadessigner-component) | Returns the type of the timestamp. | | [TimestampTSAName](#timestamptsaname-property-jadessigner-component) | This value uniquely identifies the Timestamp Authority (TSA). | | [TimestampValidationLog](#timestampvalidationlog-property-jadessigner-component) | Contains the TSA certificate chain validation log. | | [TimestampValidationResult](#timestampvalidationresult-property-jadessigner-component) | Contains the timestamp validation outcome. | | [TimestampServer](#timestampserver-property-jadessigner-component) | The address of the timestamping server. | | [TLSClientCertCount](#tlsclientcertcount-property-jadessigner-component) | The number of records in the TLSClientCert arrays. | | [TLSClientCertBytes](#tlsclientcertbytes-property-jadessigner-component) | Returns the raw certificate data in DER format. | | [TLSClientCertHandle](#tlsclientcerthandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TLSServerCertCount](#tlsservercertcount-property-jadessigner-component) | The number of records in the TLSServerCert arrays. | | [TLSServerCertBytes](#tlsservercertbytes-property-jadessigner-component) | Returns the raw certificate data in DER format. | | [TLSServerCertFingerprint](#tlsservercertfingerprint-property-jadessigner-component) | Contains the fingerprint (a hash imprint) of this certificate. | | [TLSServerCertHandle](#tlsservercerthandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TLSServerCertIssuer](#tlsservercertissuer-property-jadessigner-component) | The common name of the certificate issuer (CA), typically a company name. | | [TLSServerCertIssuerRDN](#tlsservercertissuerrdn-property-jadessigner-component) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [TLSServerCertKeyAlgorithm](#tlsservercertkeyalgorithm-property-jadessigner-component) | Specifies the public key algorithm of this certificate. | | [TLSServerCertKeyBits](#tlsservercertkeybits-property-jadessigner-component) | Returns the length of the public key in bits. | | [TLSServerCertKeyUsage](#tlsservercertkeyusage-property-jadessigner-component) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [TLSServerCertSelfSigned](#tlsservercertselfsigned-property-jadessigner-component) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [TLSServerCertSerialNumber](#tlsservercertserialnumber-property-jadessigner-component) | Returns the certificate's serial number. | | [TLSServerCertSigAlgorithm](#tlsservercertsigalgorithm-property-jadessigner-component) | Indicates the algorithm that was used by the CA to sign this certificate. | | [TLSServerCertSubject](#tlsservercertsubject-property-jadessigner-component) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [TLSServerCertSubjectRDN](#tlsservercertsubjectrdn-property-jadessigner-component) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [TLSServerCertValidFrom](#tlsservercertvalidfrom-property-jadessigner-component) | The time point at which the certificate becomes valid, in UTC. | | [TLSServerCertValidTo](#tlsservercertvalidto-property-jadessigner-component) | The time point at which the certificate expires, in UTC. | | [TLSAutoValidateCertificates](#tlsautovalidatecertificates-property-jadessigner-component) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [TLSBaseConfiguration](#tlsbaseconfiguration-property-jadessigner-component) | Selects the base configuration for the TLS settings. | | [TLSCiphersuites](#tlsciphersuites-property-jadessigner-component) | A list of ciphersuites separated with commas or semicolons. | | [TLSClientAuth](#tlsclientauth-property-jadessigner-component) | Enables or disables certificate-based client authentication. | | [TLSExtensions](#tlsextensions-property-jadessigner-component) | Provides access to TLS extensions. | | [TLSForceResumeIfDestinationChanges](#tlsforceresumeifdestinationchanges-property-jadessigner-component) | Whether to force TLS session resumption when the destination address changes. | | [TLSGroups](#tlsgroups-property-jadessigner-component) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [TLSPreSharedIdentity](#tlspresharedidentity-property-jadessigner-component) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [TLSPreSharedKey](#tlspresharedkey-property-jadessigner-component) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [TLSPreSharedKeyCiphersuite](#tlspresharedkeyciphersuite-property-jadessigner-component) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [TLSRenegotiationAttackPreventionMode](#tlsrenegotiationattackpreventionmode-property-jadessigner-component) | Selects the renegotiation attack prevention mechanism. | | [TLSRevocationCheck](#tlsrevocationcheck-property-jadessigner-component) | Specifies the kind(s) of revocation check to perform. | | [TLSSSLOptions](#tlsssloptions-property-jadessigner-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. | | [TLSMode](#tlsmode-property-jadessigner-component) | Specifies the TLS mode to use. | | [TLSUseExtendedMasterSecret](#tlsuseextendedmastersecret-property-jadessigner-component) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [TLSUseSessionResumption](#tlsusesessionresumption-property-jadessigner-component) | Enables or disables the TLS session resumption capability. | | [TLSVersions](#tlsversions-property-jadessigner-component) | The SSL/TLS versions to enable by default. | | [TrustedCertCount](#trustedcertcount-property-jadessigner-component) | The number of records in the TrustedCert arrays. | | [TrustedCertBytes](#trustedcertbytes-property-jadessigner-component) | Returns the raw certificate data in DER format. | | [TrustedCertHandle](#trustedcerthandle-property-jadessigner-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [ValidationMoment](#validationmoment-property-jadessigner-component) | The time point at which signature validity is to be established. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddSignedHTTPHeaderField](#addsignedhttpheaderfield-method-jadessigner-component) | Use this method to add HTTP header field. | | [AddSignedObject](#addsignedobject-method-jadessigner-component) | Use this method to add an object. | | [AddSignedObjectHash](#addsignedobjecthash-method-jadessigner-component) | Use this method to add an object hash. | | [Close](#close-method-jadessigner-component) | Closes an opened JWS/JAdES signature. | | [Config](#config-method-jadessigner-component) | Sets or retrieves a configuration setting. | | [CreateNew](#createnew-method-jadessigner-component) | Create a new JSON for signing. | | [DoAction](#doaction-method-jadessigner-component) | Performs an additional action. | | [ExtractAsyncData](#extractasyncdata-method-jadessigner-component) | Extracts user data from the DC signing service response. | | [Open](#open-method-jadessigner-component) | Opens a JSON for signing or updating. | | [Reset](#reset-method-jadessigner-component) | Resets the class settings. | | [Revalidate](#revalidate-method-jadessigner-component) | Revalidates a signature in accordance with current settings. | | [SelectInfo](#selectinfo-method-jadessigner-component) | Select signature information for a specific entity. | | [Sign](#sign-method-jadessigner-component) | Creates a new JAdES/JWS signature over the provided data. | | [SignAsyncBegin](#signasyncbegin-method-jadessigner-component) | Initiates the asynchronous signing operation. | | [SignAsyncEnd](#signasyncend-method-jadessigner-component) | Completes the asynchronous signing operation. | | [SignExternal](#signexternal-method-jadessigner-component) | Signs the data using an external signing facility. | | [Timestamp](#timestamp-method-jadessigner-component) | Use this method to add timestamp. | | [Upgrade](#upgrade-method-jadessigner-component) | Upgrades existing JAdES 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](#chainelementdownload-event-jadessigner-component) | Fires when there is a need to download a chain element from an online source. | | [ChainElementNeeded](#chainelementneeded-event-jadessigner-component) | Fires when an element required to validate the chain was not located. | | [ChainElementStore](#chainelementstore-event-jadessigner-component) | This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. | | [ChainValidated](#chainvalidated-event-jadessigner-component) | Reports the completion of a certificate chain validation. | | [ChainValidationProgress](#chainvalidationprogress-event-jadessigner-component) | This event is fired multiple times during chain validation to report various stages of the validation procedure. | | [Error](#error-event-jadessigner-component) | Information about errors during signing. | | [ExternalSign](#externalsign-event-jadessigner-component) | Handles remote or external signing initiated by the SignExternal method or other source. | | [HTTPHeaderFieldNeeded](#httpheaderfieldneeded-event-jadessigner-component) | This event is fired when HTTP header field value is required. | | [Loaded](#loaded-event-jadessigner-component) | This event is fired when the JSON has been loaded into memory. | | [Notification](#notification-event-jadessigner-component) | This event notifies the application about an underlying control flow event. | | [ObjectNeeded](#objectneeded-event-jadessigner-component) | This event is fired when object is required. | | [ObjectValidate](#objectvalidate-event-jadessigner-component) | This event is fired when object should be verified by user. | | [SignatureFound](#signaturefound-event-jadessigner-component) | Signifies the start of signature validation. | | [SignatureValidated](#signaturevalidated-event-jadessigner-component) | Marks the completion of the signature validation routine. | | [TimestampFound](#timestampfound-event-jadessigner-component) | Signifies the start of a timestamp validation routine. | | [TimestampRequest](#timestamprequest-event-jadessigner-component) | Fires when the class is ready to request a timestamp from an external TSA. | | [TimestampValidated](#timestampvalidated-event-jadessigner-component) | Reports the completion of the timestamp validation routine. | | [TLSCertNeeded](#tlscertneeded-event-jadessigner-component) | Fires when a remote TLS party requests a client certificate. | | [TLSCertValidate](#tlscertvalidate-event-jadessigner-component) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. | | [TLSEstablished](#tlsestablished-event-jadessigner-component) | Fires when a TLS handshake with Host successfully completes. | | [TLSHandshake](#tlshandshake-event-jadessigner-component) | Fires when a new TLS handshake is initiated, before the handshake commences. | | [TLSShutdown](#tlsshutdown-event-jadessigner-component) | Reports the graceful closure of a TLS connection. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddSignedDataTimestamp](#AddSignedDataTimestamp) | Whether to add signed data timestamp during signing. | | [AsyncDocumentID](#AsyncDocumentID) | Specifies the document ID for SignAsyncEnd() call. | | [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. | | [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. | | [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. | | [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. | | [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. | | [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. | | [CertThumbprint](#CertThumbprint) | Specifies the certificate thumbprint. | | [CertURL](#CertURL) | Specifies the certificate URL. | | [ChainCurrentCACert](#ChainCurrentCACert) | Returns the current CA certificate. | | [ChainCurrentCert](#ChainCurrentCert) | Returns the certificate that is currently being validated. | | [ChainCurrentCRL](#ChainCurrentCRL) | Returns the current CRL. | | [ChainCurrentCRLSize](#ChainCurrentCRLSize) | Returns the size of the current CRL. | | [ChainCurrentOCSP](#ChainCurrentOCSP) | Returns the current OCSP response. | | [ChainCurrentOCSPSigner](#ChainCurrentOCSPSigner) | Returns the signer of the current OCSP object. | | [ChainInterimDetails](#ChainInterimDetails) | Returns the current interim validation details. | | [ChainInterimResult](#ChainInterimResult) | Returns the current interim validation result. | | [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. | | [CustomTrustedLists](#CustomTrustedLists) | Specifies the custom TrustedLists. | | [CustomTSLs](#CustomTSLs) | Specifies the custom TrustedLists. | | [DataBase64](#DataBase64) | Specifies whether data is Base64-URL-encoded. | | [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. | | [DislikeOpenEndedOCSPs](#DislikeOpenEndedOCSPs) | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. | | [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. | | [EvaluateSystemTrustForSelfSignedCertificates](#EvaluateSystemTrustForSelfSignedCertificates) | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. | | [EvaluateSystemTrustForSSL](#EvaluateSystemTrustForSSL) | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. | | [ForceCompleteChainValidation](#ForceCompleteChainValidation) | Whether to check the CA certificates when the signing certificate is invalid. | | [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. | | [GracePeriod](#GracePeriod) | Specifies a grace period to apply during revocation information checks. | | [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. | | [IgnoreChainValidationErrors](#IgnoreChainValidationErrors) | Whether to ignore any certificate chain validation issues. | | [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. | | [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. | | [IgnoreTimestampFailure](#IgnoreTimestampFailure) | Whether to ignore time-stamping failure during signing. | | [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. | | [IncludeKnownRevocationInfoToSignature](#IncludeKnownRevocationInfoToSignature) | Whether to include custom revocation info to the signature. | | [JAdESOptions](#JAdESOptions) | Specifies the JAdES options. | | [KeyId](#KeyId) | Specifies Key ID. | | [PolicyDescription](#PolicyDescription) | signature policy description. | | [PolicyExplicitText](#PolicyExplicitText) | The explicit text of the user notice. | | [PolicyUNNumbers](#PolicyUNNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. | | [PolicyUNOrganization](#PolicyUNOrganization) | The organization part of the NoticeReference qualifier. | | [ProductionPlace](#ProductionPlace) | Identifies the place of the signature production. | | [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. | | [ProtectedHeader](#ProtectedHeader) | Specifies the protected header. | | [PSSUsed](#PSSUsed) | Whether to use RSASSA-PSS algorithm. | | [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. | | [SchemeParams](#SchemeParams) | The algorithm scheme parameters to employ. | | [SignerAttrs](#SignerAttrs) | Identifies the signer attributes. | | [SignerCommitments](#SignerCommitments) | Identifies the signer commitments. | | [SigningCertIncludeIssuerSerial](#SigningCertIncludeIssuerSerial) | Specifies whether to include signing certificate issuer and serial number. | | [SigningCertIncludeThumbprint](#SigningCertIncludeThumbprint) | Specifies whether to include signing certificate thumbprint. | | [SigningCertIncludeValue](#SigningCertIncludeValue) | Specifies whether to include signing certificate value. | | [SigningChainIncludeThumbprints](#SigningChainIncludeThumbprints) | Specifies whether to include signing chain thumbprints. | | [SigningChainIncludeValue](#SigningChainIncludeValue) | Specifies whether to include signing chain values. | | [SigPolicyDescription](#SigPolicyDescription) | signature policy description. | | [SigPolicyExplicitText](#SigPolicyExplicitText) | The explicit text of the user notice. | | [SigPolicyHash](#SigPolicyHash) | The EPES policy hash. | | [SigPolicyHashAlgorithm](#SigPolicyHashAlgorithm) | The hash algorithm that was used to generate the EPES policy hash. | | [SigPolicyID](#SigPolicyID) | The EPES policy ID. | | [SigPolicyNoticeNumbers](#SigPolicyNoticeNumbers) | The noticeNumbers part of the NoticeReference CAdES attribute. | | [SigPolicyNoticeOrganization](#SigPolicyNoticeOrganization) | The organization part of the NoticeReference qualifier. | | [SigPolicyURI](#SigPolicyURI) | The EPES policy URI. | | [TempPath](#TempPath) | Path for storing temporary files. | | [ThumbprintHashAlgorithm](#ThumbprintHashAlgorithm) | Specifies the thumbprint hash algorithm. | | [TimestampResponse](#TimestampResponse) | A base16-encoded timestamp response received from a TSA. | | [TimestampValidationDataDetails](#TimestampValidationDataDetails) | Specifies timestamp validation data details to include to the signature. | | [TLSChainValidationDetails](#TLSChainValidationDetails) | Contains the advanced details of the TLS server certificate validation. | | [TLSChainValidationResult](#TLSChainValidationResult) | Contains the result of the TLS server certificate validation. | | [TLSClientAuthRequested](#TLSClientAuthRequested) | Indicates whether the TLS server requests client authentication. | | [TLSValidationLog](#TLSValidationLog) | Contains the log of the TLS server certificate validation. | | [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. | | [TspAttemptCount](#TspAttemptCount) | Specifies the number of timestamping request attempts. | | [TspHashAlgorithm](#TspHashAlgorithm) | Sets a specific hash algorithm for use with the timestamping service. | | [TspReqPolicy](#TspReqPolicy) | Sets a request policy ID to include in the timestamping request. | | [UnprotectedHeader](#UnprotectedHeader) | Specifies the unprotected header. | | [UseDefaultTrustedLists](#UseDefaultTrustedLists) | Enables or disables the use of the default TrustedLists. | | [UseDefaultTSLs](#UseDefaultTSLs) | Enables or disables the use of the default TrustedLists. | | [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. | | [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. | | [UsePSS](#UsePSS) | Whether to use RSASSA-PSS algorithm. | | [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. | | [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. | | [UseValidatorSettingsForTLSValidation](#UseValidatorSettingsForTLSValidation) | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. | | [ValidationDataRefsDetails](#ValidationDataRefsDetails) | Specifies validation data references details to include to the signature. | | [ValidationDataRefsHashAlgorithm](#ValidationDataRefsHashAlgorithm) | Specifies the hash algorithm used in validation data references. | | [ValidationDataValuesDetails](#ValidationDataValuesDetails) | Specifies validation data values details to include to the signature. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # AutoValidateSignatures Property ([JAdESSigner](#jadessigner-component) Component) Specifies whether class should validate any present signatures when the JSON opened. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) AutoValidateSignatures() (bool, error)func (obj *JAdESSigner) SetAutoValidateSignatures(value bool) error ``` ## Default Value false ## Remarks This setting is switched off by default to speed up JSON processing. Even if the JWS/JAdES signature is loaded with this property set to false, you can validate the signatures manually on a later stage using the [Revalidate](#revalidate-method-jadessigner-component) method. ## Data Type **bool** # BlockedCertCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the BlockedCert arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) BlockedCertCount() (int32, error)func (obj *JAdESSigner) SetBlockedCertCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [BlockedCertBytes](#blockedcertbytes-property-jadessigner-component) - [BlockedCertHandle](#blockedcerthandle-property-jadessigner-component) The array indices start at *0* and end at *BlockedCertCount - 1*. ## Data Type **int32** # BlockedCertBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw certificate data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#blockedcertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # BlockedCertHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) BlockedCertHandle(BlockedCertIndex int32) (int64, error)func (obj *JAdESSigner) SetBlockedCertHandle(BlockedCertIndex int32, value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text 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](#blockedcertcount-property-jadessigner-component) property. ## Data Type **int64** # CertCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the Cert arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CertCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [CertBytes](#certbytes-property-jadessigner-component) - [CertCA](#certca-property-jadessigner-component) - [CertCAKeyID](#certcakeyid-property-jadessigner-component) - [CertCRLDistributionPoints](#certcrldistributionpoints-property-jadessigner-component) - [CertCurve](#certcurve-property-jadessigner-component) - [CertFingerprint](#certfingerprint-property-jadessigner-component) - [CertFriendlyName](#certfriendlyname-property-jadessigner-component) - [CertHandle](#certhandle-property-jadessigner-component) - [CertHashAlgorithm](#certhashalgorithm-property-jadessigner-component) - [CertIssuer](#certissuer-property-jadessigner-component) - [CertIssuerRDN](#certissuerrdn-property-jadessigner-component) - [CertKeyAlgorithm](#certkeyalgorithm-property-jadessigner-component) - [CertKeyBits](#certkeybits-property-jadessigner-component) - [CertKeyFingerprint](#certkeyfingerprint-property-jadessigner-component) - [CertKeyUsage](#certkeyusage-property-jadessigner-component) - [CertKeyValid](#certkeyvalid-property-jadessigner-component) - [CertOCSPLocations](#certocsplocations-property-jadessigner-component) - [CertOCSPNoCheck](#certocspnocheck-property-jadessigner-component) - [CertOrigin](#certorigin-property-jadessigner-component) - [CertPolicyIDs](#certpolicyids-property-jadessigner-component) - [CertPrivateKeyBytes](#certprivatekeybytes-property-jadessigner-component) - [CertPrivateKeyExists](#certprivatekeyexists-property-jadessigner-component) - [CertPrivateKeyExtractable](#certprivatekeyextractable-property-jadessigner-component) - [CertPublicKeyBytes](#certpublickeybytes-property-jadessigner-component) - [CertQualified](#certqualified-property-jadessigner-component) - [CertQualifiedStatements](#certqualifiedstatements-property-jadessigner-component) - [CertQualifiers](#certqualifiers-property-jadessigner-component) - [CertSelfSigned](#certselfsigned-property-jadessigner-component) - [CertSerialNumber](#certserialnumber-property-jadessigner-component) - [CertSigAlgorithm](#certsigalgorithm-property-jadessigner-component) - [CertSource](#certsource-property-jadessigner-component) - [CertSubject](#certsubject-property-jadessigner-component) - [CertSubjectAlternativeName](#certsubjectalternativename-property-jadessigner-component) - [CertSubjectKeyID](#certsubjectkeyid-property-jadessigner-component) - [CertSubjectRDN](#certsubjectrdn-property-jadessigner-component) - [CertType](#certtype-property-jadessigner-component) - [CertValid](#certvalid-property-jadessigner-component) - [CertValidFrom](#certvalidfrom-property-jadessigner-component) - [CertValidTo](#certvalidto-property-jadessigner-component) The array indices start at *0* and end at *CertCount - 1*. This property is read-only. ## Data Type **int32** # CertBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw certificate data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CertCA Property ([JAdESSigner](#jadessigner-component) Component) Indicates whether the certificate has a CA capability. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # CertCAKeyID Property ([JAdESSigner](#jadessigner-component) Component) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [CertSubjectKeyID](#certsubjectkeyid-property-jadessigner-component) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CertType Property ([JAdESSigner](#jadessigner-component) Component) Returns the type of the entity contained in the Certificate object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CertType(CertIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Unknown1 // X509Certificate2 // X509CertificateRequest ``` ## Default Value 0 ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](#CertificateManager) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # CertCRLDistributionPoints Property ([JAdESSigner](#jadessigner-component) Component) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertCurve Property ([JAdESSigner](#jadessigner-component) Component) Specifies the elliptic curve associated with the certificate's public key. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertFingerprint Property ([JAdESSigner](#jadessigner-component) Component) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertFriendlyName Property ([JAdESSigner](#jadessigner-component) Component) Contains an associated alias (friendly name) of the certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CertHandle(CertIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int64** # CertHashAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certsigalgorithm-property-jadessigner-component) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertIssuer Property ([JAdESSigner](#jadessigner-component) Component) The common name of the certificate issuer (CA), typically a company name. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certissuerrdn-property-jadessigner-component). The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertIssuerRDN Property ([JAdESSigner](#jadessigner-component) Component) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertKeyAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) Specifies the public key algorithm of this certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certkeybits-property-jadessigner-component), [CertCurve](#certcurve-property-jadessigner-component), and [CertPublicKeyBytes](#certpublickeybytes-property-jadessigner-component) properties to get more details about the key the certificate contains. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertKeyBits Property ([JAdESSigner](#jadessigner-component) Component) Returns the length of the public key in bits. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CertKeyBits(CertIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [CertPublicKeyBytes](#certpublickeybytes-property-jadessigner-component) or [CertPrivateKeyBytes](#certprivatekeybytes-property-jadessigner-component) property would typically contain auxiliary values, and therefore be longer. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # CertKeyFingerprint Property ([JAdESSigner](#jadessigner-component) Component) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certfingerprint-property-jadessigner-component) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertKeyUsage Property ([JAdESSigner](#jadessigner-component) Component) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CertKeyUsage(CertIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # CertKeyValid Property ([JAdESSigner](#jadessigner-component) Component) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # CertOCSPLocations Property ([JAdESSigner](#jadessigner-component) Component) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertOCSPNoCheck Property ([JAdESSigner](#jadessigner-component) Component) Accessor to the value of the certificate's ocsp-no-check extension. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # CertOrigin Property ([JAdESSigner](#jadessigner-component) Component) Returns the location that the certificate was taken or loaded from. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CertOrigin(CertIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks Returns the location that the certificate was taken or loaded from. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # CertPolicyIDs Property ([JAdESSigner](#jadessigner-component) Component) Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertPrivateKeyBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the certificate's private key in DER-encoded format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CertPrivateKeyExists Property ([JAdESSigner](#jadessigner-component) Component) Indicates whether the certificate has a usable private key associated with it. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certprivatekeybytes-property-jadessigner-component), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # CertPrivateKeyExtractable Property ([JAdESSigner](#jadessigner-component) Component) Indicates whether the private key is extractable (exportable). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # CertPublicKeyBytes Property ([JAdESSigner](#jadessigner-component) Component) Contains the certificate's public key in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CertQualified Property ([JAdESSigner](#jadessigner-component) Component) Indicates whether the certificate is qualified. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # CertQualifiedStatements Property ([JAdESSigner](#jadessigner-component) Component) Returns a simplified qualified status of the certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CertQualifiedStatements(CertIndex int32) (int32, error) ``` ## Possible Values ```text 0 // NonQualified1 // QualifiedHardware2 // QualifiedSoftware ``` ## Default Value 0 ## Remarks Returns a simplified qualified status of the certificate. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # CertQualifiers Property ([JAdESSigner](#jadessigner-component) Component) A list of qualifiers. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertSelfSigned Property ([JAdESSigner](#jadessigner-component) Component) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # CertSerialNumber Property ([JAdESSigner](#jadessigner-component) Component) Returns the certificate's serial number. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CertSigAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertSource Property ([JAdESSigner](#jadessigner-component) Component) Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CertSource(CertIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Unknown1 // Signature2 // Document3 // User4 // Local5 // Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # CertSubject Property ([JAdESSigner](#jadessigner-component) Component) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certsubjectrdn-property-jadessigner-component). The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertSubjectAlternativeName Property ([JAdESSigner](#jadessigner-component) Component) Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certsubjectrdn-property-jadessigner-component) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertSubjectKeyID Property ([JAdESSigner](#jadessigner-component) Component) Contains a unique identifier of the certificate's cryptographic key. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certsubjectkeyid-property-jadessigner-component) and [CertCAKeyID](#certcakeyid-property-jadessigner-component) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CertSubjectRDN Property ([JAdESSigner](#jadessigner-component) Component) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertValid Property ([JAdESSigner](#jadessigner-component) Component) Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # CertValidFrom Property ([JAdESSigner](#jadessigner-component) Component) The time point at which the certificate becomes valid, in UTC. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CertValidTo Property ([JAdESSigner](#jadessigner-component) Component) The time point at which the certificate expires, in UTC. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#certcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CheckTrustedLists Property ([JAdESSigner](#jadessigner-component) Component) Specifies whether the class should attempt to validate chain trust via a known Trusted List. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CheckTrustedLists() (bool, error)func (obj *JAdESSigner) 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** # CompactForm Property ([JAdESSigner](#jadessigner-component) Component) Specifies if the JWS compact serialization to be used. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CompactForm() (bool, error)func (obj *JAdESSigner) SetCompactForm(value bool) error ``` ## Default Value false ## Remarks When this property is set to "true" value, the JAdES component will use the JWS compact serialization format when saving a signature. The JWS compact serialization format is a compact, Url safe representation of a JWS (JSON Web Signature) or JWE (JSON Web Encryption) object, used for transmitting security tokens. The JWS compact serialization format supports only one signature without unprotected header (only JWS or JAdES BaselineB signature). ## Data Type **bool** # ContentType Property ([JAdESSigner](#jadessigner-component) Component) Specifies payload content type. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ContentType() (string, error)func (obj *JAdESSigner) SetContentType(value string) error ``` ## Default Value "" ## Remarks Use this property to indicate the content type of the JWS Payload. This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json". It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'. ## Data Type **string** # CRLCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the CRL arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CRLCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [CRLBytes](#crlbytes-property-jadessigner-component) - [CRLCAKeyID](#crlcakeyid-property-jadessigner-component) - [CRLEntryCount](#crlentrycount-property-jadessigner-component) - [CRLHandle](#crlhandle-property-jadessigner-component) - [CRLIssuer](#crlissuer-property-jadessigner-component) - [CRLIssuerRDN](#crlissuerrdn-property-jadessigner-component) - [CRLLocation](#crllocation-property-jadessigner-component) - [CRLNextUpdate](#crlnextupdate-property-jadessigner-component) - [CRLSigAlgorithm](#crlsigalgorithm-property-jadessigner-component) - [CRLSource](#crlsource-property-jadessigner-component) - [CRLTBS](#crltbs-property-jadessigner-component) - [CRLThisUpdate](#crlthisupdate-property-jadessigner-component) The array indices start at *0* and end at *CRLCount - 1*. This property is read-only. ## Data Type **int32** # CRLBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw CRL data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CRLCAKeyID Property ([JAdESSigner](#jadessigner-component) Component) A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CRLEntryCount Property ([JAdESSigner](#jadessigner-component) Component) Returns the number of certificate status entries in the CRL. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CRLEntryCount(CRLIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks Returns the number of certificate status entries in the CRL. The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # CRLHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CRLHandle(CRLIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int64** # CRLIssuer Property ([JAdESSigner](#jadessigner-component) Component) The common name of the CRL issuer (CA), typically a company name. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CRLIssuerRDN Property ([JAdESSigner](#jadessigner-component) Component) A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CRLLocation Property ([JAdESSigner](#jadessigner-component) Component) The URL that the CRL was downloaded from. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CRLNextUpdate Property ([JAdESSigner](#jadessigner-component) Component) The planned time and date of the next version of this CRL to be published. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CRLSigAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) The public key algorithm that was used by the CA to sign this CRL. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # CRLSource Property ([JAdESSigner](#jadessigner-component) Component) Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CRLSource(CRLIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Unknown1 // Signature2 // Document3 // User4 // Local5 // Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. The *CRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CRLCount](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # CRLTBS Property ([JAdESSigner](#jadessigner-component) Component) The to-be-signed part of the CRL (the CRL without the signature part). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # CRLThisUpdate Property ([JAdESSigner](#jadessigner-component) Component) The date and time at which this version of the CRL was published. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#crlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # DataBytes Property ([JAdESSigner](#jadessigner-component) Component) Use this property to pass a payload or an object data to class in the byte array form. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) DataBytes() ([]byte, error)func (obj *JAdESSigner) SetDataBytes(value []byte) error ``` ## Remarks Assign a byte array containing a JWS payload or an object data to be processed to this property. ## Data Type **[]byte** # DataFile Property ([JAdESSigner](#jadessigner-component) Component) A path to a file containing a payload or an object data. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) DataFile() (string, error)func (obj *JAdESSigner) SetDataFile(value string) error ``` ## Default Value "" ## Remarks Use this property to provide a JWS payload or an object data to be processed. ## Data Type **string** # DataString Property ([JAdESSigner](#jadessigner-component) Component) Use this property to pass a payload or an object data to class in the string form. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) DataString() (string, error)func (obj *JAdESSigner) SetDataString(value string) error ``` ## Default Value "" ## Remarks Assign a string containing a JWS payload or an object data to be processed to this property. ## Data Type **string** # Detached Property ([JAdESSigner](#jadessigner-component) Component) Specifies whether a detached signature should be produced or verified. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Detached() (bool, error)func (obj *JAdESSigner) SetDetached(value bool) error ``` ## Default Value false ## Remarks Use this property to specify whether a detached signature should be produced or verified. When this property is set to "true" value, the JWS payload will be detached from the signature and may either be a single detached object or the result of concatenating multiple detached data objects. In other words, the JWS payload and the signature are stored in separate objects. If this property is set to "true" value, the user must provide the detached content via the [DataFile](#datafile-property-jadessigner-component) or DataStream or [DataBytes](#databytes-property-jadessigner-component) or [DataString](#datastring-property-jadessigner-component) properties. When Detached is set to "false" value, the JWS payload is included with the signature as a single object. ## Data Type **bool** # ExternalCryptoAsyncDocumentID Property ([JAdESSigner](#jadessigner-component) Component) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoAsyncDocumentID() (string, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Custom parameters to be passed to the signing service (uninterpreted). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoCustomParams() (string, error)func (obj *JAdESSigner) SetExternalCryptoCustomParams(value string) error ``` ## Default Value "" ## Remarks Custom parameters to be passed to the signing service (uninterpreted). ## Data Type **string** # ExternalCryptoData Property ([JAdESSigner](#jadessigner-component) Component) Additional data to be included in the async state and mirrored back by the requestor. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoData() (string, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoExternalHashCalculation() (bool, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Specifies the request's signature hash algorithm. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoHashAlgorithm() (string, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) The ID of the pre-shared key used for DC request authentication. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoKeyID() (string, error)func (obj *JAdESSigner) 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](#externalcryptokeysecret-property-jadessigner-component) 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: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` ## Data Type **string** # ExternalCryptoKeySecret Property ([JAdESSigner](#jadessigner-component) Component) The pre-shared key used for DC request authentication. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoKeySecret() (string, error)func (obj *JAdESSigner) 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](#externalcryptokeyid-property-jadessigner-component) topic. ## Data Type **string** # ExternalCryptoMethod Property ([JAdESSigner](#jadessigner-component) Component) Specifies the asynchronous signing method. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoMethod() (int32, error)func (obj *JAdESSigner) SetExternalCryptoMethod(value int32) error ``` ## Possible Values ```text 0 // PKCS11 // PKCS7 ``` ## Default Value 0 ## 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 ([JAdESSigner](#jadessigner-component) Component) Specifies the external cryptography mode. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoMode() (int32, error)func (obj *JAdESSigner) SetExternalCryptoMode(value int32) error ``` ## Possible Values ```text 0 // Default1 // Disabled2 // Generic3 // DCAuth4 // DCAuthJSON ``` ## Default Value 0 ## 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 ([JAdESSigner](#jadessigner-component) Component) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExternalCryptoPublicKeyAlgorithm() (string, error)func (obj *JAdESSigner) 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** # ExtractPayload Property ([JAdESSigner](#jadessigner-component) Component) Specifies whether a payload should be extracted. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ExtractPayload() (bool, error)func (obj *JAdESSigner) SetExtractPayload(value bool) error ``` ## Default Value false ## Remarks Use this property to specify whether a payload should be extracted when signature loaded. This applies only to non-detached signatures with a payload. When this property is set to "true" value, the JWS payload will be extracted from the signature. The user must provide the [OutputFile](#outputfile-property-jadessigner-component) or OutputStream properties with a filename or stream where to save the payload, if none is provided then payload is returned via [OutputBytes](#outputbytes-property-jadessigner-component) or [OutputString](#outputstring-property-jadessigner-component) properties. ## Data Type **bool** # FIPSMode Property ([JAdESSigner](#jadessigner-component) Component) Reserved. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) FIPSMode() (bool, error)func (obj *JAdESSigner) SetFIPSMode(value bool) error ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type **bool** # FlattenedSignature Property ([JAdESSigner](#jadessigner-component) Component) Specifies if the flattened signature to be used. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) FlattenedSignature() (bool, error)func (obj *JAdESSigner) SetFlattenedSignature(value bool) error ``` ## Default Value true ## Remarks This property determines whether to use the flattened JWS JSON serialization format. This format is optimized for the single digital signature case and flattens the general JWS JSON serialization syntax by removing the "signatures" member and instead placing the "protected", "header", and "signature" members at the top-level JSON object (at the same level as the "payload" member). When the FlattenedSignature property is set to "true" value, the signature will be represented using the flattened JWS JSON serialization format, but it is only applicable when there is a single signature involved. When the property is set to "false" value, the signature will be represented using the general JWS JSON serialization format. ## Data Type **bool** # IgnoreChainValidationErrors Property ([JAdESSigner](#jadessigner-component) Component) Makes the class tolerant to chain validation errors. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) IgnoreChainValidationErrors() (bool, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Use this property to pass the input to class in byte array form. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) InputBytes() ([]byte, error)func (obj *JAdESSigner) SetInputBytes(value []byte) error ``` ## Remarks Assign a byte array containing the data to be processed to this property. ## Data Type **[]byte** # InputFile Property ([JAdESSigner](#jadessigner-component) Component) The file to be signed. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) InputFile() (string, error)func (obj *JAdESSigner) SetInputFile(value string) error ``` ## Default Value "" ## Remarks Provide the path to the JSON to be signed. ## Data Type **string** # InputString Property ([JAdESSigner](#jadessigner-component) Component) Use this property to pass the input to class in the string form. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) InputString() (string, error)func (obj *JAdESSigner) SetInputString(value string) error ``` ## Default Value "" ## Remarks Assign a string containing the data to be processed to this property. ## Data Type **string** # KnownCertCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the KnownCert arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) KnownCertCount() (int32, error)func (obj *JAdESSigner) SetKnownCertCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownCertBytes](#knowncertbytes-property-jadessigner-component) - [KnownCertHandle](#knowncerthandle-property-jadessigner-component) The array indices start at *0* and end at *KnownCertCount - 1*. ## Data Type **int32** # KnownCertBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw certificate data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#knowncertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # KnownCertHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) KnownCertHandle(KnownCertIndex int32) (int64, error)func (obj *JAdESSigner) SetKnownCertHandle(KnownCertIndex int32, value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *KnownCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCertCount](#knowncertcount-property-jadessigner-component) property. ## Data Type **int64** # KnownCRLCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the KnownCRL arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) KnownCRLCount() (int32, error)func (obj *JAdESSigner) SetKnownCRLCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownCRLBytes](#knowncrlbytes-property-jadessigner-component) - [KnownCRLHandle](#knowncrlhandle-property-jadessigner-component) The array indices start at *0* and end at *KnownCRLCount - 1*. ## Data Type **int32** # KnownCRLBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw CRL data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#knowncrlcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # KnownCRLHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) KnownCRLHandle(KnownCRLIndex int32) (int64, error)func (obj *JAdESSigner) SetKnownCRLHandle(KnownCRLIndex int32, value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *KnownCRLIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownCRLCount](#knowncrlcount-property-jadessigner-component) property. ## Data Type **int64** # KnownOCSPCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the KnownOCSP arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) KnownOCSPCount() (int32, error)func (obj *JAdESSigner) SetKnownOCSPCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownOCSPBytes](#knownocspbytes-property-jadessigner-component) - [KnownOCSPHandle](#knownocsphandle-property-jadessigner-component) The array indices start at *0* and end at *KnownOCSPCount - 1*. ## Data Type **int32** # KnownOCSPBytes Property ([JAdESSigner](#jadessigner-component) Component) A buffer containing the raw OCSP response data. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#knownocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # KnownOCSPHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) KnownOCSPHandle(KnownOCSPIndex int32) (int64, error)func (obj *JAdESSigner) SetKnownOCSPHandle(KnownOCSPIndex int32, value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *KnownOCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [KnownOCSPCount](#knownocspcount-property-jadessigner-component) property. ## Data Type **int64** # NewSigChainValidationDetails Property ([JAdESSigner](#jadessigner-component) Component) The details of a certificate chain validation outcome. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigChainValidationDetails() (int32, error) ``` ## Default Value 0 ## Remarks The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **int32** # NewSigChainValidationResult Property ([JAdESSigner](#jadessigner-component) Component) The outcome of a certificate chain validation routine. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigChainValidationResult() (int32, error) ``` ## Possible Values ```text 0 // Valid1 // ValidButUntrusted2 // Invalid3 // CantBeEstablished ``` ## Default Value 0 ## 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **int32** # NewSigClaimedSigningTime Property ([JAdESSigner](#jadessigner-component) Component) The signing time from the signer's computer. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigClaimedSigningTime() (string, error)func (obj *JAdESSigner) SetNewSigClaimedSigningTime(value string) error ``` ## Default Value "" ## Remarks The signing time from the signer's computer. Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigCompatibilityErrors Property ([JAdESSigner](#jadessigner-component) Component) Returns compatibility errors encountered during validation. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigCompatibilityErrors() (int32, error) ``` ## Default Value 0 ## Remarks Returns compatibility errors encountered during validation. Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **int32** # NewSigContainsLongTermInfo Property ([JAdESSigner](#jadessigner-component) Component) Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **bool** # NewSigContentType Property ([JAdESSigner](#jadessigner-component) Component) Specifies payload content type. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigContentType() (string, error)func (obj *JAdESSigner) SetNewSigContentType(value string) error ``` ## Default Value "" ## Remarks Specifies payload content type. Use this property to indicate the content type of the JWS Payload. This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json". It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigCountersigned Property ([JAdESSigner](#jadessigner-component) Component) Indicates if the signature is countersigned. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigCountersigned() (bool, error) ``` ## Default Value false ## Remarks Indicates if the signature is countersigned. Use this property to find out whether the JWS/JAdES signature contains any countersignatures over the main signature(s). The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **bool** # NewSigEntityLabel Property ([JAdESSigner](#jadessigner-component) Component) Use this property to get the signature entity label. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **string** # NewSigHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigHandle() (int64, error)func (obj *JAdESSigner) SetNewSigHandle(value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **int64** # NewSigHashAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) Specifies the hash algorithm to be used. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigHashAlgorithm() (string, error)func (obj *JAdESSigner) SetNewSigHashAlgorithm(value string) error ``` ## Default Value "SHA256" ## Remarks Specifies the hash algorithm to be used. Supported values: | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigIssuerRDN Property ([JAdESSigner](#jadessigner-component) Component) The Relative Distinguished Name of the signing certificate's issuer. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **string** # NewSigJAdESVersion Property ([JAdESSigner](#jadessigner-component) Component) Specifies JAdES version. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigJAdESVersion() (int32, error)func (obj *JAdESSigner) SetNewSigJAdESVersion(value int32) error ``` ## Possible Values ```text 0 // Unknown1 // 111 ``` ## Default Value 1 ## Remarks Specifies JAdES version. This property specifies the version of the JAdES specification the signature should comply with. The supported values are: | | | | | --- | --- | --- | | javUnknown | 0 | Unknown | | jav111 | 1 | JAdES v1.1.1 | The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **int32** # NewSigLastArchivalTime Property ([JAdESSigner](#jadessigner-component) Component) Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigLastArchivalTime() (string, error) ``` ## Default Value "" ## Remarks Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **string** # NewSigLevel Property ([JAdESSigner](#jadessigner-component) Component) Specifies the signature kind and level. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigLevel() (int32, error)func (obj *JAdESSigner) SetNewSigLevel(value int32) error ``` ## Possible Values ```text 0 // Unknown1 // Generic2 // BaselineB3 // BaselineT4 // BaselineLT5 // BaselineLTA ``` ## Default Value 2 ## Remarks Specifies the signature kind and level. JAdES standard defines a number of different 'levels' of signatures which can be used for different purposes. Use the *Generic* value to produce JWS signature. The supported levels are: | | | | | --- | --- | --- | | jaslUnknown | 0 | Unknown signature level | | jaslGeneric | 1 | Generic signature: JSON Web Signature (JWS) | | jaslBaselineB | 2 | Baseline B (B-B, basic) | | jaslBaselineT | 3 | Baseline T (B-T, timestamped) | | jaslBaselineLT | 4 | Baseline LT (B-LT, long-term) | | jaslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) | The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **int32** # NewSigObjectType Property ([JAdESSigner](#jadessigner-component) Component) Specifies signature object content type. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigObjectType() (string, error)func (obj *JAdESSigner) SetNewSigObjectType(value string) error ``` ## Default Value "jose+json" ## Remarks Specifies signature object content type. Use this property to specify the content type of the signature object. It is used by the application to differentiate between different types of objects that might be present in an application data structure containing a JWS or JAdES. The default value is "jose+json" which indicates that it is a JWS or JAdES using the JWS JSON Serialization, and "jose" which indicates that the object is a JWS or JAdES using the JWS Compact Serialization. Other type values can also be used by the application. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigParentEntity Property ([JAdESSigner](#jadessigner-component) Component) Use this property to get the parent signature label. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigParentEntity() (string, error)func (obj *JAdESSigner) SetNewSigParentEntity(value string) error ``` ## Default Value "" ## Remarks Use this property to get the parent signature label. This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigPolicyHash Property ([JAdESSigner](#jadessigner-component) Component) The signature policy hash value. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigPolicyHash() (string, error)func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigPolicyHashAlgorithm Property ([JAdESSigner](#jadessigner-component) 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 *Go Syntax* ```text func (obj *JAdESSigner) NewSigPolicyHashAlgorithm() (string, error)func (obj *JAdESSigner) 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](#newsigpolicyhash-property-jadessigner-component). | | | | | --- | --- | --- | | 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](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigPolicyID Property ([JAdESSigner](#jadessigner-component) Component) The policy ID that was included or to be included into the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigPolicyID() (string, error)func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigPolicyURI Property ([JAdESSigner](#jadessigner-component) Component) The signature policy URI that was included in the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigPolicyURI() (string, error)func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigSerialNumber Property ([JAdESSigner](#jadessigner-component) Component) The serial number of the signing certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **[]byte** # NewSigSignatureBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the binary representation of the JSON/JAdES signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigSignatureBytes() ([]byte, error) ``` ## Remarks Returns the binary representation of the JSON/JAdES signature. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **[]byte** # NewSigSignatureValidationResult Property ([JAdESSigner](#jadessigner-component) Component) The outcome of the cryptographic signature validation. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigSignatureValidationResult() (int32, error) ``` ## Possible Values ```text 0 // Valid1 // Unknown2 // Corrupted3 // SignerNotFound4 // Failure5 // ReferenceCorrupted ``` ## Default Value 0 ## 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **int32** # NewSigSignedData Property ([JAdESSigner](#jadessigner-component) Component) The sigD header parameter in JSON format that was included or to be included into the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigSignedData() (string, error)func (obj *JAdESSigner) SetNewSigSignedData(value string) error ``` ## Default Value "" ## Remarks The sigD header parameter in JSON format that was included or to be included into the signature. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **string** # NewSigSignedDataType Property ([JAdESSigner](#jadessigner-component) Component) Specifies the type of signed data. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigSignedDataType() (int32, error)func (obj *JAdESSigner) SetNewSigSignedDataType(value int32) error ``` ## Possible Values ```text 0 // Payload1 // HttpHeaders2 // ObjectIdByURI3 // ObjectIdByURIHash4 // Custom ``` ## Default Value 0 ## Remarks Specifies the type of signed data. Supported values: | | | | | --- | --- | --- | | jasdtPayload | 0 | JWS Payload | | jasdtHttpHeaders | 1 | HttpHeaders mechanism | | jasdtObjectIdByURI | 2 | ObjectIdByURI mechanism | | jasdtObjectIdByURIHash | 3 | ObjectIdByURIHash mechanism | | jasdtCustom | 4 | Custom mechanism | The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. ## Data Type **int32** # NewSigSubjectKeyID Property ([JAdESSigner](#jadessigner-component) Component) Contains the subject key identifier of the signing certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **[]byte** # NewSigSubjectRDN Property ([JAdESSigner](#jadessigner-component) Component) Contains information about the person owning the signing certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigSubjectRDN() (string, error) ``` ## Default Value "" ## Remarks Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **string** # NewSigTimestamped Property ([JAdESSigner](#jadessigner-component) Component) Use this property to establish whether the signature contains an embedded timestamp. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **bool** # NewSigValidatedSigningTime Property ([JAdESSigner](#jadessigner-component) Component) Contains the certified signing time. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#newsigclaimedsigningtime-property-jadessigner-component) 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](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **string** # NewSigValidationLog Property ([JAdESSigner](#jadessigner-component) Component) Contains the complete log of the certificate validation routine. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) NewSigValidationLog() (string, error) ``` ## Default Value "" ## Remarks Contains the complete log of the certificate validation routine. Use this property to access the chain validation log produced by the struct. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure. The ** parameter specifies the index of the item in the array. The size of the array is controlled by the [NewSigCount](#JAdESSigner_p_NewSigCount) property. This property is read-only. ## Data Type **string** # OCSPCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the OCSP arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) OCSPCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [OCSPBytes](#ocspbytes-property-jadessigner-component) - [OCSPEntryCount](#ocspentrycount-property-jadessigner-component) - [OCSPHandle](#ocsphandle-property-jadessigner-component) - [OCSPIssuer](#ocspissuer-property-jadessigner-component) - [OCSPIssuerRDN](#ocspissuerrdn-property-jadessigner-component) - [OCSPLocation](#ocsplocation-property-jadessigner-component) - [OCSPProducedAt](#ocspproducedat-property-jadessigner-component) - [OCSPSigAlgorithm](#ocspsigalgorithm-property-jadessigner-component) - [OCSPSource](#ocspsource-property-jadessigner-component) The array indices start at *0* and end at *OCSPCount - 1*. This property is read-only. ## Data Type **int32** # OCSPBytes Property ([JAdESSigner](#jadessigner-component) Component) A buffer containing the raw OCSP response data. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # OCSPEntryCount Property ([JAdESSigner](#jadessigner-component) Component) The number of SingleResponse elements contained in this OCSP response. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) OCSPEntryCount(OCSPIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # OCSPHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) OCSPHandle(OCSPIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int64** # OCSPIssuer Property ([JAdESSigner](#jadessigner-component) Component) Indicates the issuer of this response (a CA or its authorized representative). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # OCSPIssuerRDN Property ([JAdESSigner](#jadessigner-component) Component) Indicates the RDN of the issuer of this response (a CA or its authorized representative). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # OCSPLocation Property ([JAdESSigner](#jadessigner-component) Component) The location of the OCSP responder. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # OCSPProducedAt Property ([JAdESSigner](#jadessigner-component) Component) Specifies the time when the response was produced, in UTC. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # OCSPSigAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) The public key algorithm that was used by the CA to sign this OCSP response. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # OCSPSource Property ([JAdESSigner](#jadessigner-component) Component) Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) OCSPSource(OCSPIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Unknown1 // Signature2 // Document3 // User4 // Local5 // Online ``` ## Default Value 0 ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. The *OCSPIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OCSPCount](#ocspcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # OfflineMode Property ([JAdESSigner](#jadessigner-component) Component) Switches the class to offline mode. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) OfflineMode() (bool, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Use this property to read the output the class object has produced. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#outputfile-property-jadessigner-component) and OutputStream properties had not been assigned. This property is read-only. ## Data Type **[]byte** # OutputFile Property ([JAdESSigner](#jadessigner-component) Component) Defines where to save the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) OutputFile() (string, error)func (obj *JAdESSigner) SetOutputFile(value string) error ``` ## Default Value "" ## Remarks Specifies the path where the JWS/JAdES signature should be saved. ## Data Type **string** # OutputString Property ([JAdESSigner](#jadessigner-component) Component) Use this property to read the output the class object has produced. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) OutputString() (string, error) ``` ## Default Value "" ## Remarks Read the contents of this property after the operation is completed to read the produced output. This property will only be set if [OutputFile](#outputfile-property-jadessigner-component) and OutputStream properties had not been assigned. This property is read-only. ## Data Type **string** # Profile Property ([JAdESSigner](#jadessigner-component) Component) Specifies a pre-defined profile to apply when creating the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Profile() (string, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) The IP address of the proxy server. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyAddress() (string, error)func (obj *JAdESSigner) SetProxyAddress(value string) error ``` ## Default Value "" ## Remarks The IP address of the proxy server. ## Data Type **string** # ProxyAuthentication Property ([JAdESSigner](#jadessigner-component) Component) The authentication type used by the proxy server. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyAuthentication() (int32, error)func (obj *JAdESSigner) SetProxyAuthentication(value int32) error ``` ## Possible Values ```text 0 // NoAuthentication1 // Basic2 // Digest3 // NTLM ``` ## Default Value 0 ## Remarks The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | ## Data Type **int32** # ProxyPassword Property ([JAdESSigner](#jadessigner-component) Component) The password to authenticate to the proxy server. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyPassword() (string, error)func (obj *JAdESSigner) SetProxyPassword(value string) error ``` ## Default Value "" ## Remarks The password to authenticate to the proxy server. ## Data Type **string** # ProxyPort Property ([JAdESSigner](#jadessigner-component) Component) The port on the proxy server to connect to. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyPort() (int32, error)func (obj *JAdESSigner) SetProxyPort(value int32) error ``` ## Default Value 0 ## Remarks The port on the proxy server to connect to. ## Data Type **int32** # ProxyType Property ([JAdESSigner](#jadessigner-component) Component) The type of the proxy server. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyType() (int32, error)func (obj *JAdESSigner) SetProxyType(value int32) error ``` ## Possible Values ```text 0 // None1 // Socks42 // Socks53 // WebTunnel4 // HTTP ``` ## Default Value 0 ## Remarks The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | ## Data Type **int32** # ProxyRequestHeaders Property ([JAdESSigner](#jadessigner-component) Component) Contains HTTP request headers for WebTunnel and HTTP proxy. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyRequestHeaders() (string, error)func (obj *JAdESSigner) SetProxyRequestHeaders(value string) error ``` ## Default Value "" ## Remarks Contains HTTP request headers for WebTunnel and HTTP proxy. ## Data Type **string** # ProxyResponseBody Property ([JAdESSigner](#jadessigner-component) Component) Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyResponseBody() (string, error)func (obj *JAdESSigner) SetProxyResponseBody(value string) error ``` ## Default Value "" ## Remarks Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Data Type **string** # ProxyResponseHeaders Property ([JAdESSigner](#jadessigner-component) Component) Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyResponseHeaders() (string, error)func (obj *JAdESSigner) SetProxyResponseHeaders(value string) error ``` ## Default Value "" ## Remarks Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Data Type **string** # ProxyUseIPv6 Property ([JAdESSigner](#jadessigner-component) Component) Specifies whether IPv6 should be used when connecting through the proxy. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyUseIPv6() (bool, error)func (obj *JAdESSigner) SetProxyUseIPv6(value bool) error ``` ## Default Value false ## Remarks Specifies whether IPv6 should be used when connecting through the proxy. ## Data Type **bool** # ProxyUsername Property ([JAdESSigner](#jadessigner-component) Component) Specifies the username credential for proxy authentication. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ProxyUsername() (string, error)func (obj *JAdESSigner) SetProxyUsername(value string) error ``` ## Default Value "" ## Remarks Specifies the username credential for proxy authentication. ## Data Type **string** # RevocationCheck Property ([JAdESSigner](#jadessigner-component) Component) Specifies the kind(s) of revocation check to perform for all chain certificates. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) RevocationCheck() (int32, error)func (obj *JAdESSigner) SetRevocationCheck(value int32) error ``` ## Possible Values ```text 0 // None1 // Auto2 // AllCRL3 // AllOCSP4 // AllCRLAndOCSP5 // AnyCRL6 // AnyOCSP7 // AnyCRLOrOCSP8 // AnyOCSPOrCRL ``` ## Default Value 1 ## Remarks Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types. | | | | | --- | --- | --- | | 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 ([JAdESSigner](#jadessigner-component) Component) The number of records in the Signature arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SignatureBytes](#signaturebytes-property-jadessigner-component) - [SignatureChainValidationDetails](#signaturechainvalidationdetails-property-jadessigner-component) - [SignatureChainValidationResult](#signaturechainvalidationresult-property-jadessigner-component) - [SignatureClaimedSigningTime](#signatureclaimedsigningtime-property-jadessigner-component) - [SignatureCompatibilityErrors](#signaturecompatibilityerrors-property-jadessigner-component) - [SignatureContainsLongTermInfo](#signaturecontainslongterminfo-property-jadessigner-component) - [SignatureContentType](#signaturecontenttype-property-jadessigner-component) - [SignatureCountersigned](#signaturecountersigned-property-jadessigner-component) - [SignatureEntityLabel](#signatureentitylabel-property-jadessigner-component) - [SignatureHandle](#signaturehandle-property-jadessigner-component) - [SignatureHashAlgorithm](#signaturehashalgorithm-property-jadessigner-component) - [SignatureIssuerRDN](#signatureissuerrdn-property-jadessigner-component) - [SignatureJAdESVersion](#signaturejadesversion-property-jadessigner-component) - [SignatureLastArchivalTime](#signaturelastarchivaltime-property-jadessigner-component) - [SignatureLevel](#signaturelevel-property-jadessigner-component) - [SignatureObjectType](#signatureobjecttype-property-jadessigner-component) - [SignatureParentEntity](#signatureparententity-property-jadessigner-component) - [SignaturePolicyHash](#signaturepolicyhash-property-jadessigner-component) - [SignaturePolicyHashAlgorithm](#signaturepolicyhashalgorithm-property-jadessigner-component) - [SignaturePolicyID](#signaturepolicyid-property-jadessigner-component) - [SignaturePolicyURI](#signaturepolicyuri-property-jadessigner-component) - [SignatureSerialNumber](#signatureserialnumber-property-jadessigner-component) - [SignatureSignedData](#signaturesigneddata-property-jadessigner-component) - [SignatureSignedDataType](#signaturesigneddatatype-property-jadessigner-component) - [SignatureSubjectKeyID](#signaturesubjectkeyid-property-jadessigner-component) - [SignatureSubjectRDN](#signaturesubjectrdn-property-jadessigner-component) - [SignatureTimestamped](#signaturetimestamped-property-jadessigner-component) - [SignatureValidatedSigningTime](#signaturevalidatedsigningtime-property-jadessigner-component) - [SignatureValidationLog](#signaturevalidationlog-property-jadessigner-component) - [SignatureValidationResult](#signaturevalidationresult-property-jadessigner-component) The array indices start at *0* and end at *SignatureCount - 1*. This property is read-only. ## Data Type **int32** # SignatureChainValidationDetails Property ([JAdESSigner](#jadessigner-component) Component) The details of a certificate chain validation outcome. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureChainValidationDetails(SignatureIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # SignatureChainValidationResult Property ([JAdESSigner](#jadessigner-component) Component) The outcome of a certificate chain validation routine. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureChainValidationResult(SignatureIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Valid1 // ValidButUntrusted2 // Invalid3 // CantBeEstablished ``` ## Default Value 0 ## 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # SignatureClaimedSigningTime Property ([JAdESSigner](#jadessigner-component) Component) The signing time from the signer's computer. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureClaimedSigningTime(SignatureIndex int32) (string, error) ``` ## Default Value "" ## Remarks The signing time from the signer's computer. Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureCompatibilityErrors Property ([JAdESSigner](#jadessigner-component) Component) Returns compatibility errors encountered during validation. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureCompatibilityErrors(SignatureIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks Returns compatibility errors encountered during validation. Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # SignatureContainsLongTermInfo Property ([JAdESSigner](#jadessigner-component) Component) Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # SignatureContentType Property ([JAdESSigner](#jadessigner-component) Component) Specifies payload content type. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureContentType(SignatureIndex int32) (string, error) ``` ## Default Value "" ## Remarks Specifies payload content type. Use this property to indicate the content type of the JWS Payload. This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json". It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureCountersigned Property ([JAdESSigner](#jadessigner-component) Component) Indicates if the signature is countersigned. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureCountersigned(SignatureIndex int32) (bool, error) ``` ## Default Value false ## Remarks Indicates if the signature is countersigned. Use this property to find out whether the JWS/JAdES signature contains any countersignatures over the main signature(s). The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # SignatureEntityLabel Property ([JAdESSigner](#jadessigner-component) Component) Use this property to get the signature entity label. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureEntityLabel(SignatureIndex int32) (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 *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureHandle(SignatureIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **int64** # SignatureHashAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) Specifies the hash algorithm to be used. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureHashAlgorithm(SignatureIndex int32) (string, error) ``` ## Default Value "SHA256" ## Remarks Specifies the hash algorithm to be used. Supported values: | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureIssuerRDN Property ([JAdESSigner](#jadessigner-component) Component) The Relative Distinguished Name of the signing certificate's issuer. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureJAdESVersion Property ([JAdESSigner](#jadessigner-component) Component) Specifies JAdES version. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureJAdESVersion(SignatureIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Unknown1 // 111 ``` ## Default Value 1 ## Remarks Specifies JAdES version. This property specifies the version of the JAdES specification the signature should comply with. The supported values are: | | | | | --- | --- | --- | | javUnknown | 0 | Unknown | | jav111 | 1 | JAdES v1.1.1 | The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # SignatureLastArchivalTime Property ([JAdESSigner](#jadessigner-component) Component) Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureLastArchivalTime(SignatureIndex int32) (string, error) ``` ## Default Value "" ## Remarks Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureLevel Property ([JAdESSigner](#jadessigner-component) Component) Specifies the signature kind and level. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureLevel(SignatureIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Unknown1 // Generic2 // BaselineB3 // BaselineT4 // BaselineLT5 // BaselineLTA ``` ## Default Value 2 ## Remarks Specifies the signature kind and level. JAdES standard defines a number of different 'levels' of signatures which can be used for different purposes. Use the *Generic* value to produce JWS signature. The supported levels are: | | | | | --- | --- | --- | | jaslUnknown | 0 | Unknown signature level | | jaslGeneric | 1 | Generic signature: JSON Web Signature (JWS) | | jaslBaselineB | 2 | Baseline B (B-B, basic) | | jaslBaselineT | 3 | Baseline T (B-T, timestamped) | | jaslBaselineLT | 4 | Baseline LT (B-LT, long-term) | | jaslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) | The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # SignatureObjectType Property ([JAdESSigner](#jadessigner-component) Component) Specifies signature object content type. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureObjectType(SignatureIndex int32) (string, error) ``` ## Default Value "jose+json" ## Remarks Specifies signature object content type. Use this property to specify the content type of the signature object. It is used by the application to differentiate between different types of objects that might be present in an application data structure containing a JWS or JAdES. The default value is "jose+json" which indicates that it is a JWS or JAdES using the JWS JSON Serialization, and "jose" which indicates that the object is a JWS or JAdES using the JWS Compact Serialization. Other type values can also be used by the application. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureParentEntity Property ([JAdESSigner](#jadessigner-component) Component) Use this property to get the parent signature label. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureParentEntity(SignatureIndex int32) (string, error) ``` ## Default Value "" ## Remarks Use this property to get the parent signature label. This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignaturePolicyHash Property ([JAdESSigner](#jadessigner-component) Component) The signature policy hash value. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignaturePolicyHashAlgorithm Property ([JAdESSigner](#jadessigner-component) 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 *Go Syntax* ```text func (obj *JAdESSigner) 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](#signaturepolicyhash-property-jadessigner-component). | | | | | --- | --- | --- | | 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignaturePolicyID Property ([JAdESSigner](#jadessigner-component) Component) The policy ID that was included or to be included into the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignaturePolicyURI Property ([JAdESSigner](#jadessigner-component) Component) The signature policy URI that was included in the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureSerialNumber Property ([JAdESSigner](#jadessigner-component) Component) The serial number of the signing certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # SignatureBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the binary representation of the JSON/JAdES signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureBytes(SignatureIndex int32) ([]byte, error) ``` ## Remarks Returns the binary representation of the JSON/JAdES signature. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # SignatureValidationResult Property ([JAdESSigner](#jadessigner-component) Component) The outcome of the cryptographic signature validation. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureValidationResult(SignatureIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Valid1 // Unknown2 // Corrupted3 // SignerNotFound4 // Failure5 // ReferenceCorrupted ``` ## Default Value 0 ## Remarks The outcome of the cryptographic signature validation. The following signature validity values are supported: | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # SignatureSignedData Property ([JAdESSigner](#jadessigner-component) Component) The sigD header parameter in JSON format that was included or to be included into the signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureSignedData(SignatureIndex int32) (string, error) ``` ## Default Value "" ## Remarks The sigD header parameter in JSON format that was included or to be included into the signature. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureSignedDataType Property ([JAdESSigner](#jadessigner-component) Component) Specifies the type of signed data. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureSignedDataType(SignatureIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Payload1 // HttpHeaders2 // ObjectIdByURI3 // ObjectIdByURIHash4 // Custom ``` ## Default Value 0 ## Remarks Specifies the type of signed data. Supported values: | | | | | --- | --- | --- | | jasdtPayload | 0 | JWS Payload | | jasdtHttpHeaders | 1 | HttpHeaders mechanism | | jasdtObjectIdByURI | 2 | ObjectIdByURI mechanism | | jasdtObjectIdByURIHash | 3 | ObjectIdByURIHash mechanism | | jasdtCustom | 4 | Custom mechanism | The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # SignatureSubjectKeyID Property ([JAdESSigner](#jadessigner-component) Component) Contains the subject key identifier of the signing certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureSubjectKeyID(SignatureIndex int32) ([]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 *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # SignatureSubjectRDN Property ([JAdESSigner](#jadessigner-component) Component) Contains information about the person owning the signing certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureSubjectRDN(SignatureIndex int32) (string, error) ``` ## Default Value "" ## Remarks Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureTimestamped Property ([JAdESSigner](#jadessigner-component) Component) Use this property to establish whether the signature contains an embedded timestamp. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # SignatureValidatedSigningTime Property ([JAdESSigner](#jadessigner-component) Component) Contains the certified signing time. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureValidatedSigningTime(SignatureIndex int32) (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. [SignatureClaimedSigningTime](#signatureclaimedsigningtime-property-jadessigner-component) 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](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SignatureValidationLog Property ([JAdESSigner](#jadessigner-component) Component) Contains the complete log of the certificate validation routine. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignatureValidationLog(SignatureIndex int32) (string, error) ``` ## Default Value "" ## Remarks Contains the complete log of the certificate validation routine. Use this property to access the chain validation log produced by the struct. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure. The *SignatureIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignatureCount](#signaturecount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # SigningCertBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw certificate data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SigningCertBytes() ([]byte, error) ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. ## Data Type **[]byte** # SigningCertHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SigningCertHandle() (int64, error)func (obj *JAdESSigner) SetSigningCertHandle(value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` ## Data Type **int64** # SigningChainCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the SigningChain arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SigningChainCount() (int32, error)func (obj *JAdESSigner) SetSigningChainCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SigningChainBytes](#signingchainbytes-property-jadessigner-component) - [SigningChainHandle](#signingchainhandle-property-jadessigner-component) The array indices start at *0* and end at *SigningChainCount - 1*. ## Data Type **int32** # SigningChainBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw certificate data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signingchaincount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # SigningChainHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SigningChainHandle(SigningChainIndex int32) (int64, error)func (obj *JAdESSigner) SetSigningChainHandle(SigningChainIndex int32, value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *SigningChainIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningChainCount](#signingchaincount-property-jadessigner-component) property. ## Data Type **int64** # SocketDNSMode Property ([JAdESSigner](#jadessigner-component) Component) Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketDNSMode() (int32, error)func (obj *JAdESSigner) SetSocketDNSMode(value int32) error ``` ## Possible Values ```text 0 // Auto1 // Platform2 // Own3 // OwnSecure ``` ## Default Value 0 ## Remarks Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | ## Data Type **int32** # SocketDNSPort Property ([JAdESSigner](#jadessigner-component) Component) Specifies the port number to be used for sending queries to the DNS server. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketDNSPort() (int32, error)func (obj *JAdESSigner) SetSocketDNSPort(value int32) error ``` ## Default Value 0 ## Remarks Specifies the port number to be used for sending queries to the DNS server. ## Data Type **int32** # SocketDNSQueryTimeout Property ([JAdESSigner](#jadessigner-component) Component) The timeout (in milliseconds) for each DNS query. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketDNSQueryTimeout() (int32, error)func (obj *JAdESSigner) SetSocketDNSQueryTimeout(value int32) error ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. ## Data Type **int32** # SocketDNSServers Property ([JAdESSigner](#jadessigner-component) Component) The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketDNSServers() (string, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) The timeout (in milliseconds) for the whole resolution process. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketDNSTotalTimeout() (int32, error)func (obj *JAdESSigner) SetSocketDNSTotalTimeout(value int32) error ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. ## Data Type **int32** # SocketIncomingSpeedLimit Property ([JAdESSigner](#jadessigner-component) Component) The maximum number of bytes to read from the socket, per second. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketIncomingSpeedLimit() (int32, error)func (obj *JAdESSigner) SetSocketIncomingSpeedLimit(value int32) error ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. ## Data Type **int32** # SocketLocalAddress Property ([JAdESSigner](#jadessigner-component) Component) The local network interface to bind the socket to. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketLocalAddress() (string, error)func (obj *JAdESSigner) SetSocketLocalAddress(value string) error ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. ## Data Type **string** # SocketLocalPort Property ([JAdESSigner](#jadessigner-component) Component) The local port number to bind the socket to. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketLocalPort() (int32, error)func (obj *JAdESSigner) SetSocketLocalPort(value int32) error ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. ## Data Type **int32** # SocketOutgoingSpeedLimit Property ([JAdESSigner](#jadessigner-component) Component) The maximum number of bytes to write to the socket, per second. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketOutgoingSpeedLimit() (int32, error)func (obj *JAdESSigner) SetSocketOutgoingSpeedLimit(value int32) error ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. ## Data Type **int32** # SocketTimeout Property ([JAdESSigner](#jadessigner-component) Component) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketTimeout() (int32, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Enables or disables IP protocol version 6. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SocketUseIPv6() (bool, error)func (obj *JAdESSigner) SetSocketUseIPv6(value bool) error ``` ## Default Value false ## Remarks Enables or disables IP protocol version 6. ## Data Type **bool** # TimestampCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the Timestamp arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TimestampCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TimestampAccuracy](#timestampaccuracy-property-jadessigner-component) - [TimestampBytes](#timestampbytes-property-jadessigner-component) - [TimestampCertificateIndex](#timestampcertificateindex-property-jadessigner-component) - [TimestampChainValidationDetails](#timestampchainvalidationdetails-property-jadessigner-component) - [TimestampChainValidationResult](#timestampchainvalidationresult-property-jadessigner-component) - [TimestampContainsLongTermInfo](#timestampcontainslongterminfo-property-jadessigner-component) - [TimestampEntityLabel](#timestampentitylabel-property-jadessigner-component) - [TimestampHashAlgorithm](#timestamphashalgorithm-property-jadessigner-component) - [TimestampParentEntity](#timestampparententity-property-jadessigner-component) - [TimestampSerialNumber](#timestampserialnumber-property-jadessigner-component) - [TimestampTime](#timestamptime-property-jadessigner-component) - [TimestampTSAName](#timestamptsaname-property-jadessigner-component) - [TimestampType](#timestamptype-property-jadessigner-component) - [TimestampValidationLog](#timestampvalidationlog-property-jadessigner-component) - [TimestampValidationResult](#timestampvalidationresult-property-jadessigner-component) The array indices start at *0* and end at *TimestampCount - 1*. This property is read-only. ## Data Type **int32** # TimestampAccuracy Property ([JAdESSigner](#jadessigner-component) Component) This property indicates the accuracy of the included time mark, in microseconds. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TimestampAccuracy(TimestampIndex int32) (int64, error) ``` ## Default Value 0 ## 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int64** # TimestampBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw timestamp data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # TimestampCertificateIndex Property ([JAdESSigner](#jadessigner-component) Component) Returns the index of the TSA certificate in the Certificates collection. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # TimestampChainValidationDetails Property ([JAdESSigner](#jadessigner-component) Component) The details of a certificate chain validation outcome. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TimestampChainValidationDetails(TimestampIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # TimestampChainValidationResult Property ([JAdESSigner](#jadessigner-component) Component) The outcome of a certificate chain validation routine. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TimestampChainValidationResult(TimestampIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Valid1 // ValidButUntrusted2 // Invalid3 // CantBeEstablished ``` ## Default Value 0 ## 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # TimestampContainsLongTermInfo Property ([JAdESSigner](#jadessigner-component) Component) Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # TimestampEntityLabel Property ([JAdESSigner](#jadessigner-component) Component) Use this property to get the timestamp entity label. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TimestampHashAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) Returns the timestamp's hash algorithm. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TimestampParentEntity Property ([JAdESSigner](#jadessigner-component) Component) Use this property to get the label of the timestamp's parent entity. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TimestampSerialNumber Property ([JAdESSigner](#jadessigner-component) Component) Returns the timestamp's serial number. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # TimestampTime Property ([JAdESSigner](#jadessigner-component) Component) The time point incorporated into the timestamp. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TimestampType Property ([JAdESSigner](#jadessigner-component) Component) Returns the type of the timestamp. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TimestampType(TimestampIndex int32) (int32, error) ``` ## Default Value 0 ## 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # TimestampTSAName Property ([JAdESSigner](#jadessigner-component) Component) This value uniquely identifies the Timestamp Authority (TSA). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TimestampValidationLog Property ([JAdESSigner](#jadessigner-component) Component) Contains the TSA certificate chain validation log. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TimestampValidationResult Property ([JAdESSigner](#jadessigner-component) Component) Contains the timestamp validation outcome. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TimestampValidationResult(TimestampIndex int32) (int32, error) ``` ## Possible Values ```text 0 // Valid1 // Unknown2 // Corrupted3 // SignerNotFound4 // Failure5 // ReferenceCorrupted ``` ## Default Value 0 ## 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](#timestampcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # TimestampServer Property ([JAdESSigner](#jadessigner-component) Component) The address of the timestamping server. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TimestampServer() (string, error)func (obj *JAdESSigner) 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](#notification-event-jadessigner-component) 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 ([JAdESSigner](#jadessigner-component) Component) The number of records in the TLSClientCert arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSClientCertCount() (int32, error)func (obj *JAdESSigner) SetTLSClientCertCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TLSClientCertBytes](#tlsclientcertbytes-property-jadessigner-component) - [TLSClientCertHandle](#tlsclientcerthandle-property-jadessigner-component) The array indices start at *0* and end at *TLSClientCertCount - 1*. ## Data Type **int32** # TLSClientCertBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw certificate data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#tlsclientcertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # TLSClientCertHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSClientCertHandle(TLSClientCertIndex int32) (int64, error)func (obj *JAdESSigner) SetTLSClientCertHandle(TLSClientCertIndex int32, value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *TLSClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSClientCertCount](#tlsclientcertcount-property-jadessigner-component) property. ## Data Type **int64** # TLSServerCertCount Property ([JAdESSigner](#jadessigner-component) Component) The number of records in the TLSServerCert arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSServerCertCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TLSServerCertBytes](#tlsservercertbytes-property-jadessigner-component) - [TLSServerCertFingerprint](#tlsservercertfingerprint-property-jadessigner-component) - [TLSServerCertHandle](#tlsservercerthandle-property-jadessigner-component) - [TLSServerCertIssuer](#tlsservercertissuer-property-jadessigner-component) - [TLSServerCertIssuerRDN](#tlsservercertissuerrdn-property-jadessigner-component) - [TLSServerCertKeyAlgorithm](#tlsservercertkeyalgorithm-property-jadessigner-component) - [TLSServerCertKeyBits](#tlsservercertkeybits-property-jadessigner-component) - [TLSServerCertKeyUsage](#tlsservercertkeyusage-property-jadessigner-component) - [TLSServerCertSelfSigned](#tlsservercertselfsigned-property-jadessigner-component) - [TLSServerCertSerialNumber](#tlsservercertserialnumber-property-jadessigner-component) - [TLSServerCertSigAlgorithm](#tlsservercertsigalgorithm-property-jadessigner-component) - [TLSServerCertSubject](#tlsservercertsubject-property-jadessigner-component) - [TLSServerCertSubjectRDN](#tlsservercertsubjectrdn-property-jadessigner-component) - [TLSServerCertValidFrom](#tlsservercertvalidfrom-property-jadessigner-component) - [TLSServerCertValidTo](#tlsservercertvalidto-property-jadessigner-component) The array indices start at *0* and end at *TLSServerCertCount - 1*. This property is read-only. ## Data Type **int32** # TLSServerCertBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw certificate data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # TLSServerCertFingerprint Property ([JAdESSigner](#jadessigner-component) Component) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSServerCertHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSServerCertHandle(TLSServerCertIndex int32) (int64, error) ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int64** # TLSServerCertIssuer Property ([JAdESSigner](#jadessigner-component) Component) The common name of the certificate issuer (CA), typically a company name. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_TLSIssuerRDN). The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSServerCertIssuerRDN Property ([JAdESSigner](#jadessigner-component) Component) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSServerCertKeyAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) Specifies the public key algorithm of this certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_TLSKeyBits), [TLSCurve](#JAdESSigner_p_TLSCurve), and [TLSPublicKeyBytes](#JAdESSigner_p_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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSServerCertKeyBits Property ([JAdESSigner](#jadessigner-component) Component) Returns the length of the public key in bits. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSServerCertKeyBits(TLSServerCertIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [TLSPublicKeyBytes](#JAdESSigner_p_TLSPublicKeyBytes) or [TLSPrivateKeyBytes](#JAdESSigner_p_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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # TLSServerCertKeyUsage Property ([JAdESSigner](#jadessigner-component) Component) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSServerCertKeyUsage(TLSServerCertIndex int32) (int32, error) ``` ## Default Value 0 ## Remarks Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | 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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **int32** # TLSServerCertSelfSigned Property ([JAdESSigner](#jadessigner-component) Component) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **bool** # TLSServerCertSerialNumber Property ([JAdESSigner](#jadessigner-component) Component) Returns the certificate's serial number. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSServerCertSerialNumber(TLSServerCertIndex int32) ([]byte, error) ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # TLSServerCertSigAlgorithm Property ([JAdESSigner](#jadessigner-component) Component) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSServerCertSubject Property ([JAdESSigner](#jadessigner-component) Component) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#JAdESSigner_p_TLSSubjectRDN). The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSServerCertSubjectRDN Property ([JAdESSigner](#jadessigner-component) Component) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSServerCertSubjectRDN(TLSServerCertIndex int32) (string, error) ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSServerCertValidFrom Property ([JAdESSigner](#jadessigner-component) Component) The time point at which the certificate becomes valid, in UTC. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSServerCertValidTo Property ([JAdESSigner](#jadessigner-component) Component) The time point at which the certificate expires, in UTC. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#tlsservercertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **string** # TLSAutoValidateCertificates Property ([JAdESSigner](#jadessigner-component) Component) Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSAutoValidateCertificates() (bool, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Selects the base configuration for the TLS settings. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSBaseConfiguration() (int32, error)func (obj *JAdESSigner) SetTLSBaseConfiguration(value int32) error ``` ## Possible Values ```text 0 // Default1 // Compatible2 // ComprehensiveInsecure3 // HighlySecure ``` ## Default Value 0 ## Remarks Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | ## Data Type **int32** # TLSCiphersuites Property ([JAdESSigner](#jadessigner-component) Component) A list of ciphersuites separated with commas or semicolons. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSCiphersuites() (string, error)func (obj *JAdESSigner) 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](#tlsbaseconfiguration-property-jadessigner-component). 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 ([JAdESSigner](#jadessigner-component) Component) Enables or disables certificate-based client authentication. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSClientAuth() (int32, error)func (obj *JAdESSigner) SetTLSClientAuth(value int32) error ``` ## Possible Values ```text 0 // NoAuth1 // RequestCert2 // RequireCert ``` ## Default Value 0 ## 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 ([JAdESSigner](#jadessigner-component) Component) Provides access to TLS extensions. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSExtensions() (string, error)func (obj *JAdESSigner) SetTLSExtensions(value string) error ``` ## Default Value "" ## Remarks Provides access to TLS extensions. ## Data Type **string** # TLSForceResumeIfDestinationChanges Property ([JAdESSigner](#jadessigner-component) Component) Whether to force TLS session resumption when the destination address changes. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSForceResumeIfDestinationChanges() (bool, error)func (obj *JAdESSigner) SetTLSForceResumeIfDestinationChanges(value bool) error ``` ## Default Value false ## Remarks Whether to force TLS session resumption when the destination address changes. ## Data Type **bool** # TLSGroups Property ([JAdESSigner](#jadessigner-component) Component) Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSGroups() (string, error)func (obj *JAdESSigner) 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: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. ## Data Type **string** # TLSPreSharedIdentity Property ([JAdESSigner](#jadessigner-component) Component) Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSPreSharedIdentity() (string, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSPreSharedKey() (string, error)func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSPreSharedKeyCiphersuite() (string, error)func (obj *JAdESSigner) SetTLSPreSharedKeyCiphersuite(value string) error ``` ## Default Value "" ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Data Type **string** # TLSRenegotiationAttackPreventionMode Property ([JAdESSigner](#jadessigner-component) Component) Selects the renegotiation attack prevention mechanism. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSRenegotiationAttackPreventionMode() (int32, error)func (obj *JAdESSigner) SetTLSRenegotiationAttackPreventionMode(value int32) error ``` ## Possible Values ```text 0 // Compatible1 // Strict2 // Auto ``` ## Default Value 2 ## 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 ([JAdESSigner](#jadessigner-component) Component) Specifies the kind(s) of revocation check to perform. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSRevocationCheck() (int32, error)func (obj *JAdESSigner) SetTLSRevocationCheck(value int32) error ``` ## Possible Values ```text 0 // None1 // Auto2 // AllCRL3 // AllOCSP4 // AllCRLAndOCSP5 // AnyCRL6 // AnyOCSP7 // AnyCRLOrOCSP8 // AnyOCSPOrCRL ``` ## Default Value 1 ## Remarks Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | 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** # TLSSSLOptions Property ([JAdESSigner](#jadessigner-component) 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 *Go Syntax* ```text func (obj *JAdESSigner) TLSSSLOptions() (int32, error)func (obj *JAdESSigner) SetTLSSSLOptions(value int32) error ``` ## Default Value 16 ## 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 ([JAdESSigner](#jadessigner-component) Component) Specifies the TLS mode to use. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSMode() (int32, error)func (obj *JAdESSigner) SetTLSMode(value int32) error ``` ## Possible Values ```text 0 // Default1 // NoTLS2 // ExplicitTLS3 // ImplicitTLS4 // MixedTLS ``` ## Default Value 0 ## 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 ([JAdESSigner](#jadessigner-component) Component) Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSUseExtendedMasterSecret() (bool, error)func (obj *JAdESSigner) SetTLSUseExtendedMasterSecret(value bool) error ``` ## Default Value true ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Data Type **bool** # TLSUseSessionResumption Property ([JAdESSigner](#jadessigner-component) Component) Enables or disables the TLS session resumption capability. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSUseSessionResumption() (bool, error)func (obj *JAdESSigner) SetTLSUseSessionResumption(value bool) error ``` ## Default Value false ## Remarks Enables or disables the TLS session resumption capability. ## Data Type **bool** # TLSVersions Property ([JAdESSigner](#jadessigner-component) Component) The SSL/TLS versions to enable by default. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TLSVersions() (int32, error)func (obj *JAdESSigner) SetTLSVersions(value int32) error ``` ## Default Value 48 ## 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 ([JAdESSigner](#jadessigner-component) Component) The number of records in the TrustedCert arrays. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TrustedCertCount() (int32, error)func (obj *JAdESSigner) SetTrustedCertCount(value int32) error ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TrustedCertBytes](#trustedcertbytes-property-jadessigner-component) - [TrustedCertHandle](#trustedcerthandle-property-jadessigner-component) The array indices start at *0* and end at *TrustedCertCount - 1*. ## Data Type **int32** # TrustedCertBytes Property ([JAdESSigner](#jadessigner-component) Component) Returns the raw certificate data in DER format. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#trustedcertcount-property-jadessigner-component) property. This property is read-only. ## Data Type **[]byte** # TrustedCertHandle Property ([JAdESSigner](#jadessigner-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) TrustedCertHandle(TrustedCertIndex int32) (int64, error)func (obj *JAdESSigner) SetTrustedCertHandle(TrustedCertIndex int32, value int64) error ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *TrustedCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TrustedCertCount](#trustedcertcount-property-jadessigner-component) property. ## Data Type **int64** # ValidationMoment Property ([JAdESSigner](#jadessigner-component) Component) The time point at which signature validity is to be established. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) ValidationMoment() (string, error)func (obj *JAdESSigner) 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** # AddSignedHTTPHeaderField Method ([JAdESSigner](#jadessigner-component) Component) Use this method to add HTTP header field. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) AddSignedHTTPHeaderField(FieldName string) error ``` ## Remarks This method allows you to add HTTP header field to the list of fields that will be signed. The method takes one parameter: the name of the header field. This method changes the type of signed data to HttpHeaders mechanism and triggers the [HTTPHeaderFieldNeeded](#httpheaderfieldneeded-event-jadessigner-component) event when the value of the HTTP header field is needed. Use "(request target)" value as a field name to add request method and target URI into the list of fields that will be signed. # AddSignedObject Method ([JAdESSigner](#jadessigner-component) Component) Use this method to add an object. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) AddSignedObject(URI string, ContentType string) error ``` ## Remarks This method allows you to add an object to the list of objects that will be signed. The signed object is identified by its URI. This method changes the type of signed data to ObjectByURI mechanism and triggers the [ObjectNeeded](#objectneeded-event-jadessigner-component) event when the data of the object is needed. # AddSignedObjectHash Method ([JAdESSigner](#jadessigner-component) Component) Use this method to add an object hash. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) AddSignedObjectHash(URI string, ContentType string, Hash []byte) error ``` ## Remarks This method allows you to add an object hash to the list of objects that will be signed. The signed object is identified by its URI. This method changes the type of signed data to ObjectByURIHash mechanism and triggers the [ObjectValidate](#objectvalidate-event-jadessigner-component) event when the object must be validated. Also, it triggers the [ObjectNeeded](#objectneeded-event-jadessigner-component) event when the data of the object is needed this could occur while adding/validating SignedData or Archive timestamps. # Close Method ([JAdESSigner](#jadessigner-component) Component) Closes an opened JWS/JAdES signature. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Close(SaveChanges bool) error ``` ## Remarks Use this method to close a previously opened JWS/JAdES signature. Set *SaveChanges* to true to apply any changes made. # Config Method ([JAdESSigner](#jadessigner-component) Component) Sets or retrieves a configuration setting. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Config(ConfigurationString string) (string, error) ``` ## Remarks Config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-jadessigner-component) 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](#config-settings-jadessigner-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # CreateNew Method ([JAdESSigner](#jadessigner-component) Component) Create a new JSON for signing. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) CreateNew() error ``` ## Remarks Use this method to create a new JSON for signing. When finished, call [Close](#close-method-jadessigner-component) to complete or discard the operation. # DoAction Method ([JAdESSigner](#jadessigner-component) Component) Performs an additional action. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Extracts user data from the DC signing service response. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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. # Open Method ([JAdESSigner](#jadessigner-component) Component) Opens a JSON for signing or updating. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Open() error ``` ## Remarks Use this method to open a JSON for signing or updating. When finished, call [Close](#close-method-jadessigner-component) to complete or discard the operation. # Reset Method ([JAdESSigner](#jadessigner-component) Component) Resets the class settings. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Reset() error ``` ## Remarks Reset is a generic method available in every struct. # Revalidate Method ([JAdESSigner](#jadessigner-component) Component) Revalidates a signature in accordance with current settings. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Revalidate(SigLabel string) error ``` ## Remarks Use this method to re-validate a signature in the opened JWS/JAdES signature. # SelectInfo Method ([JAdESSigner](#jadessigner-component) Component) Select signature information for a specific entity. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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 ([JAdESSigner](#jadessigner-component) Component) Creates a new JAdES/JWS signature over the provided data. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Sign() error ``` ## Remarks Call this method to produce a new signature over the provided data. # SignAsyncBegin Method ([JAdESSigner](#jadessigner-component) Component) Initiates the asynchronous signing operation. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#outputfile-property-jadessigner-component) (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](#inputfile-property-jadessigner-component) (or InputStream), and call [SignAsyncEnd](#signasyncend-method-jadessigner-component) 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](#signasyncend-method-jadessigner-component) 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](#signasyncend-method-jadessigner-component) method. # SignAsyncEnd Method ([JAdESSigner](#jadessigner-component) Component) Completes the asynchronous signing operation. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) 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](#signasyncbegin-method-jadessigner-component) call to [InputFile](#inputfile-property-jadessigner-component) (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to [OutputFile](#outputfile-property-jadessigner-component) (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](#signasyncbegin-method-jadessigner-component)) stage. *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](#signasyncbegin-method-jadessigner-component) 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. # SignExternal Method ([JAdESSigner](#jadessigner-component) Component) Signs the data using an external signing facility. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) SignExternal() error ``` ## Remarks Call this method to delegate 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](#externalsign-event-jadessigner-component) event which allows to pass the hash value for signing. # Timestamp Method ([JAdESSigner](#jadessigner-component) Component) Use this method to add timestamp. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Timestamp(SigLabel string, TimestampType int32) error ``` ## Remarks Call this method to timestamp the signature. Use the [TimestampServer](#timestampserver-property-jadessigner-component) 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 Supported timestamp types: | | | | | --- | --- | --- | | tstSignature | 12 | Signature timestamp | | tstRefsOnly | 13 | RefsOnly timestamp | | tstSigAndRefs | 14 | SigAndRefs timestamp | | tstArchive | 7 | Archive timestamp | # Upgrade Method ([JAdESSigner](#jadessigner-component) Component) Upgrades existing JAdES signature to a new level. ## Syntax *Go Syntax* ```text func (obj *JAdESSigner) Upgrade(SigLabel string, UpgradeKind int32) error ``` ## Remarks Use this method to upgrade JAdES signature to a new level specified by *UpgradeKind*. Signatures can normally be upgraded from less sophisticated levels (B, T, LT) to more sophisticated (T, LT, LTA). Supported levels: | | | | | --- | --- | --- | | jaslUnknown | 0 | Unknown signature level | | jaslGeneric | 1 | Generic signature: JSON Web Signature (JWS) | | jaslBaselineB | 2 | Baseline B (B-B, basic) | | jaslBaselineT | 3 | Baseline T (B-T, timestamped) | | jaslBaselineLT | 4 | Baseline LT (B-LT, long-term) | | jaslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) | The supported additional upgrade kinds are: | | | | | --- | --- | --- | | jukAddValidationDataRefs | 256 | Add signature validation references | | jukAddValidationDataValues | 512 | Add signature validation values | | jukAddTimestampValidationData | 1024 | Add timestamp validation data | | jukAddAnyValidationData | 2048 | Add AnyValidationData | # ChainElementDownload Event ([JAdESSigner](#jadessigner-component) Component) Fires when there is a need to download a chain element from an online source. ## Syntax *Go Syntax* ```text // JAdESSignerChainElementDownloadEventArgs carries the JAdESSigner ChainElementDownload event's parameters. type JAdESSignerChainElementDownloadEventArgs struct {...} func (args *JAdESSignerChainElementDownloadEventArgs) Kind() int32 func (args *JAdESSignerChainElementDownloadEventArgs) CertRDN() string func (args *JAdESSignerChainElementDownloadEventArgs) CACertRDN() string func (args *JAdESSignerChainElementDownloadEventArgs) Location() string func (args *JAdESSignerChainElementDownloadEventArgs) Action() int32 func (args *JAdESSignerChainElementDownloadEventArgs) SetAction(value int32) // JAdESSignerChainElementDownloadEvent defines the signature of the JAdESSigner ChainElementDownload event's handler function. type JAdESSignerChainElementDownloadEvent func(sender *JAdESSigner, args *JAdESSignerChainElementDownloadEventArgs) func (obj *JAdESSigner) GetOnChainElementDownloadHandler() JAdESSignerChainElementDownloadEvent func (obj *JAdESSigner) SetOnChainElementDownloadHandler(handlerFunc JAdESSignerChainElementDownloadEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) Fires when an element required to validate the chain was not located. ## Syntax *Go Syntax* ```text // JAdESSignerChainElementNeededEventArgs carries the JAdESSigner ChainElementNeeded event's parameters. type JAdESSignerChainElementNeededEventArgs struct {...} func (args *JAdESSignerChainElementNeededEventArgs) Kind() int32 func (args *JAdESSignerChainElementNeededEventArgs) CertRDN() string func (args *JAdESSignerChainElementNeededEventArgs) CACertRDN() string // JAdESSignerChainElementNeededEvent defines the signature of the JAdESSigner ChainElementNeeded event's handler function. type JAdESSignerChainElementNeededEvent func(sender *JAdESSigner, args *JAdESSignerChainElementNeededEventArgs) func (obj *JAdESSigner) GetOnChainElementNeededHandler() JAdESSignerChainElementNeededEvent func (obj *JAdESSigner) SetOnChainElementNeededHandler(handlerFunc JAdESSignerChainElementNeededEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. ## Syntax *Go Syntax* ```text // JAdESSignerChainElementStoreEventArgs carries the JAdESSigner ChainElementStore event's parameters. type JAdESSignerChainElementStoreEventArgs struct {...} func (args *JAdESSignerChainElementStoreEventArgs) Kind() int32 func (args *JAdESSignerChainElementStoreEventArgs) Body() []byte func (args *JAdESSignerChainElementStoreEventArgs) URI() string func (args *JAdESSignerChainElementStoreEventArgs) SetURI(value string) // JAdESSignerChainElementStoreEvent defines the signature of the JAdESSigner ChainElementStore event's handler function. type JAdESSignerChainElementStoreEvent func(sender *JAdESSigner, args *JAdESSignerChainElementStoreEventArgs) func (obj *JAdESSigner) GetOnChainElementStoreHandler() JAdESSignerChainElementStoreEvent func (obj *JAdESSigner) SetOnChainElementStoreHandler(handlerFunc JAdESSignerChainElementStoreEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) Reports the completion of a certificate chain validation. ## Syntax *Go Syntax* ```text // JAdESSignerChainValidatedEventArgs carries the JAdESSigner ChainValidated event's parameters. type JAdESSignerChainValidatedEventArgs struct {...} func (args *JAdESSignerChainValidatedEventArgs) Index() int32 func (args *JAdESSignerChainValidatedEventArgs) EntityLabel() string func (args *JAdESSignerChainValidatedEventArgs) SubjectRDN() string func (args *JAdESSignerChainValidatedEventArgs) ValidationResult() int32 func (args *JAdESSignerChainValidatedEventArgs) ValidationDetails() int32 func (args *JAdESSignerChainValidatedEventArgs) Cancel() bool func (args *JAdESSignerChainValidatedEventArgs) SetCancel(value bool) // JAdESSignerChainValidatedEvent defines the signature of the JAdESSigner ChainValidated event's handler function. type JAdESSignerChainValidatedEvent func(sender *JAdESSigner, args *JAdESSignerChainValidatedEventArgs) func (obj *JAdESSigner) GetOnChainValidatedHandler() JAdESSignerChainValidatedEvent func (obj *JAdESSigner) SetOnChainValidatedHandler(handlerFunc JAdESSignerChainValidatedEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) This event is fired multiple times during chain validation to report various stages of the validation procedure. ## Syntax *Go Syntax* ```text // JAdESSignerChainValidationProgressEventArgs carries the JAdESSigner ChainValidationProgress event's parameters. type JAdESSignerChainValidationProgressEventArgs struct {...} func (args *JAdESSignerChainValidationProgressEventArgs) EventKind() string func (args *JAdESSignerChainValidationProgressEventArgs) CertRDN() string func (args *JAdESSignerChainValidationProgressEventArgs) CACertRDN() string func (args *JAdESSignerChainValidationProgressEventArgs) Action() int32 func (args *JAdESSignerChainValidationProgressEventArgs) SetAction(value int32) // JAdESSignerChainValidationProgressEvent defines the signature of the JAdESSigner ChainValidationProgress event's handler function. type JAdESSignerChainValidationProgressEvent func(sender *JAdESSigner, args *JAdESSignerChainValidationProgressEventArgs) func (obj *JAdESSigner) GetOnChainValidationProgressHandler() JAdESSignerChainValidationProgressEvent func (obj *JAdESSigner) SetOnChainValidationProgressHandler(handlerFunc JAdESSignerChainValidationProgressEvent) ``` ## 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 | # Error Event ([JAdESSigner](#jadessigner-component) Component) Information about errors during signing. ## Syntax *Go Syntax* ```text // JAdESSignerErrorEventArgs carries the JAdESSigner Error event's parameters. type JAdESSignerErrorEventArgs struct {...} func (args *JAdESSignerErrorEventArgs) ErrorCode() int32 func (args *JAdESSignerErrorEventArgs) Description() string // JAdESSignerErrorEvent defines the signature of the JAdESSigner Error event's handler function. type JAdESSignerErrorEvent func(sender *JAdESSigner, args *JAdESSignerErrorEventArgs) func (obj *JAdESSigner) GetOnErrorHandler() JAdESSignerErrorEvent func (obj *JAdESSigner) SetOnErrorHandler(handlerFunc JAdESSignerErrorEvent) ``` ## Remarks This event is fired in case of exceptional conditions during the JSON processing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # ExternalSign Event ([JAdESSigner](#jadessigner-component) Component) Handles remote or external signing initiated by the SignExternal method or other source. ## Syntax *Go Syntax* ```text // JAdESSignerExternalSignEventArgs carries the JAdESSigner ExternalSign event's parameters. type JAdESSignerExternalSignEventArgs struct {...} func (args *JAdESSignerExternalSignEventArgs) OperationId() string func (args *JAdESSignerExternalSignEventArgs) HashAlgorithm() string func (args *JAdESSignerExternalSignEventArgs) Pars() string func (args *JAdESSignerExternalSignEventArgs) Data() string func (args *JAdESSignerExternalSignEventArgs) SignedData() string func (args *JAdESSignerExternalSignEventArgs) SetSignedData(value string) // JAdESSignerExternalSignEvent defines the signature of the JAdESSigner ExternalSign event's handler function. type JAdESSignerExternalSignEvent func(sender *JAdESSigner, args *JAdESSignerExternalSignEventArgs) func (obj *JAdESSigner) GetOnExternalSignHandler() JAdESSignerExternalSignEvent func (obj *JAdESSigner) SetOnExternalSignHandler(handlerFunc JAdESSignerExternalSignEvent) ``` ## 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: ```text 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(); }; ``` # HTTPHeaderFieldNeeded Event ([JAdESSigner](#jadessigner-component) Component) This event is fired when HTTP header field value is required. ## Syntax *Go Syntax* ```text // JAdESSignerHTTPHeaderFieldNeededEventArgs carries the JAdESSigner HTTPHeaderFieldNeeded event's parameters. type JAdESSignerHTTPHeaderFieldNeededEventArgs struct {...} func (args *JAdESSignerHTTPHeaderFieldNeededEventArgs) FieldName() string func (args *JAdESSignerHTTPHeaderFieldNeededEventArgs) FieldValues() string func (args *JAdESSignerHTTPHeaderFieldNeededEventArgs) SetFieldValues(value string) // JAdESSignerHTTPHeaderFieldNeededEvent defines the signature of the JAdESSigner HTTPHeaderFieldNeeded event's handler function. type JAdESSignerHTTPHeaderFieldNeededEvent func(sender *JAdESSigner, args *JAdESSignerHTTPHeaderFieldNeededEventArgs) func (obj *JAdESSigner) GetOnHTTPHeaderFieldNeededHandler() JAdESSignerHTTPHeaderFieldNeededEvent func (obj *JAdESSigner) SetOnHTTPHeaderFieldNeededHandler(handlerFunc JAdESSignerHTTPHeaderFieldNeededEvent) ``` ## Remarks This event is triggered when the type of signed data is HttpHeaders mechanism (jasdtHttpHeaders). It indicates that a HTTP header field value is needed. For "(request target)" field name value return request method and target URI separated by space character. For example: "GET https://nsoftware.com/sbb/" # Loaded Event ([JAdESSigner](#jadessigner-component) Component) This event is fired when the JSON has been loaded into memory. ## Syntax *Go Syntax* ```text // JAdESSignerLoadedEventArgs carries the JAdESSigner Loaded event's parameters. type JAdESSignerLoadedEventArgs struct {...} func (args *JAdESSignerLoadedEventArgs) Cancel() bool func (args *JAdESSignerLoadedEventArgs) SetCancel(value bool) // JAdESSignerLoadedEvent defines the signature of the JAdESSigner Loaded event's handler function. type JAdESSignerLoadedEvent func(sender *JAdESSigner, args *JAdESSignerLoadedEventArgs) func (obj *JAdESSigner) GetOnLoadedHandler() JAdESSignerLoadedEvent func (obj *JAdESSigner) SetOnLoadedHandler(handlerFunc JAdESSignerLoadedEvent) ``` ## Remarks The handler for this event is a good place to check JWS/JAdES signature properties, which may be useful when preparing the signature. Set *Cancel* to true to terminate JSON processing on this stage. # Notification Event ([JAdESSigner](#jadessigner-component) Component) This event notifies the application about an underlying control flow event. ## Syntax *Go Syntax* ```text // JAdESSignerNotificationEventArgs carries the JAdESSigner Notification event's parameters. type JAdESSignerNotificationEventArgs struct {...} func (args *JAdESSignerNotificationEventArgs) EventID() string func (args *JAdESSignerNotificationEventArgs) EventParam() string // JAdESSignerNotificationEvent defines the signature of the JAdESSigner Notification event's handler function. type JAdESSignerNotificationEvent func(sender *JAdESSigner, args *JAdESSignerNotificationEventArgs) func (obj *JAdESSigner) GetOnNotificationHandler() JAdESSignerNotificationEvent func (obj *JAdESSigner) SetOnNotificationHandler(handlerFunc JAdESSignerNotificationEvent) ``` ## 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: | | | | --- | --- | | Loaded | Reports the completion of signature processing by the component. Use the event handler to access signature-related information. The EventParam value passed with this EventID is empty. | | PayloadExtracted | Reports the completion of payload extraction by the component if [ExtractPayload](#extractpayload-property-jadessigner-component) property is enabled. Use the event handler to access payload. The EventParam value passed with this EventID is empty. | | BeforeAddArchiveTimestamp | TBD | | BeforeAddSignatureTimestamp | TBD | | BeforeAddSignedDataTimestamp | TBD | | SignaturesLoaded | Notifies the application that the component has finished loading signatures. | | 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](#timestampserver-property-jadessigner-component) was set to a virtual:// URI. The EventParam parameter contains the TSP request (or the plain hash, depending on the value provided to [TimestampServer](#timestampserver-property-jadessigner-component)), 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. | # ObjectNeeded Event ([JAdESSigner](#jadessigner-component) Component) This event is fired when object is required. ## Syntax *Go Syntax* ```text // JAdESSignerObjectNeededEventArgs carries the JAdESSigner ObjectNeeded event's parameters. type JAdESSignerObjectNeededEventArgs struct {...} func (args *JAdESSignerObjectNeededEventArgs) URI() string func (args *JAdESSignerObjectNeededEventArgs) ContentType() string func (args *JAdESSignerObjectNeededEventArgs) Base64() bool func (args *JAdESSignerObjectNeededEventArgs) SetBase64(value bool) // JAdESSignerObjectNeededEvent defines the signature of the JAdESSigner ObjectNeeded event's handler function. type JAdESSignerObjectNeededEvent func(sender *JAdESSigner, args *JAdESSignerObjectNeededEventArgs) func (obj *JAdESSigner) GetOnObjectNeededHandler() JAdESSignerObjectNeededEvent func (obj *JAdESSigner) SetOnObjectNeededHandler(handlerFunc JAdESSignerObjectNeededEvent) ``` ## Remarks This event is triggered when the type of signed data is ObjectIdByURI mechanism (jasdtObjectIdByURI). It is fired to request the data to be signed/verified. The event handler must pass object data to the component via [DataFile](#datafile-property-jadessigner-component) or DataStream or [DataBytes](#databytes-property-jadessigner-component) or [DataString](#datastring-property-jadessigner-component) property. # ObjectValidate Event ([JAdESSigner](#jadessigner-component) Component) This event is fired when object should be verified by user. ## Syntax *Go Syntax* ```text // JAdESSignerObjectValidateEventArgs carries the JAdESSigner ObjectValidate event's parameters. type JAdESSignerObjectValidateEventArgs struct {...} func (args *JAdESSignerObjectValidateEventArgs) URI() string func (args *JAdESSignerObjectValidateEventArgs) ContentType() string func (args *JAdESSignerObjectValidateEventArgs) HashAlgorithm() string func (args *JAdESSignerObjectValidateEventArgs) Hash() []byte func (args *JAdESSignerObjectValidateEventArgs) Base64() bool func (args *JAdESSignerObjectValidateEventArgs) Valid() bool func (args *JAdESSignerObjectValidateEventArgs) SetValid(value bool) // JAdESSignerObjectValidateEvent defines the signature of the JAdESSigner ObjectValidate event's handler function. type JAdESSignerObjectValidateEvent func(sender *JAdESSigner, args *JAdESSignerObjectValidateEventArgs) func (obj *JAdESSigner) GetOnObjectValidateHandler() JAdESSignerObjectValidateEvent func (obj *JAdESSigner) SetOnObjectValidateHandler(handlerFunc JAdESSignerObjectValidateEvent) ``` ## Remarks This event is triggered when the type of signed data is ObjectIdByURIHash mechanism (jasdtObjectIdByURIHash). It is fired to validate the detached object. The event handler must pass the object validity to the component via *Valid* parameter. # SignatureFound Event ([JAdESSigner](#jadessigner-component) Component) Signifies the start of signature validation. ## Syntax *Go Syntax* ```text // JAdESSignerSignatureFoundEventArgs carries the JAdESSigner SignatureFound event's parameters. type JAdESSignerSignatureFoundEventArgs struct {...} func (args *JAdESSignerSignatureFoundEventArgs) Index() int32 func (args *JAdESSignerSignatureFoundEventArgs) EntityLabel() string func (args *JAdESSignerSignatureFoundEventArgs) IssuerRDN() string func (args *JAdESSignerSignatureFoundEventArgs) SerialNumber() []byte func (args *JAdESSignerSignatureFoundEventArgs) SubjectKeyID() []byte func (args *JAdESSignerSignatureFoundEventArgs) CertFound() bool func (args *JAdESSignerSignatureFoundEventArgs) ValidateSignature() bool func (args *JAdESSignerSignatureFoundEventArgs) SetValidateSignature(value bool) func (args *JAdESSignerSignatureFoundEventArgs) ValidateChain() bool func (args *JAdESSignerSignatureFoundEventArgs) SetValidateChain(value bool) // JAdESSignerSignatureFoundEvent defines the signature of the JAdESSigner SignatureFound event's handler function. type JAdESSignerSignatureFoundEvent func(sender *JAdESSigner, args *JAdESSignerSignatureFoundEventArgs) func (obj *JAdESSigner) GetOnSignatureFoundHandler() JAdESSignerSignatureFoundEvent func (obj *JAdESSigner) SetOnSignatureFoundHandler(handlerFunc JAdESSignerSignatureFoundEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) Marks the completion of the signature validation routine. ## Syntax *Go Syntax* ```text // JAdESSignerSignatureValidatedEventArgs carries the JAdESSigner SignatureValidated event's parameters. type JAdESSignerSignatureValidatedEventArgs struct {...} func (args *JAdESSignerSignatureValidatedEventArgs) Index() int32 func (args *JAdESSignerSignatureValidatedEventArgs) EntityLabel() string func (args *JAdESSignerSignatureValidatedEventArgs) IssuerRDN() string func (args *JAdESSignerSignatureValidatedEventArgs) SerialNumber() []byte func (args *JAdESSignerSignatureValidatedEventArgs) SubjectKeyID() []byte func (args *JAdESSignerSignatureValidatedEventArgs) ValidationResult() int32 func (args *JAdESSignerSignatureValidatedEventArgs) Cancel() bool func (args *JAdESSignerSignatureValidatedEventArgs) SetCancel(value bool) // JAdESSignerSignatureValidatedEvent defines the signature of the JAdESSigner SignatureValidated event's handler function. type JAdESSignerSignatureValidatedEvent func(sender *JAdESSigner, args *JAdESSignerSignatureValidatedEventArgs) func (obj *JAdESSigner) GetOnSignatureValidatedHandler() JAdESSignerSignatureValidatedEvent func (obj *JAdESSigner) SetOnSignatureValidatedHandler(handlerFunc JAdESSignerSignatureValidatedEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) Signifies the start of a timestamp validation routine. ## Syntax *Go Syntax* ```text // JAdESSignerTimestampFoundEventArgs carries the JAdESSigner TimestampFound event's parameters. type JAdESSignerTimestampFoundEventArgs struct {...} func (args *JAdESSignerTimestampFoundEventArgs) Index() int32 func (args *JAdESSignerTimestampFoundEventArgs) EntityLabel() string func (args *JAdESSignerTimestampFoundEventArgs) IssuerRDN() string func (args *JAdESSignerTimestampFoundEventArgs) SerialNumber() []byte func (args *JAdESSignerTimestampFoundEventArgs) SubjectKeyID() []byte func (args *JAdESSignerTimestampFoundEventArgs) CertFound() bool func (args *JAdESSignerTimestampFoundEventArgs) ValidateTimestamp() bool func (args *JAdESSignerTimestampFoundEventArgs) SetValidateTimestamp(value bool) func (args *JAdESSignerTimestampFoundEventArgs) ValidateChain() bool func (args *JAdESSignerTimestampFoundEventArgs) SetValidateChain(value bool) // JAdESSignerTimestampFoundEvent defines the signature of the JAdESSigner TimestampFound event's handler function. type JAdESSignerTimestampFoundEvent func(sender *JAdESSigner, args *JAdESSignerTimestampFoundEventArgs) func (obj *JAdESSigner) GetOnTimestampFoundHandler() JAdESSignerTimestampFoundEvent func (obj *JAdESSigner) SetOnTimestampFoundHandler(handlerFunc JAdESSignerTimestampFoundEvent) ``` ## Remarks This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its *IssuerRDN*, *SerialNumber*, and *SubjectKeyID* parameters. The *CertFound* parameter is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the KnownCertificates property. Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively. Use the *ValidateSignature* and *ValidateChain* parameters to tell the verifier which stages to include in the validation. # TimestampRequest Event ([JAdESSigner](#jadessigner-component) Component) Fires when the class is ready to request a timestamp from an external TSA. ## Syntax *Go Syntax* ```text // JAdESSignerTimestampRequestEventArgs carries the JAdESSigner TimestampRequest event's parameters. type JAdESSignerTimestampRequestEventArgs struct {...} func (args *JAdESSignerTimestampRequestEventArgs) TSA() string func (args *JAdESSignerTimestampRequestEventArgs) TimestampRequest() string func (args *JAdESSignerTimestampRequestEventArgs) TimestampResponse() string func (args *JAdESSignerTimestampRequestEventArgs) SetTimestampResponse(value string) func (args *JAdESSignerTimestampRequestEventArgs) SuppressDefault() bool func (args *JAdESSignerTimestampRequestEventArgs) SetSuppressDefault(value bool) // JAdESSignerTimestampRequestEvent defines the signature of the JAdESSigner TimestampRequest event's handler function. type JAdESSignerTimestampRequestEvent func(sender *JAdESSigner, args *JAdESSignerTimestampRequestEventArgs) func (obj *JAdESSigner) GetOnTimestampRequestHandler() JAdESSignerTimestampRequestEvent func (obj *JAdESSigner) SetOnTimestampRequestHandler(handlerFunc JAdESSignerTimestampRequestEvent) ``` ## 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](#timestampserver-property-jadessigner-component) 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 ([JAdESSigner](#jadessigner-component) Component) Reports the completion of the timestamp validation routine. ## Syntax *Go Syntax* ```text // JAdESSignerTimestampValidatedEventArgs carries the JAdESSigner TimestampValidated event's parameters. type JAdESSignerTimestampValidatedEventArgs struct {...} func (args *JAdESSignerTimestampValidatedEventArgs) Index() int32 func (args *JAdESSignerTimestampValidatedEventArgs) EntityLabel() string func (args *JAdESSignerTimestampValidatedEventArgs) IssuerRDN() string func (args *JAdESSignerTimestampValidatedEventArgs) SerialNumber() []byte func (args *JAdESSignerTimestampValidatedEventArgs) SubjectKeyID() []byte func (args *JAdESSignerTimestampValidatedEventArgs) Time() string func (args *JAdESSignerTimestampValidatedEventArgs) ValidationResult() int32 func (args *JAdESSignerTimestampValidatedEventArgs) ChainValidationResult() int32 func (args *JAdESSignerTimestampValidatedEventArgs) ChainValidationDetails() int32 func (args *JAdESSignerTimestampValidatedEventArgs) Cancel() bool func (args *JAdESSignerTimestampValidatedEventArgs) SetCancel(value bool) // JAdESSignerTimestampValidatedEvent defines the signature of the JAdESSigner TimestampValidated event's handler function. type JAdESSignerTimestampValidatedEvent func(sender *JAdESSigner, args *JAdESSignerTimestampValidatedEventArgs) func (obj *JAdESSigner) GetOnTimestampValidatedHandler() JAdESSignerTimestampValidatedEvent func (obj *JAdESSigner) SetOnTimestampValidatedHandler(handlerFunc JAdESSignerTimestampValidatedEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) Fires when a remote TLS party requests a client certificate. ## Syntax *Go Syntax* ```text // JAdESSignerTLSCertNeededEventArgs carries the JAdESSigner TLSCertNeeded event's parameters. type JAdESSignerTLSCertNeededEventArgs struct {...} func (args *JAdESSignerTLSCertNeededEventArgs) Host() string func (args *JAdESSignerTLSCertNeededEventArgs) CANames() string // JAdESSignerTLSCertNeededEvent defines the signature of the JAdESSigner TLSCertNeeded event's handler function. type JAdESSignerTLSCertNeededEvent func(sender *JAdESSigner, args *JAdESSignerTLSCertNeededEventArgs) func (obj *JAdESSigner) GetOnTLSCertNeededHandler() JAdESSignerTLSCertNeededEvent func (obj *JAdESSigner) SetOnTLSCertNeededHandler(handlerFunc JAdESSignerTLSCertNeededEvent) ``` ## 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](#tlshandshake-event-jadessigner-component) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-jadessigner-component) event. # TLSCertValidate Event ([JAdESSigner](#jadessigner-component) Component) This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. ## Syntax *Go Syntax* ```text // JAdESSignerTLSCertValidateEventArgs carries the JAdESSigner TLSCertValidate event's parameters. type JAdESSignerTLSCertValidateEventArgs struct {...} func (args *JAdESSignerTLSCertValidateEventArgs) ServerHost() string func (args *JAdESSignerTLSCertValidateEventArgs) ServerIP() string func (args *JAdESSignerTLSCertValidateEventArgs) Accept() bool func (args *JAdESSignerTLSCertValidateEventArgs) SetAccept(value bool) // JAdESSignerTLSCertValidateEvent defines the signature of the JAdESSigner TLSCertValidate event's handler function. type JAdESSignerTLSCertValidateEvent func(sender *JAdESSigner, args *JAdESSignerTLSCertValidateEventArgs) func (obj *JAdESSigner) GetOnTLSCertValidateHandler() JAdESSignerTLSCertValidateEvent func (obj *JAdESSigner) SetOnTLSCertValidateHandler(handlerFunc JAdESSignerTLSCertValidateEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) Fires when a TLS handshake with Host successfully completes. ## Syntax *Go Syntax* ```text // JAdESSignerTLSEstablishedEventArgs carries the JAdESSigner TLSEstablished event's parameters. type JAdESSignerTLSEstablishedEventArgs struct {...} func (args *JAdESSignerTLSEstablishedEventArgs) Host() string func (args *JAdESSignerTLSEstablishedEventArgs) Version() string func (args *JAdESSignerTLSEstablishedEventArgs) Ciphersuite() string func (args *JAdESSignerTLSEstablishedEventArgs) ConnectionId() []byte func (args *JAdESSignerTLSEstablishedEventArgs) Abort() bool func (args *JAdESSignerTLSEstablishedEventArgs) SetAbort(value bool) // JAdESSignerTLSEstablishedEvent defines the signature of the JAdESSigner TLSEstablished event's handler function. type JAdESSignerTLSEstablishedEvent func(sender *JAdESSigner, args *JAdESSignerTLSEstablishedEventArgs) func (obj *JAdESSigner) GetOnTLSEstablishedHandler() JAdESSignerTLSEstablishedEvent func (obj *JAdESSigner) SetOnTLSEstablishedHandler(handlerFunc JAdESSignerTLSEstablishedEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) Component) Fires when a new TLS handshake is initiated, before the handshake commences. ## Syntax *Go Syntax* ```text // JAdESSignerTLSHandshakeEventArgs carries the JAdESSigner TLSHandshake event's parameters. type JAdESSignerTLSHandshakeEventArgs struct {...} func (args *JAdESSignerTLSHandshakeEventArgs) Host() string func (args *JAdESSignerTLSHandshakeEventArgs) Abort() bool func (args *JAdESSignerTLSHandshakeEventArgs) SetAbort(value bool) // JAdESSignerTLSHandshakeEvent defines the signature of the JAdESSigner TLSHandshake event's handler function. type JAdESSignerTLSHandshakeEvent func(sender *JAdESSigner, args *JAdESSignerTLSHandshakeEventArgs) func (obj *JAdESSigner) GetOnTLSHandshakeHandler() JAdESSignerTLSHandshakeEvent func (obj *JAdESSigner) SetOnTLSHandshakeHandler(handlerFunc JAdESSignerTLSHandshakeEvent) ``` ## 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](#tlsestablished-event-jadessigner-component) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-jadessigner-component) event will also be fired. # TLSShutdown Event ([JAdESSigner](#jadessigner-component) Component) Reports the graceful closure of a TLS connection. ## Syntax *Go Syntax* ```text // JAdESSignerTLSShutdownEventArgs carries the JAdESSigner TLSShutdown event's parameters. type JAdESSignerTLSShutdownEventArgs struct {...} func (args *JAdESSignerTLSShutdownEventArgs) Host() string // JAdESSignerTLSShutdownEvent defines the signature of the JAdESSigner TLSShutdown event's handler function. type JAdESSignerTLSShutdownEvent func(sender *JAdESSigner, args *JAdESSignerTLSShutdownEventArgs) func (obj *JAdESSigner) GetOnTLSShutdownHandler() JAdESSignerTLSShutdownEvent func (obj *JAdESSigner) SetOnTLSShutdownHandler(handlerFunc JAdESSignerTLSShutdownEvent) ``` ## 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 ([JAdESSigner](#jadessigner-component) 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](#config-method-jadessigner-component) method. ### JAdESSigner Config Settings **AddSignedDataTimestamp**: Whether to add signed data timestamp during signing.If this property is set to True, the signed data timestamp will be added. **AsyncDocumentID**: Specifies the document ID for SignAsyncEnd() call.Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. **CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched. The default value is 1 day (86400 seconds). A value of 0 disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched. The default value is 50 percent. Values are interpreted in the 0..100 range. A value of 0 disables the CRL ratio check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched. The default value is 10 minutes (600 seconds). A value of 0 disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them. **CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched. The default value is 1 hour (3600 seconds). A value of 0 disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched. The default value is 50 percent. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. A value of 0 disables the OCSP response ratio check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched. The default value is 10 minutes (600 seconds). A value of 0 disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them. **CertThumbprint**: Specifies the certificate thumbprint.The certificate thumbprint that was included into the signature. **CertURL**: Specifies the certificate URL.The certificate URL that was included or to be included into the signature. The certificate URL is the "x5u" (X.509 URL) Header Parameter that refers to a resource for the X.509 public key certificate or certificate chain corresponding to the key used to digitally sign the JWS or JAdES. **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. **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. **DataBase64**: Specifies whether data is Base64-URL-encoded.This property controls the "b64" header parameter and it determines the representation of the JWS payload or object data. Its value must be the same for all signatures if there are multiple of them in the JSON. If the value is set to "true", the JWS payload will be represented as a Base64-URL-encoded string. If the value is "false", the JWS payload will be represented without any encoding. The default value of this property is "true". **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. **ForceCompleteChainValidation**: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid. **ForceCompleteChainValidationForTrusted**: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments. **GracePeriod**: Specifies a grace period to apply during revocation information checks.Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated. **IgnoreChainLoops**: Whether chain loops should be ignored.Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves. **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](#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. **JAdESOptions**: Specifies the JAdES options.Contains a comma-separated list of values that specifies JAdES options. Supported values are: | | | | | --- | --- | --- | | WriteBase64Param | | The parameter controls the inclusion of the "b64" header parameter in the signature. When this flag is set, the "b64" header parameter will always be included in the header. Otherwise, the "b64" header parameter will only be included in the header when it is required. | | PreferEtsiUClearInstance | | The parameter determines whether the EtsiU components should be written as clear JSON instances or as Base64-encoded strings. When this flag is set, EtsiU components will be written as clear JSON instances, if possible. Otherwise, the EtsiU components will be Base64url-encoded strings. | **KeyId**: Specifies Key ID.The Key ID that was included or to be included into the signature. Key ID is a hint indicating which key was used to secure the JWS or JAdES. **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. **ProtectedHeader**: Specifies the protected header.The protected header that was included or to be included into the signature. **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*. **RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Default. Supported values are case-insensitive: | | | | --- | --- | | Default | Applies the AdES default freshness settings: crl:86400;50;600,ocsp:3600;50;600. This means: CRL maximum age 1 day, CRL age ratio 50%, CRL overlap 10 minutes; OCSP response maximum age 1 hour, OCSP response age ratio 50%, OCSP response overlap 10 minutes. This value is the default. | | Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. | | Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. | | Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. | | N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. | | crl:;;,ocsp:;; | Sets the CRL and OCSP response freshness values explicitly. | Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values. **SchemeParams**: The algorithm scheme parameters to employ.Use this property to specify the parameters of the algorithm scheme if needed. This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: *Scheme=PSS;SaltSize=32;TrailerField=1*. **SignerAttrs**: Identifies the signer attributes.The signer attributes in JSON format that was included or to be included into the signature. **SignerCommitments**: Identifies the signer commitments.The signer commitments in JSON format that was included or to be included into the signature. **SigningCertIncludeIssuerSerial**: Specifies whether to include signing certificate issuer and serial number.If this property is set to True, the signing certificate issuer and serial number will be included into the signature. **SigningCertIncludeThumbprint**: Specifies whether to include signing certificate thumbprint.If this property is set to True, the signing certificate thumbprint will be included into the signature. **SigningCertIncludeValue**: Specifies whether to include signing certificate value.If this property is set to True, the signing certificate value will be included into the signature. **SigningChainIncludeThumbprints**: Specifies whether to include signing chain thumbprints.If this property is set to True, the signing chain thumbprints will be included into the signature. **SigningChainIncludeValue**: Specifies whether to include signing chain values.If this property is set to True, the signing chain values will be included into the signature. **SigPolicyDescription**: signature policy description.This property specifies the Description of the signature policy (an alias for PolicyDescription). **SigPolicyExplicitText**: The explicit text of the user notice.Use this property to specify the explicit text of the user notice to be displayed when the signature is verified (an alias for PolicyExplicitText); **SigPolicyHash**: The EPES policy hash.Use this configuration setting to provide the EPES policy hash. **SigPolicyHashAlgorithm**: The hash algorithm that was used to generate the EPES policy hash.Use this setting to provide the hash algorithm that was used to generate the policy hash. **SigPolicyID**: The EPES policy ID.The EPES signature policy identifier, in dotted OID format (1.2.3.4.5). **SigPolicyNoticeNumbers**: The noticeNumbers part of the NoticeReference CAdES attribute. Defines the "noticeNumbers" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNNumbers). **SigPolicyNoticeOrganization**: The organization part of the NoticeReference qualifier.Defines the "organization" part of the NoticeReference signature policy qualifier for CAdES-EPES (an alias for PolicyUNOrganization). **SigPolicyURI**: The EPES policy URI.Assign the EPES policy URI to this setting. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. **ThumbprintHashAlgorithm**: Specifies the thumbprint hash algorithm.The certificate thumbprint hash algorithm that was included or to be included into the signature. **TimestampResponse**: A base16-encoded timestamp response received from a TSA.When using *virtual://* timestamp endpoints, assign this property in your [Notification](#notification-event-jadessigner-component) event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16). **TimestampValidationDataDetails**: Specifies timestamp validation data details to include to the signature.Contains a comma-separated list of values that specifies which validation data values details to include to the "tstVD" JSON object. 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](#notification-event-jadessigner-component) 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](PDFSigner.md#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). **UnprotectedHeader**: Specifies the unprotected header.The unprotected header that was included or to be included into the signature. **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. **UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. **UsePSS**: Whether to use RSASSA-PSS algorithm.Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations. **UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. **UseValidationCache**: Enables or disable the use of the product-wide certificate chain validation cache.Use this property to enable or disable the use of the global chain validation cache. If enabled, the 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 "xRefs", "rRefs", "axRefs" and "arRefs" JSON objects/arrays. 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_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | 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 "xVals", "rVals", "axVals" and "arVals" JSON objects/arrays. Supported values are: | | | | | --- | --- | --- | | certificate | | Base64-encoded [X509v3] certificates | | crl | | Base64-encoded certificate revocation lists (CRL) | | ocsp | | OCSP responses | ### 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): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the 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: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([JAdESSigner](#jadessigner-component) Component) ### JAdESSigner Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 53477377 | The input file does not exist ([SB_ERROR_JADES_INPUTFILE_NOT_EXISTS](constants.md#const_SBERRORJADESINPUTFILENOTEXISTS)) |