HTTPClient Class
Properties Methods Events Config Settings Errors
The HTTPClient class implements client-side functionality of HTTP and HTTPS protocols.
Syntax
class secureblackbox.HTTPClient
Remarks
HTTPClient provides means of exchanging HTTP messages with HTTP servers. Both plain (HTTP) and secure (HTTPS) connection types are supported.
Features supported
- All standard request types (GET, POST, PUT etc.), plus custom VERBs
- TLS 1.2 and 1.3 (and earlier versions for older servers)
- Strong client and server authentication on TLS and HTTP levels
- Flexible custom header adjustment
- A variety of proxy server types
Configuring the component
HTTPClient is very easy to configure. In some cases, like in the example given
below, you do not need any special tuneups whatsoever:
client.Get("http://www.mywebserver.com/");
if (client.StatusCode == 200) {
string response = client.OutputString;
}
You may need to adjust the component settings if you plan to connect to endpoints
secured with TLS. By default, HTTPClient relies on the system settings when
validating server certificates. If you would prefer to ignore the system trust
and implement customized chain validation procedures - such as certificate pinning -
in your code instead, set TLSSettings.AutoValidateCertificates to false, and
subscribe to on_certificate_validate event. This event will fire whenever a server
certificate validation needs to be performed.
Use tls_client_chain collection to provide your certificates for client authentication. Make sure the provided certificate contains a private key; otherwise it will be unable to authenticate.
To provide custom HTTP headers, subscribe to on_headers_prepared event. HTTPClient fires this event right before sending the request out to the server, giving you an opportunity to alter the headers or add your own. The list of headers can be accessed via the request_headers collection. Note: the headers can only be modified from the on_headers_prepared event handler. Setting them earlier or later in your code won't provide the expected effect.
Having set up the component, use the appropriate output property (such as output_file) to obtain the response in the desired format (string, memory buffer, or file).
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| auth_types | Defines allowed HTTP authentication types. |
| 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. |
| conn_info_aead_cipher | Indicates whether the encryption algorithm used is an AEAD cipher. |
| conn_info_chain_validation_details | The details of a certificate chain validation outcome. |
| conn_info_chain_validation_result | The outcome of a certificate chain validation routine. |
| conn_info_ciphersuite | The cipher suite employed by this connection. |
| conn_info_client_authenticated | Specifies whether client authentication was performed during this connection. |
| conn_info_client_auth_requested | Specifies whether client authentication was requested during this connection. |
| conn_info_connection_established | Indicates whether the connection has been established fully. |
| conn_info_connection_id | The unique identifier assigned to this connection. |
| conn_info_digest_algorithm | The digest algorithm used in a TLS-enabled connection. |
| conn_info_encryption_algorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
| conn_info_exportable | Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
| conn_info_id | The client connection's unique identifier. |
| conn_info_key_exchange_algorithm | The key exchange algorithm used in a TLS-enabled connection. |
| conn_info_key_exchange_key_bits | The length of the key exchange key of a TLS-enabled connection. |
| conn_info_named_ec_curve | The elliptic curve used in this connection. |
| conn_info_pfs_cipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
| conn_info_pre_shared_identity | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| conn_info_pre_shared_identity_hint | A hint professed by the server to help the client select the PSK identity to use. |
| conn_info_public_key_bits | The length of the public key. |
| conn_info_remote_address | The client's IP address. |
| conn_info_remote_port | The remote port of the client connection. |
| conn_info_resumed_session | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
| conn_info_secure_connection | Indicates whether TLS or SSL is enabled for this connection. |
| conn_info_server_authenticated | Indicates whether server authentication was performed during a TLS-enabled connection. |
| conn_info_signature_algorithm | The signature algorithm used in a TLS handshake. |
| conn_info_symmetric_block_size | The block size of the symmetric algorithm used. |
| conn_info_symmetric_key_bits | The key length of the symmetric algorithm used. |
| conn_info_total_bytes_received | The total number of bytes received over this connection. |
| conn_info_total_bytes_sent | The total number of bytes sent over this connection. |
| conn_info_validation_log | Contains the server certificate's chain validation log. |
| conn_info_version | Indicates the version of SSL/TLS protocol negotiated during this connection. |
| custom_request | Specifies a custom request verb. |
| dynamic_data | Takes a piece of data to be sent to the server within a dynamic POST or PUT request. |
| 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. |
| keep_alive_policy | Defines the keep-alive handling policy. |
| 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. |
| output_bytes | Contains the response content. |
| output_file | A path to the output file. |
| output_string | Contains the response content. |
| 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_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. |
| reason_phrase | Contains the Reason Phrase element of the server's response. |
| req_header_count | The number of records in the ReqHeader arrays. |
| req_header_category | Specifies the string category of the contained value. |
| req_header_format | Specifies the format (encoding) of the value contained in the Value property. |
| req_header_name | The name element in a (name, value) pair. |
| req_header_value | The value element in a (name, value) pair. |
| req_params_accept | Specifies the Accept header property of the HTTP request. |
| req_params_accept_charset | Specifies the Accept-Charset header property of the HTTP request. |
| req_params_accept_language | Specifies the Accept-Language header property of the HTTP request. |
| req_params_accept_range_end | This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request. |
| req_params_accept_range_start | This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request. |
| req_params_authorization | Specifies the Authorization header of the HTTP request. |
| req_params_connection | Specifies the value to pass to the Connection header property of HTTP request. |
| req_params_content_length | Specifies the size of the entity-body of the HTTP request. |
| req_params_content_range_end | Specifies the upper bound used in the Content-Range header of the HTTP request. |
| req_params_content_range_full_size | Specifies the total length of the full entity-body of the HTTP request. |
| req_params_content_range_start | Specifies the lower bound used in the Content-Range header of the HTTP request. |
| req_params_content_type | The Content-Type header property of the HTTP request. |
| req_params_cookie | This header is expected to be assigned with cookies previously received from the server and stored by the client. |
| req_params_custom_headers | Assign any custom HTTP headers to be passed to the server to this property. |
| req_params_date | The date and time of the request. |
| req_params_from | Contains the From header property of the HTTP request. |
| req_params_host | This property contains the Host header property of the HTTP request. |
| req_params_http_version | Specifies the version of HTTP protocol to use: 1. |
| req_params_if_match | Contains the If-Match request header property. |
| req_params_if_modified_since | Contains the If-Modified-Since request header property. |
| req_params_if_none_match | Contains the If-None-Match request header property. |
| req_params_if_unmodified_since | Contains the If-Unmodified-Since request header property. |
| req_params_password | Assign this property with the user's password. |
| req_params_referer | The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer). |
| req_params_user_agent | The User-Agent property of the HTTP request provides information about the software that initiates the request. |
| req_params_username | Assign this property with the user's login name. |
| resp_header_count | The number of records in the RespHeader arrays. |
| resp_header_category | Specifies the string category of the contained value. |
| resp_header_format | Specifies the format (encoding) of the value contained in the Value property. |
| resp_header_name | The name element in a (name, value) pair. |
| resp_header_value | The value element in a (name, value) pair. |
| resp_params_content_length | Indicates the length of the response content in bytes. |
| resp_params_date | The date and time at which the response was generated, in server time, in UTC. |
| resp_params_reason_phrase | Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code. |
| resp_params_status_code | The server-generated status code of the request processing status. |
| socket_dns_mode | Selects the DNS resolver to use: the class'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. |
| status_code | Contains the Status Code element of the server's response. |
| 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_ec_curves | Defines the elliptic curves to enable. |
| 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_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_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. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| delete | Sends a DELETE request to the server. |
| do_action | Performs an additional action. |
| get | Sends a GET request to the server. |
| head | Sends a HEAD request to the server. |
| options | Sends an OPTIONS request to the server. |
| post | Sends a POST request to the server. |
| post_bytes | Sends a POST request to the server. |
| post_file | Sends a file to the server using a POST request. |
| post_web_form | Posts a web form data to the server. |
| put | Sends a PUT request to the server. |
| put_bytes | Sends a PUT request to the server. |
| put_file | Sends a file to the server using a PUT request. |
| reset | Resets the class settings. |
| trace | Sends a TRACE request to the server. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_cookie | Fired to report a received cookie. |
| on_document_begin | Marks the start of the incoming HTML document or file. |
| on_document_end | Marks the successful receipt of the incoming HTML document or file. |
| on_dynamic_data_needed | Requests a portion of data to be uploaded from the application. |
| on_error | Information about errors during data delivery. |
| on_external_sign | Handles remote or external signing initiated by the SignExternal method or other source. |
| on_headers_prepared | Fires when the request headers have been formed and are about to be sent to the server. |
| on_headers_received | Fires when the HTTP response headers have just been received from the server. |
| on_notification | This event notifies the application about an underlying control flow event. |
| on_progress | Fires periodically during the data transfer. |
| on_redirection | Fires when the server suggests a redirect. |
| 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_psk | Notifies the application about the PSK key exchange. |
| on_tls_shutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
| AuthStickToLastURL | TBD. |
| CacheStreamOutput | Tells the class whether to cache stream- and file-bound responses in the class. |
| Cookies | TBD. |
| DefClientCookieFmt | TBD. |
| ForceNTLMAuth | Activates and enforces NTLM authentication. |
| IgnoreCookieSecureFlag | TBD. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| IgnoreUnknownTransferEncodings | All incoming responses with unknown transfer encodings are ignored if this property is true. |
| KeepConnectionOpen | TBD. |
| MaxRedirections | The maximum number of HTTP redirects. |
| OutputFile | Specifies the file where the received content should be saved to. |
| PersistentAuthHeader | Whether to resend NTLM negotiation on every request. |
| RequestCompressionGZip | Ask server to use GZip compression. |
| RequestCompressionLevel | Ask server to use the specified compression level. |
| SendBufferSize | Size of send buffer in bytes. |
| 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. |
| SuppressRedirectionContent | Whether to suppress the redirection content. |
| TempPath | Path for storing temporary files. |
| TLSExtensions | TBD. |
| TLSPeerExtensions | TBD. |
| 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. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| Use100Continue | Whether to use 100-continue for POST and PUT commands. |
| UseCompression | Whether to use GZip compression. |
| UseKerberosAuth | TBD. |
| UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
| AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class. |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| DNSLocalSuffix | The suffix to assign for TLD names. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HardwareCryptoUsePolicy | The hardware crypto usage policy. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
| IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
| ListDelimiter | The delimiter character for multi-element lists. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
| PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| PKICachePath | Specifies the file system path where cached PKI data is stored. |
| ProductVersion | Returns the version of the SecureBlackbox library. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
| UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
| UseLegacyAdESValidation | Enables legacy AdES validation mode. |
| UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
| XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
| XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
| XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
auth_types Property
Defines allowed HTTP authentication types.
Syntax
def get_auth_types() -> int: ... def set_auth_types(value: int) -> None: ...
auth_types = property(get_auth_types, set_auth_types)
Default Value
0
Remarks
Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:
| haBasic | 0x01 | Basic authentication |
| haDigest | 0x02 | Digest authentication (RFC 2617) |
| haNTLM | 0x04 | Windows NTLM authentication |
| haKerberos | 0x08 | Kerberos (Negotiate) authentication |
| haOAuth2 | 0x10 | OAuth2 authentication |
blocked_cert_count Property
The number of records in the BlockedCert arrays.
Syntax
def get_blocked_cert_count() -> int: ... def set_blocked_cert_count(value: int) -> None: ...
blocked_cert_count = property(get_blocked_cert_count, set_blocked_cert_count)
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.blocked_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_blocked_cert_bytes(blocked_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.
This property is read-only.
blocked_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_blocked_cert_handle(blocked_cert_index: int) -> int: ... def set_blocked_cert_handle(blocked_cert_index: int, value: int) -> None: ...
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 blocked_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the blocked_cert_count property.
conn_info_aead_cipher Property
Indicates whether the encryption algorithm used is an AEAD cipher.
Syntax
def get_conn_info_aead_cipher() -> bool: ...
conn_info_aead_cipher = property(get_conn_info_aead_cipher, None)
Default Value
FALSE
Remarks
Indicates whether the encryption algorithm used is an AEAD cipher.
This property is read-only.
conn_info_chain_validation_details Property
The details of a certificate chain validation outcome.
Syntax
def get_conn_info_chain_validation_details() -> int: ...
conn_info_chain_validation_details = property(get_conn_info_chain_validation_details, None)
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 |
This property is read-only.
conn_info_chain_validation_result Property
The outcome of a certificate chain validation routine.
Syntax
def get_conn_info_chain_validation_result() -> int: ...
conn_info_chain_validation_result = property(get_conn_info_chain_validation_result, None)
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.
This property is read-only.
conn_info_ciphersuite Property
The cipher suite employed by this connection.
Syntax
def get_conn_info_ciphersuite() -> str: ...
conn_info_ciphersuite = property(get_conn_info_ciphersuite, None)
Default Value
""
Remarks
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
This property is read-only.
conn_info_client_authenticated Property
Specifies whether client authentication was performed during this connection.
Syntax
def get_conn_info_client_authenticated() -> bool: ...
conn_info_client_authenticated = property(get_conn_info_client_authenticated, None)
Default Value
FALSE
Remarks
Specifies whether client authentication was performed during this connection.
This property is read-only.
conn_info_client_auth_requested Property
Specifies whether client authentication was requested during this connection.
Syntax
def get_conn_info_client_auth_requested() -> bool: ...
conn_info_client_auth_requested = property(get_conn_info_client_auth_requested, None)
Default Value
FALSE
Remarks
Specifies whether client authentication was requested during this connection.
This property is read-only.
conn_info_connection_established Property
Indicates whether the connection has been established fully.
Syntax
def get_conn_info_connection_established() -> bool: ...
conn_info_connection_established = property(get_conn_info_connection_established, None)
Default Value
FALSE
Remarks
Indicates whether the connection has been established fully.
This property is read-only.
conn_info_connection_id Property
The unique identifier assigned to this connection.
Syntax
def get_conn_info_connection_id() -> bytes: ...
conn_info_connection_id = property(get_conn_info_connection_id, None)
Remarks
The unique identifier assigned to this connection.
This property is read-only.
conn_info_digest_algorithm Property
The digest algorithm used in a TLS-enabled connection.
Syntax
def get_conn_info_digest_algorithm() -> str: ...
conn_info_digest_algorithm = property(get_conn_info_digest_algorithm, None)
Default Value
""
Remarks
The digest algorithm used in a TLS-enabled connection.
This property is read-only.
conn_info_encryption_algorithm Property
The symmetric encryption algorithm used in a TLS-enabled connection.
Syntax
def get_conn_info_encryption_algorithm() -> str: ...
conn_info_encryption_algorithm = property(get_conn_info_encryption_algorithm, None)
Default Value
""
Remarks
The symmetric encryption algorithm used in a TLS-enabled connection.
This property is read-only.
conn_info_exportable Property
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
Syntax
def get_conn_info_exportable() -> bool: ...
conn_info_exportable = property(get_conn_info_exportable, None)
Default Value
FALSE
Remarks
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
This property is read-only.
conn_info_id Property
The client connection's unique identifier.
Syntax
def get_conn_info_id() -> int: ...
conn_info_id = property(get_conn_info_id, None)
Default Value
-1
Remarks
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
This property is read-only.
conn_info_key_exchange_algorithm Property
The key exchange algorithm used in a TLS-enabled connection.
Syntax
def get_conn_info_key_exchange_algorithm() -> str: ...
conn_info_key_exchange_algorithm = property(get_conn_info_key_exchange_algorithm, None)
Default Value
""
Remarks
The key exchange algorithm used in a TLS-enabled connection.
This property is read-only.
conn_info_key_exchange_key_bits Property
The length of the key exchange key of a TLS-enabled connection.
Syntax
def get_conn_info_key_exchange_key_bits() -> int: ...
conn_info_key_exchange_key_bits = property(get_conn_info_key_exchange_key_bits, None)
Default Value
0
Remarks
The length of the key exchange key of a TLS-enabled connection.
This property is read-only.
conn_info_named_ec_curve Property
The elliptic curve used in this connection.
Syntax
def get_conn_info_named_ec_curve() -> str: ...
conn_info_named_ec_curve = property(get_conn_info_named_ec_curve, None)
Default Value
""
Remarks
The elliptic curve used in this connection.
This property is read-only.
conn_info_pfs_cipher Property
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
Syntax
def get_conn_info_pfs_cipher() -> bool: ...
conn_info_pfs_cipher = property(get_conn_info_pfs_cipher, None)
Default Value
FALSE
Remarks
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
This property is read-only.
conn_info_pre_shared_identity Property
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
def get_conn_info_pre_shared_identity() -> str: ...
conn_info_pre_shared_identity = property(get_conn_info_pre_shared_identity, None)
Default Value
""
Remarks
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is read-only.
conn_info_pre_shared_identity_hint Property
A hint professed by the server to help the client select the PSK identity to use.
Syntax
def get_conn_info_pre_shared_identity_hint() -> str: ...
conn_info_pre_shared_identity_hint = property(get_conn_info_pre_shared_identity_hint, None)
Default Value
""
Remarks
A hint professed by the server to help the client select the PSK identity to use.
This property is read-only.
conn_info_public_key_bits Property
The length of the public key.
Syntax
def get_conn_info_public_key_bits() -> int: ...
conn_info_public_key_bits = property(get_conn_info_public_key_bits, None)
Default Value
0
Remarks
The length of the public key.
This property is read-only.
conn_info_remote_address Property
The client's IP address.
Syntax
def get_conn_info_remote_address() -> str: ...
conn_info_remote_address = property(get_conn_info_remote_address, None)
Default Value
""
Remarks
The client's IP address.
This property is read-only.
conn_info_remote_port Property
The remote port of the client connection.
Syntax
def get_conn_info_remote_port() -> int: ...
conn_info_remote_port = property(get_conn_info_remote_port, None)
Default Value
0
Remarks
The remote port of the client connection.
This property is read-only.
conn_info_resumed_session Property
Indicates whether a TLS-enabled connection was spawned from another TLS connection.
Syntax
def get_conn_info_resumed_session() -> bool: ...
conn_info_resumed_session = property(get_conn_info_resumed_session, None)
Default Value
FALSE
Remarks
Indicates whether a TLS-enabled connection was spawned from another TLS connection
This property is read-only.
conn_info_secure_connection Property
Indicates whether TLS or SSL is enabled for this connection.
Syntax
def get_conn_info_secure_connection() -> bool: ...
conn_info_secure_connection = property(get_conn_info_secure_connection, None)
Default Value
FALSE
Remarks
Indicates whether TLS or SSL is enabled for this connection.
This property is read-only.
conn_info_server_authenticated Property
Indicates whether server authentication was performed during a TLS-enabled connection.
Syntax
def get_conn_info_server_authenticated() -> bool: ...
conn_info_server_authenticated = property(get_conn_info_server_authenticated, None)
Default Value
FALSE
Remarks
Indicates whether server authentication was performed during a TLS-enabled connection.
This property is read-only.
conn_info_signature_algorithm Property
The signature algorithm used in a TLS handshake.
Syntax
def get_conn_info_signature_algorithm() -> str: ...
conn_info_signature_algorithm = property(get_conn_info_signature_algorithm, None)
Default Value
""
Remarks
The signature algorithm used in a TLS handshake.
This property is read-only.
conn_info_symmetric_block_size Property
The block size of the symmetric algorithm used.
Syntax
def get_conn_info_symmetric_block_size() -> int: ...
conn_info_symmetric_block_size = property(get_conn_info_symmetric_block_size, None)
Default Value
0
Remarks
The block size of the symmetric algorithm used.
This property is read-only.
conn_info_symmetric_key_bits Property
The key length of the symmetric algorithm used.
Syntax
def get_conn_info_symmetric_key_bits() -> int: ...
conn_info_symmetric_key_bits = property(get_conn_info_symmetric_key_bits, None)
Default Value
0
Remarks
The key length of the symmetric algorithm used.
This property is read-only.
conn_info_total_bytes_received Property
The total number of bytes received over this connection.
Syntax
def get_conn_info_total_bytes_received() -> int: ...
conn_info_total_bytes_received = property(get_conn_info_total_bytes_received, None)
Default Value
0
Remarks
The total number of bytes received over this connection.
This property is read-only.
conn_info_total_bytes_sent Property
The total number of bytes sent over this connection.
Syntax
def get_conn_info_total_bytes_sent() -> int: ...
conn_info_total_bytes_sent = property(get_conn_info_total_bytes_sent, None)
Default Value
0
Remarks
The total number of bytes sent over this connection.
This property is read-only.
conn_info_validation_log Property
Contains the server certificate's chain validation log.
Syntax
def get_conn_info_validation_log() -> str: ...
conn_info_validation_log = property(get_conn_info_validation_log, None)
Default Value
""
Remarks
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only.
conn_info_version Property
Indicates the version of SSL/TLS protocol negotiated during this connection.
Syntax
def get_conn_info_version() -> str: ...
conn_info_version = property(get_conn_info_version, None)
Default Value
""
Remarks
Indicates the version of SSL/TLS protocol negotiated during this connection.
This property is read-only.
custom_request Property
Specifies a custom request verb.
Syntax
def get_custom_request() -> str: ... def set_custom_request(value: str) -> None: ...
custom_request = property(get_custom_request, set_custom_request)
Default Value
""
Remarks
Use this property to specify a custom HTTP method verb to use instead of the original method. PATCH is one of the commonly used custom verbs.
dynamic_data Property
Takes a piece of data to be sent to the server within a dynamic POST or PUT request.
Syntax
def get_dynamic_data() -> bytes: ... def set_dynamic_data(value: bytes) -> None: ...
dynamic_data = property(get_dynamic_data, set_dynamic_data)
Remarks
Assign the next chunk of data to this property from your on_dynamic_data_needed event handler to pass it to the server. Leave it empty to tell the component that no more data is available.
external_crypto_async_document_id Property
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Syntax
def get_external_crypto_async_document_id() -> str: ... def set_external_crypto_async_document_id(value: str) -> None: ...
external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)
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.
external_crypto_custom_params Property
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
def get_external_crypto_custom_params() -> str: ... def set_external_crypto_custom_params(value: str) -> None: ...
external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
external_crypto_data Property
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
def get_external_crypto_data() -> str: ... def set_external_crypto_data(value: str) -> None: ...
external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculation Property
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
def get_external_crypto_external_hash_calculation() -> bool: ... def set_external_crypto_external_hash_calculation(value: bool) -> None: ...
external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)
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 class.
If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
external_crypto_hash_algorithm Property
Specifies the request's signature hash algorithm.
Syntax
def get_external_crypto_hash_algorithm() -> str: ... def set_external_crypto_hash_algorithm(value: str) -> None: ...
external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)
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 |
external_crypto_key_id Property
The ID of the pre-shared key used for DC request authentication.
Syntax
def get_external_crypto_key_id() -> str: ... def set_external_crypto_key_id(value: str) -> None: ...
external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)
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";
external_crypto_key_secret Property
The pre-shared key used for DC request authentication.
Syntax
def get_external_crypto_key_secret() -> str: ... def set_external_crypto_key_secret(value: str) -> None: ...
external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)
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.
external_crypto_method Property
Specifies the asynchronous signing method.
Syntax
def get_external_crypto_method() -> int: ... def set_external_crypto_method(value: int) -> None: ...
external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)
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 |
external_crypto_mode Property
Specifies the external cryptography mode.
Syntax
def get_external_crypto_mode() -> int: ... def set_external_crypto_mode(value: int) -> None: ...
external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)
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) |
external_crypto_public_key_algorithm Property
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
def get_external_crypto_public_key_algorithm() -> str: ... def set_external_crypto_public_key_algorithm(value: str) -> None: ...
external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)
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 |
fips_mode Property
Reserved.
Syntax
def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ...
fips_mode = property(get_fips_mode, set_fips_mode)
Default Value
FALSE
Remarks
This property is reserved for future use.
keep_alive_policy Property
Defines the keep-alive handling policy.
Syntax
def get_keep_alive_policy() -> int: ... def set_keep_alive_policy(value: int) -> None: ...
keep_alive_policy = property(get_keep_alive_policy, set_keep_alive_policy)
Default Value
0
Remarks
Use this property to tune-up the keep-alive mechanism as per the needs of your application.
| ckapStandardDefined | 0 | Follow the standard |
| ckapPreferKeepAlive | 1 | Always request a keep-alive connection |
| ckapRelyOnServer | 2 | Not include the "Connection" header, allowing the server to choose the keep-alive mode |
| ckapKeepAlivesDisabled | 3 | Disable keep-alives by including the "Connection: Close" header |
known_cert_count Property
The number of records in the KnownCert arrays.
Syntax
def get_known_cert_count() -> int: ... def set_known_cert_count(value: int) -> None: ...
known_cert_count = property(get_known_cert_count, set_known_cert_count)
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.known_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_known_cert_bytes(known_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.
This property is read-only.
known_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_known_cert_handle(known_cert_index: int) -> int: ... def set_known_cert_handle(known_cert_index: int, value: int) -> None: ...
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 known_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_cert_count property.
known_crl_count Property
The number of records in the KnownCRL arrays.
Syntax
def get_known_crl_count() -> int: ... def set_known_crl_count(value: int) -> None: ...
known_crl_count = property(get_known_crl_count, set_known_crl_count)
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.known_crl_bytes Property
Returns the raw CRL data in DER format.
Syntax
def get_known_crl_bytes(known_crl_index: int) -> bytes: ...
Remarks
Returns the raw CRL data in DER format.
The known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.
This property is read-only.
known_crl_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_known_crl_handle(known_crl_index: int) -> int: ... def set_known_crl_handle(known_crl_index: int, value: int) -> None: ...
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 known_crl_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_crl_count property.
known_ocsp_count Property
The number of records in the KnownOCSP arrays.
Syntax
def get_known_ocsp_count() -> int: ... def set_known_ocsp_count(value: int) -> None: ...
known_ocsp_count = property(get_known_ocsp_count, set_known_ocsp_count)
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.known_ocsp_bytes Property
A buffer containing the raw OCSP response data.
Syntax
def get_known_ocsp_bytes(known_ocsp_index: int) -> bytes: ...
Remarks
A buffer containing the raw OCSP response data.
The known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.
This property is read-only.
known_ocsp_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_known_ocsp_handle(known_ocsp_index: int) -> int: ... def set_known_ocsp_handle(known_ocsp_index: int, value: int) -> None: ...
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 known_ocsp_index parameter specifies the index of the item in the array. The size of the array is controlled by the known_ocsp_count property.
output_bytes Property
Contains the response content.
Syntax
def get_output_bytes() -> bytes: ...
output_bytes = property(get_output_bytes, None)
Remarks
Use this property to access the content received from the server in response to a prior request.
This property is read-only.
output_file Property
A path to the output file.
Syntax
def get_output_file() -> str: ... def set_output_file(value: str) -> None: ...
output_file = property(get_output_file, set_output_file)
Default Value
""
Remarks
Use this property to specify the file to store the content received from the server in response to a prior request.
output_string Property
Contains the response content.
Syntax
def get_output_string() -> str: ...
output_string = property(get_output_string, None)
Default Value
""
Remarks
Use this property to access the content received from the server in response to a prior request, as a string.
This property is read-only.
proxy_address Property
The IP address of the proxy server.
Syntax
def get_proxy_address() -> str: ... def set_proxy_address(value: str) -> None: ...
proxy_address = property(get_proxy_address, set_proxy_address)
Default Value
""
Remarks
The IP address of the proxy server.
proxy_authentication Property
The authentication type used by the proxy server.
Syntax
def get_proxy_authentication() -> int: ... def set_proxy_authentication(value: int) -> None: ...
proxy_authentication = property(get_proxy_authentication, set_proxy_authentication)
Default Value
0
Remarks
The authentication type used by the proxy server.
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |
proxy_password Property
The password to authenticate to the proxy server.
Syntax
def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ...
proxy_password = property(get_proxy_password, set_proxy_password)
Default Value
""
Remarks
The password to authenticate to the proxy server.
proxy_port Property
The port on the proxy server to connect to.
Syntax
def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ...
proxy_port = property(get_proxy_port, set_proxy_port)
Default Value
0
Remarks
The port on the proxy server to connect to.
proxy_proxy_type Property
The type of the proxy server.
Syntax
def get_proxy_proxy_type() -> int: ... def set_proxy_proxy_type(value: int) -> None: ...
proxy_proxy_type = property(get_proxy_proxy_type, set_proxy_proxy_type)
Default Value
0
Remarks
The type of the proxy server.
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |
proxy_request_headers Property
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
def get_proxy_request_headers() -> str: ... def set_proxy_request_headers(value: str) -> None: ...
proxy_request_headers = property(get_proxy_request_headers, set_proxy_request_headers)
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
proxy_response_body Property
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
def get_proxy_response_body() -> str: ... def set_proxy_response_body(value: str) -> None: ...
proxy_response_body = property(get_proxy_response_body, set_proxy_response_body)
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
proxy_response_headers Property
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
def get_proxy_response_headers() -> str: ... def set_proxy_response_headers(value: str) -> None: ...
proxy_response_headers = property(get_proxy_response_headers, set_proxy_response_headers)
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
proxy_use_ipv6 Property
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
def get_proxy_use_ipv6() -> bool: ... def set_proxy_use_ipv6(value: bool) -> None: ...
proxy_use_ipv6 = property(get_proxy_use_ipv6, set_proxy_use_ipv6)
Default Value
FALSE
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
proxy_username Property
Specifies the username credential for proxy authentication.
Syntax
def get_proxy_username() -> str: ... def set_proxy_username(value: str) -> None: ...
proxy_username = property(get_proxy_username, set_proxy_username)
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
reason_phrase Property
Contains the Reason Phrase element of the server's response.
Syntax
def get_reason_phrase() -> str: ...
reason_phrase = property(get_reason_phrase, None)
Default Value
""
Remarks
Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).
This property is read-only.
req_header_count Property
The number of records in the ReqHeader arrays.
Syntax
def get_req_header_count() -> int: ... def set_req_header_count(value: int) -> None: ...
req_header_count = property(get_req_header_count, set_req_header_count)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at req_header_count - 1.req_header_category Property
Specifies the string category of the contained value.
Syntax
def get_req_header_category(req_header_index: int) -> str: ... def set_req_header_category(req_header_index: int, value: str) -> None: ...
Default Value
""
Remarks
Specifies the string category of the contained value.
This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.
For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.
The req_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the req_header_count property.
req_header_format Property
Specifies the format (encoding) of the value contained in the Value property.
Syntax
def get_req_header_format(req_header_index: int) -> int: ... def set_req_header_format(req_header_index: int, value: int) -> None: ...
Default Value
0
Remarks
Specifies the format (encoding) of the value contained in the req_header_value property.
Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate
format that matches this setting:
utils.NameValuePairs[0].Name = "key";
utils.NameValuePairs[0].Format = svfBinary;
utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";
The following formats are currently supported:
| svfText | 0 | The property contains text |
| svfBinary | 1 | The property contains binary data. The Value property contains a hex encoding of it. |
The req_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the req_header_count property.
req_header_name Property
The name element in a (name, value) pair.
Syntax
def get_req_header_name(req_header_index: int) -> str: ... def set_req_header_name(req_header_index: int, value: str) -> None: ...
Default Value
""
Remarks
The name element in a (name, value) pair.
The req_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the req_header_count property.
req_header_value Property
The value element in a (name, value) pair.
Syntax
def get_req_header_value(req_header_index: int) -> str: ... def set_req_header_value(req_header_index: int, value: str) -> None: ...
Default Value
""
Remarks
The value element in a (name, value) pair.
The req_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the req_header_count property.
req_params_accept Property
Specifies the Accept header property of the HTTP request.
Syntax
def get_req_params_accept() -> str: ... def set_req_params_accept(value: str) -> None: ...
req_params_accept = property(get_req_params_accept, set_req_params_accept)
Default Value
""
Remarks
Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response.
req_params_accept_charset Property
Specifies the Accept-Charset header property of the HTTP request.
Syntax
def get_req_params_accept_charset() -> str: ... def set_req_params_accept_charset(value: str) -> None: ...
req_params_accept_charset = property(get_req_params_accept_charset, set_req_params_accept_charset)
Default Value
""
Remarks
Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand.
req_params_accept_language Property
Specifies the Accept-Language header property of the HTTP request.
Syntax
def get_req_params_accept_language() -> str: ... def set_req_params_accept_language(value: str) -> None: ...
req_params_accept_language = property(get_req_params_accept_language, set_req_params_accept_language)
Default Value
""
Remarks
Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand.
req_params_accept_range_end Property
This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.
Syntax
def get_req_params_accept_range_end() -> int: ... def set_req_params_accept_range_end(value: int) -> None: ...
req_params_accept_range_end = property(get_req_params_accept_range_end, set_req_params_accept_range_end)
Default Value
0
Remarks
This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.
req_params_accept_range_start Property
This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.
Syntax
def get_req_params_accept_range_start() -> int: ... def set_req_params_accept_range_start(value: int) -> None: ...
req_params_accept_range_start = property(get_req_params_accept_range_start, set_req_params_accept_range_start)
Default Value
0
Remarks
This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.
req_params_authorization Property
Specifies the Authorization header of the HTTP request.
Syntax
def get_req_params_authorization() -> str: ... def set_req_params_authorization(value: str) -> None: ...
req_params_authorization = property(get_req_params_authorization, set_req_params_authorization)
Default Value
""
Remarks
Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server.
req_params_connection Property
Specifies the value to pass to the Connection header property of HTTP request.
Syntax
def get_req_params_connection() -> str: ... def set_req_params_connection(value: str) -> None: ...
req_params_connection = property(get_req_params_connection, set_req_params_connection)
Default Value
""
Remarks
Specifies the value to pass to the Connection header field of HTTP request.
req_params_content_length Property
Specifies the size of the entity-body of the HTTP request.
Syntax
def get_req_params_content_length() -> int: ... def set_req_params_content_length(value: int) -> None: ...
req_params_content_length = property(get_req_params_content_length, set_req_params_content_length)
Default Value
0
Remarks
Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the class calculate it automatically.
req_params_content_range_end Property
Specifies the upper bound used in the Content-Range header of the HTTP request.
Syntax
def get_req_params_content_range_end() -> int: ... def set_req_params_content_range_end(value: int) -> None: ...
req_params_content_range_end = property(get_req_params_content_range_end, set_req_params_content_range_end)
Default Value
0
Remarks
Specifies the upper bound used in the Content-Range header of the HTTP request.
req_params_content_range_full_size Property
Specifies the total length of the full entity-body of the HTTP request.
Syntax
def get_req_params_content_range_full_size() -> int: ... def set_req_params_content_range_full_size(value: int) -> None: ...
req_params_content_range_full_size = property(get_req_params_content_range_full_size, set_req_params_content_range_full_size)
Default Value
0
Remarks
Specifies the total length of the full entity-body of the HTTP request.
req_params_content_range_start Property
Specifies the lower bound used in the Content-Range header of the HTTP request.
Syntax
def get_req_params_content_range_start() -> int: ... def set_req_params_content_range_start(value: int) -> None: ...
req_params_content_range_start = property(get_req_params_content_range_start, set_req_params_content_range_start)
Default Value
0
Remarks
Specifies the lower bound used in the Content-Range header of the HTTP request.
req_params_content_type Property
The Content-Type header property of the HTTP request.
Syntax
def get_req_params_content_type() -> str: ... def set_req_params_content_type(value: str) -> None: ...
req_params_content_type = property(get_req_params_content_type, set_req_params_content_type)
Default Value
""
Remarks
The Content-Type header field of the HTTP request.
req_params_cookie Property
This header is expected to be assigned with cookies previously received from the server and stored by the client.
Syntax
def get_req_params_cookie() -> str: ... def set_req_params_cookie(value: str) -> None: ...
req_params_cookie = property(get_req_params_cookie, set_req_params_cookie)
Default Value
""
Remarks
This header is expected to be assigned with cookies previously received from the server and stored by the client.
req_params_custom_headers Property
Assign any custom HTTP headers to be passed to the server to this property.
Syntax
def get_req_params_custom_headers() -> str: ... def set_req_params_custom_headers(value: str) -> None: ...
req_params_custom_headers = property(get_req_params_custom_headers, set_req_params_custom_headers)
Default Value
""
Remarks
Assign any custom HTTP headers to be passed to the server to this property.
req_params_date Property
The date and time of the request.
Syntax
def get_req_params_date() -> str: ... def set_req_params_date(value: str) -> None: ...
req_params_date = property(get_req_params_date, set_req_params_date)
Default Value
""
Remarks
The date and time of the request.
req_params_from Property
Contains the From header property of the HTTP request.
Syntax
def get_req_params_from() -> str: ... def set_req_params_from(value: str) -> None: ...
req_params_from = property(get_req_params_from, set_req_params_from)
Default Value
""
Remarks
Contains the From header field of the HTTP request. It specifies the e-mail address for the human user who controls the requesting user agent.
req_params_host Property
This property contains the Host header property of the HTTP request.
Syntax
def get_req_params_host() -> str: ... def set_req_params_host(value: str) -> None: ...
req_params_host = property(get_req_params_host, set_req_params_host)
Default Value
""
Remarks
This property contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested.
req_params_http_version Property
Specifies the version of HTTP protocol to use: 1.
Syntax
def get_req_params_http_version() -> int: ... def set_req_params_http_version(value: int) -> None: ...
req_params_http_version = property(get_req_params_http_version, set_req_params_http_version)
Default Value
1
Remarks
Specifies the version of HTTP protocol to use: 1.0 or 1.1.
| chvHTTP10 | HTTP/1.0 (0) |
| chvHTTP11 | HTTP/1.1 (1) |
req_params_if_match Property
Contains the If-Match request header property.
Syntax
def get_req_params_if_match() -> str: ... def set_req_params_if_match(value: str) -> None: ...
req_params_if_match = property(get_req_params_if_match, set_req_params_if_match)
Default Value
""
Remarks
Contains the If-Match request header field. This property makes the requested method conditional: when If-Match field is set, only the entities matching the included entity tags will be returned by the server.
req_params_if_modified_since Property
Contains the If-Modified-Since request header property.
Syntax
def get_req_params_if_modified_since() -> str: ... def set_req_params_if_modified_since(value: str) -> None: ...
req_params_if_modified_since = property(get_req_params_if_modified_since, set_req_params_if_modified_since)
Default Value
""
Remarks
Contains the If-Modified-Since request header field. This property makes the requested method conditional: when If-Modified-Since field is set, only the modified entities will be returned by the server.
req_params_if_none_match Property
Contains the If-None-Match request header property.
Syntax
def get_req_params_if_none_match() -> str: ... def set_req_params_if_none_match(value: str) -> None: ...
req_params_if_none_match = property(get_req_params_if_none_match, set_req_params_if_none_match)
Default Value
""
Remarks
Contains the If-None-Match request header field. This property makes the requested method conditional: when If-None-Match field is set, only the entities which doesn't match the included entity tags will be returned by the server.
req_params_if_unmodified_since Property
Contains the If-Unmodified-Since request header property.
Syntax
def get_req_params_if_unmodified_since() -> str: ... def set_req_params_if_unmodified_since(value: str) -> None: ...
req_params_if_unmodified_since = property(get_req_params_if_unmodified_since, set_req_params_if_unmodified_since)
Default Value
""
Remarks
Contains the If-Unmodified-Since request header field. This property makes the requested method conditional: when If-Unmodified-Since field is set, only the unmodified entities will be returned by the server.
req_params_password Property
Assign this property with the user's password.
Syntax
def get_req_params_password() -> str: ... def set_req_params_password(value: str) -> None: ...
req_params_password = property(get_req_params_password, set_req_params_password)
Default Value
""
Remarks
Assign this property with the user's password.
req_params_referer Property
The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).
Syntax
def get_req_params_referer() -> str: ... def set_req_params_referer(value: str) -> None: ...
req_params_referer = property(get_req_params_referer, set_req_params_referer)
Default Value
""
Remarks
The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).
req_params_user_agent Property
The User-Agent property of the HTTP request provides information about the software that initiates the request.
Syntax
def get_req_params_user_agent() -> str: ... def set_req_params_user_agent(value: str) -> None: ...
req_params_user_agent = property(get_req_params_user_agent, set_req_params_user_agent)
Default Value
""
Remarks
The User-Agent field of the HTTP request provides information about the software that initiates the request.
req_params_username Property
Assign this property with the user's login name.
Syntax
def get_req_params_username() -> str: ... def set_req_params_username(value: str) -> None: ...
req_params_username = property(get_req_params_username, set_req_params_username)
Default Value
""
Remarks
Assign this property with the user's login name.
resp_header_count Property
The number of records in the RespHeader arrays.
Syntax
def get_resp_header_count() -> int: ...
resp_header_count = property(get_resp_header_count, None)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at resp_header_count - 1.This property is read-only.
resp_header_category Property
Specifies the string category of the contained value.
Syntax
def get_resp_header_category(resp_header_index: int) -> str: ...
Default Value
""
Remarks
Specifies the string category of the contained value.
This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.
For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.
The resp_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the resp_header_count property.
This property is read-only.
resp_header_format Property
Specifies the format (encoding) of the value contained in the Value property.
Syntax
def get_resp_header_format(resp_header_index: int) -> int: ...
Default Value
0
Remarks
Specifies the format (encoding) of the value contained in the resp_header_value property.
Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate
format that matches this setting:
utils.NameValuePairs[0].Name = "key";
utils.NameValuePairs[0].Format = svfBinary;
utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";
The following formats are currently supported:
| svfText | 0 | The property contains text |
| svfBinary | 1 | The property contains binary data. The Value property contains a hex encoding of it. |
The resp_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the resp_header_count property.
This property is read-only.
resp_header_name Property
The name element in a (name, value) pair.
Syntax
def get_resp_header_name(resp_header_index: int) -> str: ...
Default Value
""
Remarks
The name element in a (name, value) pair.
The resp_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the resp_header_count property.
This property is read-only.
resp_header_value Property
The value element in a (name, value) pair.
Syntax
def get_resp_header_value(resp_header_index: int) -> str: ...
Default Value
""
Remarks
The value element in a (name, value) pair.
The resp_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the resp_header_count property.
This property is read-only.
resp_params_content_length Property
Indicates the length of the response content in bytes.
Syntax
def get_resp_params_content_length() -> int: ...
resp_params_content_length = property(get_resp_params_content_length, None)
Default Value
0
Remarks
Indicates the length of the response content in bytes.
This property is read-only.
resp_params_date Property
The date and time at which the response was generated, in server time, in UTC.
Syntax
def get_resp_params_date() -> str: ...
resp_params_date = property(get_resp_params_date, None)
Default Value
""
Remarks
The date and time at which the response was generated, in server time, in UTC.
This property is read-only.
resp_params_reason_phrase Property
Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.
Syntax
def get_resp_params_reason_phrase() -> str: ...
resp_params_reason_phrase = property(get_resp_params_reason_phrase, None)
Default Value
""
Remarks
Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the staus code.
This property is read-only.
resp_params_status_code Property
The server-generated status code of the request processing status.
Syntax
def get_resp_params_status_code() -> int: ...
resp_params_status_code = property(get_resp_params_status_code, None)
Default Value
0
Remarks
The server-generated status code of the request processing status.
The code is a 3-digit integer where the first digit defines the class of the response:
| 1 | Informational |
| 2 | Success |
| 3 | Redirection |
| 4 | Client Error |
| 5 | Server Error |
Common examples are 200 (page served succesfully), 404 (page not found), 302 (redirect), and 500 (internal server error).
This property is read-only.
socket_dns_mode Property
Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
Syntax
def get_socket_dns_mode() -> int: ... def set_socket_dns_mode(value: int) -> None: ...
socket_dns_mode = property(get_socket_dns_mode, set_socket_dns_mode)
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 |
socket_dns_port Property
Specifies the port number to be used for sending queries to the DNS server.
Syntax
def get_socket_dns_port() -> int: ... def set_socket_dns_port(value: int) -> None: ...
socket_dns_port = property(get_socket_dns_port, set_socket_dns_port)
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
socket_dns_query_timeout Property
The timeout (in milliseconds) for each DNS query.
Syntax
def get_socket_dns_query_timeout() -> int: ... def set_socket_dns_query_timeout(value: int) -> None: ...
socket_dns_query_timeout = property(get_socket_dns_query_timeout, set_socket_dns_query_timeout)
Default Value
0
Remarks
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
socket_dns_servers Property
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
def get_socket_dns_servers() -> str: ... def set_socket_dns_servers(value: str) -> None: ...
socket_dns_servers = property(get_socket_dns_servers, set_socket_dns_servers)
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
socket_dns_total_timeout Property
The timeout (in milliseconds) for the whole resolution process.
Syntax
def get_socket_dns_total_timeout() -> int: ... def set_socket_dns_total_timeout(value: int) -> None: ...
socket_dns_total_timeout = property(get_socket_dns_total_timeout, set_socket_dns_total_timeout)
Default Value
0
Remarks
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
socket_incoming_speed_limit Property
The maximum number of bytes to read from the socket, per second.
Syntax
def get_socket_incoming_speed_limit() -> int: ... def set_socket_incoming_speed_limit(value: int) -> None: ...
socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit)
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
socket_local_address Property
The local network interface to bind the socket to.
Syntax
def get_socket_local_address() -> str: ... def set_socket_local_address(value: str) -> None: ...
socket_local_address = property(get_socket_local_address, set_socket_local_address)
Default Value
""
Remarks
The local network interface to bind the socket to.
socket_local_port Property
The local port number to bind the socket to.
Syntax
def get_socket_local_port() -> int: ... def set_socket_local_port(value: int) -> None: ...
socket_local_port = property(get_socket_local_port, set_socket_local_port)
Default Value
0
Remarks
The local port number to bind the socket to.
socket_outgoing_speed_limit Property
The maximum number of bytes to write to the socket, per second.
Syntax
def get_socket_outgoing_speed_limit() -> int: ... def set_socket_outgoing_speed_limit(value: int) -> None: ...
socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit)
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
socket_timeout Property
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
def get_socket_timeout() -> int: ... def set_socket_timeout(value: int) -> None: ...
socket_timeout = property(get_socket_timeout, set_socket_timeout)
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).
socket_use_ipv6 Property
Enables or disables IP protocol version 6.
Syntax
def get_socket_use_ipv6() -> bool: ... def set_socket_use_ipv6(value: bool) -> None: ...
socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6)
Default Value
FALSE
Remarks
Enables or disables IP protocol version 6.
status_code Property
Contains the Status Code element of the server's response.
Syntax
def get_status_code() -> int: ...
status_code = property(get_status_code, None)
Default Value
0
Remarks
Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK).
This property is read-only.
tls_client_cert_count Property
The number of records in the TLSClientCert arrays.
Syntax
def get_tls_client_cert_count() -> int: ... def set_tls_client_cert_count(value: int) -> None: ...
tls_client_cert_count = property(get_tls_client_cert_count, set_tls_client_cert_count)
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.tls_client_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_tls_client_cert_bytes(tls_client_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The tls_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_client_cert_count property.
This property is read-only.
tls_client_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_tls_client_cert_handle(tls_client_cert_index: int) -> int: ... def set_tls_client_cert_handle(tls_client_cert_index: int, value: int) -> None: ...
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 tls_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_client_cert_count property.
tls_server_cert_count Property
The number of records in the TLSServerCert arrays.
Syntax
def get_tls_server_cert_count() -> int: ...
tls_server_cert_count = property(get_tls_server_cert_count, None)
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.
tls_server_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_fingerprint Property
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
def get_tls_server_cert_fingerprint(tls_server_cert_index: int) -> str: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_issuer Property
The common name of the certificate issuer (CA), typically a company name.
Syntax
def get_tls_server_cert_issuer(tls_server_cert_index: int) -> str: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_issuer_rdn Property
A list of Property=Value pairs that uniquely identify the certificate issuer.
Syntax
def get_tls_server_cert_issuer_rdn(tls_server_cert_index: int) -> str: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_key_algorithm Property
Specifies the public key algorithm of this certificate.
Syntax
def get_tls_server_cert_key_algorithm(tls_server_cert_index: int) -> str: ...
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 |
Use the tls_key_bits, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_key_bits Property
Returns the length of the public key in bits.
Syntax
def get_tls_server_cert_key_bits(tls_server_cert_index: int) -> int: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_key_usage Property
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
def get_tls_server_cert_key_usage(tls_server_cert_index: int) -> int: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_self_signed Property
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
def get_tls_server_cert_self_signed(tls_server_cert_index: int) -> bool: ...
Default Value
FALSE
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_serial_number Property
Returns the certificate's serial number.
Syntax
def get_tls_server_cert_serial_number(tls_server_cert_index: int) -> bytes: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_sig_algorithm Property
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
def get_tls_server_cert_sig_algorithm(tls_server_cert_index: int) -> str: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_subject Property
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
def get_tls_server_cert_subject(tls_server_cert_index: int) -> str: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_subject_rdn Property
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Syntax
def get_tls_server_cert_subject_rdn(tls_server_cert_index: int) -> str: ...
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 tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_valid_from Property
The time point at which the certificate becomes valid, in UTC.
Syntax
def get_tls_server_cert_valid_from(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_server_cert_valid_to Property
The time point at which the certificate expires, in UTC.
Syntax
def get_tls_server_cert_valid_to(tls_server_cert_index: int) -> str: ...
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The tls_server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the tls_server_cert_count property.
This property is read-only.
tls_auto_validate_certificates Property
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
def get_tls_auto_validate_certificates() -> bool: ... def set_tls_auto_validate_certificates(value: bool) -> None: ...
tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates)
Default Value
TRUE
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
tls_base_configuration Property
Selects the base configuration for the TLS settings.
Syntax
def get_tls_base_configuration() -> int: ... def set_tls_base_configuration(value: int) -> None: ...
tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration)
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 |
tls_ciphersuites Property
A list of ciphersuites separated with commas or semicolons.
Syntax
def get_tls_ciphersuites() -> str: ... def set_tls_ciphersuites(value: str) -> None: ...
tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites)
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
tls_client_auth Property
Enables or disables certificate-based client authentication.
Syntax
def get_tls_client_auth() -> int: ... def set_tls_client_auth(value: int) -> None: ...
tls_client_auth = property(get_tls_client_auth, set_tls_client_auth)
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 |
tls_ec_curves Property
Defines the elliptic curves to enable.
Syntax
def get_tls_ec_curves() -> str: ... def set_tls_ec_curves(value: str) -> None: ...
tls_ec_curves = property(get_tls_ec_curves, set_tls_ec_curves)
Default Value
""
Remarks
Defines the elliptic curves to enable.
tls_extensions Property
Provides access to TLS extensions.
Syntax
def get_tls_extensions() -> str: ... def set_tls_extensions(value: str) -> None: ...
tls_extensions = property(get_tls_extensions, set_tls_extensions)
Default Value
""
Remarks
Provides access to TLS extensions.
tls_force_resume_if_destination_changes Property
Whether to force TLS session resumption when the destination address changes.
Syntax
def get_tls_force_resume_if_destination_changes() -> bool: ... def set_tls_force_resume_if_destination_changes(value: bool) -> None: ...
tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes)
Default Value
FALSE
Remarks
Whether to force TLS session resumption when the destination address changes.
tls_pre_shared_identity Property
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
def get_tls_pre_shared_identity() -> str: ... def set_tls_pre_shared_identity(value: str) -> None: ...
tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity)
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
tls_pre_shared_key Property
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
def get_tls_pre_shared_key() -> str: ... def set_tls_pre_shared_key(value: str) -> None: ...
tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key)
Default Value
""
Remarks
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
tls_pre_shared_key_ciphersuite Property
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
def get_tls_pre_shared_key_ciphersuite() -> str: ... def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ...
tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite)
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
tls_renegotiation_attack_prevention_mode Property
Selects the renegotiation attack prevention mechanism.
Syntax
def get_tls_renegotiation_attack_prevention_mode() -> int: ... def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ...
tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode)
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. |
tls_revocation_check Property
Specifies the kind(s) of revocation check to perform.
Syntax
def get_tls_revocation_check() -> int: ... def set_tls_revocation_check(value: int) -> None: ...
tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)
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.
tls_ssl_options Property
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
def get_tls_ssl_options() -> int: ... def set_tls_ssl_options(value: int) -> None: ...
tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)
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 |
tls_tls_mode Property
Specifies the TLS mode to use.
Syntax
def get_tls_tls_mode() -> int: ... def set_tls_tls_mode(value: int) -> None: ...
tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)
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. |
tls_use_extended_master_secret Property
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
def get_tls_use_extended_master_secret() -> bool: ... def set_tls_use_extended_master_secret(value: bool) -> None: ...
tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)
Default Value
FALSE
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumption Property
Enables or disables the TLS session resumption capability.
Syntax
def get_tls_use_session_resumption() -> bool: ... def set_tls_use_session_resumption(value: bool) -> None: ...
tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)
Default Value
FALSE
Remarks
Enables or disables the TLS session resumption capability.
tls_versions Property
The SSL/TLS versions to enable by default.
Syntax
def get_tls_versions() -> int: ... def set_tls_versions(value: int) -> None: ...
tls_versions = property(get_tls_versions, set_tls_versions)
Default Value
16
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 |
trusted_cert_count Property
The number of records in the TrustedCert arrays.
Syntax
def get_trusted_cert_count() -> int: ... def set_trusted_cert_count(value: int) -> None: ...
trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count)
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.trusted_cert_bytes Property
Returns the raw certificate data in DER format.
Syntax
def get_trusted_cert_bytes(trusted_cert_index: int) -> bytes: ...
Remarks
Returns the raw certificate data in DER format.
The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.
This property is read-only.
trusted_cert_handle Property
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
def get_trusted_cert_handle(trusted_cert_index: int) -> int: ... def set_trusted_cert_handle(trusted_cert_index: int, value: int) -> None: ...
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 trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.
config Method
Sets or retrieves a configuration setting.
Syntax
def config(configuration_string: str) -> str: ...
Remarks
config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.
delete Method
Sends a DELETE request to the server.
Syntax
def delete(url: str) -> None: ...
Remarks
Use this method to send a DELETE request to server. In response to this request, the server may (without any guarantees) delete the resource specified in Url. Most of the servers disable DELETE requests.
If this request fails, an exception will be thrown, and the error details published in status_code and reason_phrase properties.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
do_action Method
Performs an additional action.
Syntax
def do_action(action_id: str, action_params: str) -> str: ...
Remarks
do_action is a generic method available in every class. 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. |
get Method
Sends a GET request to the server.
Syntax
def get(url: str) -> None: ...
Remarks
GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in Url.
If the request is successful, the received content will be available in output_bytes and output_string properties. Otherwise an exception will be thrown, and the error details published in status_code and reason_phrase properties.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
head Method
Sends a HEAD request to the server.
Syntax
def head(url: str) -> None: ...
Remarks
HEAD is very similar to GET, with the only difference being that only the headers (but not the content) is returned.
HEAD is often use to retrieve the parameters of the resource, such as its size and modification date. If the request is successful, those details will be available via response_parameters and response_headers properties. Otherwise, an exception will be thrown, and the error details published in status_code and reason_phrase properties.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
options Method
Sends an OPTIONS request to the server.
Syntax
def options(url: str) -> None: ...
Remarks
This request gets various information about the server such as supported HTTP methods. No content is included in the response.
post Method
Sends a POST request to the server.
Syntax
def post(url: str, content: str) -> None: ...
Remarks
POST is used to send data to the remote HTTP endpoint/script.
Provide the data you need to send via the Content parameter. If Content is omitted, and only Url is set, the data will be streamed dynamically using the on_dynamic_data_needed event.
To post a web form's data (including file attachments to the form) use post_web_form method.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
post_bytes Method
Sends a POST request to the server.
Syntax
def post_bytes(url: str, content_bytes: bytes) -> None: ...
Remarks
POST is used to send data to the remote HTTP endpoint/script.
Provide the data you need to send via the ContentBytes parameter. If content is omitted, and only Url is set, the data will be streamed dynamically using the on_dynamic_data_needed event.
To post a web form's data (including file attachments to the form) use post_web_form method.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
post_file Method
Sends a file to the server using a POST request.
Syntax
def post_file(url: str, file_name: str) -> None: ...
Remarks
POST is used to send data to the remote HTTP endpoint/script. The content to send will be taken from FileName.
To post a web form's data (including file attachments to the form) use post_web_form method.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
post_web_form Method
Posts a web form data to the server.
Syntax
def post_web_form(url: str, fields: str, file_field: str, file_name: str, content_type: str) -> None: ...
Remarks
This variant of the POST method provides means to submit a form (as in a web browser) with an optional file attachment. Fields are expected to contain a list of field names and values in "Name=Value" format separated with EOLs. This list can be empty.
If including a file with your request, use the FileField and FileName properties to specify the file field name and the local filename for the uploaded file. Use ContentType to override the default content type chosen by the client, e.g., "application/x-www-form-urlencoded".
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
put Method
Sends a PUT request to the server.
Syntax
def put(url: str, content: str) -> None: ...
Remarks
PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.
If Content is not present, and only Url is set, the data will be streamed dynamically using the on_dynamic_data_needed event. Note that some servers do not support streaming.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
put_bytes Method
Sends a PUT request to the server.
Syntax
def put_bytes(url: str, content_bytes: bytes) -> None: ...
Remarks
PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers.
If ContentBytes is not present, and only Url is set, the data will be streamed dynamically using the on_dynamic_data_needed event. Note that some servers do not support streaming.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
put_file Method
Sends a file to the server using a PUT request.
Syntax
def put_file(url: str, file_name: str) -> None: ...
Remarks
PUT is an alternative to POST and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off. The content to send will be taken from FileName.
Note that any parameters you intend to pass to this method should be properly encoded before this method is called.
reset Method
Resets the class settings.
Syntax
def reset() -> None: ...
Remarks
reset is a generic method available in every class.
trace Method
Sends a TRACE request to the server.
Syntax
def trace(url: str) -> None: ...
Remarks
TRACE is a debug command and is typically switched off and/or not supported by web servers.
on_cookie Event
Fired to report a received cookie.
Syntax
class HTTPClientCookieEventParams(object): @property def cookie_text() -> str: ... # In class HTTPClient: @property def on_cookie() -> Callable[[HTTPClientCookieEventParams], None]: ... @on_cookie.setter def on_cookie(event_hook: Callable[[HTTPClientCookieEventParams], None]) -> None: ...
Remarks
The CookieText parameter contains the text of the cookie.
on_document_begin Event
Marks the start of the incoming HTML document or file.
Syntax
class HTTPClientDocumentBeginEventParams(object): # In class HTTPClient: @property def on_document_begin() -> Callable[[HTTPClientDocumentBeginEventParams], None]: ... @on_document_begin.setter def on_document_begin(event_hook: Callable[[HTTPClientDocumentBeginEventParams], None]) -> None: ...
Remarks
This event is followed by one or more on_progress calls. When the document has been received in full, the on_document_end event is fired.
on_document_end Event
Marks the successful receipt of the incoming HTML document or file.
Syntax
class HTTPClientDocumentEndEventParams(object): # In class HTTPClient: @property def on_document_end() -> Callable[[HTTPClientDocumentEndEventParams], None]: ... @on_document_end.setter def on_document_end(event_hook: Callable[[HTTPClientDocumentEndEventParams], None]) -> None: ...
Remarks
This event fires when the document has been received in full.
on_dynamic_data_needed Event
Requests a portion of data to be uploaded from the application.
Syntax
class HTTPClientDynamicDataNeededEventParams(object): @property def bytes_needed() -> int: ... # In class HTTPClient: @property def on_dynamic_data_needed() -> Callable[[HTTPClientDynamicDataNeededEventParams], None]: ... @on_dynamic_data_needed.setter def on_dynamic_data_needed(event_hook: Callable[[HTTPClientDynamicDataNeededEventParams], None]) -> None: ...
Remarks
If dynamic ('streaming') variants of PUT or POST methods are used, this event is fired periodically to request portions of data to be sent to the server.
When handling this event, assign the next portion of data of BytesNeeded length (or less) to dynamic_data. If no more data is available to upload (the whole document has been sent), leave dynamic_data empty.
on_error Event
Information about errors during data delivery.
Syntax
class HTTPClientErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class HTTPClient: @property def on_error() -> Callable[[HTTPClientErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[HTTPClientErrorEventParams], None]) -> None: ...
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.
on_external_sign Event
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
class HTTPClientExternalSignEventParams(object): @property def operation_id() -> str: ... @property def hash_algorithm() -> str: ... @property def pars() -> str: ... @property def data() -> str: ... @property def signed_data() -> str: ... @signed_data.setter def signed_data(value) -> None: ... # In class HTTPClient: @property def on_external_sign() -> Callable[[HTTPClientExternalSignEventParams], None]: ... @on_external_sign.setter def on_external_sign(event_hook: Callable[[HTTPClientExternalSignEventParams], None]) -> None: ...
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 class via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The class 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_headers_prepared Event
Fires when the request headers have been formed and are about to be sent to the server.
Syntax
class HTTPClientHeadersPreparedEventParams(object): # In class HTTPClient: @property def on_headers_prepared() -> Callable[[HTTPClientHeadersPreparedEventParams], None]: ... @on_headers_prepared.setter def on_headers_prepared(event_hook: Callable[[HTTPClientHeadersPreparedEventParams], None]) -> None: ...
Remarks
The prepared headers are available in request_headers property. This event provides you the last chance to review/alter them.
on_headers_received Event
Fires when the HTTP response headers have just been received from the server.
Syntax
class HTTPClientHeadersReceivedEventParams(object): # In class HTTPClient: @property def on_headers_received() -> Callable[[HTTPClientHeadersReceivedEventParams], None]: ... @on_headers_received.setter def on_headers_received(event_hook: Callable[[HTTPClientHeadersReceivedEventParams], None]) -> None: ...
Remarks
The received headers are available via the response_headers property.
on_notification Event
This event notifies the application about an underlying control flow event.
Syntax
class HTTPClientNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class HTTPClient: @property def on_notification() -> Callable[[HTTPClientNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[HTTPClientNotificationEventParams], None]) -> None: ...
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
| TLSExtensions.CertificateStatus | TBD |
| TLSExtensions.PreSharedIdentityHint | TBD |
on_progress Event
Fires periodically during the data transfer.
Syntax
class HTTPClientProgressEventParams(object): @property def total() -> int: ... @property def current() -> int: ... @property def cancel() -> bool: ... @cancel.setter def cancel(value) -> None: ... # In class HTTPClient: @property def on_progress() -> Callable[[HTTPClientProgressEventParams], None]: ... @on_progress.setter def on_progress(event_hook: Callable[[HTTPClientProgressEventParams], None]) -> None: ...
Remarks
Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.
on_redirection Event
Fires when the server suggests a redirect.
Syntax
class HTTPClientRedirectionEventParams(object): @property def old_url() -> str: ... @property def new_url() -> str: ... @new_url.setter def new_url(value) -> None: ... @property def allow_redirection() -> bool: ... @allow_redirection.setter def allow_redirection(value) -> None: ... # In class HTTPClient: @property def on_redirection() -> Callable[[HTTPClientRedirectionEventParams], None]: ... @on_redirection.setter def on_redirection(event_hook: Callable[[HTTPClientRedirectionEventParams], None]) -> None: ...
Remarks
This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). OldURL indicates the 'from' page, and NewURL indicates the 'to' one. The destination page can be altered by the application if needed. Use AllowRedirection to block undesirable redirects.
Generally, this is a notification event: the component handles redirections automatically. Use the MaxRedirections config property to limit the number of redirection hops.
on_tls_cert_needed Event
Fires when a remote TLS party requests a client certificate.
Syntax
class HTTPClientTLSCertNeededEventParams(object): @property def host() -> str: ... @property def ca_names() -> str: ... # In class HTTPClient: @property def on_tls_cert_needed() -> Callable[[HTTPClientTLSCertNeededEventParams], None]: ... @on_tls_cert_needed.setter def on_tls_cert_needed(event_hook: Callable[[HTTPClientTLSCertNeededEventParams], None]) -> None: ...
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
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
class HTTPClientTLSCertValidateEventParams(object): @property def server_host() -> str: ... @property def server_ip() -> str: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class HTTPClient: @property def on_tls_cert_validate() -> Callable[[HTTPClientTLSCertValidateEventParams], None]: ... @on_tls_cert_validate.setter def on_tls_cert_validate(event_hook: Callable[[HTTPClientTLSCertValidateEventParams], None]) -> None: ...
Remarks
This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, classes 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 class, and can be adjusted if needed.
on_tls_established Event
Fires when a TLS handshake with Host successfully completes.
Syntax
class HTTPClientTLSEstablishedEventParams(object): @property def host() -> str: ... @property def version() -> str: ... @property def ciphersuite() -> str: ... @property def connection_id() -> bytes: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class HTTPClient: @property def on_tls_established() -> Callable[[HTTPClientTLSEstablishedEventParams], None]: ... @on_tls_established.setter def on_tls_established(event_hook: Callable[[HTTPClientTLSEstablishedEventParams], None]) -> None: ...
Remarks
The class 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
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
class HTTPClientTLSHandshakeEventParams(object): @property def host() -> str: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class HTTPClient: @property def on_tls_handshake() -> Callable[[HTTPClientTLSHandshakeEventParams], None]: ... @on_tls_handshake.setter def on_tls_handshake(event_hook: Callable[[HTTPClientTLSHandshakeEventParams], None]) -> None: ...
Remarks
The class 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_psk Event
Notifies the application about the PSK key exchange.
Syntax
class HTTPClientTLSPSKEventParams(object): @property def host() -> str: ... @property def hint() -> str: ... # In class HTTPClient: @property def on_tls_psk() -> Callable[[HTTPClientTLSPSKEventParams], None]: ... @on_tls_psk.setter def on_tls_psk(event_hook: Callable[[HTTPClientTLSPSKEventParams], None]) -> None: ...
Remarks
The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of tls_settings to provide the pre-shared key to the component.
on_tls_shutdown Event
Reports the graceful closure of a TLS connection.
Syntax
class HTTPClientTLSShutdownEventParams(object): @property def host() -> str: ... # In class HTTPClient: @property def on_tls_shutdown() -> Callable[[HTTPClientTLSShutdownEventParams], None]: ... @on_tls_shutdown.setter def on_tls_shutdown(event_hook: Callable[[HTTPClientTLSShutdownEventParams], None]) -> None: ...
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
HTTPClient Config Settings
The class 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 class, access to these internal properties is provided through the config method.HTTPClient Config Settings
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.
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
- 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
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 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");
HTTPClient Errors
HTTPClient 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) |
| 19922945 | Unsupported keep-alive policy (SB_ERROR_HTTP_UNSUPPORTED_KEEPALIVEPOLICY) |
| 19922946 | Wrong request filter string format (SB_ERROR_HTTP_WRONG_REQUEST_FILTER_FORMAT) |