# Struct secureblackbox::MessageSigner The MessageSigner struct digitally signs data and stores it in the PKCS#7 format. ## Syntax ```text secureblackbox::MessageSigner ``` ## Remarks PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS. MessageSigner can sign binary data into PKCS#7 SignedData and AuthenticatedData subformats. RSA, ECDSA, and EdDSA algorithms are supported. Setting up and using MessageSigner is easy: - Set up your source and destination via [input_file](#input_file-property-messagesigner-struct) ([input_bytes](#input_bytes-property-messagesigner-struct)) and [output_file](#output_file-property-messagesigner-struct) ([output_bytes](#output_bytes-property-messagesigner-struct)) properties. - Set [signature_type](#signature_type-property-messagesigner-struct) as per the desired signature type (PKCS#7 SignedData or AuthenticatedData, or PKCS#1) and the detached option. - Set signature properties, such as [claimed_signing_time](#claimed_signing_time-property-messagesigner-struct) and attributes ([add_attribute](#add_attribute-method-messagesigner-struct)). - For the SignedData-type signature (most commonly used), assign the signing certificate with its private key to the signing_certificate property. - For the AuthenticatedData-type signature, assign the recipient's certificate to recipient_certificate property. - Optionally provide the timestamping server URL to [timestamp_server](#timestamp_server-property-messagesigner-struct). - Call [sign](#sign-method-messagesigner-struct) to execute the operation. Note that MessageSigner always produces binary PKCS#7-compliant signed messages. For S/MIME email signing, see [MailWriter](MailWriter.md#MailWriter). For PGP signing, see [PGPWriter](PGPWriter.md#PGPWriter). For XML-SIG encryption, see [XMLSigner](XMLSigner.md#XMLSigner). MessageSigner is a simplified form of [CAdESSigner](CAdESSigner.md#CAdESSigner). Both classes work with PKCS#7 signed messages. [CAdESSigner](CAdESSigner.md#CAdESSigner), however, provides support for advanced (CAdES) signatures, including long-term validity, archival, and full chain validation capabilities. These advanced capabilities are absent from MessageSigner, which is only capable of creating basic PKCS#7 signatures. ```text MessageSigner signer = new MessageSigner(); signer.setHashAlgorithm("SHA256"); // Default hashing algorithm SHA256 // Select the file which contains the message that will be signed signer.setInputFile("message.txt"); // Select the file where the signed message will be written signer.setOutputFile("signedMessage.bin"); // Specify the certificate that shall be used for signing the data signer.setSigningCertificate(new Certificate("cert.pfx","password")); // Provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature signer.setTimestampServer("http://..."); signer.sign(); // Sign ``` ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the MessageSigner struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of MessageSigner when you have finished using the instance. ## Property List *The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [claimed_signing_time](#claimed_signing_time-property-messagesigner-struct) | The signing time from the signer's computer. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property-messagesigner-struct) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property-messagesigner-struct) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property-messagesigner-struct) | Additional data to be included in the async state and mirrored back by the requestor. | | [external_crypto_external_hash_calculation](#external_crypto_external_hash_calculation-property-messagesigner-struct) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property-messagesigner-struct) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property-messagesigner-struct) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property-messagesigner-struct) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property-messagesigner-struct) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property-messagesigner-struct) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property-messagesigner-struct) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [fips_mode](#fips_mode-property-messagesigner-struct) | Reserved. | | [hash_algorithm](#hash_algorithm-property-messagesigner-struct) | Specifies the hash algorithm to be used. | | [input_bytes](#input_bytes-property-messagesigner-struct) | Use this property to pass the input to struct in byte array form. | | [input_file](#input_file-property-messagesigner-struct) | A path to the source file. | | [input_is_hash](#input_is_hash-property-messagesigner-struct) | Specifies whether the input source contains the hash of the data or the actual data. | | [mac_algorithm](#mac_algorithm-property-messagesigner-struct) | Specifies the keyed MAC algorithm to use. | | [output_bytes](#output_bytes-property-messagesigner-struct) | Use this property to read the output the struct object has produced. | | [output_file](#output_file-property-messagesigner-struct) | A path to the output file. | | [proxy_address](#proxy_address-property-messagesigner-struct) | The IP address of the proxy server. | | [proxy_authentication](#proxy_authentication-property-messagesigner-struct) | The authentication type used by the proxy server. | | [proxy_password](#proxy_password-property-messagesigner-struct) | The password to authenticate to the proxy server. | | [proxy_port](#proxy_port-property-messagesigner-struct) | The port on the proxy server to connect to. | | [proxy_type](#proxy_type-property-messagesigner-struct) | The type of the proxy server. | | [proxy_request_headers](#proxy_request_headers-property-messagesigner-struct) | Contains HTTP request headers for WebTunnel and HTTP proxy. | | [proxy_response_body](#proxy_response_body-property-messagesigner-struct) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. | | [proxy_response_headers](#proxy_response_headers-property-messagesigner-struct) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. | | [proxy_use_ipv6](#proxy_use_ipv6-property-messagesigner-struct) | Specifies whether IPv6 should be used when connecting through the proxy. | | [proxy_username](#proxy_username-property-messagesigner-struct) | Specifies the username credential for proxy authentication. | | [recipient_cert_bytes](#recipient_cert_bytes-property-messagesigner-struct) | Returns the raw certificate data in DER format. | | [recipient_cert_handle](#recipient_cert_handle-property-messagesigner-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signature_type](#signature_type-property-messagesigner-struct) | Specifies the kind of signature to create. | | [signed_attribute_count](#signed_attribute_count-property-messagesigner-struct) | The number of records in the SignedAttribute arrays. | | [signed_attribute_oid](#signed_attribute_oid-property-messagesigner-struct) | The object identifier of the attribute. | | [signed_attribute_value](#signed_attribute_value-property-messagesigner-struct) | The value of the attribute. | | [signing_cert_bytes](#signing_cert_bytes-property-messagesigner-struct) | Returns the raw certificate data in DER format. | | [signing_cert_handle](#signing_cert_handle-property-messagesigner-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [signing_chain_count](#signing_chain_count-property-messagesigner-struct) | The number of records in the SigningChain arrays. | | [signing_chain_bytes](#signing_chain_bytes-property-messagesigner-struct) | Returns the raw certificate data in DER format. | | [signing_chain_handle](#signing_chain_handle-property-messagesigner-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [socket_dns_mode](#socket_dns_mode-property-messagesigner-struct) | Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system. | | [socket_dns_port](#socket_dns_port-property-messagesigner-struct) | Specifies the port number to be used for sending queries to the DNS server. | | [socket_dns_query_timeout](#socket_dns_query_timeout-property-messagesigner-struct) | The timeout (in milliseconds) for each DNS query. | | [socket_dns_servers](#socket_dns_servers-property-messagesigner-struct) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. | | [socket_dns_total_timeout](#socket_dns_total_timeout-property-messagesigner-struct) | The timeout (in milliseconds) for the whole resolution process. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property-messagesigner-struct) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property-messagesigner-struct) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property-messagesigner-struct) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property-messagesigner-struct) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property-messagesigner-struct) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property-messagesigner-struct) | Enables or disables IP protocol version 6. | | [timestamp_server](#timestamp_server-property-messagesigner-struct) | The address of the timestamping server. | | [tls_client_cert_count](#tls_client_cert_count-property-messagesigner-struct) | The number of records in the TLSClientCert arrays. | | [tls_client_cert_bytes](#tls_client_cert_bytes-property-messagesigner-struct) | Returns the raw certificate data in DER format. | | [tls_client_cert_handle](#tls_client_cert_handle-property-messagesigner-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [tls_server_cert_count](#tls_server_cert_count-property-messagesigner-struct) | The number of records in the TLSServerCert arrays. | | [tls_server_cert_bytes](#tls_server_cert_bytes-property-messagesigner-struct) | Returns the raw certificate data in DER format. | | [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property-messagesigner-struct) | Contains the fingerprint (a hash imprint) of this certificate. | | [tls_server_cert_handle](#tls_server_cert_handle-property-messagesigner-struct) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [tls_server_cert_issuer](#tls_server_cert_issuer-property-messagesigner-struct) | The common name of the certificate issuer (CA), typically a company name. | | [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property-messagesigner-struct) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property-messagesigner-struct) | Specifies the public key algorithm of this certificate. | | [tls_server_cert_key_bits](#tls_server_cert_key_bits-property-messagesigner-struct) | Returns the length of the public key in bits. | | [tls_server_cert_key_usage](#tls_server_cert_key_usage-property-messagesigner-struct) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [tls_server_cert_self_signed](#tls_server_cert_self_signed-property-messagesigner-struct) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [tls_server_cert_serial_number](#tls_server_cert_serial_number-property-messagesigner-struct) | Returns the certificate's serial number. | | [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property-messagesigner-struct) | Indicates the algorithm that was used by the CA to sign this certificate. | | [tls_server_cert_subject](#tls_server_cert_subject-property-messagesigner-struct) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property-messagesigner-struct) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [tls_server_cert_valid_from](#tls_server_cert_valid_from-property-messagesigner-struct) | The time point at which the certificate becomes valid, in UTC. | | [tls_server_cert_valid_to](#tls_server_cert_valid_to-property-messagesigner-struct) | The time point at which the certificate expires, in UTC. | | [tls_auto_validate_certificates](#tls_auto_validate_certificates-property-messagesigner-struct) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property-messagesigner-struct) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property-messagesigner-struct) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property-messagesigner-struct) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property-messagesigner-struct) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property-messagesigner-struct) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property-messagesigner-struct) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property-messagesigner-struct) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [tls_pre_shared_key](#tls_pre_shared_key-property-messagesigner-struct) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property-messagesigner-struct) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property-messagesigner-struct) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property-messagesigner-struct) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#tls_ssl_options-property-messagesigner-struct) | 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. | | [tls_mode](#tls_mode-property-messagesigner-struct) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property-messagesigner-struct) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property-messagesigner-struct) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property-messagesigner-struct) | The SSL/TLS versions to enable by default. | | [unsigned_attribute_count](#unsigned_attribute_count-property-messagesigner-struct) | The number of records in the UnsignedAttribute arrays. | | [unsigned_attribute_oid](#unsigned_attribute_oid-property-messagesigner-struct) | The object identifier of the attribute. | | [unsigned_attribute_value](#unsigned_attribute_value-property-messagesigner-struct) | The value of the attribute. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [add_attribute](#add_attribute-method-messagesigner-struct) | Adds an attribute to the signature. | | [config](#config-method-messagesigner-struct) | Sets or retrieves a configuration setting. | | [countersign](#countersign-method-messagesigner-struct) | Countersigns an existing signature. | | [do_action](#do_action-method-messagesigner-struct) | Performs an additional action. | | [extract_async_data](#extract_async_data-method-messagesigner-struct) | Extracts user data from the DC signing service response. | | [reset](#reset-method-messagesigner-struct) | Resets the struct settings. | | [sign](#sign-method-messagesigner-struct) | Signs the data. | | [sign_async_begin](#sign_async_begin-method-messagesigner-struct) | Initiates the asynchronous signing operation. | | [sign_async_end](#sign_async_end-method-messagesigner-struct) | Completes the asynchronous signing operation. | | [timestamp](#timestamp-method-messagesigner-struct) | Timestamps a signature. | ## Event List *The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_error](#on_error-event-messagesigner-struct) | Information about errors during PKCS#7 message signing. | | [on_external_sign](#on_external_sign-event-messagesigner-struct) | Handles remote or external signing initiated by the SignExternal method or other source. | | [on_notification](#on_notification-event-messagesigner-struct) | This event notifies the application about an underlying control flow event. | | [on_timestamp_request](#on_timestamp_request-event-messagesigner-struct) | Fires when the struct is ready to request a timestamp from an external TSA. | | [on_tls_cert_needed](#on_tls_cert_needed-event-messagesigner-struct) | Fires when a remote TLS party requests a client certificate. | | [on_tls_cert_validate](#on_tls_cert_validate-event-messagesigner-struct) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. | | [on_tls_established](#on_tls_established-event-messagesigner-struct) | Fires when a TLS handshake with Host successfully completes. | | [on_tls_handshake](#on_tls_handshake-event-messagesigner-struct) | Fires when a new TLS handshake is initiated, before the handshake commences. | | [on_tls_shutdown](#on_tls_shutdown-event-messagesigner-struct) | Reports the graceful closure of a TLS connection. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AsyncDocumentID](#AsyncDocumentID) | Specifies the document ID for SignAsyncEnd() call. | | [ContentType](#ContentType) | Content type of the message. | | [PSSUsed](#PSSUsed) | Whether to use RSASSA-PSS algorithm. | | [TempPath](#TempPath) | Path for storing temporary files. | | [TimestampResponse](#TimestampResponse) | A base16-encoded timestamp response received from a TSA. | | [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. | | [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. | | [UsePSS](#UsePSS) | Whether to use RSASSA-PSS algorithm. | | [UseUndefSize](#UseUndefSize) | Allows or forbids the use of ASN.1 tags of undefined size. | | [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 struct. | | [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 structs. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server structs. | | [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 structs 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 structs 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. | # claimed_signing_time property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The signing time from the signer's computer. ## Syntax *Rust Syntax* ```text fn claimed_signing_time(&self ) -> Result fn set_claimed_signing_time(&self, value : &str) -> Option fn set_claimed_signing_time_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks 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. ## Data Type String # external_crypto_async_document_id property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax *Rust Syntax* ```text fn external_crypto_async_document_id(&self ) -> Result fn set_external_crypto_async_document_id(&self, value : &str) -> Option fn set_external_crypto_async_document_id_ref(&self, value : &String) -> Option ``` ## 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 # external_crypto_custom_params property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Custom parameters to be passed to the signing service (uninterpreted). ## Syntax *Rust Syntax* ```text fn external_crypto_custom_params(&self ) -> Result fn set_external_crypto_custom_params(&self, value : &str) -> Option fn set_external_crypto_custom_params_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Custom parameters to be passed to the signing service (uninterpreted). ## Data Type String # external_crypto_data property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Additional data to be included in the async state and mirrored back by the requestor. ## Syntax *Rust Syntax* ```text fn external_crypto_data(&self ) -> Result fn set_external_crypto_data(&self, value : &str) -> Option fn set_external_crypto_data_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Additional data to be included in the async state and mirrored back by the requestor. ## Data Type String # external_crypto_external_hash_calculation property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax *Rust Syntax* ```text fn external_crypto_external_hash_calculation(&self ) -> Result fn set_external_crypto_external_hash_calculation(&self, value : bool) -> Option ``` ## 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 # external_crypto_hash_algorithm property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the request's signature hash algorithm. ## Syntax *Rust Syntax* ```text fn external_crypto_hash_algorithm(&self ) -> Result fn set_external_crypto_hash_algorithm(&self, value : &str) -> Option fn set_external_crypto_hash_algorithm_ref(&self, value : &String) -> Option ``` ## 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 # external_crypto_key_id property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The ID of the pre-shared key used for DC request authentication. ## Syntax *Rust Syntax* ```text fn external_crypto_key_id(&self ) -> Result fn set_external_crypto_key_id(&self, value : &str) -> Option fn set_external_crypto_key_id_ref(&self, value : &String) -> Option ``` ## 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 [external_crypto_key_secret](#external_crypto_key_secret-property-messagesigner-struct) 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 # external_crypto_key_secret property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The pre-shared key used for DC request authentication. ## Syntax *Rust Syntax* ```text fn external_crypto_key_secret(&self ) -> Result fn set_external_crypto_key_secret(&self, value : &str) -> Option fn set_external_crypto_key_secret_ref(&self, value : &String) -> Option ``` ## 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 [external_crypto_key_id](#external_crypto_key_id-property-messagesigner-struct) topic. ## Data Type String # external_crypto_method property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the asynchronous signing method. ## Syntax *Rust Syntax* ```text fn external_crypto_method(&self ) -> Result fn set_external_crypto_method(&self, value : i32) -> Option ``` ## 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 i32 # external_crypto_mode property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the external cryptography mode. ## Syntax *Rust Syntax* ```text fn external_crypto_mode(&self ) -> Result fn set_external_crypto_mode(&self, value : i32) -> Option ``` ## 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 i32 # external_crypto_public_key_algorithm property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax *Rust Syntax* ```text fn external_crypto_public_key_algorithm(&self ) -> Result fn set_external_crypto_public_key_algorithm(&self, value : &str) -> Option fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) -> Option ``` ## 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 # fips_mode property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Reserved. ## Syntax *Rust Syntax* ```text fn fips_mode(&self ) -> Result fn set_fips_mode(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type bool # hash_algorithm property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the hash algorithm to be used. ## Syntax *Rust Syntax* ```text fn hash_algorithm(&self ) -> Result fn set_hash_algorithm(&self, value : &str) -> Option fn set_hash_algorithm_ref(&self, value : &String) -> Option ``` ## Default Value "SHA256" ## Remarks This property specifies the hash algorithm to used for calculating the 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 | | ## Data Type String # input_bytes property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Use this property to pass the input to struct in byte array form. ## Syntax *Rust Syntax* ```text fn input_bytes(&self ) -> Result, SecureBlackboxError> fn set_input_bytes(&self, value : Vec) -> Option fn set_input_bytes_ref(&self, value : &[u8]) -> Option ``` ## Remarks Assign a byte array containing the data to be processed to this property. ## Data Type Vec # input_file property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) A path to the source file. ## Syntax *Rust Syntax* ```text fn input_file(&self ) -> Result fn set_input_file(&self, value : &str) -> Option fn set_input_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Use this property to provide a path to the file containing the data to be signed. ## Data Type String # input_is_hash property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies whether the input source contains the hash of the data or the actual data. ## Syntax *Rust Syntax* ```text fn input_is_hash(&self ) -> Result fn set_input_is_hash(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Use this property to tell the component whether the input source contains the actual data or its hash. ## Data Type bool # mac_algorithm property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the keyed MAC algorithm to use. ## Syntax *Rust Syntax* ```text fn mac_algorithm(&self ) -> Result fn set_mac_algorithm(&self, value : &str) -> Option fn set_mac_algorithm_ref(&self, value : &String) -> Option ``` ## Default Value "SHA256" ## Remarks This property specifies the MAC algorithm to use for calculating the MAC signature. | | | | | --- | --- | --- | | SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | | | SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | | | SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 | | ## Data Type String # output_bytes property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Use this property to read the output the struct object has produced. ## Syntax *Rust Syntax* ```text fn output_bytes(&self ) -> Result, SecureBlackboxError> ``` ## 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 [output_file](#output_file-property-messagesigner-struct) and output_stream properties had not been assigned. This property is read-only. ## Data Type Vec # output_file property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) A path to the output file. ## Syntax *Rust Syntax* ```text fn output_file(&self ) -> Result fn set_output_file(&self, value : &str) -> Option fn set_output_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Use this property to specify the file to save the signed message to. ## Data Type String # proxy_address property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The IP address of the proxy server. ## Syntax *Rust Syntax* ```text fn proxy_address(&self ) -> Result fn set_proxy_address(&self, value : &str) -> Option fn set_proxy_address_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The IP address of the proxy server. ## Data Type String # proxy_authentication property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The authentication type used by the proxy server. ## Syntax *Rust Syntax* ```text fn proxy_authentication(&self ) -> Result fn set_proxy_authentication(&self, value : i32) -> Option ``` ## 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 i32 # proxy_password property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The password to authenticate to the proxy server. ## Syntax *Rust Syntax* ```text fn proxy_password(&self ) -> Result fn set_proxy_password(&self, value : &str) -> Option fn set_proxy_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The password to authenticate to the proxy server. ## Data Type String # proxy_port property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The port on the proxy server to connect to. ## Syntax *Rust Syntax* ```text fn proxy_port(&self ) -> Result fn set_proxy_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The port on the proxy server to connect to. ## Data Type i32 # proxy_type property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The type of the proxy server. ## Syntax *Rust Syntax* ```text fn proxy_type(&self ) -> Result fn set_proxy_type(&self, value : i32) -> Option ``` ## 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 i32 # proxy_request_headers property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Contains HTTP request headers for WebTunnel and HTTP proxy. ## Syntax *Rust Syntax* ```text fn proxy_request_headers(&self ) -> Result fn set_proxy_request_headers(&self, value : &str) -> Option fn set_proxy_request_headers_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains HTTP request headers for WebTunnel and HTTP proxy. ## Data Type String # proxy_response_body property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Syntax *Rust Syntax* ```text fn proxy_response_body(&self ) -> Result fn set_proxy_response_body(&self, value : &str) -> Option fn set_proxy_response_body_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains the HTTP or HTTPS (WebTunnel) proxy response body. ## Data Type String # proxy_response_headers property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Syntax *Rust Syntax* ```text fn proxy_response_headers(&self ) -> Result fn set_proxy_response_headers(&self, value : &str) -> Option fn set_proxy_response_headers_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. ## Data Type String # proxy_use_ipv6 property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies whether IPv6 should be used when connecting through the proxy. ## Syntax *Rust Syntax* ```text fn proxy_use_ipv6(&self ) -> Result fn set_proxy_use_ipv6(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Specifies whether IPv6 should be used when connecting through the proxy. ## Data Type bool # proxy_username property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the username credential for proxy authentication. ## Syntax *Rust Syntax* ```text fn proxy_username(&self ) -> Result fn set_proxy_username(&self, value : &str) -> Option fn set_proxy_username_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Specifies the username credential for proxy authentication. ## Data Type String # recipient_cert_bytes property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn recipient_cert_bytes(&self ) -> Result, SecureBlackboxError> ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. ## Data Type Vec # recipient_cert_handle property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn recipient_cert_handle(&self ) -> Result fn set_recipient_cert_handle(&self, value : i64) -> Option ``` ## 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 i64 # signature_type property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the kind of signature to create. ## Syntax *Rust Syntax* ```text fn signature_type(&self ) -> Result fn set_signature_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Unknown1 // PKCS1Detached2 // PKCS7Detached3 // PKCS7Enveloping4 // PKCS7MACDetached5 // PKCS7MACEnveloping ``` ## Default Value 2 ## Remarks Possible values: | | | | | --- | --- | --- | | stUnknown | 0 | Unknown or unsupported signature types | | stPKCS1Detached | 1 | Detached PKCS#1 signature | | stPKCS7Detached | 2 | Detached PKCS#7 signature | | stPKCS7Enveloping | 3 | Enveloping PKCS#7 signature | | stPKCS7MACDetached | 4 | Detached PKCS#7 MAC signature | | stPKCS7MACEnveloping | 5 | Enveloping PKCS#7 MAC signature | ## Data Type i32 # signed_attribute_count property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The number of records in the SignedAttribute arrays. ## Syntax *Rust Syntax* ```text fn signed_attribute_count(&self ) -> Result fn set_signed_attribute_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [signed_attribute_oid](#signed_attribute_oid-property-messagesigner-struct) - [signed_attribute_value](#signed_attribute_value-property-messagesigner-struct) The array indices start at *0* and end at *signed_attribute_count - 1*. ## Data Type i32 # signed_attribute_oid property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The object identifier of the attribute. ## Syntax *Rust Syntax* ```text fn signed_attribute_oid(&self , SignedAttributeIndex : i32) -> Result fn set_signed_attribute_oid(&self, SignedAttributeIndex : i32, value : &str) -> Option fn set_signed_attribute_oid_ref(&self, SignedAttributeIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The object identifier of the attribute. The *SignedAttributeIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignedAttributeCount](#signed_attribute_count-property-messagesigner-struct) property. ## Data Type String # signed_attribute_value property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The value of the attribute. ## Syntax *Rust Syntax* ```text fn signed_attribute_value(&self , SignedAttributeIndex : i32) -> Result, SecureBlackboxError> fn set_signed_attribute_value(&self, SignedAttributeIndex : i32, value : Vec) -> Option fn set_signed_attribute_value_ref(&self, SignedAttributeIndex : i32, value : &[u8]) -> Option ``` ## Remarks The value of the attribute. The *SignedAttributeIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignedAttributeCount](#signed_attribute_count-property-messagesigner-struct) property. ## Data Type Vec # signing_cert_bytes property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn signing_cert_bytes(&self ) -> Result, SecureBlackboxError> ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only. ## Data Type Vec # signing_cert_handle property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn signing_cert_handle(&self ) -> Result fn set_signing_cert_handle(&self, value : i64) -> Option ``` ## 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 i64 # signing_chain_count property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The number of records in the SigningChain arrays. ## Syntax *Rust Syntax* ```text fn signing_chain_count(&self ) -> Result fn set_signing_chain_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [signing_chain_bytes](#signing_chain_bytes-property-messagesigner-struct) - [signing_chain_handle](#signing_chain_handle-property-messagesigner-struct) The array indices start at *0* and end at *signing_chain_count - 1*. ## Data Type i32 # signing_chain_bytes property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn signing_chain_bytes(&self , SigningChainIndex : i32) -> Result, SecureBlackboxError> ``` ## 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](#signing_chain_count-property-messagesigner-struct) property. This property is read-only. ## Data Type Vec # signing_chain_handle property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result fn set_signing_chain_handle(&self, SigningChainIndex : i32, value : i64) -> Option ``` ## 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](#signing_chain_count-property-messagesigner-struct) property. ## Data Type i64 # socket_dns_mode property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system. ## Syntax *Rust Syntax* ```text fn socket_dns_mode(&self ) -> Result fn set_socket_dns_mode(&self, value : i32) -> Option ``` ## 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 i32 # socket_dns_port property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the port number to be used for sending queries to the DNS server. ## Syntax *Rust Syntax* ```text fn socket_dns_port(&self ) -> Result fn set_socket_dns_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks Specifies the port number to be used for sending queries to the DNS server. ## Data Type i32 # socket_dns_query_timeout property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The timeout (in milliseconds) for each DNS query. ## Syntax *Rust Syntax* ```text fn socket_dns_query_timeout(&self ) -> Result fn set_socket_dns_query_timeout(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. ## Data Type i32 # socket_dns_servers property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Syntax *Rust Syntax* ```text fn socket_dns_servers(&self ) -> Result fn set_socket_dns_servers(&self, value : &str) -> Option fn set_socket_dns_servers_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The addresses of DNS servers to use for address resolution, separated by commas or semicolons. ## Data Type String # socket_dns_total_timeout property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The timeout (in milliseconds) for the whole resolution process. ## Syntax *Rust Syntax* ```text fn socket_dns_total_timeout(&self ) -> Result fn set_socket_dns_total_timeout(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. ## Data Type i32 # socket_incoming_speed_limit property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The maximum number of bytes to read from the socket, per second. ## Syntax *Rust Syntax* ```text fn socket_incoming_speed_limit(&self ) -> Result fn set_socket_incoming_speed_limit(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. ## Data Type i32 # socket_local_address property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The local network interface to bind the socket to. ## Syntax *Rust Syntax* ```text fn socket_local_address(&self ) -> Result fn set_socket_local_address(&self, value : &str) -> Option fn set_socket_local_address_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. ## Data Type String # socket_local_port property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The local port number to bind the socket to. ## Syntax *Rust Syntax* ```text fn socket_local_port(&self ) -> Result fn set_socket_local_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. ## Data Type i32 # socket_outgoing_speed_limit property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The maximum number of bytes to write to the socket, per second. ## Syntax *Rust Syntax* ```text fn socket_outgoing_speed_limit(&self ) -> Result fn set_socket_outgoing_speed_limit(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. ## Data Type i32 # socket_timeout property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax *Rust Syntax* ```text fn socket_timeout(&self ) -> Result fn set_socket_timeout(&self, value : i32) -> Option ``` ## 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 i32 # socket_use_ipv6 property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Enables or disables IP protocol version 6. ## Syntax *Rust Syntax* ```text fn socket_use_ipv6(&self ) -> Result fn set_socket_use_ipv6(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Enables or disables IP protocol version 6. ## Data Type bool # timestamp_server property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The address of the timestamping server. ## Syntax *Rust Syntax* ```text fn timestamp_server(&self ) -> Result fn set_timestamp_server(&self, value : &str) -> Option fn set_timestamp_server_ref(&self, value : &String) -> Option ``` ## 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 tls_client_chain 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 [on_notification](#on_notification-event-messagesigner-struct) 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 # tls_client_cert_count property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The number of records in the TLSClientCert arrays. ## Syntax *Rust Syntax* ```text fn tls_client_cert_count(&self ) -> Result fn set_tls_client_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_client_cert_bytes](#tls_client_cert_bytes-property-messagesigner-struct) - [tls_client_cert_handle](#tls_client_cert_handle-property-messagesigner-struct) The array indices start at *0* and end at *tls_client_cert_count - 1*. ## Data Type i32 # tls_client_cert_bytes property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn tls_client_cert_bytes(&self , TLSClientCertIndex : i32) -> Result, SecureBlackboxError> ``` ## 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](#tls_client_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type Vec # tls_client_cert_handle property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn tls_client_cert_handle(&self , TLSClientCertIndex : i32) -> Result fn set_tls_client_cert_handle(&self, TLSClientCertIndex : i32, value : i64) -> Option ``` ## 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](#tls_client_cert_count-property-messagesigner-struct) property. ## Data Type i64 # tls_server_cert_count property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The number of records in the TLSServerCert arrays. ## Syntax *Rust Syntax* ```text fn tls_server_cert_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_server_cert_bytes](#tls_server_cert_bytes-property-messagesigner-struct) - [tls_server_cert_fingerprint](#tls_server_cert_fingerprint-property-messagesigner-struct) - [tls_server_cert_handle](#tls_server_cert_handle-property-messagesigner-struct) - [tls_server_cert_issuer](#tls_server_cert_issuer-property-messagesigner-struct) - [tls_server_cert_issuer_rdn](#tls_server_cert_issuer_rdn-property-messagesigner-struct) - [tls_server_cert_key_algorithm](#tls_server_cert_key_algorithm-property-messagesigner-struct) - [tls_server_cert_key_bits](#tls_server_cert_key_bits-property-messagesigner-struct) - [tls_server_cert_key_usage](#tls_server_cert_key_usage-property-messagesigner-struct) - [tls_server_cert_self_signed](#tls_server_cert_self_signed-property-messagesigner-struct) - [tls_server_cert_serial_number](#tls_server_cert_serial_number-property-messagesigner-struct) - [tls_server_cert_sig_algorithm](#tls_server_cert_sig_algorithm-property-messagesigner-struct) - [tls_server_cert_subject](#tls_server_cert_subject-property-messagesigner-struct) - [tls_server_cert_subject_rdn](#tls_server_cert_subject_rdn-property-messagesigner-struct) - [tls_server_cert_valid_from](#tls_server_cert_valid_from-property-messagesigner-struct) - [tls_server_cert_valid_to](#tls_server_cert_valid_to-property-messagesigner-struct) The array indices start at *0* and end at *tls_server_cert_count - 1*. This property is read-only. ## Data Type i32 # tls_server_cert_bytes property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Returns the raw certificate data in DER format. ## Syntax *Rust Syntax* ```text fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result, SecureBlackboxError> ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type Vec # tls_server_cert_fingerprint property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *Rust Syntax* ```text fn tls_server_cert_fingerprint(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_server_cert_handle property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *Rust Syntax* ```text fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type i64 # tls_server_cert_issuer property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The common name of the certificate issuer (CA), typically a company name. ## Syntax *Rust Syntax* ```text fn tls_server_cert_issuer(&self , TLSServerCertIndex : i32) -> Result ``` ## 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 [tls_issuer_rdn](#MessageSigner_p_TLSIssuerRDN). The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_server_cert_issuer_rdn property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *Rust Syntax* ```text fn tls_server_cert_issuer_rdn(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_server_cert_key_algorithm property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the public key algorithm of this certificate. ## Syntax *Rust Syntax* ```text fn tls_server_cert_key_algorithm(&self , TLSServerCertIndex : i32) -> Result ``` ## 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 [tls_key_bits](#MessageSigner_p_TLSKeyBits), [tls_curve](#MessageSigner_p_TLSCurve), and [tls_public_key_bytes](#MessageSigner_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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_server_cert_key_bits property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Returns the length of the public key in bits. ## Syntax *Rust Syntax* ```text fn tls_server_cert_key_bits(&self , TLSServerCertIndex : i32) -> Result ``` ## 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 [tls_public_key_bytes](#MessageSigner_p_TLSPublicKeyBytes) or [tls_private_key_bytes](#MessageSigner_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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type i32 # tls_server_cert_key_usage property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *Rust Syntax* ```text fn tls_server_cert_key_usage(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type i32 # tls_server_cert_self_signed property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *Rust Syntax* ```text fn tls_server_cert_self_signed(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type bool # tls_server_cert_serial_number property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Returns the certificate's serial number. ## Syntax *Rust Syntax* ```text fn tls_server_cert_serial_number(&self , TLSServerCertIndex : i32) -> Result, SecureBlackboxError> ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type Vec # tls_server_cert_sig_algorithm property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *Rust Syntax* ```text fn tls_server_cert_sig_algorithm(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_server_cert_subject property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *Rust Syntax* ```text fn tls_server_cert_subject(&self , TLSServerCertIndex : i32) -> Result ``` ## 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 [tls_subject_rdn](#MessageSigner_p_TLSSubjectRDN). The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_server_cert_subject_rdn property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *Rust Syntax* ```text fn tls_server_cert_subject_rdn(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_server_cert_valid_from property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The time point at which the certificate becomes valid, in UTC. ## Syntax *Rust Syntax* ```text fn tls_server_cert_valid_from(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_server_cert_valid_to property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The time point at which the certificate expires, in UTC. ## Syntax *Rust Syntax* ```text fn tls_server_cert_valid_to(&self , TLSServerCertIndex : i32) -> Result ``` ## 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](#tls_server_cert_count-property-messagesigner-struct) property. This property is read-only. ## Data Type String # tls_auto_validate_certificates property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax *Rust Syntax* ```text fn tls_auto_validate_certificates(&self ) -> Result fn set_tls_auto_validate_certificates(&self, value : bool) -> Option ``` ## Default Value true ## Remarks Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Data Type bool # tls_base_configuration property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Selects the base configuration for the TLS settings. ## Syntax *Rust Syntax* ```text fn tls_base_configuration(&self ) -> Result fn set_tls_base_configuration(&self, value : i32) -> Option ``` ## 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 i32 # tls_ciphersuites property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) A list of ciphersuites separated with commas or semicolons. ## Syntax *Rust Syntax* ```text fn tls_ciphersuites(&self ) -> Result fn set_tls_ciphersuites(&self, value : &str) -> Option fn set_tls_ciphersuites_ref(&self, value : &String) -> Option ``` ## 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 [tls_base_configuration](#tls_base_configuration-property-messagesigner-struct). 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 # tls_client_auth property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Enables or disables certificate-based client authentication. ## Syntax *Rust Syntax* ```text fn tls_client_auth(&self ) -> Result fn set_tls_client_auth(&self, value : i32) -> Option ``` ## 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 i32 # tls_extensions property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Provides access to TLS extensions. ## Syntax *Rust Syntax* ```text fn tls_extensions(&self ) -> Result fn set_tls_extensions(&self, value : &str) -> Option fn set_tls_extensions_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Provides access to TLS extensions. ## Data Type String # tls_force_resume_if_destination_changes property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Whether to force TLS session resumption when the destination address changes. ## Syntax *Rust Syntax* ```text fn tls_force_resume_if_destination_changes(&self ) -> Result fn set_tls_force_resume_if_destination_changes(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to force TLS session resumption when the destination address changes. ## Data Type bool # tls_groups property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax *Rust Syntax* ```text fn tls_groups(&self ) -> Result fn set_tls_groups(&self, value : &str) -> Option fn set_tls_groups_ref(&self, value : &String) -> Option ``` ## 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 # tls_pre_shared_identity property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *Rust Syntax* ```text fn tls_pre_shared_identity(&self ) -> Result fn set_tls_pre_shared_identity(&self, value : &str) -> Option fn set_tls_pre_shared_identity_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Data Type String # tls_pre_shared_key property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax *Rust Syntax* ```text fn tls_pre_shared_key(&self ) -> Result fn set_tls_pre_shared_key(&self, value : &str) -> Option fn set_tls_pre_shared_key_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Data Type String # tls_pre_shared_key_ciphersuite property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax *Rust Syntax* ```text fn tls_pre_shared_key_ciphersuite(&self ) -> Result fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) -> Option fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Data Type String # tls_renegotiation_attack_prevention_mode property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Selects the renegotiation attack prevention mechanism. ## Syntax *Rust Syntax* ```text fn tls_renegotiation_attack_prevention_mode(&self ) -> Result fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) -> Option ``` ## 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 i32 # tls_revocation_check property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the kind(s) of revocation check to perform. ## Syntax *Rust Syntax* ```text fn tls_revocation_check(&self ) -> Result fn set_tls_revocation_check(&self, value : i32) -> Option ``` ## 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 i32 # tls_ssl_options property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) 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 *Rust Syntax* ```text fn tls_ssl_options(&self ) -> Result fn set_tls_ssl_options(&self, value : i32) -> Option ``` ## 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 i32 # tls_mode property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Specifies the TLS mode to use. ## Syntax *Rust Syntax* ```text fn tls_mode(&self ) -> Result fn set_tls_mode(&self, value : i32) -> Option ``` ## 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 i32 # tls_use_extended_master_secret property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax *Rust Syntax* ```text fn tls_use_extended_master_secret(&self ) -> Result fn set_tls_use_extended_master_secret(&self, value : bool) -> Option ``` ## Default Value true ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Data Type bool # tls_use_session_resumption property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Enables or disables the TLS session resumption capability. ## Syntax *Rust Syntax* ```text fn tls_use_session_resumption(&self ) -> Result fn set_tls_use_session_resumption(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Enables or disables the TLS session resumption capability. ## Data Type bool # tls_versions property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The SSL/TLS versions to enable by default. ## Syntax *Rust Syntax* ```text fn tls_versions(&self ) -> Result fn set_tls_versions(&self, value : i32) -> Option ``` ## 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 i32 # unsigned_attribute_count property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The number of records in the UnsignedAttribute arrays. ## Syntax *Rust Syntax* ```text fn unsigned_attribute_count(&self ) -> Result fn set_unsigned_attribute_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [unsigned_attribute_oid](#unsigned_attribute_oid-property-messagesigner-struct) - [unsigned_attribute_value](#unsigned_attribute_value-property-messagesigner-struct) The array indices start at *0* and end at *unsigned_attribute_count - 1*. ## Data Type i32 # unsigned_attribute_oid property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The object identifier of the attribute. ## Syntax *Rust Syntax* ```text fn unsigned_attribute_oid(&self , UnsignedAttributeIndex : i32) -> Result fn set_unsigned_attribute_oid(&self, UnsignedAttributeIndex : i32, value : &str) -> Option fn set_unsigned_attribute_oid_ref(&self, UnsignedAttributeIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The object identifier of the attribute. The *UnsignedAttributeIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [UnsignedAttributeCount](#unsigned_attribute_count-property-messagesigner-struct) property. ## Data Type String # unsigned_attribute_value property ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) The value of the attribute. ## Syntax *Rust Syntax* ```text fn unsigned_attribute_value(&self , UnsignedAttributeIndex : i32) -> Result, SecureBlackboxError> fn set_unsigned_attribute_value(&self, UnsignedAttributeIndex : i32, value : Vec) -> Option fn set_unsigned_attribute_value_ref(&self, UnsignedAttributeIndex : i32, value : &[u8]) -> Option ``` ## Remarks The value of the attribute. The *UnsignedAttributeIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [UnsignedAttributeCount](#unsigned_attribute_count-property-messagesigner-struct) property. ## Data Type Vec # add_attribute method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Adds an attribute to the signature. ## Syntax *Rust Syntax* ```text fn add_attribute(&self, oid : &str, value : &[u8], signed_attribute : bool) -> Result ``` ## Remarks Use this method to add a signed or unsigned attribute to the collection of attributes included in the new signature. Note that CAdESSigner creates certain mandatory and/or widely used attributes automatically in accordance with requirements for a specific signing profile. For example, attributes such as SigningCertificateV2 or SigningTime are always added. Policy attributes are added if specified via the PolicyID or PolicyURI properties of the signature object. Use the *OID* parameter to provide the object identifier of the attribute, in string form. For example, the OID for the SigningCertificateV2 attribute is 1.2.840.113549.1.9.16.2.47. The *Value* parameter should contain a well-formed, DER-encoded representation of the attribute value, in accordance with its specification. # config method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-messagesigner-struct) 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-messagesigner-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # countersign method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Countersigns an existing signature. ## Syntax *Rust Syntax* ```text fn countersign(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks Use this method to certify an existing document signature. Countersigning doesn't alter the existing signatures or the signed document itself. # do_action method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Performs an additional action. ## Syntax *Rust Syntax* ```text fn do_action(&self, action_id : &str, action_params : &str) -> Result ``` ## Remarks do_action 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. | # extract_async_data method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Extracts user data from the DC signing service response. ## Syntax *Rust Syntax* ```text fn extract_async_data(&self, async_reply : &str) -> Result ``` ## 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. # reset method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Resets the struct settings. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks reset is a generic method available in every struct. # sign method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Signs the data. ## Syntax *Rust Syntax* ```text fn sign(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks This method signs the data provided via [input_file](#input_file-property-messagesigner-struct) (or input_stream) with signing_certificate, and saves the signature in [output_file](#output_file-property-messagesigner-struct) (output_stream). Set the desired signature variant via [signature_type](#signature_type-property-messagesigner-struct) property. The struct automatically timestamps the created signature if a [timestamp_server](#timestamp_server-property-messagesigner-struct) is provided. # sign_async_begin method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Initiates the asynchronous signing operation. ## Syntax *Rust Syntax* ```text fn sign_async_begin(&self) -> Result ``` ## 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 [output_file](#output_file-property-messagesigner-struct) (or output_stream). 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 [input_file](#input_file-property-messagesigner-struct) (or input_stream), and call [sign_async_end](#sign_async_end-method-messagesigner-struct) 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 signing_certificate 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 [sign_async_end](#sign_async_end-method-messagesigner-struct) 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 sign_async_begin 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 [sign_async_end](#sign_async_end-method-messagesigner-struct) method. # sign_async_end method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Completes the asynchronous signing operation. ## Syntax *Rust Syntax* ```text fn sign_async_end(&self, async_reply : &str) -> Result<(), SecureBlackboxError> ``` ## 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 [sign_async_begin](#sign_async_begin-method-messagesigner-struct) call to [input_file](#input_file-property-messagesigner-struct) (or input_stream). The method will embed the signature into the pre-signed document, and save the complete signed document to [output_file](#output_file-property-messagesigner-struct) (or output_stream). 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 signing_certificate 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 ([sign_async_begin](#sign_async_begin-method-messagesigner-struct)) 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 [sign_async_begin](#sign_async_begin-method-messagesigner-struct) 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 sign_async_end method. # timestamp method ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Timestamps a signature. ## Syntax *Rust Syntax* ```text fn timestamp(&self) -> Result<(), SecureBlackboxError> ``` ## Remarks This method timestamps an existing PKCS#7 signature with [timestamp_server](#timestamp_server-property-messagesigner-struct). Pass your existing signature via [input_file](#input_file-property-messagesigner-struct) (or input_stream), and collect the timestamped variant from [output_file](#output_file-property-messagesigner-struct) (output_stream). # on_error event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Information about errors during PKCS#7 message signing. ## Syntax *Rust Syntax* ```text // MessageSignerErrorEventArgs carries the MessageSigner Error event's parameters. pub struct MessageSignerErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String } // MessageSignerErrorEvent defines the signature of the MessageSigner Error event's handler function. pub trait MessageSignerErrorEvent { fn on_error(&self, sender : MessageSigner, e : &mut MessageSignerErrorEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_error(&self) -> &'a dyn MessageSignerErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn MessageSignerErrorEvent); ... } ``` ## Remarks The event is fired in case of exceptional conditions during message processing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Messages](#trappable-errors-messagesigner-struct) section. # on_external_sign event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Handles remote or external signing initiated by the SignExternal method or other source. ## Syntax *Rust Syntax* ```text // MessageSignerExternalSignEventArgs carries the MessageSigner ExternalSign event's parameters. pub struct MessageSignerExternalSignEventArgs { fn operation_id(&self) -> &String fn hash_algorithm(&self) -> &String fn pars(&self) -> &String fn data(&self) -> &String fn signed_data(&self) -> &String fn set_signed_data(&self, value : &str) fn set_signed_data_ref(&self, value : &String) } // MessageSignerExternalSignEvent defines the signature of the MessageSigner ExternalSign event's handler function. pub trait MessageSignerExternalSignEvent { fn on_external_sign(&self, sender : MessageSigner, e : &mut MessageSignerExternalSignEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_external_sign(&self) -> &'a dyn MessageSignerExternalSignEvent; pub fn set_on_external_sign(&mut self, value : &'a dyn MessageSignerExternalSignEvent); ... } ``` ## 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(); }; ``` # on_notification event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) This event notifies the application about an underlying control flow event. ## Syntax *Rust Syntax* ```text // MessageSignerNotificationEventArgs carries the MessageSigner Notification event's parameters. pub struct MessageSignerNotificationEventArgs { fn event_id(&self) -> &String fn event_param(&self) -> &String } // MessageSignerNotificationEvent defines the signature of the MessageSigner Notification event's handler function. pub trait MessageSignerNotificationEvent { fn on_notification(&self, sender : MessageSigner, e : &mut MessageSignerNotificationEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_notification(&self) -> &'a dyn MessageSignerNotificationEvent; pub fn set_on_notification(&mut self, value : &'a dyn MessageSignerNotificationEvent); ... } ``` ## 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: | | | | --- | --- | | 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 [timestamp_server](#timestamp_server-property-messagesigner-struct) was set to a virtual:// URI. The EventParam parameter contains the TSP request (or the plain hash, depending on the value provided to [timestamp_server](#timestamp_server-property-messagesigner-struct)), 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. | | Progress | Fires periodically to report the progress of the current operation. The EventParam parameter contains a slash-separated pair of values (Current/Total). | # on_timestamp_request event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Fires when the struct is ready to request a timestamp from an external TSA. ## Syntax *Rust Syntax* ```text // MessageSignerTimestampRequestEventArgs carries the MessageSigner TimestampRequest event's parameters. pub struct MessageSignerTimestampRequestEventArgs { fn tsa(&self) -> &String fn timestamp_request(&self) -> &String fn timestamp_response(&self) -> &String fn set_timestamp_response(&self, value : &str) fn set_timestamp_response_ref(&self, value : &String) fn suppress_default(&self) -> bool fn set_suppress_default(&self, value : bool) } // MessageSignerTimestampRequestEvent defines the signature of the MessageSigner TimestampRequest event's handler function. pub trait MessageSignerTimestampRequestEvent { fn on_timestamp_request(&self, sender : MessageSigner, e : &mut MessageSignerTimestampRequestEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_timestamp_request(&self) -> &'a dyn MessageSignerTimestampRequestEvent; pub fn set_on_timestamp_request(&mut self, value : &'a dyn MessageSignerTimestampRequestEvent); ... } ``` ## 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 [timestamp_server](#timestamp_server-property-messagesigner-struct) 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. # on_tls_cert_needed event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Fires when a remote TLS party requests a client certificate. ## Syntax *Rust Syntax* ```text // MessageSignerTLSCertNeededEventArgs carries the MessageSigner TLSCertNeeded event's parameters. pub struct MessageSignerTLSCertNeededEventArgs { fn host(&self) -> &String fn ca_names(&self) -> &String } // MessageSignerTLSCertNeededEvent defines the signature of the MessageSigner TLSCertNeeded event's handler function. pub trait MessageSignerTLSCertNeededEvent { fn on_tls_cert_needed(&self, sender : MessageSigner, e : &mut MessageSignerTLSCertNeededEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_tls_cert_needed(&self) -> &'a dyn MessageSignerTLSCertNeededEvent; pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn MessageSignerTLSCertNeededEvent); ... } ``` ## 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 tls_client_chain 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 [on_tls_handshake](#on_tls_handshake-event-messagesigner-struct) event for the given host and, if the certificate was accepted, succeeded by the [on_tls_established](#on_tls_established-event-messagesigner-struct) event. # on_tls_cert_validate event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. ## Syntax *Rust Syntax* ```text // MessageSignerTLSCertValidateEventArgs carries the MessageSigner TLSCertValidate event's parameters. pub struct MessageSignerTLSCertValidateEventArgs { fn server_host(&self) -> &String fn server_ip(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // MessageSignerTLSCertValidateEvent defines the signature of the MessageSigner TLSCertValidate event's handler function. pub trait MessageSignerTLSCertValidateEvent { fn on_tls_cert_validate(&self, sender : MessageSigner, e : &mut MessageSignerTLSCertValidateEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_tls_cert_validate(&self) -> &'a dyn MessageSignerTLSCertValidateEvent; pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn MessageSignerTLSCertValidateEvent); ... } ``` ## Remarks This event is fired during a TLS handshake. Use the tls_server_chain 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. # on_tls_established event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Fires when a TLS handshake with Host successfully completes. ## Syntax *Rust Syntax* ```text // MessageSignerTLSEstablishedEventArgs carries the MessageSigner TLSEstablished event's parameters. pub struct MessageSignerTLSEstablishedEventArgs { fn host(&self) -> &String fn version(&self) -> &String fn ciphersuite(&self) -> &String fn connection_id(&self) -> &[u8] fn abort(&self) -> bool fn set_abort(&self, value : bool) } // MessageSignerTLSEstablishedEvent defines the signature of the MessageSigner TLSEstablished event's handler function. pub trait MessageSignerTLSEstablishedEvent { fn on_tls_established(&self, sender : MessageSigner, e : &mut MessageSignerTLSEstablishedEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_tls_established(&self) -> &'a dyn MessageSignerTLSEstablishedEvent; pub fn set_on_tls_established(&mut self, value : &'a dyn MessageSignerTLSEstablishedEvent); ... } ``` ## 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. # on_tls_handshake event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Fires when a new TLS handshake is initiated, before the handshake commences. ## Syntax *Rust Syntax* ```text // MessageSignerTLSHandshakeEventArgs carries the MessageSigner TLSHandshake event's parameters. pub struct MessageSignerTLSHandshakeEventArgs { fn host(&self) -> &String fn abort(&self) -> bool fn set_abort(&self, value : bool) } // MessageSignerTLSHandshakeEvent defines the signature of the MessageSigner TLSHandshake event's handler function. pub trait MessageSignerTLSHandshakeEvent { fn on_tls_handshake(&self, sender : MessageSigner, e : &mut MessageSignerTLSHandshakeEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_tls_handshake(&self) -> &'a dyn MessageSignerTLSHandshakeEvent; pub fn set_on_tls_handshake(&mut self, value : &'a dyn MessageSignerTLSHandshakeEvent); ... } ``` ## 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 [on_tls_established](#on_tls_established-event-messagesigner-struct) event. If the server chooses to request a client certificate, the [on_tls_cert_needed](#on_tls_cert_needed-event-messagesigner-struct) event will also be fired. # on_tls_shutdown event ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) Reports the graceful closure of a TLS connection. ## Syntax *Rust Syntax* ```text // MessageSignerTLSShutdownEventArgs carries the MessageSigner TLSShutdown event's parameters. pub struct MessageSignerTLSShutdownEventArgs { fn host(&self) -> &String } // MessageSignerTLSShutdownEvent defines the signature of the MessageSigner TLSShutdown event's handler function. pub trait MessageSignerTLSShutdownEvent { fn on_tls_shutdown(&self, sender : MessageSigner, e : &mut MessageSignerTLSShutdownEventArgs); } impl <'a> MessageSigner<'a> { pub fn on_tls_shutdown(&self) -> &'a dyn MessageSignerTLSShutdownEvent; pub fn set_on_tls_shutdown(&mut self, value : &'a dyn MessageSignerTLSShutdownEvent); ... } ``` ## 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 ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) 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-messagesigner-struct) method. ### MessageSigner Config Settings **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. **ContentType**: Content type of the message.Specifies the content type of the PKCS#7 message. **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*. **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. **TimestampResponse**: A base16-encoded timestamp response received from a TSA.When using *virtual://* timestamp endpoints, assign this property in your [on_notification](#on_notification-event-messagesigner-struct) event handler with the TSP response that you receive from the TSA. Remember to encode the response in hex (base16). **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. **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 [on_notification](#on_notification-event-messagesigner-struct) 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). **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. **UseUndefSize**: Allows or forbids the use of ASN.1 tags of undefined size.Usually PKCS#7 messages are handled correctly when undefined-size tags are used. However some ASN.1 parsers (S/MIME handler in Outlook Express, security plugins of Adobe Acrobat) can't correctly handle such tags. If you are targeting such software, you need this property. ### 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 ([MessageSigner](#struct-secureblackboxmessagesigner) Struct) ### MessageSigner 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)) |