DCAuthWebServer Class

Properties   Methods   Events   Config Settings   Errors  

The DCAuthWebServer Class offers higher-level access to 'private key side' functionality of SecureBlackbox DC protocol.

Syntax

class secureblackbox.DCAuthWebServer

Remarks

DCAuthWebServer provides a built-in REST responder for DC requests. Use it in conjunction with the in-browser Javascript that comes with DC package, or with standalone DC requestors. DCAuthWebServer listens to DC requests on a specific port or a port chosen between port_range_from and port_range_to. Use DCAuth, which provides a lower-level access to the signing engine, to implement DC in applications, apps, or services.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

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.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

active Property

Indicates whether the server is active and is listening to new connections.

Syntax

def get_active() -> bool: ...

active = property(get_active, None)

Default Value

FALSE

Remarks

This read-only property returns True if the server is listening to incoming connections.

This property is read-only.

allow_origin Property

Specifies the content of AllowOrigin header of the service reply.

Syntax

def get_allow_origin() -> str: ...
def set_allow_origin(value: str) -> None: ...

allow_origin = property(get_allow_origin, set_allow_origin)

Default Value

""

Remarks

Use this property to specify the content of AllowOrigin header included with the service reply. If left empty, the * header will be returned.

auth_realm Property

Specifies authentication realm for digest and NTLM authentication.

Syntax

def get_auth_realm() -> str: ...
def set_auth_realm(value: str) -> None: ...

auth_realm = property(get_auth_realm, set_auth_realm)

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

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:

bound_port Property

Indicates the bound listening port.

Syntax

def get_bound_port() -> int: ...

bound_port = property(get_bound_port, None)

Default Value

0

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals port if it is provided, or is allocated dynamically if configured to fall in the range between port_range_from and port_range_to constraints.

This property is read-only.

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.

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:

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:

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.

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.

handshake_timeout Property

Specifies the handshake timeout in milliseconds.

Syntax

def get_handshake_timeout() -> int: ...
def set_handshake_timeout(value: int) -> None: ...

handshake_timeout = property(get_handshake_timeout, set_handshake_timeout)

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

host Property

The host to bind the listening port to.

Syntax

def get_host() -> str: ...
def set_host(value: str) -> None: ...

host = property(get_host, set_host)

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

key_id Property

Specifies the KeyID of the pre-shared authentication key.

Syntax

def get_key_id() -> str: ...
def set_key_id(value: str) -> None: ...

key_id = property(get_key_id, set_key_id)

Default Value

""

Remarks

If processing requests from a single known party, assign the Id of the key you pre-shared with them to this property, and the key itself to the key_secret property. If you expect to receive requests from many parties with different authentication keys, use on_key_secret_needed event instead.

key_secret Property

The pre-shared authentication key.

Syntax

def get_key_secret() -> str: ...
def set_key_secret(value: str) -> None: ...

key_secret = property(get_key_secret, set_key_secret)

Default Value

""

Remarks

If processing requests from a single known party, assign the key you pre-shared with them to this property. Use key_id property to assign the ID of that key. If you expect to receive requests from many parties with different authentication keys, use on_key_secret_needed event instead.

pinned_client_aead_cipher Property

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

def get_pinned_client_aead_cipher() -> bool: ...

pinned_client_aead_cipher = property(get_pinned_client_aead_cipher, None)

Default Value

FALSE

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

pinned_client_chain_validation_details Property

The details of a certificate chain validation outcome.

Syntax

def get_pinned_client_chain_validation_details() -> int: ...

