pdftools_sdk.http_client_handler

Classes

HttpClientHandler()

The handler and options for communication to remote server
class pdftools_sdk.http_client_handler.HttpClientHandler[source]

Bases: _NativeObject

The handler and options for communication to remote server

This class can be used to configure HTTP and HTTPS communication.

Also see pdftools_sdk.sdk.Sdk.proxy for the product wide proxy configuration.

For HTTPS (SSL/TLS) communication, the server certificate’s trustworthiness is verified using the system’s default trust store (CA certificate store). If the server certificate’s trustworthiness cannot be determined, the connection to the server is aborted.

The default trust store is:

  • Windows: The Windows certificate store for “Trusted Root Certification Authorities” is used. You can manually install the root certificate of a private CA on a computer by using the CertMgr tool. The certificate store is only available if the user profile has been loaded.

  • Linux: The certificates available in CAfile and CApath are trusted: - CAfile: The file can contain a concatenated sequence of CA certificates in PEM format. The SDK searches for the file at the following locations: - The file of your local OpenSSL installation (if libssl.so is found), or - the environment variable SSL_CERT_FILE, or - the default location /etc/ssl/cert.pem. - CApath: A directory containing CA certificates in PEM format. The files are looked up by the CA subject name hash value, e.g. 9d66eef0.0. The SDK searches for the directory at the following locations: - The directory of your local OpenSSL installation (if libssl.so is found), or - the environment variable SSL_CERT_DIR, or - the default location /etc/ssl/certs/.

  • macOS: The trusted certificates from the macOS keychain are used. You can manually install the root certificate of a private CA by dragging the certificate file onto the Keychain Access app.

You can add more certificates to the trust store using pdftools_sdk.http_client_handler.HttpClientHandler.add_trusted_certificate() .

Instances of this class can be used in multiple threads concurrently, as long as they are not modified concurrently.

__init__()[source]

The default values of newly created objects are not copied from the default handler pdftools_sdk.sdk.Sdk.http_client_handler , but are as described in this documentation.

set_client_certificate(archive: IOBase, password: str | None) → None[source]

Set the SSL/TLS client certificate as PFX (PKCS#12) archive

The file must contain the certificate itself, all certificates of the trust chain, and the private key.

Parameters:

  • archive (io.IOBase) – The SSL client certificate in PKCS#12 format (.p12, .pfx)

  • password (Optional[str]) – The password required to decrypt the private key of the archive

Raises:
set_client_certificate_and_key(cert: IOBase, key: IOBase, password: str | None) → None[source]

Set the SSL/TLS client certificate and private key

The file must contain the certificate and its private key. It is also recommended to include all certificates of the trust chain.

Parameters:

  • cert (io.IOBase) – The certificate may be in either PEM (.pem, ASCII text) or DER (.cer, binary) form.

  • key (io.IOBase) – The encrypted private key of the certificate must be in PEM (ASCII text) form (.pem).

  • password (Optional[str]) – The password required to decrypt the private key.

Raises:
add_trusted_certificate(cert: IOBase) → None[source]

Add a certificate to the trust store

Add a certificate to the trust store of this HttpClientHandler instance. The certificates in the trust store are used to verify the certificate of the SSL/TLS server (see pdftools_sdk.http_client_handler.HttpClientHandler ). You should add trusted certification authorities (Root CA) certificates to the trust store. However, you can also add server certificates (e.g. self-signed certificates) and intermediate CA certificates.

Parameters:

cert (io.IOBase) – The certificate may be in either PEM (.pem, ASCII text) or DER (.cer, binary) form.

Raises:

pdftools_sdk.corrupt_error.CorruptError – The certificate cannot be read.

property ssl_verify_server_certificate: bool

Verify the server certificate for SSL/TLS

If True the server certificate’s trustworthiness is verified. If the verification process fails, the handshake is immediately terminated and the connection is aborted. The verification requires a trust store; otherwise, verification always fails.

Default is True

Returns:

bool