Struct secureblackbox::SOAPSigner
Properties Methods Events Config Settings Errors
The SOAPSigner struct signs SOAP messages.
Syntax
secureblackbox::SOAPSigner
Remarks
SOAPSigner creates electronic signatures for SOAP messages, and includes advanced security features such as support for timestamps and advanced electronic signatures (XAdES).
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 SOAPSigner struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SOAPSigner 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.
| auto_validate_signatures | Specifies whether struct should validate any present signatures when the document is opened. |
| blocked_cert_count | The number of records in the BlockedCert arrays. |
| blocked_cert_bytes | Returns the raw certificate data in DER format. |
| blocked_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| cert_count | The number of records in the Cert arrays. |
| cert_bytes | Returns the raw certificate data in DER format. |
| cert_ca | Indicates whether the certificate has a CA capability. |
| cert_ca_key_id | A unique identifier (fingerprint) of the CA certificate's cryptographic key. |
| cert_type | Returns the type of the entity contained in the Certificate object. |
| cert_crl_distribution_points | Contains a list of locations of CRL distribution points used to check this certificate's validity. |
| cert_curve | Specifies the elliptic curve associated with the certificate's public key. |
| cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| cert_friendly_name | Contains an associated alias (friendly name) of the certificate. |
| cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| cert_hash_algorithm | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). |
| cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| cert_issuer_rdn | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| cert_key_bits | Returns the length of the public key in bits. |
| cert_key_fingerprint | Returns a SHA1 fingerprint of the public key contained in the certificate. |
| cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| cert_key_valid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| cert_ocsp_locations | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. |
| cert_ocsp_no_check | Accessor to the value of the certificate's ocsp-no-check extension. |
| cert_origin | Returns the location that the certificate was taken or loaded from. |
| cert_policy_i_ds | Contains identifiers (OIDs) of the applicable certificate policies. |
| cert_private_key_bytes | Returns the certificate's private key in DER-encoded format. |
| cert_private_key_exists | Indicates whether the certificate has a usable private key associated with it. |
| cert_private_key_extractable | Indicates whether the private key is extractable (exportable). |
| cert_public_key_bytes | Contains the certificate's public key in DER format. |
| cert_qualified | Indicates whether the certificate is qualified. |
| cert_qualified_statements | Returns a simplified qualified status of the certificate. |
| cert_qualifiers | A list of qualifiers. |
| cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| cert_serial_number | Returns the certificate's serial number. |
| cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| cert_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| cert_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| cert_subject_alternative_name | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
| cert_subject_key_id | Contains a unique identifier of the certificate's cryptographic key. |
| cert_subject_rdn | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| cert_valid | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. |
| cert_valid_from | The time point at which the certificate becomes valid, in UTC. |
| cert_valid_to | The time point at which the certificate expires, in UTC. |
| check_trusted_lists | Specifies whether the struct should attempt to validate chain trust via a known Trusted List. |
| crl_count | The number of records in the CRL arrays. |
| crl_bytes | Returns the raw CRL data in DER format. |
| crlca_key_id | A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
| crl_entry_count | Returns the number of certificate status entries in the CRL. |
| crl_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| crl_issuer | The common name of the CRL issuer (CA), typically a company name. |
| crl_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
| crl_location | The URL that the CRL was downloaded from. |
| crl_next_update | The planned time and date of the next version of this CRL to be published. |
| crl_sig_algorithm | The public key algorithm that was used by the CA to sign this CRL. |
| crl_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| crltbs | The to-be-signed part of the CRL (the CRL without the signature part). |
| crl_this_update | The date and time at which this version of the CRL was published. |
| embed_certificate_method | Controls the certificate disposition within the signature. |
| encoding | Specifies XML encoding. |
| external_crypto_async_document_id | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| external_crypto_custom_params | Custom parameters to be passed to the signing service (uninterpreted). |
| external_crypto_data | Additional data to be included in the async state and mirrored back by the requestor. |
| external_crypto_external_hash_calculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| external_crypto_hash_algorithm | Specifies the request's signature hash algorithm. |
| external_crypto_key_id | The ID of the pre-shared key used for DC request authentication. |
| external_crypto_key_secret | The pre-shared key used for DC request authentication. |
| external_crypto_method | Specifies the asynchronous signing method. |
| external_crypto_mode | Specifies the external cryptography mode. |
| external_crypto_public_key_algorithm | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
| fips_mode | Reserved. |
| ignore_chain_validation_errors | Makes the struct tolerant to chain validation errors. |
| input_bytes | Use this property to pass the input to struct in byte array form. |
| input_file | Specifies the SOAP message to be signed. |
| known_cert_count | The number of records in the KnownCert arrays. |
| known_cert_bytes | Returns the raw certificate data in DER format. |
| known_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| known_crl_count | The number of records in the KnownCRL arrays. |
| known_crl_bytes | Returns the raw CRL data in DER format. |
| known_crl_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| known_ocsp_count | The number of records in the KnownOCSP arrays. |
| known_ocsp_bytes | A buffer containing the raw OCSP response data. |
| known_ocsp_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| new_sig_canonicalization_method | The XML canonicalization method that was used for signing. |
| new_sig_chain_validation_details | The details of a certificate chain validation outcome. |
| new_sig_chain_validation_result | The outcome of a certificate chain validation routine. |
| new_sig_claimed_signing_time | The signing time from the signer's computer. |
| new_sig_compatibility_errors | Returns compatibility errors encountered during validation. |
| new_sig_contains_long_term_info | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| new_sig_entity_label | Use this property to get the signature entity label. |
| new_sig_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| new_sig_hash_algorithm | The hash algorithm used for signing. |
| new_sig_issuer_rdn | The Relative Distinguished Name of the signing certificate's issuer. |
| new_sig_last_archival_time | Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. |
| new_sig_level | Specifies which level or form of XAdES should be produced. |
| new_sig_parent_entity | Use this property to get the parent signature label. |
| new_sig_policy_hash | The signature policy hash value. |
| new_sig_policy_hash_algorithm | The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash. |
| new_sig_policy_id | The policy ID that was included or to be included into the signature. |
| new_sig_policy_uri | The signature policy URI that was included in the signature. |
| new_sig_serial_number | The serial number of the signing certificate. |
| new_sig_signature_bytes | Returns the binary representation of the SOAP signature. |
| new_sig_signature_type | The SOAP signature type to use. |
| new_sig_signature_validation_result | The outcome of the cryptographic signature validation. |
| new_sig_subject_key_id | Contains the subject key identifier of the signing certificate. |
| new_sig_subject_rdn | Contains information about the person owning the signing certificate. |
| new_sig_timestamped | Use this property to establish whether the signature contains an embedded timestamp. |
| new_sig_validated_signing_time | Contains the certified signing time. |
| new_sig_validation_log | Contains the complete log of the certificate validation routine. |
| new_sig_xades_version | Specifies XAdES version. |
| new_sig_xml_element | Specifies the XML element where to save the signature or containing the signature. |
| ocsp_count | The number of records in the OCSP arrays. |
| ocsp_bytes | A buffer containing the raw OCSP response data. |
| ocsp_entry_count | The number of SingleResponse elements contained in this OCSP response. |
| ocsp_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| ocsp_issuer | Indicates the issuer of this response (a CA or its authorized representative). |
| ocsp_issuer_rdn | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
| ocsp_location | The location of the OCSP responder. |
| ocsp_produced_at | Specifies the time when the response was produced, in UTC. |
| ocsp_sig_algorithm | The public key algorithm that was used by the CA to sign this OCSP response. |
| ocsp_source | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. |
| offline_mode | Switches the struct to offline mode. |
| output_bytes | Use this property to read the output the struct object has produced. |
| output_file | A file where the signed SOAP message will be saved. |
| profile | Specifies a pre-defined profile to apply when creating the signature. |
| proxy_address | The IP address of the proxy server. |
| proxy_authentication | The authentication type used by the proxy server. |
| proxy_password | The password to authenticate to the proxy server. |
| proxy_port | The port on the proxy server to connect to. |
| proxy_type | The type of the proxy server. |
| proxy_request_headers | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| proxy_response_body | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| proxy_response_headers | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| proxy_use_ipv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
| proxy_username | Specifies the username credential for proxy authentication. |
| reference_count | The number of records in the Reference arrays. |
| reference_auto_generate_element_id | Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. |
| reference_canonicalization_method | Use this property to specify the canonicalization method for the transform of the reference. |
| reference_custom_element_id | Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. |
| reference_data_object_description | This property contains textual information related to the referenced data object, which is found in the corresponding DataObjectFormat's Description element. |
| reference_data_object_encoding | This property contains an indication of the encoding format of the referenced data object, which is found in the corresponding DataObjectFormat's Encoding element. |
| reference_data_object_identifier | This property contains an identifier indicating the type of the referenced data object, which is found in the corresponding DataObjectFormat's ObjectIdentifier element. |
| reference_data_object_mime_type | This property contains an indication of the MIME type of the referenced data object, which is found in the corresponding DataObjectFormat's MimeType element. |
| reference_digest_value | Use this property to get or set the value of the digest calculated over the referenced data. |
| reference_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| reference_has_data_object_format | Specifies whether corresponding XAdES DataObjectFormat element is created for the current reference. |
| reference_hash_algorithm | Specifies the hash algorithm to be used. |
| reference_has_uri | Specifies whether the URI is set (even when it is empty). |
| reference_id | A user-defined identifier (ID) attribute of this Reference element. |
| reference_inclusive_namespaces_prefix_list | Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. |
| reference_type | The Reference's type attribute as defined in XMLDSIG specification. |
| reference_target_data | Contains the referenced external data when the digest value is not explicitly specified. |
| reference_target_type | The reference's target type to use. |
| reference_target_xml_element | This property specifies the referenced XML element. |
| reference_uri | Use this property to get or set the URL which references the data. |
| reference_use_base64_transform | Specifies whether Base64 transform is included in transform chain. |
| reference_use_enveloped_signature_transform | Specifies whether enveloped signature transform is included in transform chain. |
| reference_use_xpath_filter2_transform | Specifies whether XPath Filter 2. |
| reference_use_xpath_transform | Specifies whether XPath transform is included in transform chain. |
| reference_validation_result | The outcome of the cryptographic reference validation. |
| reference_xpath_expression | Use this property to specify XPath expression for XPath transform of the reference. |
| reference_xpath_filter2_expressions | Use this property to specify XPointer expression(s) for XPath Filter 2. |
| reference_xpath_filter2_filters | Use this property to specify XPointer filter(s) for XPath Filter 2. |
| reference_xpath_filter2_prefix_list | Use this property to specify a prefix list for XPath Filter 2. |
| reference_xpath_prefix_list | Use this property to specify a prefix list for XPath transform of the reference. |
| revocation_check | Specifies the kind(s) of revocation check to perform for all chain certificates. |
| security_header_index | Specifies the SecurityHeader index. |
| signature_count | The number of records in the Signature arrays. |
| signature_canonicalization_method | The XML canonicalization method that was used for signing. |
| signature_chain_validation_details | The details of a certificate chain validation outcome. |
| signature_chain_validation_result | The outcome of a certificate chain validation routine. |
| signature_claimed_signing_time | The signing time from the signer's computer. |
| signature_compatibility_errors | Returns compatibility errors encountered during validation. |
| signature_contains_long_term_info | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| signature_entity_label | Use this property to get the signature entity label. |
| signature_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signature_hash_algorithm | The hash algorithm used for signing. |
| signature_issuer_rdn | The Relative Distinguished Name of the signing certificate's issuer. |
| signature_last_archival_time | Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature. |
| signature_level | Specifies which level or form of XAdES should be produced. |
| signature_parent_entity | Use this property to get the parent signature label. |
| signature_policy_hash | The signature policy hash value. |
| signature_policy_hash_algorithm | The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash. |
| signature_policy_id | The policy ID that was included or to be included into the signature. |
| signature_policy_uri | The signature policy URI that was included in the signature. |
| signature_serial_number | The serial number of the signing certificate. |
| signature_bytes | Returns the binary representation of the SOAP signature. |
| signature_type | The SOAP signature type to use. |
| signature_validation_result | The outcome of the cryptographic signature validation. |
| signature_subject_key_id | Contains the subject key identifier of the signing certificate. |
| signature_subject_rdn | Contains information about the person owning the signing certificate. |
| signature_timestamped | Use this property to establish whether the signature contains an embedded timestamp. |
| signature_validated_signing_time | Contains the certified signing time. |
| signature_validation_log | Contains the complete log of the certificate validation routine. |
| signature_xades_version | Specifies XAdES version. |
| signature_xml_element | Specifies the XML element where to save the signature or containing the signature. |
| signing_cert_bytes | Returns the raw certificate data in DER format. |
| signing_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| signing_chain_count | The number of records in the SigningChain arrays. |
| signing_chain_bytes | Returns the raw certificate data in DER format. |
| signing_chain_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| socket_dns_mode | Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system. |
| socket_dns_port | Specifies the port number to be used for sending queries to the DNS server. |
| socket_dns_query_timeout | The timeout (in milliseconds) for each DNS query. |
| socket_dns_servers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| socket_dns_total_timeout | The timeout (in milliseconds) for the whole resolution process. |
| socket_incoming_speed_limit | The maximum number of bytes to read from the socket, per second. |
| socket_local_address | The local network interface to bind the socket to. |
| socket_local_port | The local port number to bind the socket to. |
| socket_outgoing_speed_limit | The maximum number of bytes to write to the socket, per second. |
| socket_timeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| socket_use_ipv6 | Enables or disables IP protocol version 6. |
| timestamp_count | The number of records in the Timestamp arrays. |
| timestamp_accuracy | This property indicates the accuracy of the included time mark, in microseconds. |
| timestamp_bytes | Returns the raw timestamp data in DER format. |
| timestamp_certificate_index | Returns the index of the TSA certificate in the Certificates collection. |
| timestamp_chain_validation_details | The details of a certificate chain validation outcome. |
| timestamp_chain_validation_result | The outcome of a certificate chain validation routine. |
| timestamp_contains_long_term_info | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). |
| timestamp_entity_label | Use this property to get the timestamp entity label. |
| timestamp_hash_algorithm | Returns the timestamp's hash algorithm. |
| timestamp_parent_entity | Use this property to get the label of the timestamp's parent entity. |
| timestamp_serial_number | Returns the timestamp's serial number. |
| timestamp_time | The time point incorporated into the timestamp. |
| timestamp_type | Returns the type of the timestamp. |
| timestamp_tsa_name | This value uniquely identifies the Timestamp Authority (TSA). |
| timestamp_validation_log | Contains the TSA certificate chain validation log. |
| timestamp_validation_result | Contains the timestamp validation outcome. |
| timestamp_server | The address of the timestamping server. |
| tls_client_cert_count | The number of records in the TLSClientCert arrays. |
| tls_client_cert_bytes | Returns the raw certificate data in DER format. |
| tls_client_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| tls_server_cert_count | The number of records in the TLSServerCert arrays. |
| tls_server_cert_bytes | Returns the raw certificate data in DER format. |
| tls_server_cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| tls_server_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| tls_server_cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
| tls_server_cert_issuer_rdn | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| tls_server_cert_key_algorithm | Specifies the public key algorithm of this certificate. |
| tls_server_cert_key_bits | Returns the length of the public key in bits. |
| tls_server_cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| tls_server_cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| tls_server_cert_serial_number | Returns the certificate's serial number. |
| tls_server_cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| tls_server_cert_subject | 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 | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| tls_server_cert_valid_from | The time point at which the certificate becomes valid, in UTC. |
| tls_server_cert_valid_to | The time point at which the certificate expires, in UTC. |
| tls_auto_validate_certificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| tls_base_configuration | Selects the base configuration for the TLS settings. |
| tls_ciphersuites | A list of ciphersuites separated with commas or semicolons. |
| tls_client_auth | Enables or disables certificate-based client authentication. |
| tls_extensions | Provides access to TLS extensions. |
| tls_force_resume_if_destination_changes | Whether to force TLS session resumption when the destination address changes. |
| tls_groups | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| tls_pre_shared_identity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| tls_pre_shared_key | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| tls_pre_shared_key_ciphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| tls_renegotiation_attack_prevention_mode | Selects the renegotiation attack prevention mechanism. |
| tls_revocation_check | Specifies the kind(s) of revocation check to perform. |
| tls_ssl_options | 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 | Specifies the TLS mode to use. |
| tls_use_extended_master_secret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| tls_use_session_resumption | Enables or disables the TLS session resumption capability. |
| tls_versions | The SSL/TLS versions to enable by default. |
| trusted_cert_count | The number of records in the TrustedCert arrays. |
| trusted_cert_bytes | Returns the raw certificate data in DER format. |
| trusted_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| validation_moment | The time point at which signature validity is to be established. |
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_body_reference | Creates a new XML reference to the Body element of the SOAP message. |
| add_data_reference | Creates a new XML reference to the specified data. |
| add_known_namespace | Adds known prefix and correspondent namespace URI. |
| add_reference | Creates a new XML reference to the specified XML element. |
| close | Closes an opened SOAP message. |
| config | Sets or retrieves a configuration setting. |
| do_action | Performs an additional action. |
| extract_async_data | Extracts user data from the DC signing service response. |
| get_inner_xml | Get the inner XML content of the selected XML element. |
| get_outer_xml | Get the outer XML content of the selected XML element. |
| get_text_content | Get the text content of the selected XML element. |
| open | Opens a document for signing or updating. |
| reset | Resets the struct settings. |
| revalidate | Revalidates a signature in accordance with current settings. |
| select_info | Select signature information for a specific entity. |
| set_inner_xml | Set the inner XML content of the selected XML element. |
| set_text_content | Set the text content of the selected XML element. |
| sign | Signs the SOAP message. |
| sign_async_begin | Initiates the asynchronous signing operation. |
| sign_async_end | Completes the asynchronous signing operation. |
| sign_external | Signs the document using an external signing facility. |
| timestamp | Use this method to add an timestamp. |
| upgrade | Upgrades existing XAdES signature to a new form. |
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_chain_element_download | Fires when there is a need to download a chain element from an online source. |
| on_chain_element_needed | Fires when an element required to validate the chain was not located. |
| on_chain_element_store | This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature. |
| on_chain_validated | Reports the completion of a certificate chain validation. |
| on_chain_validation_progress | This event is fired multiple times during chain validation to report various stages of the validation procedure. |
| on_error | Information about errors during signing. |
| on_external_sign | Handles remote or external signing initiated by the SignExternal method or other source. |
| on_format_element | Reports the XML element that is currently being processed. |
| on_format_text | Reports XML text that is currently being processed. |
| on_message_loaded | This event is fired when the message has been loaded into memory. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_reference_validated | Marks the end of a reference validation. |
| on_resolve_reference | Asks the application to resolve a reference. |
| on_signature_found | Signifies the start of signature validation. |
| on_signature_validated | Marks the completion of the signature validation routine. |
| on_timestamp_found | Signifies the start of a timestamp validation routine. |
| on_timestamp_request | Fires when the struct is ready to request a timestamp from an external TSA. |
| on_timestamp_validated | Reports the completion of the timestamp validation routine. |
| on_tls_cert_needed | Fires when a remote TLS party requests a client certificate. |
| on_tls_cert_validate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| on_tls_established | Fires when a TLS handshake with Host successfully completes. |
| on_tls_handshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
| on_tls_shutdown | 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.
| AddAllDataObjectsTimestamp | Whether to add all data objects timestamp during signing. |
| AsyncDocumentID | Specifies the document ID for SignAsyncEnd() call. |
| BinarySecurityTokenID | Specifies the ID for BinarySecurityToken element. |
| BinarySecurityTokenType | Specifies the token type for BinarySecurityToken element. |
| CachedCRLMaxAge | Specifies the maximum age of a cached CRL. |
| CachedCRLMaxAgeRatio | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. |
| CachedCRLOverlapTime | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. |
| CachedOCSPResponseMaxAge | Specifies the maximum age of a cached OCSP response. |
| CachedOCSPResponseMaxAgeRatio | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. |
| CachedOCSPResponseOverlapTime | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. |
| ChainCurrentCACert | Returns the current CA certificate. |
| ChainCurrentCert | Returns the certificate that is currently being validated. |
| ChainCurrentCRL | Returns the current CRL. |
| ChainCurrentCRLSize | Returns the size of the current CRL. |
| ChainCurrentOCSP | Returns the current OCSP response. |
| ChainCurrentOCSPSigner | Returns the signer of the current OCSP object. |
| ChainInterimDetails | Returns the current interim validation details. |
| ChainInterimResult | Returns the current interim validation result. |
| CheckValidityPeriodForTrusted | Whether to check validity period for trusted certificates. |
| ClaimedRolesXML | The XML content of the claimed roles. |
| ClaimedRoleText | The text of the claimed role. |
| CommitmentTypeIndicationAllSignedDataObjects[Index] | Specifies the CommitmentTypeIndication's AllSignedDataObjects. |
| CommitmentTypeIndicationCount | The number of the CommitmentTypeIndication elements. |
| CommitmentTypeIndicationIdentifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Identifier. |
| CommitmentTypeIndicationIdentifierDescription[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's Description. |
| CommitmentTypeIndicationIdentifierDocumentationReferences[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's DocumentationReferences. |
| CommitmentTypeIndicationIdentifierQualifier[Index] | Specifies the CommitmentTypeIndication's CommitmentTypeId's IdentifierQualifier. |
| CommitmentTypeIndicationObjectReference[Index] | Specifies the CommitmentTypeIndication's ObjectReference. |
| CommitmentTypeIndicationQualifiersXML[Index] | The XML content of the CommitmentTypeIndication's Qualifiers. |
| CustomTrustedLists | Specifies the custom TrustedLists. |
| CustomTSLs | Specifies the custom TrustedLists. |
| DataObjectFormatCount | The number of the DataObjectFormat elements. |
| DataObjectFormatDescription[Index] | Specifies the DataObjectFormat's Description. |
| DataObjectFormatEncoding[Index] | Specifies the DataObjectFormat's Encoding. |
| DataObjectFormatMimeType[Index] | Specifies the DataObjectFormat's MimeType. |
| DataObjectFormatObjectIdentifier[Index] | Specifies the DataObjectFormat's ObjectIdentifier's Identifier. |
| DataObjectFormatObjectIdentifierDescription[Index] | Specifies the DataObjectFormat's ObjectIdentifier's Description. |
| DataObjectFormatObjectIdentifierDocumentationReferences[Index] | Specifies the DataObjectFormat's ObjectIdentifier's DocumentationReferences. |
| DataObjectFormatObjectIdentifierQualifier[Index] | Specifies the DataObjectFormat's ObjectIdentifier's IdentifierQualifier. |
| DataObjectFormatObjectReference[Index] | Specifies the DataObjectFormat's ObjectReference. |
| DeltaCRLPreference | Specifies whether complete or delta CRLs are preferred. |
| DislikeOpenEndedOCSPs | Tells the struct to discourage OCSP responses without an explicit NextUpdate parameter. |
| EvaluateSystemTrust | Enables or disables usage of the platform's built-in trust validation facilities. |
| EvaluateSystemTrustForSelfSignedCertificates | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. |
| EvaluateSystemTrustForSSL | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. |
| ExclusiveCanonicalizationPrefix | Specifies the exclusive canonicalization prefix. |
| ForceCompleteChainValidation | Whether to check the CA certificates when the signing certificate is invalid. |
| ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
| GracePeriod | Specifies a grace period to apply during revocation information checks. |
| HMACKey | The key value for HMAC. |
| HMACOutputLength | Sets the length of the HMAC output. |
| HMACSigningUsed | Whether to use HMAC signing. |
| IgnoreChainLoops | Whether chain loops should be ignored. |
| IgnoreChainValidationErrors | Whether to ignore any certificate chain validation issues. |
| IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| IgnoreTimestampFailure | Whether to ignore time-stamping failure during signing. |
| ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
| IncludeKey | Specifies whether to include the signing key to the signature. |
| IncludeKeyValue | Specifies whether the key value must be included to the signature. |
| IncludeKnownRevocationInfoToSignature | Whether to include custom revocation info to the signature. |
| InclusiveNamespacesPrefixList | Specifies the InclusiveNamespaces PrefixList. |
| KeyInfoCustomXML | The custom XML content for KeyInfo element. |
| KeyInfoDetails | Specifies the signing key info details to include to the signature. |
| KeyInfoID | Specifies the ID for KeyInfo element. |
| KeyName | Contains information about the key used for signing. |
| NormalizeNewLine | Controls whether newline combinations should be automatically normalized. |
| PolicyDescription | signature policy description. |
| PolicyExplicitText | The explicit text of the user notice. |
| PolicyUNNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| PolicyUNOrganization | The organization part of the NoticeReference qualifier. |
| PrependCustomXML | The custom XML content that prepended before signature. |
| ProductionPlace | Identifies the place of the signature production. |
| PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
| PSSUsed | Whether to use RSASSA-PSS algorithm. |
| QualifyingPropertiesID | Specifies the ID for QualifyingProperties element. |
| QualifyingPropertiesObjectID | Specifies the ID for object with QualifyingProperties element. |
| QualifyingPropertiesReferenceCount | The number of the QualifyingPropertiesReference elements. |
| QualifyingPropertiesReferenceID[Index] | Specifies the QualifyingPropertiesReference's ID. |
| QualifyingPropertiesReferenceURI[Index] | Specifies the QualifyingPropertiesReference's URI. |
| RefsTimestampType | Specifies references timestamp type to include to the signature. |
| RevocationCacheAgePolicy | Specifies a preset policy for cached CRL and OCSP response freshness settings. |
| SchemeParams | The algorithm scheme parameters to employ. |
| SecurityHeaderIndex | Specifies the SecurityHeader index. |
| SecurityHeaderMustUnderstand | Specifies the MustUnderstand for SecurityHeader element. |
| SecurityTokenReferenceID | Specifies the ID for SecurityTokenReference element. |
| SecurityTokenReferenceTokenType | Specifies the token type for SecurityTokenReference element. |
| SignatureID | Specifies the ID for Signature element. |
| SignaturePrefix | Specifies the signature prefix. |
| SignatureValueID | Specifies the ID for SignatureValue element. |
| SignedInfoID | Specifies the ID for SignedInfo element. |
| SignedPropertiesID | Specifies the ID for SignedProperties element. |
| SignedPropertiesReferenceCanonicalizationMethod | Specifies the canonicalization method used in SignedProperties reference. |
| SignedPropertiesReferenceHashAlgorithm | Specifies the hash algorithm used in SignedProperties reference. |
| SignedPropertiesReferenceID | Specifies the ID for Reference element that points to SignedProperties element. |
| SignedPropertiesReferenceInclusiveNamespacesPrefixList | Specifies the InclusiveNamespaces PrefixList used in SignedProperties reference. |
| SignedPropertiesReferenceIndex | Specifies the index of SignedProperties reference. |
| SignedSignaturePropertiesID | Specifies the ID for SignedSignatureProperties element. |
| SigningCertificatesChain | Specifies which certificates from SigningChain are included in the xades:SigningCertificate element. |
| SigningCertificatesHashAlgorithm | Specifies the hash algorithm used for SigningCertificates. |
| SigningTimeFormat | Specifies the date time format for the XAdES signing time. |
| SigningTimeIsUTC | Specifies whether the XAdES signing time is in UTC. |
| SigningTimeZoneOffset | Specifies the time zone offset for the XAdES signing time. |
| SigPolicyDescription | signature policy description. |
| SigPolicyExplicitText | The explicit text of the user notice. |
| SigPolicyHash | The EPES policy hash. |
| SigPolicyHashAlgorithm | The hash algorithm that was used to generate the EPES policy hash. |
| SigPolicyID | The EPES policy ID. |
| SigPolicyNoticeNumbers | The noticeNumbers part of the NoticeReference CAdES attribute. |
| SigPolicyNoticeOrganization | The organization part of the NoticeReference qualifier. |
| SigPolicyURI | The EPES policy URI. |
| StripWhitespace | Controls whether excessive whitespace characters should be stripped off when loading the document. |
| TempPath | Path for storing temporary files. |
| TimestampCanonicalizationMethod | Specifies canonicalization method used in timestamp. |
| TimestampResponse | A base16-encoded timestamp response received from a TSA. |
| TimestampValidationDataDetails | Specifies timestamp validation data details to include to the signature. |
| TLSChainValidationDetails | Contains the advanced details of the TLS server certificate validation. |
| TLSChainValidationResult | Contains the result of the TLS server certificate validation. |
| TLSClientAuthRequested | Indicates whether the TLS server requests client authentication. |
| TLSValidationLog | Contains the log of the TLS server certificate validation. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TspAttemptCount | Specifies the number of timestamping request attempts. |
| TspHashAlgorithm | Sets a specific hash algorithm for use with the timestamping service. |
| TspReqPolicy | Sets a request policy ID to include in the timestamping request. |
| UseCustomTransformOrder | Enables custom ordering for the document transforms. |
| UseDefaultTrustedLists | Enables or disables the use of the default TrustedLists. |
| UseDefaultTSLs | Enables or disables the use of the default TrustedLists. |
| UseEnvStorages | Enables or disables use of the environment storages. |
| UseHMACSigning | Whether to use HMAC signing. |
| UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| UsePSS | Whether to use RSASSA-PSS algorithm. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
| UseValidatorSettingsForTLSValidation | Whether to employ the primary chain validator setup for auxiliary TLS chain validations. |
| ValidationDataRefsDetails | Specifies validation data references details to include to the signature. |
| ValidationDataRefsHashAlgorithm | Specifies the hash algorithm used in validation data references. |
| ValidationDataValuesDetails | Specifies validation data values details to include to the signature. |
| WriteBOM | Specifies whether byte-order mark should be written when saving the document. |
| WSSEPrefix | Specifies the WSSE prefix. |
| WSUPrefix | Specifies the WSU prefix. |
| WSUTimestampCreated | Specifies the message creation time. |
| WSUTimestampCreatedFormat | Specifies the date time format for message creation time. |
| WSUTimestampCreatedTimeIsUTC | Specifies whether the message creation time is in UTC. |
| WSUTimestampCreatedTimeZoneOffset | Specifies the time zone offset for message creation time. |
| WSUTimestampExpires | Specifies the message expiration time. |
| WSUTimestampExpiresFormat | Specifies the date time format for message expiration time. |
| WSUTimestampExpiresTimeIsUTC | Specifies whether the message expiration time is in UTC. |
| WSUTimestampExpiresTimeZoneOffset | Specifies the time zone offset for message expiration time. |
| WSUTimestampID | Specifies the ID for wsu:Timestamp element. |
| XAdESPrefix | Specifies the XAdES prefix. |
| XAdESv141Prefix | Specifies the XAdES v1.4.1 prefix. |
| XMLFormatting | Specifies the signature XML formatting. |
| XMLSerializationCanonicalizationMethod | Specifies the canonicalization method to use for serialization. |
| XMLSerializationMode | Specifies the serialization mode for the extracted part of XML document. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the struct. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| EnableSSHMLKEM | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server structs. |
| EnableTLSMLKEM | Enables support for ML-KEM and hybrid groups in TLS client and server structs. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client structs created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client structs should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
auto_validate_signatures property (SOAPSigner Struct)
Specifies whether struct should validate any present signatures when the document is opened.
Syntax
fn auto_validate_signatures(&self ) -> Result<bool, SecureBlackboxError>
fn set_auto_validate_signatures(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
This setting is switched off by default to speed up document processing. Even if the document is loaded with this property set to false, you can validate the signatures manually on a later stage using the revalidate method.
Data Type
bool
blocked_cert_count property (SOAPSigner Struct)
The number of records in the BlockedCert arrays.
Syntax
fn blocked_cert_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_blocked_cert_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at blocked_cert_count - 1.Data Type
i32
blocked_cert_bytes property (SOAPSigner Struct)
Returns the raw certificate data in DER format.
Syntax
fn blocked_cert_bytes(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is read-only.
Data Type
Vec
blocked_cert_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn blocked_cert_handle(&self , BlockedCertIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_blocked_cert_handle(&self, BlockedCertIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
Data Type
i64
cert_count property (SOAPSigner Struct)
The number of records in the Cert arrays.
Syntax
fn cert_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- cert_bytes
- cert_ca
- cert_ca_key_id
- cert_crl_distribution_points
- cert_curve
- cert_fingerprint
- cert_friendly_name
- cert_handle
- cert_hash_algorithm
- cert_issuer
- cert_issuer_rdn
- cert_key_algorithm
- cert_key_bits
- cert_key_fingerprint
- cert_key_usage
- cert_key_valid
- cert_ocsp_locations
- cert_ocsp_no_check
- cert_origin
- cert_policy_i_ds
- cert_private_key_bytes
- cert_private_key_exists
- cert_private_key_extractable
- cert_public_key_bytes
- cert_qualified
- cert_qualified_statements
- cert_qualifiers
- cert_self_signed
- cert_serial_number
- cert_sig_algorithm
- cert_source
- cert_subject
- cert_subject_alternative_name
- cert_subject_key_id
- cert_subject_rdn
- cert_type
- cert_valid
- cert_valid_from
- cert_valid_to
This property is read-only.
Data Type
i32
cert_bytes property (SOAPSigner Struct)
Returns the raw certificate data in DER format.
Syntax
fn cert_bytes(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
Vec
cert_ca property (SOAPSigner Struct)
Indicates whether the certificate has a CA capability.
Syntax
fn cert_ca(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
bool
cert_ca_key_id property (SOAPSigner Struct)
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Syntax
fn cert_ca_key_id(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
Vec
cert_type property (SOAPSigner Struct)
Returns the type of the entity contained in the Certificate object.
Syntax
fn cert_type(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // X509Certificate
2 // X509CertificateRequest
Default Value
0
Remarks
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager struct to load or create new certificate and certificate requests objects.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_crl_distribution_points property (SOAPSigner Struct)
Contains a list of locations of CRL distribution points used to check this certificate's validity.
Syntax
fn cert_crl_distribution_points(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_curve property (SOAPSigner Struct)
Specifies the elliptic curve associated with the certificate's public key.
Syntax
fn cert_curve(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
| SB_EC_SECP112R1 | SECP112R1 | |
| SB_EC_SECP112R2 | SECP112R2 | |
| SB_EC_SECP128R1 | SECP128R1 | |
| SB_EC_SECP128R2 | SECP128R2 | |
| SB_EC_SECP160K1 | SECP160K1 | |
| SB_EC_SECP160R1 | SECP160R1 | |
| SB_EC_SECP160R2 | SECP160R2 | |
| SB_EC_SECP192K1 | SECP192K1 | |
| SB_EC_SECP192R1 | SECP192R1 | |
| SB_EC_SECP224K1 | SECP224K1 | |
| SB_EC_SECP224R1 | SECP224R1 | |
| SB_EC_SECP256K1 | SECP256K1 | |
| SB_EC_SECP256R1 | SECP256R1 | |
| SB_EC_SECP384R1 | SECP384R1 | |
| SB_EC_SECP521R1 | SECP521R1 | |
| SB_EC_SECT113R1 | SECT113R1 | |
| SB_EC_SECT113R2 | SECT113R2 | |
| SB_EC_SECT131R1 | SECT131R1 | |
| SB_EC_SECT131R2 | SECT131R2 | |
| SB_EC_SECT163K1 | SECT163K1 | |
| SB_EC_SECT163R1 | SECT163R1 | |
| SB_EC_SECT163R2 | SECT163R2 | |
| SB_EC_SECT193R1 | SECT193R1 | |
| SB_EC_SECT193R2 | SECT193R2 | |
| SB_EC_SECT233K1 | SECT233K1 | |
| SB_EC_SECT233R1 | SECT233R1 | |
| SB_EC_SECT239K1 | SECT239K1 | |
| SB_EC_SECT283K1 | SECT283K1 | |
| SB_EC_SECT283R1 | SECT283R1 | |
| SB_EC_SECT409K1 | SECT409K1 | |
| SB_EC_SECT409R1 | SECT409R1 | |
| SB_EC_SECT571K1 | SECT571K1 | |
| SB_EC_SECT571R1 | SECT571R1 | |
| SB_EC_PRIME192V1 | PRIME192V1 | |
| SB_EC_PRIME192V2 | PRIME192V2 | |
| SB_EC_PRIME192V3 | PRIME192V3 | |
| SB_EC_PRIME239V1 | PRIME239V1 | |
| SB_EC_PRIME239V2 | PRIME239V2 | |
| SB_EC_PRIME239V3 | PRIME239V3 | |
| SB_EC_PRIME256V1 | PRIME256V1 | |
| SB_EC_C2PNB163V1 | C2PNB163V1 | |
| SB_EC_C2PNB163V2 | C2PNB163V2 | |
| SB_EC_C2PNB163V3 | C2PNB163V3 | |
| SB_EC_C2PNB176W1 | C2PNB176W1 | |
| SB_EC_C2TNB191V1 | C2TNB191V1 | |
| SB_EC_C2TNB191V2 | C2TNB191V2 | |
| SB_EC_C2TNB191V3 | C2TNB191V3 | |
| SB_EC_C2ONB191V4 | C2ONB191V4 | |
| SB_EC_C2ONB191V5 | C2ONB191V5 | |
| SB_EC_C2PNB208W1 | C2PNB208W1 | |
| SB_EC_C2TNB239V1 | C2TNB239V1 | |
| SB_EC_C2TNB239V2 | C2TNB239V2 | |
| SB_EC_C2TNB239V3 | C2TNB239V3 | |
| SB_EC_C2ONB239V4 | C2ONB239V4 | |
| SB_EC_C2ONB239V5 | C2ONB239V5 | |
| SB_EC_C2PNB272W1 | C2PNB272W1 | |
| SB_EC_C2PNB304W1 | C2PNB304W1 | |
| SB_EC_C2TNB359V1 | C2TNB359V1 | |
| SB_EC_C2PNB368W1 | C2PNB368W1 | |
| SB_EC_C2TNB431R1 | C2TNB431R1 | |
| SB_EC_NISTP192 | NISTP192 | |
| SB_EC_NISTP224 | NISTP224 | |
| SB_EC_NISTP256 | NISTP256 | |
| SB_EC_NISTP384 | NISTP384 | |
| SB_EC_NISTP521 | NISTP521 | |
| SB_EC_NISTB163 | NISTB163 | |
| SB_EC_NISTB233 | NISTB233 | |
| SB_EC_NISTB283 | NISTB283 | |
| SB_EC_NISTB409 | NISTB409 | |
| SB_EC_NISTB571 | NISTB571 | |
| SB_EC_NISTK163 | NISTK163 | |
| SB_EC_NISTK233 | NISTK233 | |
| SB_EC_NISTK283 | NISTK283 | |
| SB_EC_NISTK409 | NISTK409 | |
| SB_EC_NISTK571 | NISTK571 | |
| SB_EC_GOSTCPTEST | GOSTCPTEST | |
| SB_EC_GOSTCPA | GOSTCPA | |
| SB_EC_GOSTCPB | GOSTCPB | |
| SB_EC_GOSTCPC | GOSTCPC | |
| SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
| SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
| SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
| SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
| SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
| SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
| SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
| SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
| SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
| SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
| SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
| SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
| SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
| SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
| SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
| SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
| SB_EC_CURVE25519 | CURVE25519 | |
| SB_EC_CURVE448 | CURVE448 |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_fingerprint property (SOAPSigner Struct)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
fn cert_fingerprint(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_friendly_name property (SOAPSigner Struct)
Contains an associated alias (friendly name) of the certificate.
Syntax
fn cert_friendly_name(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn cert_handle(&self , CertIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i64
cert_hash_algorithm property (SOAPSigner Struct)
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
Syntax
fn cert_hash_algorithm(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_issuer property (SOAPSigner Struct)
The common name of the certificate issuer (CA), typically a company name.
Syntax
fn cert_issuer(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
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 cert_issuer_rdn.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_issuer_rdn property (SOAPSigner Struct)
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
fn cert_issuer_rdn(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_key_algorithm property (SOAPSigner Struct)
Specifies the public key algorithm of this certificate.
Syntax
fn cert_key_algorithm(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
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 cert_key_bits, cert_curve, and cert_public_key_bytes properties to get more details about the key the certificate contains.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_key_bits property (SOAPSigner Struct)
Returns the length of the public key in bits.
Syntax
fn cert_key_bits(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
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 cert_public_key_bytes or cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_key_fingerprint property (SOAPSigner Struct)
Returns a SHA1 fingerprint of the public key contained in the certificate.
Syntax
fn cert_key_fingerprint(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the cert_fingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_key_usage property (SOAPSigner Struct)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
fn cert_key_usage(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
| ckuUnknown | 0x00000 | Unknown key usage |
| ckuDigitalSignature | 0x00001 | Digital signature |
| ckuNonRepudiation | 0x00002 | Non-repudiation |
| ckuKeyEncipherment | 0x00004 | Key encipherment |
| ckuDataEncipherment | 0x00008 | Data encipherment |
| ckuKeyAgreement | 0x00010 | Key agreement |
| ckuKeyCertSign | 0x00020 | Certificate signing |
| ckuCRLSign | 0x00040 | Revocation signing |
| ckuEncipherOnly | 0x00080 | Encipher only |
| ckuDecipherOnly | 0x00100 | Decipher only |
| ckuServerAuthentication | 0x00200 | Server authentication |
| ckuClientAuthentication | 0x00400 | Client authentication |
| ckuCodeSigning | 0x00800 | Code signing |
| ckuEmailProtection | 0x01000 | Email protection |
| ckuTimeStamping | 0x02000 | Timestamping |
| ckuOCSPSigning | 0x04000 | OCSP signing |
| ckuSmartCardLogon | 0x08000 | Smartcard logon |
| ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
| ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this property before generating the certificate to propagate the key usage flags to the new certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_key_valid property (SOAPSigner Struct)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
fn cert_key_valid(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
bool
cert_ocsp_locations property (SOAPSigner Struct)
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Syntax
fn cert_ocsp_locations(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this property before calling the certificate manager's generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_ocsp_no_check property (SOAPSigner Struct)
Accessor to the value of the certificate's ocsp-no-check extension.
Syntax
fn cert_ocsp_no_check(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Accessor to the value of the certificate's ocsp-no-check extension.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
bool
cert_origin property (SOAPSigner Struct)
Returns the location that the certificate was taken or loaded from.
Syntax
fn cert_origin(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Returns the location that the certificate was taken or loaded from.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_policy_i_ds property (SOAPSigner Struct)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
fn cert_policy_i_ds(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this property when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_private_key_bytes property (SOAPSigner Struct)
Returns the certificate's private key in DER-encoded format.
Syntax
fn cert_private_key_bytes(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
Vec
cert_private_key_exists property (SOAPSigner Struct)
Indicates whether the certificate has a usable private key associated with it.
Syntax
fn cert_private_key_exists(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This property is independent from cert_private_key_bytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
bool
cert_private_key_extractable property (SOAPSigner Struct)
Indicates whether the private key is extractable (exportable).
Syntax
fn cert_private_key_extractable(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether the private key is extractable (exportable).
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
bool
cert_public_key_bytes property (SOAPSigner Struct)
Contains the certificate's public key in DER format.
Syntax
fn cert_public_key_bytes(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
Vec
cert_qualified property (SOAPSigner Struct)
Indicates whether the certificate is qualified.
Syntax
fn cert_qualified(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
bool
cert_qualified_statements property (SOAPSigner Struct)
Returns a simplified qualified status of the certificate.
Syntax
fn cert_qualified_statements(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // NonQualified
1 // QualifiedHardware
2 // QualifiedSoftware
Default Value
0
Remarks
Returns a simplified qualified status of the certificate.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_qualifiers property (SOAPSigner Struct)
A list of qualifiers.
Syntax
fn cert_qualifiers(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_self_signed property (SOAPSigner Struct)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
fn cert_self_signed(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
bool
cert_serial_number property (SOAPSigner Struct)
Returns the certificate's serial number.
Syntax
fn cert_serial_number(&self , CertIndex : i32) -> Result<Vec<u8>, 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 CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
Vec
cert_sig_algorithm property (SOAPSigner Struct)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
fn cert_sig_algorithm(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_source property (SOAPSigner Struct)
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
fn cert_source(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
i32
cert_subject property (SOAPSigner Struct)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
fn cert_subject(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
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 cert_subject_rdn.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_subject_alternative_name property (SOAPSigner Struct)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
fn cert_subject_alternative_name(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main cert_subject_rdn field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_subject_key_id property (SOAPSigner Struct)
Contains a unique identifier of the certificate's cryptographic key.
Syntax
fn cert_subject_key_id(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The cert_subject_key_id and cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
Vec
cert_subject_rdn property (SOAPSigner Struct)
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
fn cert_subject_rdn(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_valid property (SOAPSigner Struct)
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
Syntax
fn cert_valid(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
bool
cert_valid_from property (SOAPSigner Struct)
The time point at which the certificate becomes valid, in UTC.
Syntax
fn cert_valid_from(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
cert_valid_to property (SOAPSigner Struct)
The time point at which the certificate expires, in UTC.
Syntax
fn cert_valid_to(&self , CertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.
This property is read-only.
Data Type
String
check_trusted_lists property (SOAPSigner Struct)
Specifies whether the struct should attempt to validate chain trust via a known Trusted List.
Syntax
fn check_trusted_lists(&self ) -> Result<bool, SecureBlackboxError>
fn set_check_trusted_lists(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).
Data Type
bool
crl_count property (SOAPSigner Struct)
The number of records in the CRL arrays.
Syntax
fn crl_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- crl_bytes
- crlca_key_id
- crl_entry_count
- crl_handle
- crl_issuer
- crl_issuer_rdn
- crl_location
- crl_next_update
- crl_sig_algorithm
- crl_source
- crltbs
- crl_this_update
This property is read-only.
Data Type
i32
crl_bytes property (SOAPSigner Struct)
Returns the raw CRL data in DER format.
Syntax
fn crl_bytes(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw CRL data in DER format.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
Vec
crlca_key_id property (SOAPSigner Struct)
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
Syntax
fn crlca_key_id(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
Vec
crl_entry_count property (SOAPSigner Struct)
Returns the number of certificate status entries in the CRL.
Syntax
fn crl_entry_count(&self , CRLIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Returns the number of certificate status entries in the CRL.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
i32
crl_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn crl_handle(&self , CRLIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
i64
crl_issuer property (SOAPSigner Struct)
The common name of the CRL issuer (CA), typically a company name.
Syntax
fn crl_issuer(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The common name of the CRL issuer (CA), typically a company name.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
String
crl_issuer_rdn property (SOAPSigner Struct)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Syntax
fn crl_issuer_rdn(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
String
crl_location property (SOAPSigner Struct)
The URL that the CRL was downloaded from.
Syntax
fn crl_location(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The URL that the CRL was downloaded from.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
String
crl_next_update property (SOAPSigner Struct)
The planned time and date of the next version of this CRL to be published.
Syntax
fn crl_next_update(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The planned time and date of the next version of this CRL to be published.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
String
crl_sig_algorithm property (SOAPSigner Struct)
The public key algorithm that was used by the CA to sign this CRL.
Syntax
fn crl_sig_algorithm(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
"0"
Remarks
The public key algorithm that was used by the CA to sign this CRL.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
String
crl_source property (SOAPSigner Struct)
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
fn crl_source(&self , CRLIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
i32
crltbs property (SOAPSigner Struct)
The to-be-signed part of the CRL (the CRL without the signature part).
Syntax
fn crltbs(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
The to-be-signed part of the CRL (the CRL without the signature part).
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
Vec
crl_this_update property (SOAPSigner Struct)
The date and time at which this version of the CRL was published.
Syntax
fn crl_this_update(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The date and time at which this version of the CRL was published.
The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.
This property is read-only.
Data Type
String
embed_certificate_method property (SOAPSigner Struct)
Controls the certificate disposition within the signature.
Syntax
fn embed_certificate_method(&self ) -> Result<i32, SecureBlackboxError>
fn set_embed_certificate_method(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // InSignature
1 // InBinarySecurityToken
2 // InSignedBinarySecurityToken
3 // InBinarySecurityTokenAndSignature
4 // None
Default Value
1
Remarks
This property controls the method of embedding the signing certificate(s) into the signature if WS-Security signature type is used.
Supported values:
| cwecInSignature | 0 | Embed certificate(s) into the signature |
| cwecInBinarySecurityToken | 1 | Embed certificate(s) into the BinarySecurityToken element |
| cwecInSignedBinarySecurityToken | 2 | Embed certificate(s) into the BinarySecurityToken element and sign them |
| cwecInBinarySecurityTokenAndSignature | 3 | Embed certificate(s) into the BinarySecurityToken element and the signature |
| cwecNone | 4 | Don't embed certificate(s) into the BinarySecurityToken element or the signature |
Data Type
i32
encoding property (SOAPSigner Struct)
Specifies XML encoding.
Syntax
fn encoding(&self ) -> Result<String, SecureBlackboxError>
fn set_encoding(&self, value : &str) -> Option<SecureBlackboxError> fn set_encoding_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify the encoding to apply to the XML documents.
Data Type
String
external_crypto_async_document_id property (SOAPSigner Struct)
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Syntax
fn external_crypto_async_document_id(&self ) -> Result<String, SecureBlackboxError>
fn set_external_crypto_async_document_id(&self, value : &str) -> Option<SecureBlackboxError> fn set_external_crypto_async_document_id_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
fn external_crypto_custom_params(&self ) -> Result<String, SecureBlackboxError>
fn set_external_crypto_custom_params(&self, value : &str) -> Option<SecureBlackboxError> fn set_external_crypto_custom_params_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
Data Type
String
external_crypto_data property (SOAPSigner Struct)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
fn external_crypto_data(&self ) -> Result<String, SecureBlackboxError>
fn set_external_crypto_data(&self, value : &str) -> Option<SecureBlackboxError> fn set_external_crypto_data_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
fn external_crypto_external_hash_calculation(&self ) -> Result<bool, SecureBlackboxError>
fn set_external_crypto_external_hash_calculation(&self, value : bool) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Specifies the request's signature hash algorithm.
Syntax
fn external_crypto_hash_algorithm(&self ) -> Result<String, SecureBlackboxError>
fn set_external_crypto_hash_algorithm(&self, value : &str) -> Option<SecureBlackboxError> fn set_external_crypto_hash_algorithm_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
The ID of the pre-shared key used for DC request authentication.
Syntax
fn external_crypto_key_id(&self ) -> Result<String, SecureBlackboxError>
fn set_external_crypto_key_id(&self, value : &str) -> Option<SecureBlackboxError> fn set_external_crypto_key_id_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
Data Type
String
external_crypto_key_secret property (SOAPSigner Struct)
The pre-shared key used for DC request authentication.
Syntax
fn external_crypto_key_secret(&self ) -> Result<String, SecureBlackboxError>
fn set_external_crypto_key_secret(&self, value : &str) -> Option<SecureBlackboxError> fn set_external_crypto_key_secret_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 topic.
Data Type
String
external_crypto_method property (SOAPSigner Struct)
Specifies the asynchronous signing method.
Syntax
fn external_crypto_method(&self ) -> Result<i32, SecureBlackboxError>
fn set_external_crypto_method(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // PKCS1
1 // 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 (SOAPSigner Struct)
Specifies the external cryptography mode.
Syntax
fn external_crypto_mode(&self ) -> Result<i32, SecureBlackboxError>
fn set_external_crypto_mode(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Default
1 // Disabled
2 // Generic
3 // DCAuth
4 // 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 (SOAPSigner Struct)
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
fn external_crypto_public_key_algorithm(&self ) -> Result<String, SecureBlackboxError>
fn set_external_crypto_public_key_algorithm(&self, value : &str) -> Option<SecureBlackboxError> fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Reserved.
Syntax
fn fips_mode(&self ) -> Result<bool, SecureBlackboxError>
fn set_fips_mode(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
This property is reserved for future use.
Data Type
bool
ignore_chain_validation_errors property (SOAPSigner Struct)
Makes the struct tolerant to chain validation errors.
Syntax
fn ignore_chain_validation_errors(&self ) -> Result<bool, SecureBlackboxError>
fn set_ignore_chain_validation_errors(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.
Data Type
bool
input_bytes property (SOAPSigner Struct)
Use this property to pass the input to struct in byte array form.
Syntax
fn input_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError>
fn set_input_bytes(&self, value : Vec<u8>) -> Option<SecureBlackboxError> fn set_input_bytes_ref(&self, value : &[u8]) -> Option<SecureBlackboxError>
Remarks
Assign a byte array containing the data to be processed to this property.
Data Type
Vec
input_file property (SOAPSigner Struct)
Specifies the SOAP message to be signed.
Syntax
fn input_file(&self ) -> Result<String, SecureBlackboxError>
fn set_input_file(&self, value : &str) -> Option<SecureBlackboxError> fn set_input_file_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Provide a full path to the SOAP message to be signed.
Data Type
String
known_cert_count property (SOAPSigner Struct)
The number of records in the KnownCert arrays.
Syntax
fn known_cert_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_known_cert_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at known_cert_count - 1.Data Type
i32
known_cert_bytes property (SOAPSigner Struct)
Returns the raw certificate data in DER format.
Syntax
fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is read-only.
Data Type
Vec
known_cert_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn known_cert_handle(&self , KnownCertIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
Data Type
i64
known_crl_count property (SOAPSigner Struct)
The number of records in the KnownCRL arrays.
Syntax
fn known_crl_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_known_crl_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at known_crl_count - 1.Data Type
i32
known_crl_bytes property (SOAPSigner Struct)
Returns the raw CRL data in DER format.
Syntax
fn known_crl_bytes(&self , KnownCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw CRL data in DER format.
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is read-only.
Data Type
Vec
known_crl_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn known_crl_handle(&self , KnownCRLIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_known_crl_handle(&self, KnownCRLIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
Data Type
i64
known_ocsp_count property (SOAPSigner Struct)
The number of records in the KnownOCSP arrays.
Syntax
fn known_ocsp_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_known_ocsp_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at known_ocsp_count - 1.Data Type
i32
known_ocsp_bytes property (SOAPSigner Struct)
A buffer containing the raw OCSP response data.
Syntax
fn known_ocsp_bytes(&self , KnownOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
A buffer containing the raw OCSP response data.
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is read-only.
Data Type
Vec
known_ocsp_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn known_ocsp_handle(&self , KnownOCSPIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_known_ocsp_handle(&self, KnownOCSPIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
Data Type
i64
new_sig_canonicalization_method property (SOAPSigner Struct)
The XML canonicalization method that was used for signing.
Syntax
fn new_sig_canonicalization_method(&self ) -> Result<i32, SecureBlackboxError>
fn set_new_sig_canonicalization_method(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // None
1 // Canon
2 // CanonComment
3 // ExclCanon
4 // ExclCanonComment
5 // MinCanon
6 // Canon_v1_1
7 // CanonComment_v1_1
Default Value
0
Remarks
The XML canonicalization method that was used for signing.
Supported canonicalization methods:
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
i32
new_sig_chain_validation_details property (SOAPSigner Struct)
The details of a certificate chain validation outcome.
Syntax
fn new_sig_chain_validation_details(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
i32
new_sig_chain_validation_result property (SOAPSigner Struct)
The outcome of a certificate chain validation routine.
Syntax
fn new_sig_chain_validation_result(&self ) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // ValidButUntrusted
2 // Invalid
3 // CantBeEstablished
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
i32
new_sig_claimed_signing_time property (SOAPSigner Struct)
The signing time from the signer's computer.
Syntax
fn new_sig_claimed_signing_time(&self ) -> Result<String, SecureBlackboxError>
fn set_new_sig_claimed_signing_time(&self, value : &str) -> Option<SecureBlackboxError> fn set_new_sig_claimed_signing_time_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The signing time from the signer's computer.
Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
String
new_sig_compatibility_errors property (SOAPSigner Struct)
Returns compatibility errors encountered during validation.
Syntax
fn new_sig_compatibility_errors(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Returns compatibility errors encountered during validation.
Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
i32
new_sig_contains_long_term_info property (SOAPSigner Struct)
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
Syntax
fn new_sig_contains_long_term_info(&self ) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
bool
new_sig_entity_label property (SOAPSigner Struct)
Use this property to get the signature entity label.
Syntax
fn new_sig_entity_label(&self ) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Use this property to get the signature entity label.
This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
String
new_sig_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn new_sig_handle(&self ) -> Result<i64, SecureBlackboxError>
fn set_new_sig_handle(&self, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
i64
new_sig_hash_algorithm property (SOAPSigner Struct)
The hash algorithm used for signing.
Syntax
fn new_sig_hash_algorithm(&self ) -> Result<String, SecureBlackboxError>
fn set_new_sig_hash_algorithm(&self, value : &str) -> Option<SecureBlackboxError> fn set_new_sig_hash_algorithm_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
"Unknown"
Remarks
The hash algorithm used for signing.
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
String
new_sig_issuer_rdn property (SOAPSigner Struct)
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
fn new_sig_issuer_rdn(&self ) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
String
new_sig_last_archival_time property (SOAPSigner Struct)
Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.
Syntax
fn new_sig_last_archival_time(&self ) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Indicates the most recent archival time of an archived signature
This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
String
new_sig_level property (SOAPSigner Struct)
Specifies which level or form of XAdES should be produced.
Syntax
fn new_sig_level(&self ) -> Result<i32, SecureBlackboxError>
fn set_new_sig_level(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Unknown
1 // Generic
2 // BaselineB
3 // BaselineT
4 // BaselineLT
5 // BaselineLTA
6 // BES
7 // EPES
8 // T
9 // C
10 // X
11 // XType1
12 // XType2
13 // XL
14 // XLType1
15 // XLType2
16 // A
17 // ExtendedBES
18 // ExtendedEPES
19 // ExtendedT
20 // ExtendedC
21 // ExtendedX
22 // ExtendedXType1
23 // ExtendedXType2
24 // ExtendedXLong
25 // ExtendedXL
26 // ExtendedXLType1
27 // ExtendedXLType2
28 // ExtendedA
29 // BaselineExtendedB
30 // BaselineExtendedT
31 // BaselineExtendedLT
32 // BaselineExtendedLTA
Default Value
2
Remarks
Specifies which level or form of XAdES should be produced.
Use this property to specify the level or form of advanced electronic signature to be produced.
Use the Generic value to produce XML-DSIG signature.
The supported levels and forms are:
| aslUnknown | 0 | Unknown signature level |
| aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) |
| aslBaselineB | 2 | Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineT | 3 | Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLT | 4 | Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBES | 6 | BES (Basic Electronic Signature) |
| aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| aslT | 8 | T (Timestamped) |
| aslC | 9 | C (T with revocation references) |
| aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) |
| aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) |
| aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslA | 16 | A (archived) |
| aslExtendedBES | 17 | Extended BES |
| aslExtendedEPES | 18 | Extended EPES |
| aslExtendedT | 19 | Extended T |
| aslExtendedC | 20 | Extended C |
| aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) |
| aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) |
| aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) |
| aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) |
| aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) |
| aslExtendedA | 28 | Extended A |
| aslBaselineExtendedB | 29 | Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedT | 30 | Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLT | 31 | Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLTA | 32 | Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only) |
* For XAdES form from XAdES v1.1.1 use either BES or EPES form values ** Extended forms are supported starting from XAdES v1.3.2
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
i32
new_sig_parent_entity property (SOAPSigner Struct)
Use this property to get the parent signature label.
Syntax
fn new_sig_parent_entity(&self ) -> Result<String, SecureBlackboxError>
fn set_new_sig_parent_entity(&self, value : &str) -> Option<SecureBlackboxError> fn set_new_sig_parent_entity_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to get the parent signature label.
This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
String
new_sig_policy_hash property (SOAPSigner Struct)
The signature policy hash value.
Syntax
fn new_sig_policy_hash(&self ) -> Result<String, SecureBlackboxError>
fn set_new_sig_policy_hash(&self, value : &str) -> Option<SecureBlackboxError> fn set_new_sig_policy_hash_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The signature policy hash value.
Use this property to get the signature policy hash from EPES signatures
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
String
new_sig_policy_hash_algorithm property (SOAPSigner Struct)
The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.
Syntax
fn new_sig_policy_hash_algorithm(&self ) -> Result<String, SecureBlackboxError>
fn set_new_sig_policy_hash_algorithm(&self, value : &str) -> Option<SecureBlackboxError> fn set_new_sig_policy_hash_algorithm_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The algorithm that was used to calculate the signature policy hash
Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from new_sig_policy_hash.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
String
new_sig_policy_id property (SOAPSigner Struct)
The policy ID that was included or to be included into the signature.
Syntax
fn new_sig_policy_id(&self ) -> Result<String, SecureBlackboxError>
fn set_new_sig_policy_id(&self, value : &str) -> Option<SecureBlackboxError> fn set_new_sig_policy_id_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The policy ID that was included or to be included into the signature.
Use this property to retrieve the signature policy identifier from EPES signatures.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
String
new_sig_policy_uri property (SOAPSigner Struct)
The signature policy URI that was included in the signature.
Syntax
fn new_sig_policy_uri(&self ) -> Result<String, SecureBlackboxError>
fn set_new_sig_policy_uri(&self, value : &str) -> Option<SecureBlackboxError> fn set_new_sig_policy_uri_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The signature policy URI that was included in the signature.
Use this property to set or retrieve the URI of the signature policy from EPES signatures.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
String
new_sig_serial_number property (SOAPSigner Struct)
The serial number of the signing certificate.
Syntax
fn new_sig_serial_number(&self ) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
The serial number of the signing certificate.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
Vec
new_sig_signature_bytes property (SOAPSigner Struct)
Returns the binary representation of the SOAP signature.
Syntax
fn new_sig_signature_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the binary representation of the SOAP signature.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
Vec
new_sig_signature_type property (SOAPSigner Struct)
The SOAP signature type to use.
Syntax
fn new_sig_signature_type(&self ) -> Result<i32, SecureBlackboxError>
fn set_new_sig_signature_type(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Unknown
1 // WSSSignature
2 // SOAPSignature
Default Value
1
Remarks
The SOAP signature type to use.
Use this property to specify the signature type to use when forming the signature.
Supported values:
| sstUnknown | 0 | Unknown signature |
| sstWSSSignature | 1 | Uses Web Services Security (WS-Security, WSS) signature. It is implemented according to the OASIS Web Services Security extension to SOAP |
| sstSOAPSignature | 2 | Uses SOAP signature. It is implemented according to the SOAP Security Extensions: Digital Signature. |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
i32
new_sig_signature_validation_result property (SOAPSigner Struct)
The outcome of the cryptographic signature validation.
Syntax
fn new_sig_signature_validation_result(&self ) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
i32
new_sig_subject_key_id property (SOAPSigner Struct)
Contains the subject key identifier of the signing certificate.
Syntax
fn new_sig_subject_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
Vec
new_sig_subject_rdn property (SOAPSigner Struct)
Contains information about the person owning the signing certificate.
Syntax
fn new_sig_subject_rdn(&self ) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
String
new_sig_timestamped property (SOAPSigner Struct)
Use this property to establish whether the signature contains an embedded timestamp.
Syntax
fn new_sig_timestamped(&self ) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Use this property to establish whether the signature contains an embedded timestamp.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
bool
new_sig_validated_signing_time property (SOAPSigner Struct)
Contains the certified signing time.
Syntax
fn new_sig_validated_signing_time(&self ) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the certified signing time.
Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.
new_sig_claimed_signing_time returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
String
new_sig_validation_log property (SOAPSigner Struct)
Contains the complete log of the certificate validation routine.
Syntax
fn new_sig_validation_log(&self ) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the complete log of the certificate validation routine.
Use this property to access the chain validation log produced by the struct. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
This property is read-only.
Data Type
String
new_sig_xades_version property (SOAPSigner Struct)
Specifies XAdES version.
Syntax
fn new_sig_xades_version(&self ) -> Result<i32, SecureBlackboxError>
fn set_new_sig_xades_version(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Unknown
1 // 111
2 // 122
3 // 132
4 // 141
Default Value
3
Remarks
Specifies XAdES version.
This property specifies the version of the XAdES specification the signature should comply with.
The supported versions are:
| xavUnknown | 0 | Unknown |
| xav111 | 1 | XAdES v1.1.1 |
| xav122 | 2 | XAdES v1.2.2 |
| xav132 | 3 | XAdES v1.3.2 |
| xav141 | 4 | XAdES v1.4.1 (aka v1.4.2) |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
i32
new_sig_xml_element property (SOAPSigner Struct)
Specifies the XML element where to save the signature or containing the signature.
Syntax
fn new_sig_xml_element(&self ) -> Result<String, SecureBlackboxError>
fn set_new_sig_xml_element(&self, value : &str) -> Option<SecureBlackboxError> fn set_new_sig_xml_element_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Specifies the XML element where to save the signature or containing the signature.
This property specifies the XML element where to save the electronic signature or that contains the signature to be validated.
Supported values are:
| "" | an empty string indicates the Document element |
| "#id" | indicates an XML element with specified Id |
| XPath expression | indicates an XML element selected using XPath expression. Use add_known_namespace method to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via add_known_namespace method. |
| Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
The parameter specifies the index of the item in the array. The size of the array is controlled by the NewSigCount property.
Data Type
String
ocsp_count property (SOAPSigner Struct)
The number of records in the OCSP arrays.
Syntax
fn ocsp_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- ocsp_bytes
- ocsp_entry_count
- ocsp_handle
- ocsp_issuer
- ocsp_issuer_rdn
- ocsp_location
- ocsp_produced_at
- ocsp_sig_algorithm
- ocsp_source
This property is read-only.
Data Type
i32
ocsp_bytes property (SOAPSigner Struct)
A buffer containing the raw OCSP response data.
Syntax
fn ocsp_bytes(&self , OCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
A buffer containing the raw OCSP response data.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
Vec
ocsp_entry_count property (SOAPSigner Struct)
The number of SingleResponse elements contained in this OCSP response.
Syntax
fn ocsp_entry_count(&self , OCSPIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
i32
ocsp_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn ocsp_handle(&self , OCSPIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
i64
ocsp_issuer property (SOAPSigner Struct)
Indicates the issuer of this response (a CA or its authorized representative).
Syntax
fn ocsp_issuer(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Indicates the issuer of this response (a CA or its authorized representative).
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
String
ocsp_issuer_rdn property (SOAPSigner Struct)
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Syntax
fn ocsp_issuer_rdn(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
String
ocsp_location property (SOAPSigner Struct)
The location of the OCSP responder.
Syntax
fn ocsp_location(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The location of the OCSP responder.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
String
ocsp_produced_at property (SOAPSigner Struct)
Specifies the time when the response was produced, in UTC.
Syntax
fn ocsp_produced_at(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the time when the response was produced, in UTC.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
String
ocsp_sig_algorithm property (SOAPSigner Struct)
The public key algorithm that was used by the CA to sign this OCSP response.
Syntax
fn ocsp_sig_algorithm(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
"0"
Remarks
The public key algorithm that was used by the CA to sign this OCSP response.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
String
ocsp_source property (SOAPSigner Struct)
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Syntax
fn ocsp_source(&self , OCSPIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Signature
2 // Document
3 // User
4 // Local
5 // Online
Default Value
0
Remarks
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.
This property is read-only.
Data Type
i32
offline_mode property (SOAPSigner Struct)
Switches the struct to offline mode.
Syntax
fn offline_mode(&self ) -> Result<bool, SecureBlackboxError>
fn set_offline_mode(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
When working in offline mode, the struct restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via known_certificates, known_crls, and other related properties.
Data Type
bool
output_bytes property (SOAPSigner Struct)
Use this property to read the output the struct object has produced.
Syntax
fn output_bytes(&self ) -> Result<Vec<u8>, 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 and output_stream properties had not been assigned.
This property is read-only.
Data Type
Vec
output_file property (SOAPSigner Struct)
A file where the signed SOAP message will be saved.
Syntax
fn output_file(&self ) -> Result<String, SecureBlackboxError>
fn set_output_file(&self, value : &str) -> Option<SecureBlackboxError> fn set_output_file_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Provide a full path to the file where the signed SOAP message should be saved.
Data Type
String
profile property (SOAPSigner Struct)
Specifies a pre-defined profile to apply when creating the signature.
Syntax
fn profile(&self ) -> Result<String, SecureBlackboxError>
fn set_profile(&self, value : &str) -> Option<SecureBlackboxError> fn set_profile_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.
Data Type
String
proxy_address property (SOAPSigner Struct)
The IP address of the proxy server.
Syntax
fn proxy_address(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_address(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_address_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
proxy_authentication property (SOAPSigner Struct)
The authentication type used by the proxy server.
Syntax
fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError>
fn set_proxy_authentication(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // NoAuthentication
1 // Basic
2 // Digest
3 // 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 (SOAPSigner Struct)
The password to authenticate to the proxy server.
Syntax
fn proxy_password(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_password(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_password_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
proxy_port property (SOAPSigner Struct)
The port on the proxy server to connect to.
Syntax
fn proxy_port(&self ) -> Result<i32, SecureBlackboxError>
fn set_proxy_port(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
i32
proxy_type property (SOAPSigner Struct)
The type of the proxy server.
Syntax
fn proxy_type(&self ) -> Result<i32, SecureBlackboxError>
fn set_proxy_type(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // None
1 // Socks4
2 // Socks5
3 // WebTunnel
4 // 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 (SOAPSigner Struct)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_request_headers(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_request_headers_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
proxy_response_body property (SOAPSigner Struct)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_response_body(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_response_body_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
proxy_response_headers property (SOAPSigner Struct)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_response_headers(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_response_headers_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
proxy_use_ipv6 property (SOAPSigner Struct)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError>
fn set_proxy_use_ipv6(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
bool
proxy_username property (SOAPSigner Struct)
Specifies the username credential for proxy authentication.
Syntax
fn proxy_username(&self ) -> Result<String, SecureBlackboxError>
fn set_proxy_username(&self, value : &str) -> Option<SecureBlackboxError> fn set_proxy_username_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
reference_count property (SOAPSigner Struct)
The number of records in the Reference arrays.
Syntax
fn reference_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_reference_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- reference_auto_generate_element_id
- reference_canonicalization_method
- reference_custom_element_id
- reference_data_object_description
- reference_data_object_encoding
- reference_data_object_identifier
- reference_data_object_mime_type
- reference_digest_value
- reference_handle
- reference_has_data_object_format
- reference_hash_algorithm
- reference_has_uri
- reference_id
- reference_inclusive_namespaces_prefix_list
- reference_target_data
- reference_target_type
- reference_target_xml_element
- reference_type
- reference_uri
- reference_use_base64_transform
- reference_use_enveloped_signature_transform
- reference_use_xpath_filter2_transform
- reference_use_xpath_transform
- reference_validation_result
- reference_xpath_expression
- reference_xpath_filter2_expressions
- reference_xpath_filter2_filters
- reference_xpath_filter2_prefix_list
- reference_xpath_prefix_list
Data Type
i32
reference_auto_generate_element_id property (SOAPSigner Struct)
Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.
Syntax
fn reference_auto_generate_element_id(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError>
fn set_reference_auto_generate_element_id(&self, ReferenceIndex : i32, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are empty.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
bool
reference_canonicalization_method property (SOAPSigner Struct)
Use this property to specify the canonicalization method for the transform of the reference.
Syntax
fn reference_canonicalization_method(&self , ReferenceIndex : i32) -> Result<i32, SecureBlackboxError>
fn set_reference_canonicalization_method(&self, ReferenceIndex : i32, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // None
1 // Canon
2 // CanonComment
3 // ExclCanon
4 // ExclCanonComment
5 // MinCanon
6 // Canon_v1_1
7 // CanonComment_v1_1
Default Value
0
Remarks
Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 |
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
i32
reference_custom_element_id property (SOAPSigner Struct)
Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.
Syntax
fn reference_custom_element_id(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_custom_element_id(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_custom_element_id_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_data_object_description property (SOAPSigner Struct)
This property contains textual information related to the referenced data object, which is found in the corresponding DataObjectFormat's Description element.
Syntax
fn reference_data_object_description(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_data_object_description(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_data_object_description_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
This property contains textual information related to the referenced data object, which is found in the corresponding DataObjectFormat's Description element.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_data_object_encoding property (SOAPSigner Struct)
This property contains an indication of the encoding format of the referenced data object, which is found in the corresponding DataObjectFormat's Encoding element.
Syntax
fn reference_data_object_encoding(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_data_object_encoding(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_data_object_encoding_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
This property contains an indication of the encoding format of the referenced data object, which is found in the corresponding DataObjectFormat's Encoding element.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_data_object_identifier property (SOAPSigner Struct)
This property contains an identifier indicating the type of the referenced data object, which is found in the corresponding DataObjectFormat's ObjectIdentifier element.
Syntax
fn reference_data_object_identifier(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_data_object_identifier(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_data_object_identifier_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
This property contains an identifier indicating the type of the referenced data object, which is found in the corresponding DataObjectFormat's ObjectIdentifier element.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_data_object_mime_type property (SOAPSigner Struct)
This property contains an indication of the MIME type of the referenced data object, which is found in the corresponding DataObjectFormat's MimeType element.
Syntax
fn reference_data_object_mime_type(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_data_object_mime_type(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_data_object_mime_type_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
This property contains an indication of the MIME type of the referenced data object, which is found in the corresponding DataObjectFormat's MimeType element.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_digest_value property (SOAPSigner Struct)
Use this property to get or set the value of the digest calculated over the referenced data.
Syntax
fn reference_digest_value(&self , ReferenceIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
fn set_reference_digest_value(&self, ReferenceIndex : i32, value : Vec<u8>) -> Option<SecureBlackboxError> fn set_reference_digest_value_ref(&self, ReferenceIndex : i32, value : &[u8]) -> Option<SecureBlackboxError>
Remarks
Use this property to get or set the value of the digest calculated over the referenced data.
This property is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
Vec
reference_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn reference_handle(&self , ReferenceIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_reference_handle(&self, ReferenceIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
i64
reference_has_data_object_format property (SOAPSigner Struct)
Specifies whether corresponding XAdES DataObjectFormat element is created for the current reference.
Syntax
fn reference_has_data_object_format(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError>
fn set_reference_has_data_object_format(&self, ReferenceIndex : i32, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Specifies whether corresponding XAdES DataObjectFormat element is created for the current reference.
Check this property to find out if the reference has an associated DataObjectFormat element.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
bool
reference_hash_algorithm property (SOAPSigner Struct)
Specifies the hash algorithm to be used.
Syntax
fn reference_hash_algorithm(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_hash_algorithm(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_hash_algorithm_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
"SHA256"
Remarks
Specifies the hash algorithm to be used.
Supported values:
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_has_uri property (SOAPSigner Struct)
Specifies whether the URI is set (even when it is empty).
Syntax
fn reference_has_uri(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError>
fn set_reference_has_uri(&self, ReferenceIndex : i32, value : bool) -> Option<SecureBlackboxError>
Default Value
true
Remarks
Specifies whether the URI is set (even when it is empty).
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
bool
reference_id property (SOAPSigner Struct)
A user-defined identifier (ID) attribute of this Reference element.
Syntax
fn reference_id(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_id(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_id_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
A user-defined identifier (ID) attribute of this Reference element.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_inclusive_namespaces_prefix_list property (SOAPSigner Struct)
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.
Syntax
fn reference_inclusive_namespaces_prefix_list(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_inclusive_namespaces_prefix_list(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_inclusive_namespaces_prefix_list_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_type property (SOAPSigner Struct)
The Reference's type attribute as defined in XMLDSIG specification.
Syntax
fn reference_type(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_type(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_type_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The Reference's type attribute as defined in XMLDSIG specification.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_target_data property (SOAPSigner Struct)
Contains the referenced external data when the digest value is not explicitly specified.
Syntax
fn reference_target_data(&self , ReferenceIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
fn set_reference_target_data(&self, ReferenceIndex : i32, value : Vec<u8>) -> Option<SecureBlackboxError> fn set_reference_target_data_ref(&self, ReferenceIndex : i32, value : &[u8]) -> Option<SecureBlackboxError>
Remarks
Contains the referenced external data when the digest value is not explicitly specified.
This property is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
Vec
reference_target_type property (SOAPSigner Struct)
The reference's target type to use.
Syntax
fn reference_target_type(&self , ReferenceIndex : i32) -> Result<i32, SecureBlackboxError>
fn set_reference_target_type(&self, ReferenceIndex : i32, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Auto
1 // XMLElement
2 // Data
3 // URI
Default Value
0
Remarks
The reference's target type to use.
Use this property to specify the reference's target type to use when forming the signature.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
i32
reference_target_xml_element property (SOAPSigner Struct)
This property specifies the referenced XML element.
Syntax
fn reference_target_xml_element(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_target_xml_element(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_target_xml_element_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event.
Supported values are:
| "" | an empty string indicates the Document element. |
| "#id" | indicates an XML element with specified Id. |
| XPointer expression | indicates an XML element selected using XPointer expression. Use the add_known_namespace method to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via add_known_namespace method. |
| Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_uri property (SOAPSigner Struct)
Use this property to get or set the URL which references the data.
Syntax
fn reference_uri(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_uri(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_uri_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_use_base64_transform property (SOAPSigner Struct)
Specifies whether Base64 transform is included in transform chain.
Syntax
fn reference_use_base64_transform(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError>
fn set_reference_use_base64_transform(&self, ReferenceIndex : i32, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Specifies whether Base64 transform is included in transform chain.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
bool
reference_use_enveloped_signature_transform property (SOAPSigner Struct)
Specifies whether enveloped signature transform is included in transform chain.
Syntax
fn reference_use_enveloped_signature_transform(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError>
fn set_reference_use_enveloped_signature_transform(&self, ReferenceIndex : i32, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Specifies whether enveloped signature transform is included in transform chain.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
bool
reference_use_xpath_filter2_transform property (SOAPSigner Struct)
Specifies whether XPath Filter 2.
Syntax
fn reference_use_xpath_filter2_transform(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError>
fn set_reference_use_xpath_filter2_transform(&self, ReferenceIndex : i32, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Specifies whether XPath Filter 2.0 transform is included in transform chain.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
bool
reference_use_xpath_transform property (SOAPSigner Struct)
Specifies whether XPath transform is included in transform chain.
Syntax
fn reference_use_xpath_transform(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError>
fn set_reference_use_xpath_transform(&self, ReferenceIndex : i32, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Specifies whether XPath transform is included in transform chain.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
bool
reference_validation_result property (SOAPSigner Struct)
The outcome of the cryptographic reference validation.
Syntax
fn reference_validation_result(&self , ReferenceIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
The outcome of the cryptographic reference validation.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
This property is read-only.
Data Type
bool
reference_xpath_expression property (SOAPSigner Struct)
Use this property to specify XPath expression for XPath transform of the reference.
Syntax
fn reference_xpath_expression(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_xpath_expression(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_xpath_expression_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify XPath expression for XPath transform of the reference.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_xpath_filter2_expressions property (SOAPSigner Struct)
Use this property to specify XPointer expression(s) for XPath Filter 2.
Syntax
fn reference_xpath_filter2_expressions(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_xpath_filter2_expressions(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_xpath_filter2_expressions_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_xpath_filter2_filters property (SOAPSigner Struct)
Use this property to specify XPointer filter(s) for XPath Filter 2.
Syntax
fn reference_xpath_filter2_filters(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_xpath_filter2_filters(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_xpath_filter2_filters_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.
Supported values:
| "intersect" | Intersect filter computes the intersection of the selected subtrees with the filter node-set. |
| "subtract" | Subtract filter computes the subtraction of the selected subtrees with the filter node-set. |
| "union" | Union filter computes the union of the selected subtrees with the filter node-set. |
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_xpath_filter2_prefix_list property (SOAPSigner Struct)
Use this property to specify a prefix list for XPath Filter 2.
Syntax
fn reference_xpath_filter2_prefix_list(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_xpath_filter2_prefix_list(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_xpath_filter2_prefix_list_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
reference_xpath_prefix_list property (SOAPSigner Struct)
Use this property to specify a prefix list for XPath transform of the reference.
Syntax
fn reference_xpath_prefix_list(&self , ReferenceIndex : i32) -> Result<String, SecureBlackboxError>
fn set_reference_xpath_prefix_list(&self, ReferenceIndex : i32, value : &str) -> Option<SecureBlackboxError> fn set_reference_xpath_prefix_list_ref(&self, ReferenceIndex : i32, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.
The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.
Data Type
String
revocation_check property (SOAPSigner Struct)
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
fn revocation_check(&self ) -> Result<i32, SecureBlackboxError>
fn set_revocation_check(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL
Default Value
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
| 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
security_header_index property (SOAPSigner Struct)
Specifies the SecurityHeader index.
Syntax
fn security_header_index(&self ) -> Result<i32, SecureBlackboxError>
fn set_security_header_index(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
-1
Remarks
Use this property to specify the index of SecurityHeader element where to put the signature. If the specified SecurityHeader element doesn't exist then a new SecurityHeader element will be created. The default value is "-1", in this case a new SecurityHeader element will be always created.
Data Type
i32
signature_count property (SOAPSigner Struct)
The number of records in the Signature arrays.
Syntax
fn signature_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- signature_bytes
- signature_canonicalization_method
- signature_chain_validation_details
- signature_chain_validation_result
- signature_claimed_signing_time
- signature_compatibility_errors
- signature_contains_long_term_info
- signature_entity_label
- signature_handle
- signature_hash_algorithm
- signature_issuer_rdn
- signature_last_archival_time
- signature_level
- signature_parent_entity
- signature_policy_hash
- signature_policy_hash_algorithm
- signature_policy_id
- signature_policy_uri
- signature_serial_number
- signature_subject_key_id
- signature_subject_rdn
- signature_timestamped
- signature_type
- signature_validated_signing_time
- signature_validation_log
- signature_validation_result
- signature_xades_version
- signature_xml_element
This property is read-only.
Data Type
i32
signature_canonicalization_method property (SOAPSigner Struct)
The XML canonicalization method that was used for signing.
Syntax
fn signature_canonicalization_method(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // None
1 // Canon
2 // CanonComment
3 // ExclCanon
4 // ExclCanonComment
5 // MinCanon
6 // Canon_v1_1
7 // CanonComment_v1_1
Default Value
0
Remarks
The XML canonicalization method that was used for signing.
Supported canonicalization methods:
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_chain_validation_details property (SOAPSigner Struct)
The details of a certificate chain validation outcome.
Syntax
fn signature_chain_validation_details(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_chain_validation_result property (SOAPSigner Struct)
The outcome of a certificate chain validation routine.
Syntax
fn signature_chain_validation_result(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // ValidButUntrusted
2 // Invalid
3 // CantBeEstablished
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_claimed_signing_time property (SOAPSigner Struct)
The signing time from the signer's computer.
Syntax
fn signature_claimed_signing_time(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The signing time from the signer's computer.
Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_compatibility_errors property (SOAPSigner Struct)
Returns compatibility errors encountered during validation.
Syntax
fn signature_compatibility_errors(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Returns compatibility errors encountered during validation.
Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_contains_long_term_info property (SOAPSigner Struct)
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
Syntax
fn signature_contains_long_term_info(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
signature_entity_label property (SOAPSigner Struct)
Use this property to get the signature entity label.
Syntax
fn signature_entity_label(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Use this property to get the signature entity label.
This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn signature_handle(&self , SignatureIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i64
signature_hash_algorithm property (SOAPSigner Struct)
The hash algorithm used for signing.
Syntax
fn signature_hash_algorithm(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
"Unknown"
Remarks
The hash algorithm used for signing.
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_issuer_rdn property (SOAPSigner Struct)
The Relative Distinguished Name of the signing certificate's issuer.
Syntax
fn signature_issuer_rdn(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The Relative Distinguished Name of the signing certificate's issuer.
A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_last_archival_time property (SOAPSigner Struct)
Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.
Syntax
fn signature_last_archival_time(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Indicates the most recent archival time of an archived signature
This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is in UTC.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_level property (SOAPSigner Struct)
Specifies which level or form of XAdES should be produced.
Syntax
fn signature_level(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // Generic
2 // BaselineB
3 // BaselineT
4 // BaselineLT
5 // BaselineLTA
6 // BES
7 // EPES
8 // T
9 // C
10 // X
11 // XType1
12 // XType2
13 // XL
14 // XLType1
15 // XLType2
16 // A
17 // ExtendedBES
18 // ExtendedEPES
19 // ExtendedT
20 // ExtendedC
21 // ExtendedX
22 // ExtendedXType1
23 // ExtendedXType2
24 // ExtendedXLong
25 // ExtendedXL
26 // ExtendedXLType1
27 // ExtendedXLType2
28 // ExtendedA
29 // BaselineExtendedB
30 // BaselineExtendedT
31 // BaselineExtendedLT
32 // BaselineExtendedLTA
Default Value
2
Remarks
Specifies which level or form of XAdES should be produced.
Use this property to specify the level or form of advanced electronic signature to be produced.
Use the Generic value to produce XML-DSIG signature.
The supported levels and forms are:
| aslUnknown | 0 | Unknown signature level |
| aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) |
| aslBaselineB | 2 | Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineT | 3 | Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLT | 4 | Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBES | 6 | BES (Basic Electronic Signature) |
| aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| aslT | 8 | T (Timestamped) |
| aslC | 9 | C (T with revocation references) |
| aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) |
| aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) |
| aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslA | 16 | A (archived) |
| aslExtendedBES | 17 | Extended BES |
| aslExtendedEPES | 18 | Extended EPES |
| aslExtendedT | 19 | Extended T |
| aslExtendedC | 20 | Extended C |
| aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) |
| aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) |
| aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) |
| aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) |
| aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) |
| aslExtendedA | 28 | Extended A |
| aslBaselineExtendedB | 29 | Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedT | 30 | Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLT | 31 | Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLTA | 32 | Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only) |
* For XAdES form from XAdES v1.1.1 use either BES or EPES form values ** Extended forms are supported starting from XAdES v1.3.2
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_parent_entity property (SOAPSigner Struct)
Use this property to get the parent signature label.
Syntax
fn signature_parent_entity(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Use this property to get the parent signature label.
This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_policy_hash property (SOAPSigner Struct)
The signature policy hash value.
Syntax
fn signature_policy_hash(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The signature policy hash value.
Use this property to get the signature policy hash from EPES signatures
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_policy_hash_algorithm property (SOAPSigner Struct)
The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm used to calculate the signature policy hash.
Syntax
fn signature_policy_hash_algorithm(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The algorithm that was used to calculate the signature policy hash
Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from signature_policy_hash.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_policy_id property (SOAPSigner Struct)
The policy ID that was included or to be included into the signature.
Syntax
fn signature_policy_id(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The policy ID that was included or to be included into the signature.
Use this property to retrieve the signature policy identifier from EPES signatures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_policy_uri property (SOAPSigner Struct)
The signature policy URI that was included in the signature.
Syntax
fn signature_policy_uri(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The signature policy URI that was included in the signature.
Use this property to set or retrieve the URI of the signature policy from EPES signatures.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_serial_number property (SOAPSigner Struct)
The serial number of the signing certificate.
Syntax
fn signature_serial_number(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
The serial number of the signing certificate.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
Vec
signature_bytes property (SOAPSigner Struct)
Returns the binary representation of the SOAP signature.
Syntax
fn signature_bytes(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the binary representation of the SOAP signature.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
Vec
signature_type property (SOAPSigner Struct)
The SOAP signature type to use.
Syntax
fn signature_type(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // WSSSignature
2 // SOAPSignature
Default Value
1
Remarks
The SOAP signature type to use.
Use this property to specify the signature type to use when forming the signature.
Supported values:
| sstUnknown | 0 | Unknown signature |
| sstWSSSignature | 1 | Uses Web Services Security (WS-Security, WSS) signature. It is implemented according to the OASIS Web Services Security extension to SOAP |
| sstSOAPSignature | 2 | Uses SOAP signature. It is implemented according to the SOAP Security Extensions: Digital Signature. |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_validation_result property (SOAPSigner Struct)
The outcome of the cryptographic signature validation.
Syntax
fn signature_validation_result(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted
Default Value
0
Remarks
The outcome of the cryptographic signature validation.
The following signature validity values are supported:
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_subject_key_id property (SOAPSigner Struct)
Contains the subject key identifier of the signing certificate.
Syntax
fn signature_subject_key_id(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Contains the subject key identifier of the signing certificate.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
Vec
signature_subject_rdn property (SOAPSigner Struct)
Contains information about the person owning the signing certificate.
Syntax
fn signature_subject_rdn(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_timestamped property (SOAPSigner Struct)
Use this property to establish whether the signature contains an embedded timestamp.
Syntax
fn signature_timestamped(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Use this property to establish whether the signature contains an embedded timestamp.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
bool
signature_validated_signing_time property (SOAPSigner Struct)
Contains the certified signing time.
Syntax
fn signature_validated_signing_time(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the certified signing time.
Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there was a valid timestamp included in the signature.
signature_claimed_signing_time returns a non-trusted signing time from the signer's computer.
Both times are in UTC.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_validation_log property (SOAPSigner Struct)
Contains the complete log of the certificate validation routine.
Syntax
fn signature_validation_log(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the complete log of the certificate validation routine.
Use this property to access the chain validation log produced by the struct. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signature_xades_version property (SOAPSigner Struct)
Specifies XAdES version.
Syntax
fn signature_xades_version(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Unknown
1 // 111
2 // 122
3 // 132
4 // 141
Default Value
3
Remarks
Specifies XAdES version.
This property specifies the version of the XAdES specification the signature should comply with.
The supported versions are:
| xavUnknown | 0 | Unknown |
| xav111 | 1 | XAdES v1.1.1 |
| xav122 | 2 | XAdES v1.2.2 |
| xav132 | 3 | XAdES v1.3.2 |
| xav141 | 4 | XAdES v1.4.1 (aka v1.4.2) |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
i32
signature_xml_element property (SOAPSigner Struct)
Specifies the XML element where to save the signature or containing the signature.
Syntax
fn signature_xml_element(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Specifies the XML element where to save the signature or containing the signature.
This property specifies the XML element where to save the electronic signature or that contains the signature to be validated.
Supported values are:
| "" | an empty string indicates the Document element |
| "#id" | indicates an XML element with specified Id |
| XPath expression | indicates an XML element selected using XPath expression. Use add_known_namespace method to specify Prefixes and NamespaceURIs
For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined via add_known_namespace method. |
| Node name | indicates an XML element selected using its NodeName.
For example: "data" - indicates an XML element with node name "data". |
The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.
This property is read-only.
Data Type
String
signing_cert_bytes property (SOAPSigner Struct)
Returns the raw certificate data in DER format.
Syntax
fn signing_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
This property is read-only.
Data Type
Vec
signing_cert_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError>
fn set_signing_cert_handle(&self, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Data Type
i64
signing_chain_count property (SOAPSigner Struct)
The number of records in the SigningChain arrays.
Syntax
fn signing_chain_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_signing_chain_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at signing_chain_count - 1.Data Type
i32
signing_chain_bytes property (SOAPSigner Struct)
Returns the raw certificate data in DER format.
Syntax
fn signing_chain_bytes(&self , SigningChainIndex : i32) -> Result<Vec<u8>, 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 property.
This property is read-only.
Data Type
Vec
signing_chain_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_signing_chain_handle(&self, SigningChainIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.
Data Type
i64
socket_dns_mode property (SOAPSigner Struct)
Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system.
Syntax
fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_dns_mode(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Auto
1 // Platform
2 // Own
3 // OwnSecure
Default Value
0
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |
Data Type
i32
socket_dns_port property (SOAPSigner Struct)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_dns_port(&self, value : i32) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
The timeout (in milliseconds) for each DNS query.
Syntax
fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_dns_query_timeout(&self, value : i32) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError>
fn set_socket_dns_servers(&self, value : &str) -> Option<SecureBlackboxError> fn set_socket_dns_servers_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
The timeout (in milliseconds) for the whole resolution process.
Syntax
fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_dns_total_timeout(&self, value : i32) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
The maximum number of bytes to read from the socket, per second.
Syntax
fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_incoming_speed_limit(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
i32
socket_local_address property (SOAPSigner Struct)
The local network interface to bind the socket to.
Syntax
fn socket_local_address(&self ) -> Result<String, SecureBlackboxError>
fn set_socket_local_address(&self, value : &str) -> Option<SecureBlackboxError> fn set_socket_local_address_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
socket_local_port property (SOAPSigner Struct)
The local port number to bind the socket to.
Syntax
fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_local_port(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
i32
socket_outgoing_speed_limit property (SOAPSigner Struct)
The maximum number of bytes to write to the socket, per second.
Syntax
fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_outgoing_speed_limit(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
i32
socket_timeout property (SOAPSigner Struct)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError>
fn set_socket_timeout(&self, value : i32) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Enables or disables IP protocol version 6.
Syntax
fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError>
fn set_socket_use_ipv6(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
bool
timestamp_count property (SOAPSigner Struct)
The number of records in the Timestamp arrays.
Syntax
fn timestamp_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- timestamp_accuracy
- timestamp_bytes
- timestamp_certificate_index
- timestamp_chain_validation_details
- timestamp_chain_validation_result
- timestamp_contains_long_term_info
- timestamp_entity_label
- timestamp_hash_algorithm
- timestamp_parent_entity
- timestamp_serial_number
- timestamp_time
- timestamp_tsa_name
- timestamp_type
- timestamp_validation_log
- timestamp_validation_result
This property is read-only.
Data Type
i32
timestamp_accuracy property (SOAPSigner Struct)
This property indicates the accuracy of the included time mark, in microseconds.
Syntax
fn timestamp_accuracy(&self , TimestampIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
This field indicates the accuracy of the included time mark, in microseconds.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
i64
timestamp_bytes property (SOAPSigner Struct)
Returns the raw timestamp data in DER format.
Syntax
fn timestamp_bytes(&self , TimestampIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw timestamp data in DER format.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
Vec
timestamp_certificate_index property (SOAPSigner Struct)
Returns the index of the TSA certificate in the Certificates collection.
Syntax
fn timestamp_certificate_index(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
-1
Remarks
Returns the index of the TSA certificate in the Certificates collection.
Use this property to look up the TSA certificate in the Certificates collection.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
i32
timestamp_chain_validation_details property (SOAPSigner Struct)
The details of a certificate chain validation outcome.
Syntax
fn timestamp_chain_validation_details(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
i32
timestamp_chain_validation_result property (SOAPSigner Struct)
The outcome of a certificate chain validation routine.
Syntax
fn timestamp_chain_validation_result(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // ValidButUntrusted
2 // Invalid
3 // CantBeEstablished
Default Value
0
Remarks
The outcome of a certificate chain validation routine.
Available options:
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
i32
timestamp_contains_long_term_info property (SOAPSigner Struct)
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
Syntax
fn timestamp_contains_long_term_info(&self , TimestampIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
bool
timestamp_entity_label property (SOAPSigner Struct)
Use this property to get the timestamp entity label.
Syntax
fn timestamp_entity_label(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Use this property to get the timestamp entity label.
This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
String
timestamp_hash_algorithm property (SOAPSigner Struct)
Returns the timestamp's hash algorithm.
Syntax
fn timestamp_hash_algorithm(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Returns the timestamp's hash algorithm.
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_MD2 | MD2 | |
| SB_HASH_ALGORITHM_MD4 | MD4 | |
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_CRC32 | CRC32 | |
| SB_HASH_ALGORITHM_SSL3 | SSL3 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
| SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
| SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
| SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
| SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
| SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
| SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
| SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
| SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
| SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
| SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
| SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
| SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
String
timestamp_parent_entity property (SOAPSigner Struct)
Use this property to get the label of the timestamp's parent entity.
Syntax
fn timestamp_parent_entity(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Use this property to get the label of the timestamp's parent entity.
This property references the EntityLabel of the object that the timestamp covers, typically a signature.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
String
timestamp_serial_number property (SOAPSigner Struct)
Returns the timestamp's serial number.
Syntax
fn timestamp_serial_number(&self , TimestampIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the timestamp's serial number.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
Vec
timestamp_time property (SOAPSigner Struct)
The time point incorporated into the timestamp.
Syntax
fn timestamp_time(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The time point incorporated into the timestamp.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
String
timestamp_type property (SOAPSigner Struct)
Returns the type of the timestamp.
Syntax
fn timestamp_type(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
Returns the type of the timestamp.
Available options:
| tstUnknown | 0 | |
| tstLegacy | 1 | Supported by: Authenticode components |
| tstTrusted | 2 | Supported by: Authenticode components |
| tstGeneric | 3 | Supported by: CAdES components |
| tstESC | 4 | Supported by: CAdES components |
| tstContent | 5 | Supported by: CAdES components |
| tstCertsAndCRLs | 6 | Supported by: CAdES components |
| tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components |
| tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components |
| tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components |
| tstIndividualDataObjects | 10 | Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components |
| tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components |
| tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components |
| tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components |
Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
i32
timestamp_tsa_name property (SOAPSigner Struct)
This value uniquely identifies the Timestamp Authority (TSA).
Syntax
fn timestamp_tsa_name(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
This value uniquely identifies the Timestamp Authority (TSA).
This property provides information about the entity that manages the TSA.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
String
timestamp_validation_log property (SOAPSigner Struct)
Contains the TSA certificate chain validation log.
Syntax
fn timestamp_validation_log(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
String
timestamp_validation_result property (SOAPSigner Struct)
Contains the timestamp validation outcome.
Syntax
fn timestamp_validation_result(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError>
Possible Values
0 // Valid
1 // Unknown
2 // Corrupted
3 // SignerNotFound
4 // Failure
5 // ReferenceCorrupted
Default Value
0
Remarks
Contains the timestamp validation outcome.
Use this property to check the result of the most recent timestamp validation.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.
This property is read-only.
Data Type
i32
timestamp_server property (SOAPSigner Struct)
The address of the timestamping server.
Syntax
fn timestamp_server(&self ) -> Result<String, SecureBlackboxError>
fn set_timestamp_server(&self, value : &str) -> Option<SecureBlackboxError> fn set_timestamp_server_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 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 (SOAPSigner Struct)
The number of records in the TLSClientCert arrays.
Syntax
fn tls_client_cert_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_client_cert_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at tls_client_cert_count - 1.Data Type
i32
tls_client_cert_bytes property (SOAPSigner Struct)
Returns the raw certificate data in DER format.
Syntax
fn tls_client_cert_bytes(&self , TLSClientCertIndex : i32) -> Result<Vec<u8>, 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 property.
This property is read-only.
Data Type
Vec
tls_client_cert_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn tls_client_cert_handle(&self , TLSClientCertIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_tls_client_cert_handle(&self, TLSClientCertIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
Data Type
i64
tls_server_cert_count property (SOAPSigner Struct)
The number of records in the TLSServerCert arrays.
Syntax
fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
- tls_server_cert_bytes
- tls_server_cert_fingerprint
- tls_server_cert_handle
- tls_server_cert_issuer
- tls_server_cert_issuer_rdn
- tls_server_cert_key_algorithm
- tls_server_cert_key_bits
- tls_server_cert_key_usage
- tls_server_cert_self_signed
- tls_server_cert_serial_number
- tls_server_cert_sig_algorithm
- tls_server_cert_subject
- tls_server_cert_subject_rdn
- tls_server_cert_valid_from
- tls_server_cert_valid_to
This property is read-only.
Data Type
i32
tls_server_cert_bytes property (SOAPSigner Struct)
Returns the raw certificate data in DER format.
Syntax
fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, 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 property.
This property is read-only.
Data Type
Vec
tls_server_cert_fingerprint property (SOAPSigner Struct)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
fn tls_server_cert_fingerprint(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
i64
tls_server_cert_issuer property (SOAPSigner Struct)
The common name of the certificate issuer (CA), typically a company name.
Syntax
fn tls_server_cert_issuer(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
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.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_issuer_rdn property (SOAPSigner Struct)
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
fn tls_server_cert_issuer_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_key_algorithm property (SOAPSigner Struct)
Specifies the public key algorithm of this certificate.
Syntax
fn tls_server_cert_key_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
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, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_key_bits property (SOAPSigner Struct)
Returns the length of the public key in bits.
Syntax
fn tls_server_cert_key_bits(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError>
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 or tls_private_key_bytes property would typically contain auxiliary values, and therefore be longer.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
i32
tls_server_cert_key_usage property (SOAPSigner Struct)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
fn tls_server_cert_key_usage(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError>
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 property.
This property is read-only.
Data Type
i32
tls_server_cert_self_signed property (SOAPSigner Struct)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
fn tls_server_cert_self_signed(&self , TLSServerCertIndex : i32) -> Result<bool, SecureBlackboxError>
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
bool
tls_server_cert_serial_number property (SOAPSigner Struct)
Returns the certificate's serial number.
Syntax
fn tls_server_cert_serial_number(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, 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 property.
This property is read-only.
Data Type
Vec
tls_server_cert_sig_algorithm property (SOAPSigner Struct)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
fn tls_server_cert_sig_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_subject property (SOAPSigner Struct)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
fn tls_server_cert_subject(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
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.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_subject_rdn property (SOAPSigner Struct)
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
fn tls_server_cert_subject_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_valid_from property (SOAPSigner Struct)
The time point at which the certificate becomes valid, in UTC.
Syntax
fn tls_server_cert_valid_from(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_server_cert_valid_to property (SOAPSigner Struct)
The time point at which the certificate expires, in UTC.
Syntax
fn tls_server_cert_valid_to(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError>
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only.
Data Type
String
tls_auto_validate_certificates property (SOAPSigner Struct)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError>
fn set_tls_auto_validate_certificates(&self, value : bool) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Selects the base configuration for the TLS settings.
Syntax
fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_base_configuration(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Default
1 // Compatible
2 // ComprehensiveInsecure
3 // HighlySecure
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
Data Type
i32
tls_ciphersuites property (SOAPSigner Struct)
A list of ciphersuites separated with commas or semicolons.
Syntax
fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_ciphersuites(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_ciphersuites_ref(&self, value : &String) -> Option<SecureBlackboxError>
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. 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 (SOAPSigner Struct)
Enables or disables certificate-based client authentication.
Syntax
fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_client_auth(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // NoAuth
1 // RequestCert
2 // RequireCert
Default Value
0
Remarks
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
| ccatNoAuth | 0 | |
| ccatRequestCert | 1 | |
| ccatRequireCert | 2 |
Data Type
i32
tls_extensions property (SOAPSigner Struct)
Provides access to TLS extensions.
Syntax
fn tls_extensions(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_extensions(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_extensions_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
tls_force_resume_if_destination_changes property (SOAPSigner Struct)
Whether to force TLS session resumption when the destination address changes.
Syntax
fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError>
fn set_tls_force_resume_if_destination_changes(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
bool
tls_groups property (SOAPSigner Struct)
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Syntax
fn tls_groups(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_groups(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_groups_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Specifies a list of key exchange groups to attempt during the TLS key exchange.
Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:
// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";
// Only enable the hybrid X25519/ML-KEM768 group
client.TLSSettings.Groups = "-all;+x25519mlkem768";
The list of groups supported by the component is provided below. All the names are case-insensitive:
Elliptic curve-based groups:
- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448
Finite field-based groups:
- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192
Post-Quantum and Hybrid groups:
- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024
Note: this property was called ECCurves in SecureBlackbox 2024 and older.
Data Type
String
tls_pre_shared_identity property (SOAPSigner Struct)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_pre_shared_identity(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_pre_shared_identity_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_pre_shared_key(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_pre_shared_key_ref(&self, value : &String) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError>
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) -> Option<SecureBlackboxError> fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
tls_renegotiation_attack_prevention_mode property (SOAPSigner Struct)
Selects the renegotiation attack prevention mechanism.
Syntax
fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Compatible
1 // Strict
2 // 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 (SOAPSigner Struct)
Specifies the kind(s) of revocation check to perform.
Syntax
fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_revocation_check(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // None
1 // Auto
2 // AllCRL
3 // AllOCSP
4 // AllCRLAndOCSP
5 // AnyCRL
6 // AnyOCSP
7 // AnyCRLOrOCSP
8 // AnyOCSPOrCRL
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
| 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 (SOAPSigner 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
fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_ssl_options(&self, value : i32) -> Option<SecureBlackboxError>
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 (SOAPSigner Struct)
Specifies the TLS mode to use.
Syntax
fn tls_mode(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_mode(&self, value : i32) -> Option<SecureBlackboxError>
Possible Values
0 // Default
1 // NoTLS
2 // ExplicitTLS
3 // ImplicitTLS
4 // 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 (SOAPSigner Struct)
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError>
fn set_tls_use_extended_master_secret(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
true
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Data Type
bool
tls_use_session_resumption property (SOAPSigner Struct)
Enables or disables the TLS session resumption capability.
Syntax
fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError>
fn set_tls_use_session_resumption(&self, value : bool) -> Option<SecureBlackboxError>
Default Value
false
Remarks
Enables or disables the TLS session resumption capability.
Data Type
bool
tls_versions property (SOAPSigner Struct)
The SSL/TLS versions to enable by default.
Syntax
fn tls_versions(&self ) -> Result<i32, SecureBlackboxError>
fn set_tls_versions(&self, value : i32) -> Option<SecureBlackboxError>
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
trusted_cert_count property (SOAPSigner Struct)
The number of records in the TrustedCert arrays.
Syntax
fn trusted_cert_count(&self ) -> Result<i32, SecureBlackboxError>
fn set_trusted_cert_count(&self, value : i32) -> Option<SecureBlackboxError>
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at trusted_cert_count - 1.Data Type
i32
trusted_cert_bytes property (SOAPSigner Struct)
Returns the raw certificate data in DER format.
Syntax
fn trusted_cert_bytes(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError>
Remarks
Returns the raw certificate data in DER format.
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is read-only.
Data Type
Vec
trusted_cert_handle property (SOAPSigner Struct)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
fn trusted_cert_handle(&self , TrustedCertIndex : i32) -> Result<i64, SecureBlackboxError>
fn set_trusted_cert_handle(&self, TrustedCertIndex : i32, value : i64) -> Option<SecureBlackboxError>
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
Data Type
i64
validation_moment property (SOAPSigner Struct)
The time point at which signature validity is to be established.
Syntax
fn validation_moment(&self ) -> Result<String, SecureBlackboxError>
fn set_validation_moment(&self, value : &str) -> Option<SecureBlackboxError> fn set_validation_moment_ref(&self, value : &String) -> Option<SecureBlackboxError>
Default Value
""
Remarks
Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).
The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.
Data Type
String
add_body_reference method (SOAPSigner Struct)
Creates a new XML reference to the Body element of the SOAP message.
Syntax
fn add_body_reference(&self, custom_id : &str, auto_generate_id : bool) -> Result<i32, SecureBlackboxError>
Remarks
Use this method to add a reference to the Body element of the SOAP message.
The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.
Use canonicalization_method and hash_algorithm properties to specify the canonicalization method and hash algorithm to use.
The method returns the index of the new reference entry in the references collection.
add_data_reference method (SOAPSigner Struct)
Creates a new XML reference to the specified data.
Syntax
fn add_data_reference(&self, data_uri : &str, data : &[u8]) -> Result<i32, SecureBlackboxError>
Remarks
Use this method to add a reference to the custom data. Pass the reference's URI via DataURI parameter.
Use hash_algorithm property to specify the hash algorithm to use.
The method returns the index of the new reference entry in the references collection.
add_known_namespace method (SOAPSigner Struct)
Adds known prefix and correspondent namespace URI.
Syntax
fn add_known_namespace(&self, prefix : &str, uri : &str) -> Result<(), SecureBlackboxError>
Remarks
Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.
add_reference method (SOAPSigner Struct)
Creates a new XML reference to the specified XML element.
Syntax
fn add_reference(&self, target_xml_element : &str, custom_id : &str, auto_generate_id : bool) -> Result<i32, SecureBlackboxError>
Remarks
Use this method to add a reference to a particular XML element.
The reference's URI is set basing on the ID of the XML element. If the XML element doesn't have an ID then a CustomId value will be used. If CustomId is empty and AutoGenerateId is set, the ID will be generated automatically. An exception will be thrown otherwise.
Use canonicalization_method and hash_algorithm properties to specify the canonicalization method and hash algorithm to use.
The method returns the index of the new reference entry in the references collection.
close method (SOAPSigner Struct)
Closes an opened SOAP message.
Syntax
fn close(&self, save_changes : bool) -> Result<(), SecureBlackboxError>
Remarks
Use this method to close a previously opened SOAP message. Set SaveChanges to true to apply any changes made.
config method (SOAPSigner Struct)
Sets or retrieves a configuration setting.
Syntax
fn config(&self, configuration_string : &str) -> Result<String, SecureBlackboxError>
Remarks
config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
do_action method (SOAPSigner Struct)
Performs an additional action.
Syntax
fn do_action(&self, action_id : &str, action_params : &str) -> Result<String, SecureBlackboxError>
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 (SOAPSigner Struct)
Extracts user data from the DC signing service response.
Syntax
fn extract_async_data(&self, async_reply : &str) -> Result<String, SecureBlackboxError>
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.
get_inner_xml method (SOAPSigner Struct)
Get the inner XML content of the selected XML element.
Syntax
fn get_inner_xml(&self, xpath : &str) -> Result<String, SecureBlackboxError>
Remarks
Call this method to get the inner XML content of the selected XML element.
get_outer_xml method (SOAPSigner Struct)
Get the outer XML content of the selected XML element.
Syntax
fn get_outer_xml(&self, xpath : &str) -> Result<String, SecureBlackboxError>
Remarks
Call this method to get the outer XML content of the selected XML element.
get_text_content method (SOAPSigner Struct)
Get the text content of the selected XML element.
Syntax
fn get_text_content(&self, xpath : &str) -> Result<String, SecureBlackboxError>
Remarks
Call this method to get the text content of the selected XML element.
open method (SOAPSigner Struct)
Opens a document for signing or updating.
Syntax
fn open(&self) -> Result<(), SecureBlackboxError>
Remarks
Use this method to open a document for signing or updating. When finished, call close to complete or discard the operation.
reset method (SOAPSigner Struct)
Resets the struct settings.
Syntax
fn reset(&self) -> Result<(), SecureBlackboxError>
Remarks
reset is a generic method available in every struct.
revalidate method (SOAPSigner Struct)
Revalidates a signature in accordance with current settings.
Syntax
fn revalidate(&self, sig_label : &str) -> Result<(), SecureBlackboxError>
Remarks
Use this method to re-validate a signature in the opened SOAP message.
select_info method (SOAPSigner Struct)
Select signature information for a specific entity.
Syntax
fn select_info(&self, entity_label : &str, info_type : i32, clear_selection : bool) -> Result<(), SecureBlackboxError>
Remarks
Use this method to select (or filter) signature-related information for a specific signature element.
Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:
| sitEntity | 1 | Select the current entity |
| sitParentEntity | 2 | Select the parent entity of the current entity |
| sitTimestamps | 4 | Select all timestamps covering the current entity |
| sitSignatures | 8 | Select all signatures covering the current entity |
| sitSigningChain | 16 | Select the signing chain of the current entity |
| sitEmbeddedCertificates | 256 | Select all certificates embedded in the current entity |
| sitEmbeddedCRLs | 512 | Select all CRLs embedded in the current entity |
| sitEmbeddedOCSPs | 1024 | Select all OCSP responses embedded in the current entity |
| sitEmbeddedRevInfo | 1792 | Select the whole pack of embedded revocation information (certificates, CRLs and OCSPs) |
| sitUsedCertificates | 4096 | Select all the certificates used to validate this entity's chain |
| sitUsedCRLs | 8192 | Select all the CRLs used to validate this entity's chain |
| sitUsedOCSPs | 16384 | Select all the OCSP responses used to validate this entity's chain |
| sitUsedRevInfo | 28672 | Select the whole pack of revocation information used to validate this entity's chain (certificates, CRLs, OCSP responses) |
| sitAttributes | 65536 | Select this entity's CMS attributes |
| sitReferences | 131072 | Select this entity's XML references |
| sitSignedParts | 262144 | Select this entity's signed parts |
Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to select_info and keeping ClearSelection set to false.
This method is useful if you would like to read/display detailed information about a particular signature or timestamp.
set_inner_xml method (SOAPSigner Struct)
Set the inner XML content of the selected XML element.
Syntax
fn set_inner_xml(&self, xpath : &str, value : &str) -> Result<(), SecureBlackboxError>
Remarks
Call this method to set the inner XML content of the selected XML element.
set_text_content method (SOAPSigner Struct)
Set the text content of the selected XML element.
Syntax
fn set_text_content(&self, xpath : &str, value : &str) -> Result<(), SecureBlackboxError>
Remarks
Call this method to set the text content of the selected XML element.
sign method (SOAPSigner Struct)
Signs the SOAP message.
Syntax
fn sign(&self) -> Result<(), SecureBlackboxError>
Remarks
Call this method to generate a signed SOAP message.
sign_async_begin method (SOAPSigner Struct)
Initiates the asynchronous signing operation.
Syntax
fn sign_async_begin(&self) -> Result<String, SecureBlackboxError>
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 (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 (or input_stream), and call sign_async_end 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 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 method.
sign_async_end method (SOAPSigner Struct)
Completes the asynchronous signing operation.
Syntax
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 call to input_file (or input_stream). The method will embed the signature into the pre-signed document, and save the complete signed document to output_file (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) 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 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.
sign_external method (SOAPSigner Struct)
Signs the document using an external signing facility.
Syntax
fn sign_external(&self) -> Result<(), SecureBlackboxError>
Remarks
Call this method to delegate the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.
When all preparations are done and hash is computed, the struct fires on_external_sign event which allows to pass the hash value for signing.
timestamp method (SOAPSigner Struct)
Use this method to add an timestamp.
Syntax
fn timestamp(&self, sig_label : &str, timestamp_type : i32) -> Result<(), SecureBlackboxError>
Remarks
Call this method to timestamp the signature. Use the TimestampServer property to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. This method could be called separately or in on_signature_validated event handler after successful signature validation. Use the TimestampType parameter to specify the type of timestamp to create
Supported timestamp types:
| tstSignature | 12 | Signature timestamp |
| tstRefsOnly | 13 | RefsOnly timestamp |
| tstSigAndRefs | 14 | SigAndRefs timestamp |
| tstArchive | 7 | Archive timestamp |
upgrade method (SOAPSigner Struct)
Upgrades existing XAdES signature to a new form.
Syntax
fn upgrade(&self, sig_label : &str, upgrade_kind : i32) -> Result<(), SecureBlackboxError>
Remarks
XAdES standard defines a number of different 'forms' of signatures which can be used for different purposes. Use this method to upgrade XAdES signature to a new form or level specified by UpgradeKind. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, C, X, X-L, A).
The supported levels and forms are:
| aslUnknown | 0 | Unknown signature level |
| aslGeneric | 1 | Generic (this value applicable to XAdES signature only and corresponds to XML-DSIG signature) |
| aslBaselineB | 2 | Baseline B (B-B, basic) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineT | 3 | Baseline T (B-T, timestamped) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLT | 4 | Baseline LT (B-LT, long-term) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBaselineLTA | 5 | Baseline LTA (B-LTA, long-term with archived timestamp) (for XAdES as defined in ETSI TS 103 171, for CAdES as defined in ETSI EN 319 122) |
| aslBES | 6 | BES (Basic Electronic Signature) |
| aslEPES | 7 | EPES (Electronic Signature with an Explicit Policy) |
| aslT | 8 | T (Timestamped) |
| aslC | 9 | C (T with revocation references) |
| aslX | 10 | X (C with SigAndRefs timestamp or RefsOnly timestamp) (this value applicable to XAdES signature only) |
| aslXType1 | 11 | X Type 1 (C with an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXType2 | 12 | X Type 2 (C with a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslXL | 13 | X-L (X with revocation values) (this value applicable to XAdES signature only) |
| aslXLType1 | 14 | X-L Type 1 (C with revocation values and an ES-C timestamp) (this value applicable to CAdES signature only) |
| aslXLType2 | 15 | X-L Type 2 (C with revocation values and a CertsAndCRLs timestamp) (this value applicable to CAdES signature only) |
| aslA | 16 | A (archived) |
| aslExtendedBES | 17 | Extended BES |
| aslExtendedEPES | 18 | Extended EPES |
| aslExtendedT | 19 | Extended T |
| aslExtendedC | 20 | Extended C |
| aslExtendedX | 21 | Extended X (this value applicable to XAdES signature only) |
| aslExtendedXType1 | 22 | Extended X (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXType2 | 23 | Extended X (type 2) (this value applicable to CAdES signature only) |
| aslExtendedXLong | 24 | Extended X-Long (this value applicable to XAdES signature only) |
| aslExtendedXL | 25 | Extended X-L (this value applicable to XAdES signature only) |
| aslExtendedXLType1 | 26 | Extended XL (type 1) (this value applicable to CAdES signature only) |
| aslExtendedXLType2 | 27 | Extended XL (type 2) (this value applicable to CAdES signature only) |
| aslExtendedA | 28 | Extended A |
| aslBaselineExtendedB | 29 | Baseline B (B-B, basic) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedT | 30 | Baseline T (B-T, timestamped) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLT | 31 | Baseline LT (B-LT, long-term) according to ETSI EN 319 132 (this value applicable to XAdES signature only) |
| aslBaselineExtendedLTA | 32 | Baseline LTA (B-LTA, long-term with archived timestamp) as defined in ETSI EN 319 132 (this value applicable to XAdES signature only) |
The supported additional upgrade kinds are:
| xukAddValidationDataRefs | 256 | Add signature validation references |
| xukAddValidationDataValues | 512 | Add signature validation values |
| xukAddTimestampValidationData | 1024 | Add timestamp validation data |
| xukAddAnyValidationData | 2048 | Add AnyValidationData |
on_chain_element_download event (SOAPSigner Struct)
Fires when there is a need to download a chain element from an online source.
Syntax
// SOAPSignerChainElementDownloadEventArgs carries the SOAPSigner ChainElementDownload event's parameters.
pub struct SOAPSignerChainElementDownloadEventArgs {
fn kind(&self) -> i32
fn cert_rdn(&self) -> &String
fn ca_cert_rdn(&self) -> &String
fn location(&self) -> &String
fn action(&self) -> i32
fn set_action(&self, value : i32)
}
// SOAPSignerChainElementDownloadEvent defines the signature of the SOAPSigner ChainElementDownload event's handler function.
pub trait SOAPSignerChainElementDownloadEvent {
fn on_chain_element_download(&self, sender : SOAPSigner, e : &mut SOAPSignerChainElementDownloadEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_chain_element_download(&self) -> &'a dyn SOAPSignerChainElementDownloadEvent;
pub fn set_on_chain_element_download(&mut self, value : &'a dyn SOAPSignerChainElementDownloadEvent);
...
}
Remarks
Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |
on_chain_element_needed event (SOAPSigner Struct)
Fires when an element required to validate the chain was not located.
Syntax
// SOAPSignerChainElementNeededEventArgs carries the SOAPSigner ChainElementNeeded event's parameters.
pub struct SOAPSignerChainElementNeededEventArgs {
fn kind(&self) -> i32
fn cert_rdn(&self) -> &String
fn ca_cert_rdn(&self) -> &String
}
// SOAPSignerChainElementNeededEvent defines the signature of the SOAPSigner ChainElementNeeded event's handler function.
pub trait SOAPSignerChainElementNeededEvent {
fn on_chain_element_needed(&self, sender : SOAPSigner, e : &mut SOAPSignerChainElementNeededEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_chain_element_needed(&self) -> &'a dyn SOAPSignerChainElementNeededEvent;
pub fn set_on_chain_element_needed(&mut self, value : &'a dyn SOAPSignerChainElementNeededEvent);
...
}
Remarks
Subscribe to this event to be notified about missing validation elements. Use the known_crls, known_certificates, and known_ocsps properties in the event handler to provide the missing piece.
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |
on_chain_element_store event (SOAPSigner Struct)
This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.
Syntax
// SOAPSignerChainElementStoreEventArgs carries the SOAPSigner ChainElementStore event's parameters.
pub struct SOAPSignerChainElementStoreEventArgs {
fn kind(&self) -> i32
fn body(&self) -> &[u8]
fn uri(&self) -> &String
fn set_uri(&self, value : &str)
fn set_uri_ref(&self, value : &String)
}
// SOAPSignerChainElementStoreEvent defines the signature of the SOAPSigner ChainElementStore event's handler function.
pub trait SOAPSignerChainElementStoreEvent {
fn on_chain_element_store(&self, sender : SOAPSigner, e : &mut SOAPSignerChainElementStoreEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_chain_element_store(&self) -> &'a dyn SOAPSignerChainElementStoreEvent;
pub fn set_on_chain_element_store(&mut self, value : &'a dyn SOAPSignerChainElementStoreEvent);
...
}
Remarks
This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.
| cekUnknown | 0 | Unknown or unsupported element type |
| cekCertificate | 1 | An X.509 certificate |
| cekCRL | 2 | A CRL |
| cekOCSP | 3 | An OCSP response |
on_chain_validated event (SOAPSigner Struct)
Reports the completion of a certificate chain validation.
Syntax
// SOAPSignerChainValidatedEventArgs carries the SOAPSigner ChainValidated event's parameters.
pub struct SOAPSignerChainValidatedEventArgs {
fn index(&self) -> i32
fn entity_label(&self) -> &String
fn subject_rdn(&self) -> &String
fn validation_result(&self) -> i32
fn validation_details(&self) -> i32
fn cancel(&self) -> bool
fn set_cancel(&self, value : bool)
}
// SOAPSignerChainValidatedEvent defines the signature of the SOAPSigner ChainValidated event's handler function.
pub trait SOAPSignerChainValidatedEvent {
fn on_chain_validated(&self, sender : SOAPSigner, e : &mut SOAPSignerChainValidatedEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_chain_validated(&self) -> &'a dyn SOAPSignerChainValidatedEvent;
pub fn set_on_chain_validated(&mut self, value : &'a dyn SOAPSignerChainValidatedEvent);
...
}
Remarks
This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.
ValidationResult set to 0 (zero) indicates successful chain validation.
| cvtValid | 0 | The chain is valid |
| cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
| cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
| cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
| cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
| cvrRevoked | 0x0002 | One or more certificates are revoked |
| cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
| cvrExpired | 0x0008 | One or more certificates are expired |
| cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
| cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
| cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
| cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
| cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
| cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
| cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
| cvrBlocked | 0x0800 | One or more certificates are blocked |
| cvrFailure | 0x1000 | General validation failure |
| cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
| cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
| cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
on_chain_validation_progress event (SOAPSigner Struct)
This event is fired multiple times during chain validation to report various stages of the validation procedure.
Syntax
// SOAPSignerChainValidationProgressEventArgs carries the SOAPSigner ChainValidationProgress event's parameters.
pub struct SOAPSignerChainValidationProgressEventArgs {
fn event_kind(&self) -> &String
fn cert_rdn(&self) -> &String
fn ca_cert_rdn(&self) -> &String
fn action(&self) -> i32
fn set_action(&self, value : i32)
}
// SOAPSignerChainValidationProgressEvent defines the signature of the SOAPSigner ChainValidationProgress event's handler function.
pub trait SOAPSignerChainValidationProgressEvent {
fn on_chain_validation_progress(&self, sender : SOAPSigner, e : &mut SOAPSignerChainValidationProgressEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_chain_validation_progress(&self) -> &'a dyn SOAPSignerChainValidationProgressEvent;
pub fn set_on_chain_validation_progress(&mut self, value : &'a dyn SOAPSignerChainValidationProgressEvent);
...
}
Remarks
Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.
The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.
| veaAuto | 0 | Handle the action automatically (the default behaviour) |
| veaContinue | 1 | Accept the request implied by the event (accept the certificate, allow the object retrieval) |
| veaReject | 2 | Reject the request implied by the event (reject the certificate, disallow the object retrieval) |
| veaAcceptNow | 3 | Accept the validated certificate immediately |
| veaAbortNow | 4 | Abort the validation, reject the certificate |
on_error event (SOAPSigner Struct)
Information about errors during signing.
Syntax
// SOAPSignerErrorEventArgs carries the SOAPSigner Error event's parameters.
pub struct SOAPSignerErrorEventArgs {
fn error_code(&self) -> i32
fn description(&self) -> &String
}
// SOAPSignerErrorEvent defines the signature of the SOAPSigner Error event's handler function.
pub trait SOAPSignerErrorEvent {
fn on_error(&self, sender : SOAPSigner, e : &mut SOAPSignerErrorEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_error(&self) -> &'a dyn SOAPSignerErrorEvent;
pub fn set_on_error(&mut self, value : &'a dyn SOAPSignerErrorEvent);
...
}
Remarks
The event is fired in case of exceptional conditions during signing.
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 SOAP.
on_external_sign event (SOAPSigner Struct)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
// SOAPSignerExternalSignEventArgs carries the SOAPSigner ExternalSign event's parameters.
pub struct SOAPSignerExternalSignEventArgs {
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)
}
// SOAPSignerExternalSignEvent defines the signature of the SOAPSigner ExternalSign event's handler function.
pub trait SOAPSignerExternalSignEvent {
fn on_external_sign(&self, sender : SOAPSigner, e : &mut SOAPSignerExternalSignEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_external_sign(&self) -> &'a dyn SOAPSignerExternalSignEvent;
pub fn set_on_external_sign(&mut self, value : &'a dyn SOAPSignerExternalSignEvent);
...
}
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the struct via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The struct uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
on_format_element event (SOAPSigner Struct)
Reports the XML element that is currently being processed.
Syntax
// SOAPSignerFormatElementEventArgs carries the SOAPSigner FormatElement event's parameters.
pub struct SOAPSignerFormatElementEventArgs {
fn start_tag_whitespace(&self) -> &String
fn set_start_tag_whitespace(&self, value : &str)
fn set_start_tag_whitespace_ref(&self, value : &String)
fn end_tag_whitespace(&self) -> &String
fn set_end_tag_whitespace(&self, value : &str)
fn set_end_tag_whitespace_ref(&self, value : &String)
fn level(&self) -> i32
fn path(&self) -> &String
fn has_child_elements(&self) -> bool
}
// SOAPSignerFormatElementEvent defines the signature of the SOAPSigner FormatElement event's handler function.
pub trait SOAPSignerFormatElementEvent {
fn on_format_element(&self, sender : SOAPSigner, e : &mut SOAPSignerFormatElementEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_format_element(&self) -> &'a dyn SOAPSignerFormatElementEvent;
pub fn set_on_format_element(&mut self, value : &'a dyn SOAPSignerFormatElementEvent);
...
}
Remarks
Path and Level specify the path to the XML element being processed and its nesting level, respectively.
HasChildElements specify if processed XML element has child elements.
Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.
on_format_text event (SOAPSigner Struct)
Reports XML text that is currently being processed.
Syntax
// SOAPSignerFormatTextEventArgs carries the SOAPSigner FormatText event's parameters.
pub struct SOAPSignerFormatTextEventArgs {
fn text(&self) -> &String
fn set_text(&self, value : &str)
fn set_text_ref(&self, value : &String)
fn text_type(&self) -> i32
fn level(&self) -> i32
fn path(&self) -> &String
}
// SOAPSignerFormatTextEvent defines the signature of the SOAPSigner FormatText event's handler function.
pub trait SOAPSignerFormatTextEvent {
fn on_format_text(&self, sender : SOAPSigner, e : &mut SOAPSignerFormatTextEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_format_text(&self) -> &'a dyn SOAPSignerFormatTextEvent;
pub fn set_on_format_text(&mut self, value : &'a dyn SOAPSignerFormatTextEvent);
...
}
Remarks
TextType parameter specifies the type of the XML text (normal or Base64-encoded) that is stored in the element; Path and Level specify the path to the XML element and its nesting level.
Among other purposes, this event may be used to add whitespace formatting before or after a particular element in the signature.
on_message_loaded event (SOAPSigner Struct)
This event is fired when the message has been loaded into memory.
Syntax
// SOAPSignerMessageLoadedEventArgs carries the SOAPSigner MessageLoaded event's parameters.
pub struct SOAPSignerMessageLoadedEventArgs {
fn cancel(&self) -> bool
fn set_cancel(&self, value : bool)
}
// SOAPSignerMessageLoadedEvent defines the signature of the SOAPSigner MessageLoaded event's handler function.
pub trait SOAPSignerMessageLoadedEvent {
fn on_message_loaded(&self, sender : SOAPSigner, e : &mut SOAPSignerMessageLoadedEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_message_loaded(&self) -> &'a dyn SOAPSignerMessageLoadedEvent;
pub fn set_on_message_loaded(&mut self, value : &'a dyn SOAPSignerMessageLoadedEvent);
...
}
Remarks
The handler for this event is a good place to check message properties, which may be useful when preparing the signature.
Set Cancel to true to terminate message processing on this stage.
on_notification event (SOAPSigner Struct)
This event notifies the application about an underlying control flow event.
Syntax
// SOAPSignerNotificationEventArgs carries the SOAPSigner Notification event's parameters.
pub struct SOAPSignerNotificationEventArgs {
fn event_id(&self) -> &String
fn event_param(&self) -> &String
}
// SOAPSignerNotificationEvent defines the signature of the SOAPSigner Notification event's handler function.
pub trait SOAPSignerNotificationEvent {
fn on_notification(&self, sender : SOAPSigner, e : &mut SOAPSignerNotificationEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_notification(&self) -> &'a dyn SOAPSignerNotificationEvent;
pub fn set_on_notification(&mut self, value : &'a dyn SOAPSignerNotificationEvent);
...
}
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 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), 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. |
on_reference_validated event (SOAPSigner Struct)
Marks the end of a reference validation.
Syntax
// SOAPSignerReferenceValidatedEventArgs carries the SOAPSigner ReferenceValidated event's parameters.
pub struct SOAPSignerReferenceValidatedEventArgs {
fn reference_index(&self) -> i32
fn id(&self) -> &String
fn uri(&self) -> &String
fn ref_type(&self) -> &String
fn digest_valid(&self) -> bool
}
// SOAPSignerReferenceValidatedEvent defines the signature of the SOAPSigner ReferenceValidated event's handler function.
pub trait SOAPSignerReferenceValidatedEvent {
fn on_reference_validated(&self, sender : SOAPSigner, e : &mut SOAPSignerReferenceValidatedEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_reference_validated(&self) -> &'a dyn SOAPSignerReferenceValidatedEvent;
pub fn set_on_reference_validated(&mut self, value : &'a dyn SOAPSignerReferenceValidatedEvent);
...
}
Remarks
The struct fires this event to report completion of a reference validation. A reference is a building block of a signature as it binds signature coverage to a particular piece of the document.
on_resolve_reference event (SOAPSigner Struct)
Asks the application to resolve a reference.
Syntax
// SOAPSignerResolveReferenceEventArgs carries the SOAPSigner ResolveReference event's parameters.
pub struct SOAPSignerResolveReferenceEventArgs {
fn reference_index(&self) -> i32
fn uri(&self) -> &String
}
// SOAPSignerResolveReferenceEvent defines the signature of the SOAPSigner ResolveReference event's handler function.
pub trait SOAPSignerResolveReferenceEvent {
fn on_resolve_reference(&self, sender : SOAPSigner, e : &mut SOAPSignerResolveReferenceEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_resolve_reference(&self) -> &'a dyn SOAPSignerResolveReferenceEvent;
pub fn set_on_resolve_reference(&mut self, value : &'a dyn SOAPSignerResolveReferenceEvent);
...
}
Remarks
This event is fired when the control could not automatically resolve a reference and requires custom treatment.
URI contains a reference to the data.
ReferenceIndex specifies the index of the reference to process.
Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.
on_signature_found event (SOAPSigner Struct)
Signifies the start of signature validation.
Syntax
// SOAPSignerSignatureFoundEventArgs carries the SOAPSigner SignatureFound event's parameters.
pub struct SOAPSignerSignatureFoundEventArgs {
fn index(&self) -> i32
fn entity_label(&self) -> &String
fn issuer_rdn(&self) -> &String
fn serial_number(&self) -> &[u8]
fn subject_key_id(&self) -> &[u8]
fn cert_found(&self) -> bool
fn validate_signature(&self) -> bool
fn set_validate_signature(&self, value : bool)
fn validate_chain(&self) -> bool
fn set_validate_chain(&self, value : bool)
}
// SOAPSignerSignatureFoundEvent defines the signature of the SOAPSigner SignatureFound event's handler function.
pub trait SOAPSignerSignatureFoundEvent {
fn on_signature_found(&self, sender : SOAPSigner, e : &mut SOAPSignerSignatureFoundEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_signature_found(&self) -> &'a dyn SOAPSignerSignatureFoundEvent;
pub fn set_on_signature_found(&mut self, value : &'a dyn SOAPSignerSignatureFoundEvent);
...
}
Remarks
This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.
The CertFound parameter is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.
Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
on_signature_validated event (SOAPSigner Struct)
Marks the completion of the signature validation routine.
Syntax
// SOAPSignerSignatureValidatedEventArgs carries the SOAPSigner SignatureValidated event's parameters.
pub struct SOAPSignerSignatureValidatedEventArgs {
fn index(&self) -> i32
fn entity_label(&self) -> &String
fn issuer_rdn(&self) -> &String
fn serial_number(&self) -> &[u8]
fn subject_key_id(&self) -> &[u8]
fn validation_result(&self) -> i32
fn cancel(&self) -> bool
fn set_cancel(&self, value : bool)
}
// SOAPSignerSignatureValidatedEvent defines the signature of the SOAPSigner SignatureValidated event's handler function.
pub trait SOAPSignerSignatureValidatedEvent {
fn on_signature_validated(&self, sender : SOAPSigner, e : &mut SOAPSignerSignatureValidatedEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_signature_validated(&self) -> &'a dyn SOAPSignerSignatureValidatedEvent;
pub fn set_on_signature_validated(&mut self, value : &'a dyn SOAPSignerSignatureValidatedEvent);
...
}
Remarks
This event is fired upon the completion of the signature validation routine, and reports the respective validation result.
Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
on_timestamp_found event (SOAPSigner Struct)
Signifies the start of a timestamp validation routine.
Syntax
// SOAPSignerTimestampFoundEventArgs carries the SOAPSigner TimestampFound event's parameters.
pub struct SOAPSignerTimestampFoundEventArgs {
fn index(&self) -> i32
fn entity_label(&self) -> &String
fn issuer_rdn(&self) -> &String
fn serial_number(&self) -> &[u8]
fn subject_key_id(&self) -> &[u8]
fn cert_found(&self) -> bool
fn validate_timestamp(&self) -> bool
fn set_validate_timestamp(&self, value : bool)
fn validate_chain(&self) -> bool
fn set_validate_chain(&self, value : bool)
}
// SOAPSignerTimestampFoundEvent defines the signature of the SOAPSigner TimestampFound event's handler function.
pub trait SOAPSignerTimestampFoundEvent {
fn on_timestamp_found(&self, sender : SOAPSigner, e : &mut SOAPSignerTimestampFoundEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_timestamp_found(&self) -> &'a dyn SOAPSignerTimestampFoundEvent;
pub fn set_on_timestamp_found(&mut self, value : &'a dyn SOAPSignerTimestampFoundEvent);
...
}
Remarks
This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.
The CertFound parameter is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.
Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.
Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.
on_timestamp_request event (SOAPSigner Struct)
Fires when the struct is ready to request a timestamp from an external TSA.
Syntax
// SOAPSignerTimestampRequestEventArgs carries the SOAPSigner TimestampRequest event's parameters.
pub struct SOAPSignerTimestampRequestEventArgs {
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)
}
// SOAPSignerTimestampRequestEvent defines the signature of the SOAPSigner TimestampRequest event's handler function.
pub trait SOAPSignerTimestampRequestEvent {
fn on_timestamp_request(&self, sender : SOAPSigner, e : &mut SOAPSignerTimestampRequestEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_timestamp_request(&self) -> &'a dyn SOAPSignerTimestampRequestEvent;
pub fn set_on_timestamp_request(&mut self, value : &'a dyn SOAPSignerTimestampRequestEvent);
...
}
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 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_timestamp_validated event (SOAPSigner Struct)
Reports the completion of the timestamp validation routine.
Syntax
// SOAPSignerTimestampValidatedEventArgs carries the SOAPSigner TimestampValidated event's parameters.
pub struct SOAPSignerTimestampValidatedEventArgs {
fn index(&self) -> i32
fn entity_label(&self) -> &String
fn issuer_rdn(&self) -> &String
fn serial_number(&self) -> &[u8]
fn subject_key_id(&self) -> &[u8]
fn time(&self) -> &String
fn validation_result(&self) -> i32
fn chain_validation_result(&self) -> i32
fn chain_validation_details(&self) -> i32
fn cancel(&self) -> bool
fn set_cancel(&self, value : bool)
}
// SOAPSignerTimestampValidatedEvent defines the signature of the SOAPSigner TimestampValidated event's handler function.
pub trait SOAPSignerTimestampValidatedEvent {
fn on_timestamp_validated(&self, sender : SOAPSigner, e : &mut SOAPSignerTimestampValidatedEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_timestamp_validated(&self) -> &'a dyn SOAPSignerTimestampValidatedEvent;
pub fn set_on_timestamp_validated(&mut self, value : &'a dyn SOAPSignerTimestampValidatedEvent);
...
}
Remarks
This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.
ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.
| svtValid | 0 | The signature is valid |
| svtUnknown | 1 | Signature validity is unknown |
| svtCorrupted | 2 | The signature is corrupted |
| svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. |
| svtFailure | 4 | General failure |
| svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) |
on_tls_cert_needed event (SOAPSigner Struct)
Fires when a remote TLS party requests a client certificate.
Syntax
// SOAPSignerTLSCertNeededEventArgs carries the SOAPSigner TLSCertNeeded event's parameters.
pub struct SOAPSignerTLSCertNeededEventArgs {
fn host(&self) -> &String
fn ca_names(&self) -> &String
}
// SOAPSignerTLSCertNeededEvent defines the signature of the SOAPSigner TLSCertNeeded event's handler function.
pub trait SOAPSignerTLSCertNeededEvent {
fn on_tls_cert_needed(&self, sender : SOAPSigner, e : &mut SOAPSignerTLSCertNeededEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_tls_cert_needed(&self) -> &'a dyn SOAPSignerTLSCertNeededEvent;
pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn SOAPSignerTLSCertNeededEvent);
...
}
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 event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.
on_tls_cert_validate event (SOAPSigner Struct)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
// SOAPSignerTLSCertValidateEventArgs carries the SOAPSigner TLSCertValidate event's parameters.
pub struct SOAPSignerTLSCertValidateEventArgs {
fn server_host(&self) -> &String
fn server_ip(&self) -> &String
fn accept(&self) -> bool
fn set_accept(&self, value : bool)
}
// SOAPSignerTLSCertValidateEvent defines the signature of the SOAPSigner TLSCertValidate event's handler function.
pub trait SOAPSignerTLSCertValidateEvent {
fn on_tls_cert_validate(&self, sender : SOAPSigner, e : &mut SOAPSignerTLSCertValidateEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_tls_cert_validate(&self) -> &'a dyn SOAPSignerTLSCertValidateEvent;
pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn SOAPSignerTLSCertValidateEvent);
...
}
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 (SOAPSigner Struct)
Fires when a TLS handshake with Host successfully completes.
Syntax
// SOAPSignerTLSEstablishedEventArgs carries the SOAPSigner TLSEstablished event's parameters.
pub struct SOAPSignerTLSEstablishedEventArgs {
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)
}
// SOAPSignerTLSEstablishedEvent defines the signature of the SOAPSigner TLSEstablished event's handler function.
pub trait SOAPSignerTLSEstablishedEvent {
fn on_tls_established(&self, sender : SOAPSigner, e : &mut SOAPSignerTLSEstablishedEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_tls_established(&self) -> &'a dyn SOAPSignerTLSEstablishedEvent;
pub fn set_on_tls_established(&mut self, value : &'a dyn SOAPSignerTLSEstablishedEvent);
...
}
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 (SOAPSigner Struct)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
// SOAPSignerTLSHandshakeEventArgs carries the SOAPSigner TLSHandshake event's parameters.
pub struct SOAPSignerTLSHandshakeEventArgs {
fn host(&self) -> &String
fn abort(&self) -> bool
fn set_abort(&self, value : bool)
}
// SOAPSignerTLSHandshakeEvent defines the signature of the SOAPSigner TLSHandshake event's handler function.
pub trait SOAPSignerTLSHandshakeEvent {
fn on_tls_handshake(&self, sender : SOAPSigner, e : &mut SOAPSignerTLSHandshakeEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_tls_handshake(&self) -> &'a dyn SOAPSignerTLSHandshakeEvent;
pub fn set_on_tls_handshake(&mut self, value : &'a dyn SOAPSignerTLSHandshakeEvent);
...
}
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 event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.
on_tls_shutdown event (SOAPSigner Struct)
Reports the graceful closure of a TLS connection.
Syntax
// SOAPSignerTLSShutdownEventArgs carries the SOAPSigner TLSShutdown event's parameters.
pub struct SOAPSignerTLSShutdownEventArgs {
fn host(&self) -> &String
}
// SOAPSignerTLSShutdownEvent defines the signature of the SOAPSigner TLSShutdown event's handler function.
pub trait SOAPSignerTLSShutdownEvent {
fn on_tls_shutdown(&self, sender : SOAPSigner, e : &mut SOAPSignerTLSShutdownEventArgs);
}
impl <'a> SOAPSigner<'a> {
pub fn on_tls_shutdown(&self) -> &'a dyn SOAPSignerTLSShutdownEvent;
pub fn set_on_tls_shutdown(&mut self, value : &'a dyn SOAPSignerTLSShutdownEvent);
...
}
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 (SOAPSigner 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 method.SOAPSigner Config Settings
The supported values are: "X509v3", "X509PKIPathv1", "PKCS7", "Default" or fully qualified URLs for the first three values.
For default value, the component uses the "X509v3" type if one signing certificate is provided, and uses the "PKCS7" type otherwise.
The default value is 1 day (86400 seconds). A value of 0 disables the absolute CRL age check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
The default value is 50 percent. Values are interpreted in the 0..100 range. A value of 0 disables the CRL ratio check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
The default value is 10 minutes (600 seconds). A value of 0 disables the CRL overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
This setting is evaluated independently from CachedCRLMaxAge and CachedCRLMaxAgeRatio. If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.
The default value is 1 hour (3600 seconds). A value of 0 disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
The default value is 50 percent. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use CachedOCSPResponseMaxAge to limit their age. A value of 0 disables the OCSP response ratio check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
The default value is 10 minutes (600 seconds). A value of 0 disables the OCSP response overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.
This setting is evaluated independently from CachedOCSPResponseMaxAge and CachedOCSPResponseMaxAgeRatio. If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.
For example, if the corresponding ds:Reference element has an Id "reference-id-1", then you should set this property to "#reference-id-1" value.
Index value could be omitted for the first DataObjectFormat element.
The default value is dcrlpPreferComplete (1).
Supported values:
- dcrlpPreferDelta (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
- dcrlpPreferComplete (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.
Default value is "ec". In this case "ec:" prefix will be used.
Special values:
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the trusted_certificates property) are considered trusted.
The empty elements in the custom XML content act as a placeholder for auto-generated elements.
For example to change the order of ds:KeyValue and ds:X509Data auto-generated elements use the value: "<X509Data/><KeyValue/>"
Supported values are:
| certificate | Base64-encoded [X509v3] certificate is placed to the signature | |
| issuerserial | X.509 issuer distinguished name/serial number pair are placed to the signature | |
| subjectname | X.509 subject distinguished name is placed to the signature | |
| ski | Base64 encoded plain (i.e. non-DER-encoded) value of a X509 V.3 SubjectKeyIdentifier extension is placed to the signature | |
| crl | Base64-encoded certificate revocation list (CRL) is placed to the signature |
Sample value: '{"addressCountry": "UK", "addressLocality": "London", "postalCode": "N1 7GU", "streetAddress": "20-22 Wenlock Road"}'
Supported values are:
| SigAndRefs | SigAndRefs timestamp | |
| RefsOnly | RefsOnly timestamp |
Supported values are case-insensitive:
| Default | Applies the AdES default freshness settings: crl:86400;50;600,ocsp:3600;50;600. This means: CRL maximum age 1 day, CRL age ratio 50%, CRL overlap 10 minutes; OCSP response maximum age 1 hour, OCSP response age ratio 50%, OCSP response overlap 10 minutes. This value is the default. |
| Disabled | Sets CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio to 0. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. |
| Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. |
| Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. |
| N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. |
| crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap> | Sets the CRL and OCSP response freshness values explicitly. |
Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.
This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: Scheme=PSS;SaltSize=32;TrailerField=1.
Default value is "ds". In this case "ds:" prefix will be used.
Special values:
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 |
Supported values:
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in hash_algorithm property is used.
Supported values:
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in hash_algorithm property is used.
Supported values:
| YYYY | Year (e.g. 1997) | |
| YYYY-MM | Year and month (e.g. 1997-07) | |
| YYYY-MM-DD | Complete date (e.g. 1997-07-16) | |
| YYYY-MM-DDThh:mmTZD | Complete date plus hours and minutes (e.g. 1997-07-16T19:20+01:00) | |
| YYYY-MM-DDThh:mm:ssTZD | Complete date plus hours, minutes and seconds (e.g. 1997-07-16T20:20:30Z) | |
| YYYY-MM-DDThh:mm:ss.sTZD | Complete date plus hours, minutes, seconds and a decimal fraction of a second (e.g. 1997-07-16T20:20:30.4Z) | |
| YYYY-MM-DDThh:mm:ss.sssTZD | Default. Complete date plus hours, minutes, seconds and a fraction of a second (e.g. 1997-07-16T20:20:30.451Z) |
Behavior:
| "true" | Default. The provided time is interpreted as UTC. If SigningTimeZoneOffset is non-zero, the time is converted to the corresponding local time (UTC plus the offset) and serialized with that offset; otherwise it is serialized as UTC. | |
| "false" | The provided time is interpreted as local time. No clock-time adjustment is performed. The value is serialized as local time; if SigningTimeZoneOffset is non-zero, the specified offset is included. |
| cxcmNone | 0 | |
| cxcmCanon | 1 | |
| cxcmCanonComment | 2 | |
| cxcmExclCanon | 3 | |
| cxcmExclCanonComment | 4 | |
| cxcmMinCanon | 5 | |
| cxcmCanon_v1_1 | 6 | |
| cxcmCanonComment_v1_1 | 7 |
Supported values are:
| certificate | Base64-encoded [X509v3] certificates | |
| crl | Base64-encoded certificate revocation lists (CRL) | |
| ocsp | OCSP responses |
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
In case of a timestamping failure, provide new TSA and HTTP settings inside the on_notification event handler ('BeforeTimestamp' and 'TimestampError' event IDs).
Note: Unlike other structs, PDFSigner struct uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
The following default TSLs are used: EU (European Union) LOTL (list of trusted lists).
Supported values are:
| certificate | References to X.509 certificates | |
| crl | References to certificate revocation lists (CRL) | |
| ocsp | References to OCSP responses |
Supported values:
| SB_HASH_ALGORITHM_MD5 | MD5 | |
| SB_HASH_ALGORITHM_SHA1 | SHA1 | |
| SB_HASH_ALGORITHM_SHA224 | SHA224 | |
| SB_HASH_ALGORITHM_SHA256 | SHA256 | |
| SB_HASH_ALGORITHM_SHA384 | SHA384 | |
| SB_HASH_ALGORITHM_SHA512 | SHA512 | |
| SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
| SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
| SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
| SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
| SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
| SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 |
The default value is empty string, in this case, the hash algorithm specified in hash_algorithm property is used.
Supported values are:
| certificate | Base64-encoded [X509v3] certificates | |
| crl | Base64-encoded certificate revocation lists (CRL) | |
| ocsp | OCSP responses |
Default value is "wsse". In this case "wsse:" prefix will be used.
Special values:
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Default value is "wsu". In this case "wsu:" prefix will be used.
Special values:
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Supported values:
| YYYY | Year (eg 1997) | |
| YYYY-MM | Year and month (eg 1997-07) | |
| YYYY-MM-DD | Complete date (eg 1997-07-16) | |
| YYYY-MM-DDThh:mmTZD | Complete date plus hours and minutes (eg 1997-07-16T19:20+01:00) | |
| YYYY-MM-DDThh:mm:ssTZD | Complete date plus hours, minutes and seconds (eg 1997-07-16T20:20:30Z) | |
| YYYY-MM-DDThh:mm:ss.sTZD | Default. Complete date plus hours, minutes, seconds and a decimal fraction of a second (eg 1997-07-16T20:20:30.4Z) | |
| YYYY-MM-DDThh:mm:ss.sssTZD | Complete date plus hours, minutes, seconds and a fraction of a second (eg 1997-07-16T20:20:30.451Z) |
Behavior:
| "true" | The provided time is interpreted as UTC. If WSUTimestampCreatedTimeZoneOffset is non-zero, the time is converted to the corresponding local time (UTC plus the offset) and serialized with that offset; otherwise it is serialized as UTC. | |
| "false" | Default. the provided time is interpreted as local time. No clock-time adjustment is performed. The value is serialized as local time; if WSUTimestampCreatedTimeZoneOffset is non-zero, the specified offset is included. |
Supported values:
| YYYY | Year (eg 1997) | |
| YYYY-MM | Year and month (eg 1997-07) | |
| YYYY-MM-DD | Complete date (eg 1997-07-16) | |
| YYYY-MM-DDThh:mmTZD | Complete date plus hours and minutes (eg 1997-07-16T19:20+01:00) | |
| YYYY-MM-DDThh:mm:ssTZD | Complete date plus hours, minutes and seconds (eg 1997-07-16T20:20:30Z) | |
| YYYY-MM-DDThh:mm:ss.sTZD | Default. Complete date plus hours, minutes, seconds and a decimal fraction of a second (eg 1997-07-16T20:20:30.4Z) | |
| YYYY-MM-DDThh:mm:ss.sssTZD | Complete date plus hours, minutes, seconds and a fraction of a second (eg 1997-07-16T20:20:30.451Z) |
Behavior:
| "true" | The provided time is interpreted as UTC. If WSUTimestampExpiresTimeZoneOffset is non-zero, the time is converted to the corresponding local time (UTC plus the offset) and serialized with that offset; otherwise it is serialized as UTC. | |
| "false" | Default. the provided time is interpreted as local time. No clock-time adjustment is performed. The value is serialized as local time; if WSUTimestampExpiresTimeZoneOffset is non-zero, the specified offset is included. |
Default value is "xades". In this case "xades:" prefix will be used.
Special values:
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Default value is "xadesv141". In this case "xadesv141:" prefix will be used.
Special values:
| "#default" or "" | indicates that the prefix will be omitted. |
| "#auto" | indicates that the prefix will be auto-detected based on the parent nodes. |
Supported values:
| "" or "none" | no formatting (by default). | |
| "auto" | enables auto-formatting, equivalent to: "indent: 1; indent-char: tab; base64-max-length: 64; starting-level: node" |
| indent | specifies indentation level (default is 1) | |
| indent-char | specifies indentation character: "space" or "tab" (default) | |
| base64-max-length | specifies max length of base64 encoded data, such as signature value, certificate data and etc. (default is 64) | |
| starting-level | specifies starting indentation level: non-negative integer or "node" - detected based on parent node, or "root" - detected based on number of parent nodes to a document element (default is "node"). | |
| indent-before-main | specifies if whitespace characters should be inserted before a main (ds:Signature) element: "auto" (default), "yes" or "no" |
Supported values:
- cxcmNone (0)
- cxcmCanon (1)
- cxcmCanonComment (2)
- cxcmExclCanon (3)
- cxcmExclCanonComment (4)
- cxcmMinCanon (5)
- cxcmCanon_v1_1 (6)
Supported values:
| "completefragment" | as complete fragment (the default setting). | |
| "rawtree" | as a raw tree |
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
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. |
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
| 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) |
Supported Values:
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (SOAPSigner Struct)
SOAPSigner Errors
| 1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
| 1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
| 1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
| 1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
| 1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
| 1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
| 1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
| 1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
| 1048585 | General error (SB_ERROR_GENERAL_ERROR) |
| 33554433 | The input file does not exist (SB_ERROR_SOAP_INPUTFILE_NOT_EXISTS) |
| 33554434 | Invalid key type (SB_ERROR_SOAP_INVALID_KEY_TYPE) |
| 33554435 | No signature found to complete the asynchronous signing (SB_ERROR_SOAP_SIGNATURE_NOT_FOUND) |
| 33554436 | Unsupported signature type (SB_ERROR_SOAP_UNSUPPORTED_SIGNATURE_TYPE) |
| 33554437 | Unexpected HTTP status code (SB_ERROR_SOAP_UNEXPECTED_HTTP_STATUS_CODE) |
| 33554438 | SOAP service failed (SB_ERROR_SOAP_SERVICE_FAILED) |