pinned_client_chain_validation_details = property(get_pinned_client_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:

This property is read-only.

pinned_client_chain_validation_result Property

The outcome of a certificate chain validation routine.

Syntax

def get_pinned_client_chain_validation_result() -> int: ...

pinned_client_chain_validation_result = property(get_pinned_client_chain_validation_result, None)

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

pinned_client_ciphersuite Property

The cipher suite employed by this connection.

Syntax

def get_pinned_client_ciphersuite() -> str: ...

pinned_client_ciphersuite = property(get_pinned_client_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.

pinned_client_client_authenticated Property

Specifies whether client authentication was performed during this connection.

Syntax

def get_pinned_client_client_authenticated() -> bool: ...

pinned_client_client_authenticated = property(get_pinned_client_client_authenticated, None)

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

pinned_client_client_auth_requested Property

Specifies whether client authentication was requested during this connection.

Syntax

def get_pinned_client_client_auth_requested() -> bool: ...

pinned_client_client_auth_requested = property(get_pinned_client_client_auth_requested, None)

Default Value

FALSE

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

pinned_client_connection_established Property

Indicates whether the connection has been established fully.

Syntax

def get_pinned_client_connection_established() -> bool: ...

pinned_client_connection_established = property(get_pinned_client_connection_established, None)

Default Value

FALSE

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

pinned_client_connection_id Property

The unique identifier assigned to this connection.

Syntax

def get_pinned_client_connection_id() -> bytes: ...

pinned_client_connection_id = property(get_pinned_client_connection_id, None)

Remarks

The unique identifier assigned to this connection.

This property is read-only.

pinned_client_digest_algorithm Property

The digest algorithm used in a TLS-enabled connection.

Syntax

def get_pinned_client_digest_algorithm() -> str: ...

pinned_client_digest_algorithm = property(get_pinned_client_digest_algorithm, None)

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

pinned_client_encryption_algorithm Property

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

def get_pinned_client_encryption_algorithm() -> str: ...

pinned_client_encryption_algorithm = property(get_pinned_client_encryption_algorithm, None)

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only.

pinned_client_exportable Property

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

def get_pinned_client_exportable() -> bool: ...

pinned_client_exportable = property(get_pinned_client_exportable, None)

Default Value

FALSE

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only.

pinned_client_id Property

The client connection's unique identifier.

Syntax

def get_pinned_client_id() -> int: ...

pinned_client_id = property(get_pinned_client_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.

pinned_client_key_exchange_algorithm Property

The key exchange algorithm used in a TLS-enabled connection.

Syntax

def get_pinned_client_key_exchange_algorithm() -> str: ...

pinned_client_key_exchange_algorithm = property(get_pinned_client_key_exchange_algorithm, None)

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only.

pinned_client_key_exchange_key_bits Property

The length of the key exchange key of a TLS-enabled connection.

Syntax

def get_pinned_client_key_exchange_key_bits() -> int: ...

pinned_client_key_exchange_key_bits = property(get_pinned_client_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.

pinned_client_named_ec_curve Property

The elliptic curve used in this connection.

Syntax

def get_pinned_client_named_ec_curve() -> str: ...

pinned_client_named_ec_curve = property(get_pinned_client_named_ec_curve, None)

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only.

pinned_client_pfs_cipher Property

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

def get_pinned_client_pfs_cipher() -> bool: ...

pinned_client_pfs_cipher = property(get_pinned_client_pfs_cipher, None)

Default Value

FALSE

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only.

pinned_client_pre_shared_identity Property

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

def get_pinned_client_pre_shared_identity() -> str: ...

pinned_client_pre_shared_identity = property(get_pinned_client_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.

pinned_client_pre_shared_identity_hint Property

A hint professed by the server to help the client select the PSK identity to use.

Syntax

def get_pinned_client_pre_shared_identity_hint() -> str: ...

pinned_client_pre_shared_identity_hint = property(get_pinned_client_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.

pinned_client_public_key_bits Property

The length of the public key.

Syntax

def get_pinned_client_public_key_bits() -> int: ...

pinned_client_public_key_bits = property(get_pinned_client_public_key_bits, None)

Default Value

0

Remarks

The length of the public key.

This property is read-only.

pinned_client_remote_address Property

The client's IP address.

Syntax

def get_pinned_client_remote_address() -> str: ...

pinned_client_remote_address = property(get_pinned_client_remote_address, None)

Default Value

""

Remarks

The client's IP address.

This property is read-only.

pinned_client_remote_port Property

The remote port of the client connection.

Syntax

def get_pinned_client_remote_port() -> int: ...

pinned_client_remote_port = property(get_pinned_client_remote_port, None)

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

pinned_client_resumed_session Property

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

def get_pinned_client_resumed_session() -> bool: ...

pinned_client_resumed_session = property(get_pinned_client_resumed_session, None)

Default Value

FALSE

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only.

pinned_client_secure_connection Property

Indicates whether TLS or SSL is enabled for this connection.

Syntax

def get_pinned_client_secure_connection() -> bool: ...

pinned_client_secure_connection = property(get_pinned_client_secure_connection, None)

Default Value

FALSE

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

pinned_client_server_authenticated Property

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

def get_pinned_client_server_authenticated() -> bool: ...

pinned_client_server_authenticated = property(get_pinned_client_server_authenticated, None)

Default Value

FALSE

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only.

pinned_client_signature_algorithm Property

The signature algorithm used in a TLS handshake.

Syntax

def get_pinned_client_signature_algorithm() -> str: ...

pinned_client_signature_algorithm = property(get_pinned_client_signature_algorithm, None)

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

pinned_client_symmetric_block_size Property

The block size of the symmetric algorithm used.

Syntax

def get_pinned_client_symmetric_block_size() -> int: ...

pinned_client_symmetric_block_size = property(get_pinned_client_symmetric_block_size, None)

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

pinned_client_symmetric_key_bits Property

The key length of the symmetric algorithm used.

Syntax

def get_pinned_client_symmetric_key_bits() -> int: ...

pinned_client_symmetric_key_bits = property(get_pinned_client_symmetric_key_bits, None)

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

pinned_client_total_bytes_received Property

The total number of bytes received over this connection.

Syntax

def get_pinned_client_total_bytes_received() -> int: ...

pinned_client_total_bytes_received = property(get_pinned_client_total_bytes_received, None)

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

pinned_client_total_bytes_sent Property

The total number of bytes sent over this connection.

Syntax

def get_pinned_client_total_bytes_sent() -> int: ...

pinned_client_total_bytes_sent = property(get_pinned_client_total_bytes_sent, None)

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

pinned_client_validation_log Property

Contains the server certificate's chain validation log.

Syntax

def get_pinned_client_validation_log() -> str: ...

pinned_client_validation_log = property(get_pinned_client_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.

pinned_client_version Property

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

def get_pinned_client_version() -> str: ...

pinned_client_version = property(get_pinned_client_version, None)

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only.

pinned_client_cert_count Property

The number of records in the PinnedClientCert arrays.

Syntax

def get_pinned_client_cert_count() -> int: ...

pinned_client_cert_count = property(get_pinned_client_cert_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• pinned_client_cert_bytes
• pinned_client_cert_ca_key_id
• pinned_client_cert_fingerprint
• pinned_client_cert_handle
• pinned_client_cert_issuer
• pinned_client_cert_issuer_rdn
• pinned_client_cert_key_algorithm
• pinned_client_cert_key_bits
• pinned_client_cert_key_fingerprint
• pinned_client_cert_key_usage
• pinned_client_cert_public_key_bytes
• pinned_client_cert_self_signed
• pinned_client_cert_serial_number
• pinned_client_cert_sig_algorithm
• pinned_client_cert_subject
• pinned_client_cert_subject_key_id
• pinned_client_cert_subject_rdn
• pinned_client_cert_valid_from
• pinned_client_cert_valid_to

The array indices start at 0 and end at pinned_client_cert_count - 1.

This property is read-only.

pinned_client_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_pinned_client_cert_bytes(pinned_client_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_ca_key_id Property

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

def get_pinned_client_cert_ca_key_id(pinned_client_cert_index: int) -> bytes: ...

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the pinned_client_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_fingerprint Property

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

def get_pinned_client_cert_fingerprint(pinned_client_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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_pinned_client_cert_handle(pinned_client_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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_issuer Property

The common name of the certificate issuer (CA), typically a company name.

Syntax

def get_pinned_client_cert_issuer(pinned_client_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 pinned_client_cert_issuer_rdn.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_issuer_rdn Property

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

def get_pinned_client_cert_issuer_rdn(pinned_client_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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_key_algorithm Property

Specifies the public key algorithm of this certificate.

Syntax

def get_pinned_client_cert_key_algorithm(pinned_client_cert_index: int) -> str: ...

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the pinned_client_cert_key_bits, pinned_client_cert_curve, and pinned_client_cert_public_key_bytes properties to get more details about the key the certificate contains.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_key_bits Property

Returns the length of the public key in bits.

Syntax

def get_pinned_client_cert_key_bits(pinned_client_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 pinned_client_cert_public_key_bytes or pinned_client_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_key_fingerprint Property

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

def get_pinned_client_cert_key_fingerprint(pinned_client_cert_index: int) -> str: ...

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the pinned_client_cert_fingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_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_pinned_client_cert_key_usage(pinned_client_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:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_public_key_bytes Property

Contains the certificate's public key in DER format.

Syntax

def get_pinned_client_cert_public_key_bytes(pinned_client_cert_index: int) -> bytes: ...

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_self_signed Property

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

def get_pinned_client_cert_self_signed(pinned_client_cert_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_serial_number Property

Returns the certificate's serial number.

Syntax

def get_pinned_client_cert_serial_number(pinned_client_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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_sig_algorithm Property

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

def get_pinned_client_cert_sig_algorithm(pinned_client_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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_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_pinned_client_cert_subject(pinned_client_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 pinned_client_cert_subject_rdn.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_subject_key_id Property

Contains a unique identifier of the certificate's cryptographic key.

Syntax

def get_pinned_client_cert_subject_key_id(pinned_client_cert_index: int) -> bytes: ...

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The pinned_client_cert_subject_key_id and pinned_client_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_subject_rdn Property

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

def get_pinned_client_cert_subject_rdn(pinned_client_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 pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_valid_from Property

The time point at which the certificate becomes valid, in UTC.

Syntax

def get_pinned_client_cert_valid_from(pinned_client_cert_index: int) -> str: ...

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

pinned_client_cert_valid_to Property

The time point at which the certificate expires, in UTC.

Syntax

def get_pinned_client_cert_valid_to(pinned_client_cert_index: int) -> str: ...

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The pinned_client_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the pinned_client_cert_count property.

This property is read-only.

policies Property

Specifies the policies to use when processing requests.

Syntax

def get_policies() -> int: ...
def set_policies(value: int) -> None: ...

policies = property(get_policies, set_policies)

Default Value

0

Remarks

This property lets you specify policies to apply blanketly to the requests. If this property does not give you enough flexibility - for example, if you need to cherry-pick requests basing on their content - please consider using the on_sign_request (allows you to track individual requests) and/or on_external_sign (lets you perform the signing manually) events. This setting is a bit mask of the following flags:

port Property

Specifies the port number to listen for connections on.

Syntax

def get_port() -> int: ...
def set_port(value: int) -> None: ...

port = property(get_port, set_port)

Default Value

80

Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via port_range_from and port_range_to properties. In this case the port will be allocated within the requested range by the operating system, and reported in bound_port.

port_range_from Property

Specifies the lower limit of the listening port range for incoming connections.

Syntax

def get_port_range_from() -> int: ...
def set_port_range_from(value: int) -> None: ...

port_range_from = property(get_port_range_from, set_port_range_from)

Default Value

0

Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via port), the port will be allocated within the requested range by the operating system, and reported in bound_port.

Note that this property is ignored if the port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

port_range_to Property

Specifies the upper limit of the listening port range for incoming connections.

Syntax

def get_port_range_to() -> int: ...
def set_port_range_to(value: int) -> None: ...

port_range_to = property(get_port_range_to, set_port_range_to)

Default Value

0

Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via port), the port will be allocated within the requested range by the operating system, and reported in bound_port.

Note that this property is ignored if the port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

session_timeout Property

Specifies the default session timeout value in milliseconds.

Syntax

def get_session_timeout() -> int: ...
def set_session_timeout(value: int) -> None: ...

session_timeout = property(get_session_timeout, set_session_timeout)

Default Value

360000

Remarks

Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.

sign_endpoint Property

The signing service endpoint.

Syntax

def get_sign_endpoint() -> str: ...
def set_sign_endpoint(value: str) -> None: ...

sign_endpoint = property(get_sign_endpoint, set_sign_endpoint)

Default Value

"/sign"

Remarks

Use this property to specify the signing service end point on the server.

signing_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_signing_cert_bytes() -> bytes: ...

signing_cert_bytes = property(get_signing_cert_bytes, None)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

signing_cert_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_signing_cert_handle() -> int: ...
def set_signing_cert_handle(value: int) -> None: ...

signing_cert_handle = property(get_signing_cert_handle, set_signing_cert_handle)

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());

signing_chain_count Property

The number of records in the SigningChain arrays.

Syntax

def get_signing_chain_count() -> int: ...
def set_signing_chain_count(value: int) -> None: ...

signing_chain_count = property(get_signing_chain_count, set_signing_chain_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• signing_chain_bytes
• signing_chain_handle

The array indices start at 0 and end at signing_chain_count - 1.

signing_chain_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_signing_chain_bytes(signing_chain_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The signing_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signing_chain_count property.

This property is read-only.

signing_chain_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_signing_chain_handle(signing_chain_index: int) -> int: ...
def set_signing_chain_handle(signing_chain_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 signing_chain_index parameter specifies the index of the item in the array. The size of the array is controlled by the signing_chain_count property.

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.

storage_id Property

Specifies the signing certificate residing in an alternative location.

Syntax

def get_storage_id() -> str: ...
def set_storage_id(value: str) -> None: ...

storage_id = property(get_storage_id, set_storage_id)

Default Value

""

Remarks

Use this property to specify the signing certificate contained on alternative media, such as a hardware device or in a system certificate store.

Example 1: The certificate resides on a PKCS#11 device

pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1

Example 2: The certificate resides in a system store

system://localmachine@/?store=MY

You can use the following URI modifiers to provide more accurate specifiers for the needed certificate:

• cn: the common name of the certificate subject.
• keyid: the unique identifier included in subject key identifier extension of the certificate.
• keyusage: a comma-separated list of enabled (+) or disabled (-) key usages. The following usages are supported: signature, nonrepudiation, keyencipherment, dataencipherment, keyagreement, keycertsign, crlsign, encipheronly, decipheronly, serverauth, clientauth, codesigning, emailprotection, timestamping, ocspsigning, smartcardlogon, keypurposeclientauth, keypurposekdc.
• fingerprint: the fingerprint of the certificate.

Example 3: selecting the certificate with a given fingerprint:

pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1&fingerprint=001122334455667788aabbccddeeff0011223344

timestamp_server Property

The address of the timestamping server.

Syntax

def get_timestamp_server() -> str: ...
def set_timestamp_server(value: str) -> None: ...

timestamp_server = property(get_timestamp_server, set_timestamp_server)

Default Value

""

Remarks

Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.

SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.

If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:

http://user:password@timestamp.server.com/TsaService

For TSAs using certificate-based TLS authentication, provide the client certificate via the tls_client_chain property.

If this property is left empty, no timestamp will be added to the signature.

Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.

To employ the virtual service, assign an URI of the following format to this property:

virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true

Subscribe to on_notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:

component.Config("TimestampResponse=308208ab...");

Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.

The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.

The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.

The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.

The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

tls_server_cert_count Property

The number of records in the TLSServerCert arrays.

Syntax

def get_tls_server_cert_count() -> int: ...
def set_tls_server_cert_count(value: int) -> None: ...

tls_server_cert_count = property(get_tls_server_cert_count, set_tls_server_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_handle

The array indices start at 0 and end at tls_server_cert_count - 1.

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_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: ...
def set_tls_server_cert_handle(tls_server_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_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.

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.

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:

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:

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.

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

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.

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.

user_count Property

The number of records in the User arrays.

Syntax

def get_user_count() -> int: ...
def set_user_count(value: int) -> None: ...

user_count = property(get_user_count, set_user_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• user_associated_data
• user_base_path
• user_data
• user_handle
• user_hash_algorithm
• user_incoming_speed_limit
• user_outgoing_speed_limit
• user_password
• user_shared_secret
• user_username

The array indices start at 0 and end at user_count - 1.

user_associated_data Property

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

def get_user_associated_data(user_index: int) -> bytes: ...
def set_user_associated_data(user_index: int, value: bytes) -> None: ...

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_base_path Property

Base path for this user in the server's file system.

Syntax

def get_user_base_path(user_index: int) -> str: ...
def set_user_base_path(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

Base path for this user in the server's file system.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_data Property

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

def get_user_data(user_index: int) -> str: ...
def set_user_data(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_handle Property

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

def get_user_handle(user_index: int) -> int: ...
def set_user_handle(user_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 user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_hash_algorithm Property

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

def get_user_hash_algorithm(user_index: int) -> str: ...
def set_user_hash_algorithm(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_incoming_speed_limit Property

Specifies the incoming speed limit for this user.

Syntax

def get_user_incoming_speed_limit(user_index: int) -> int: ...
def set_user_incoming_speed_limit(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_outgoing_speed_limit Property

Specifies the outgoing speed limit for this user.

Syntax

def get_user_outgoing_speed_limit(user_index: int) -> int: ...
def set_user_outgoing_speed_limit(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_password Property

The user's authentication password.

Syntax

def get_user_password(user_index: int) -> str: ...
def set_user_password(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The user's authentication password.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_shared_secret Property

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

def get_user_shared_secret(user_index: int) -> bytes: ...
def set_user_shared_secret(user_index: int, value: bytes) -> None: ...

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

user_username Property

The registered name (login) of the user.

Syntax

def get_user_username(user_index: int) -> str: ...
def set_user_username(user_index: int, value: str) -> None: ...

Default Value

""

Remarks

The registered name (login) of the user.

The user_index parameter specifies the index of the item in the array. The size of the array is controlled by the user_count property.

website_name Property

Specifies the web site name to use in the certificate.

Syntax

def get_website_name() -> str: ...
def set_website_name(value: str) -> None: ...

website_name = property(get_website_name, set_website_name)

Default Value

"secureblackbox"

Remarks

If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.

cleanup Method

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

def cleanup() -> None: ...

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

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.

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;....

drop_client Method

Terminates a client connection.

Syntax

def drop_client(connection_id: int, forced: bool) -> None: ...

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

list_clients Method

Enumerates the connected clients.

Syntax

def list_clients() -> str: ...

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

pin_client Method

Takes a snapshot of the connection's properties.

Syntax

def pin_client(connection_id: int) -> None: ...

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in pinned_client and pinned_client_chain properties.

reset Method

Resets the class settings.

Syntax

def reset() -> None: ...

Remarks

reset is a generic method available in every class.

start Method

Starts the server.

Syntax

def start() -> None: ...

Remarks

Use this method to activate the server and start listening to incoming connections.

stop Method

Stops the server.

Syntax

def stop() -> None: ...

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

on_accept Event

Reports an incoming connection.

Syntax

class DCAuthWebServerAcceptEventParams(object):
  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_accept() -> Callable[[DCAuthWebServerAcceptEventParams], None]: ...
@on_accept.setter
def on_accept(event_hook: Callable[[DCAuthWebServerAcceptEventParams], None]) -> None: ...

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to on_connect event to be notified of every connection that has been set up.

on_auth_attempt Event

Fires when a connected client makes an authentication attempt.

Syntax

class DCAuthWebServerAuthAttemptEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def http_method() -> str: ...

  @property
  def uri() -> str: ...

  @property
  def auth_method() -> str: ...

  @property
  def username() -> str: ...

  @property
  def password() -> str: ...

  @property
  def allow() -> bool: ...
  @allow.setter
  def allow(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_auth_attempt() -> Callable[[DCAuthWebServerAuthAttemptEventParams], None]: ...
@on_auth_attempt.setter
def on_auth_attempt(event_hook: Callable[[DCAuthWebServerAuthAttemptEventParams], None]) -> None: ...

Remarks

The class fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

ConnectionID contains the unique session identifier for that client, HTTPMethod specifies the HTTP method (GET, POST, etc.) used to access the URI resource, AuthMethod specifies the authentication method, and Username and Password contain the professed credentials.

on_connect Event

Reports an accepted connection.

Syntax

class DCAuthWebServerConnectEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def remote_address() -> str: ...

  @property
  def remote_port() -> int: ...

# In class DCAuthWebServer:
@property
def on_connect() -> Callable[[DCAuthWebServerConnectEventParams], None]: ...
@on_connect.setter
def on_connect(event_hook: Callable[[DCAuthWebServerConnectEventParams], None]) -> None: ...

Remarks

The class fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as on_tls_handshake or on_data.

on_custom_parameters_received Event

Passes custom request parameters to the application.

Syntax

class DCAuthWebServerCustomParametersReceivedEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def value() -> str: ...

# In class DCAuthWebServer:
@property
def on_custom_parameters_received() -> Callable[[DCAuthWebServerCustomParametersReceivedEventParams], None]: ...
@on_custom_parameters_received.setter
def on_custom_parameters_received(event_hook: Callable[[DCAuthWebServerCustomParametersReceivedEventParams], None]) -> None: ...

Remarks

Subscribe to this event to access custom signing parameters supplied by the signer in their request. The Value string contains the parameters as included by the requestor.

on_disconnect Event

Fires to report a disconnected client.

Syntax

class DCAuthWebServerDisconnectEventParams(object):
  @property
  def connection_id() -> int: ...

# In class DCAuthWebServer:
@property
def on_disconnect() -> Callable[[DCAuthWebServerDisconnectEventParams], None]: ...
@on_disconnect.setter
def on_disconnect(event_hook: Callable[[DCAuthWebServerDisconnectEventParams], None]) -> None: ...

Remarks

The class fires this event when a connected client disconnects.

on_error Event

Information about errors during data delivery.

Syntax

class DCAuthWebServerErrorEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def error_code() -> int: ...

  @property
  def fatal() -> bool: ...

  @property
  def remote() -> bool: ...

  @property
  def description() -> str: ...

# In class DCAuthWebServer:
@property
def on_error() -> Callable[[DCAuthWebServerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[DCAuthWebServerErrorEventParams], 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 server protocol.

Syntax

class DCAuthWebServerExternalSignEventParams(object):
  @property
  def connection_id() -> int: ...

  @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 DCAuthWebServer:
@property
def on_external_sign() -> Callable[[DCAuthWebServerExternalSignEventParams], None]: ...
@on_external_sign.setter
def on_external_sign(event_hook: Callable[[DCAuthWebServerExternalSignEventParams], 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_key_secret_needed Event

Requests the key secret from the application.

Syntax

class DCAuthWebServerKeySecretNeededEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def key_id() -> str: ...

  @property
  def key_secret() -> str: ...
  @key_secret.setter
  def key_secret(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_key_secret_needed() -> Callable[[DCAuthWebServerKeySecretNeededEventParams], None]: ...
@on_key_secret_needed.setter
def on_key_secret_needed(event_hook: Callable[[DCAuthWebServerKeySecretNeededEventParams], None]) -> None: ...

Remarks

Subscribe to this event to pass the key secret (a pre-shared request authentication code) to the signing component when it is needed. The authentication combination consists of the KeyId, a non-secret unique key identifier, and the KeySecret, shared by the parties, which should be kept private. This event is an alternative for key_secret property. Use it when you expect to process requests from requestors with different KeyIds and secrets. If you only expect to receive requests from a single requestor with a known KeyId, providing the key secret via key_id and key_secret properties would be an easier route.

on_log Event

Reports a single log line.

Syntax

class DCAuthWebServerLogEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def log_type() -> int: ...

  @property
  def details() -> str: ...

# In class DCAuthWebServer:
@property
def on_log() -> Callable[[DCAuthWebServerLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[DCAuthWebServerLogEventParams], None]) -> None: ...

Remarks

This event is fired repeatedly during the component's work to inform the application about the flow of the signing process. The application may use this event to create an operation log.

on_notification Event

This event notifies the application about an underlying control flow event.

Syntax

class DCAuthWebServerNotificationEventParams(object):
  @property
  def event_id() -> str: ...

  @property
  def event_param() -> str: ...

# In class DCAuthWebServer:
@property
def on_notification() -> Callable[[DCAuthWebServerNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[DCAuthWebServerNotificationEventParams], 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.

on_parameter_received Event

Passes a standard request parameter to the user code.

Syntax

class DCAuthWebServerParameterReceivedEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

# In class DCAuthWebServer:
@property
def on_parameter_received() -> Callable[[DCAuthWebServerParameterReceivedEventParams], None]: ...
@on_parameter_received.setter
def on_parameter_received(event_hook: Callable[[DCAuthWebServerParameterReceivedEventParams], None]) -> None: ...

Remarks

This event is fired when one of 'standard' protocol parameters has been found in the request:

• SessionID
• DataURL
• GoURL
• Token
• PKCS11Libraries
• AllowFileStorage
• AllowTokenStorage
• AllowWindowsStorage
• AllowOSStorage

Parameters are reported one-by-one upon being processed.

on_password_needed Event

Requests a password from the application.

Syntax

class DCAuthWebServerPasswordNeededEventParams(object):
  @property
  def needed_for() -> str: ...

  @property
  def id() -> str: ...

  @property
  def password() -> str: ...
  @password.setter
  def password(value) -> None: ...

  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_password_needed() -> Callable[[DCAuthWebServerPasswordNeededEventParams], None]: ...
@on_password_needed.setter
def on_password_needed(event_hook: Callable[[DCAuthWebServerPasswordNeededEventParams], None]) -> None: ...

Remarks

Subscribe to this event to pass a password to the server component. The NeededFor parameter specifies the entity a password for which is being requested (which is typically a certificate). The Id parameter provides the entity's identifier, such as a path to the certificate being loaded. When handling this event, assign the Password to the valid password if you have it; otherwise, set Cancel to true to abort the operation.

on_read_option Event

Fires when the client sends in a read option request.

Syntax

class DCAuthWebServerReadOptionEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def name() -> str: ...

  @property
  def value() -> str: ...
  @value.setter
  def value(value) -> None: ...

  @property
  def success() -> bool: ...
  @success.setter
  def success(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_read_option() -> Callable[[DCAuthWebServerReadOptionEventParams], None]: ...
@on_read_option.setter
def on_read_option(event_hook: Callable[[DCAuthWebServerReadOptionEventParams], None]) -> None: ...

Remarks

Subscribe to this event to respond to the clients' read option requests. The handler should retrieve the value of the requested option from a local configuration setting and assign it to the Value parameter.

on_select_cert Event

Requests certificate selection criteria from the application.

Syntax

class DCAuthWebServerSelectCertEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def common_name() -> str: ...
  @common_name.setter
  def common_name(value) -> None: ...

  @property
  def key_id() -> str: ...
  @key_id.setter
  def key_id(value) -> None: ...

  @property
  def key_usage() -> str: ...
  @key_usage.setter
  def key_usage(value) -> None: ...

  @property
  def fingerprint() -> str: ...
  @fingerprint.setter
  def fingerprint(value) -> None: ...

  @property
  def store_type() -> str: ...
  @store_type.setter
  def store_type(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_select_cert() -> Callable[[DCAuthWebServerSelectCertEventParams], None]: ...
@on_select_cert.setter
def on_select_cert(event_hook: Callable[[DCAuthWebServerSelectCertEventParams], None]) -> None: ...

Remarks

Subscribe to this event to provide signing certificate details on the fly, right before the hash is signed.

on_sign_request Event

This event signifies the processing of an atomic signing request.

Syntax

class DCAuthWebServerSignRequestEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def method() -> int: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def hash() -> bytes: ...

  @property
  def key_id() -> str: ...

  @property
  def pars() -> str: ...

  @property
  def method_pars() -> str: ...

  @property
  def allow() -> bool: ...
  @allow.setter
  def allow(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_sign_request() -> Callable[[DCAuthWebServerSignRequestEventParams], None]: ...
@on_sign_request.setter
def on_sign_request(event_hook: Callable[[DCAuthWebServerSignRequestEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified of every signature request processed by the DC server. Note that any one request coming from the requestor may contain multiple individual signature requests (so-called 'batching'). This event is a good mechanism to track signature requests for accountability purposes, and provide basic access control over the signing operations. The Method parameter specifies the async signing method requested by the client:

The Hash parameter contains the hash, made using HashAlgorithm, that needs to be signed. KeyID contains the key identifier of the requestor.

The Pars string contains a semicolon-separated string of the principal signature parameters. This has the same format and content that is passed to on_external_sign, if it is used. The MethodPars contains a similar parameter string, but for the specific async signing method used. For the PKCS1 method there are no defined method parameters, while the PKCS7 method supports a selection of settings that tune up the CMS blob.

Set Allow to false to reject the request. Use the on_sign_request_completed event to track completion of the initiated operation.

on_sign_request_completed Event

This event signifies completion of the processing of an atomic signing request.

Syntax

class DCAuthWebServerSignRequestCompletedEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def method() -> int: ...

  @property
  def hash_algorithm() -> str: ...

  @property
  def hash() -> bytes: ...

  @property
  def key_id() -> str: ...

  @property
  def pars() -> str: ...

  @property
  def method_pars() -> str: ...

  @property
  def signature() -> bytes: ...

# In class DCAuthWebServer:
@property
def on_sign_request_completed() -> Callable[[DCAuthWebServerSignRequestCompletedEventParams], None]: ...
@on_sign_request_completed.setter
def on_sign_request_completed(event_hook: Callable[[DCAuthWebServerSignRequestCompletedEventParams], None]) -> None: ...

Remarks

Use this event to track completion of signing request processing. The Hash parameter contains the hash that is signed, as supplied by the requestor, and the Signature parameter contains the resulting cryptographic signature. The Username parameter matches the parameter in on_sign_request event.

on_timestamp_request Event

Fires when the class is ready to request a timestamp from an external TSA.

Syntax

class DCAuthWebServerTimestampRequestEventParams(object):
  @property
  def tsa() -> str: ...

  @property
  def timestamp_request() -> str: ...

  @property
  def timestamp_response() -> str: ...
  @timestamp_response.setter
  def timestamp_response(value) -> None: ...

  @property
  def suppress_default() -> bool: ...
  @suppress_default.setter
  def suppress_default(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_timestamp_request() -> Callable[[DCAuthWebServerTimestampRequestEventParams], None]: ...
@on_timestamp_request.setter
def on_timestamp_request(event_hook: Callable[[DCAuthWebServerTimestampRequestEventParams], None]) -> None: ...

Remarks

Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The TSA parameter indicates the timestamping service being used. It matches the value passed to the timestamp_server property. Set the SuppressDefault parameter to false if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.

on_tls_cert_validate Event

Fires when a client certificate needs to be validated.

Syntax

class DCAuthWebServerTLSCertValidateEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_tls_cert_validate() -> Callable[[DCAuthWebServerTLSCertValidateEventParams], None]: ...
@on_tls_cert_validate.setter
def on_tls_cert_validate(event_hook: Callable[[DCAuthWebServerTLSCertValidateEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

on_tls_established Event

Reports the setup of a TLS session.

Syntax

class DCAuthWebServerTLSEstablishedEventParams(object):
  @property
  def connection_id() -> int: ...

# In class DCAuthWebServer:
@property
def on_tls_established() -> Callable[[DCAuthWebServerTLSEstablishedEventParams], None]: ...
@on_tls_established.setter
def on_tls_established(event_hook: Callable[[DCAuthWebServerTLSEstablishedEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

on_tls_handshake Event

Fires when a newly established client connection initiates a TLS handshake.

Syntax

class DCAuthWebServerTLSHandshakeEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def server_name() -> str: ...

  @property
  def abort() -> bool: ...
  @abort.setter
  def abort(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_tls_handshake() -> Callable[[DCAuthWebServerTLSHandshakeEventParams], None]: ...
@on_tls_handshake.setter
def on_tls_handshake(event_hook: Callable[[DCAuthWebServerTLSHandshakeEventParams], None]) -> None: ...

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

on_tls_psk Event

Requests a pre-shared key for TLS-PSK.

Syntax

class DCAuthWebServerTLSPSKEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def identity() -> str: ...

  @property
  def psk() -> str: ...
  @psk.setter
  def psk(value) -> None: ...

  @property
  def ciphersuite() -> str: ...
  @ciphersuite.setter
  def ciphersuite(value) -> None: ...

# In class DCAuthWebServer:
@property
def on_tls_psk() -> Callable[[DCAuthWebServerTLSPSKEventParams], None]: ...
@on_tls_psk.setter
def on_tls_psk(event_hook: Callable[[DCAuthWebServerTLSPSKEventParams], None]) -> None: ...

Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

on_tls_shutdown Event

Reports closure of a TLS session.

Syntax

class DCAuthWebServerTLSShutdownEventParams(object):
  @property
  def connection_id() -> int: ...

# In class DCAuthWebServer:
@property
def on_tls_shutdown() -> Callable[[DCAuthWebServerTLSShutdownEventParams], None]: ...
@on_tls_shutdown.setter
def on_tls_shutdown(event_hook: Callable[[DCAuthWebServerTLSShutdownEventParams], None]) -> None: ...

Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a on_disconnect, which marks the closure of the underlying TCP session.

on_write_option Event

Fires when the client sends in a write option request.

Syntax

class DCAuthWebServerWriteOptionEventParams(object):
  @property
  def connection_id() -> int: ...

  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

# In class DCAuthWebServer:
@property
def on_write_option() -> Callable[[DCAuthWebServerWriteOptionEventParams], None]: ...
@on_write_option.setter
def on_write_option(event_hook: Callable[[DCAuthWebServerWriteOptionEventParams], None]) -> None: ...

Remarks

Subscribe to this event to respond to the clients' write option requests. The handler should save the Value of the Name option to a local configuration database.

DCAuthWebServer 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.

DCAuthWebServer Config Settings

Base Config Settings

DCAuthWebServer Errors