WebDAVServer Class

Properties   Methods   Events   Config Settings   Errors  

The WebDAVServer class offers server-side functionality for the WebDAV protocol.

Syntax

class secureblackbox.WebDAVServer

Remarks

Both plain (HTTP) and secure (HTTPS) connection types are supported.

Property List


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

activeIndicates whether the server is active and is listening to new connections.
auth_basicEnables or disables basic authentication.
auth_digestEnables or disables digest authentication.
auth_digest_expireSpecifies digest expiration time for digest authentication.
auth_realmSpecifies authentication realm for digest and NTLM authentication.
bound_portIndicates the bound listening port.
client_authEnables or disables certificate-based client authentication.
client_file_entry_a_timeContains the last access time for this object, in UTC.
client_file_entry_content_typeThe object's content type.
client_file_entry_c_timeContains this object's creation time, in UTC.
client_file_entry_directorySpecifies whether this object is a directory.
client_file_entry_display_nameContains the display name of the object.
client_file_entry_e_tagAn e-tag of the object.
client_file_entry_full_urlA full path to the object.
client_file_entry_m_timeThe last modification time of the object, in UTC.
client_file_entry_parent_urlSpecifies the object's parent URL.
client_file_entry_sizeThe size of the object in bytes.
client_file_entry_supports_exclusive_lockIndicates whether the entry supports exclusive locking.
client_file_entry_supports_shared_lockIndicates whether the entry supports shared lock.
client_file_entry_urlA URL of the object.
document_rootThe document root of the server.
error_originIndicates the endpoint where the error originates from.
error_severityThe severity of the error that happened.
external_crypto_async_document_idSpecifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
external_crypto_custom_paramsCustom parameters to be passed to the signing service (uninterpreted).
external_crypto_dataAdditional data to be included in the async state and mirrored back by the requestor.
external_crypto_external_hash_calculationSpecifies whether the message hash is to be calculated at the external endpoint.
external_crypto_hash_algorithmSpecifies the request's signature hash algorithm.
external_crypto_key_idThe ID of the pre-shared key used for DC request authentication.
external_crypto_key_secretThe pre-shared key used for DC request authentication.
external_crypto_methodSpecifies the asynchronous signing method.
external_crypto_modeSpecifies the external cryptography mode.
external_crypto_public_key_algorithmProvide the public key algorithm here if the certificate is not available on the pre-signing stage.
fips_modeReserved.
hostThe host to bind the listening port to.
metadata_flush_timeoutSpecifies metadata flush timeout.
metadata_rootThe metadata directory root.
pinned_client_addressThe client's IP address.
pinned_client_chain_validation_detailsThe details of a certificate chain validation outcome.
pinned_client_chain_validation_resultThe outcome of a certificate chain validation routine.
pinned_client_ciphersuiteThe cipher suite employed by this connection.
pinned_client_client_authenticatedSpecifies whether client authentication was performed during this connection.
pinned_client_digest_algorithmThe digest algorithm used in a TLS-enabled connection.
pinned_client_encryption_algorithmThe symmetric encryption algorithm used in a TLS-enabled connection.
pinned_client_idThe client connection's unique identifier.
pinned_client_key_exchange_algorithmThe key exchange algorithm used in a TLS-enabled connection.
pinned_client_key_exchange_key_bitsThe length of the key exchange key of a TLS-enabled connection.
pinned_client_named_ec_curveThe elliptic curve used in this connection.
pinned_client_pfs_cipherIndicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
pinned_client_portThe remote port of the client connection.
pinned_client_pre_shared_identitySpecifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
pinned_client_public_key_bitsThe length of the public key.
pinned_client_resumed_sessionIndicates whether a TLS-enabled connection was spawned from another TLS connection.
pinned_client_secure_connectionIndicates whether TLS or SSL is enabled for this connection.
pinned_client_signature_algorithmThe signature algorithm used in a TLS handshake.
pinned_client_symmetric_block_sizeThe block size of the symmetric algorithm used.
pinned_client_symmetric_key_bitsThe key length of the symmetric algorithm used.
pinned_client_total_bytes_receivedThe total number of bytes received over this connection.
pinned_client_total_bytes_sentThe total number of bytes sent over this connection.
pinned_client_validation_logContains the server certificate's chain validation log.
pinned_client_versionIndicates the version of SSL/TLS protocol negotiated during this connection.
pinned_client_cert_countThe number of records in the PinnedClientCert arrays.
pinned_client_cert_bytesReturns the raw certificate data in DER format.
pinned_client_cert_caIndicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
pinned_client_cert_ca_key_idA unique identifier (fingerprint) of the CA certificate's private key.
pinned_client_cert_crl_distribution_pointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
pinned_client_cert_curveSpecifies the elliptic curve of the EC public key.
pinned_client_cert_fingerprintContains the fingerprint (a hash imprint) of this certificate.
pinned_client_cert_friendly_nameContains an associated alias (friendly name) of the certificate.
pinned_client_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
pinned_client_cert_hash_algorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
pinned_client_cert_issuerThe common name of the certificate issuer (CA), typically a company name.
pinned_client_cert_issuer_rdnA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
pinned_client_cert_key_algorithmSpecifies the public key algorithm of this certificate.
pinned_client_cert_key_bitsReturns the length of the public key.
pinned_client_cert_key_fingerprintReturns a fingerprint of the public key contained in the certificate.
pinned_client_cert_key_usageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
pinned_client_cert_key_validReturns True if the certificate's key is cryptographically valid, and False otherwise.
pinned_client_cert_ocsp_locationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
pinned_client_cert_ocsp_no_checkAccessor to the value of the certificate's ocsp-no-check extension.
pinned_client_cert_originReturns the origin of this certificate.
pinned_client_cert_policy_i_dsContains identifiers (OIDs) of the applicable certificate policies.
pinned_client_cert_private_key_bytesContains the certificate's private key.
pinned_client_cert_private_key_existsIndicates whether the certificate has an associated private key.
pinned_client_cert_private_key_extractableIndicates whether the private key is extractable.
pinned_client_cert_public_key_bytesContains the certificate's public key in DER format.
pinned_client_cert_qualified_statementsReturns the qualified status of the certificate.
pinned_client_cert_self_signedIndicates whether the certificate is self-signed (root) or signed by an external CA.
pinned_client_cert_serial_numberReturns the certificate's serial number.
pinned_client_cert_sig_algorithmIndicates the algorithm that was used by the CA to sign this certificate.
pinned_client_cert_subjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
pinned_client_cert_subject_alternative_nameReturns or sets the value of the Subject Alternative Name extension of the certificate.
pinned_client_cert_subject_key_idContains a unique identifier (fingerprint) of the certificate's private key.
pinned_client_cert_subject_rdnA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
pinned_client_cert_valid_fromThe time point at which the certificate becomes valid, in UTC.
pinned_client_cert_valid_toThe time point at which the certificate expires, in UTC.
portSpecifies the port number to listen for connections on.
port_range_fromSpecifies the lower limit of the listening port range for incoming connections.
port_range_toSpecifies the upper limit of the listening port range for incoming connections.
server_cert_countThe number of records in the ServerCert arrays.
server_cert_bytesReturns the raw certificate data in DER format.
server_cert_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
socket_incoming_speed_limitThe maximum number of bytes to read from the socket, per second.
socket_local_addressThe local network interface to bind the socket to.
socket_local_portThe local port number to bind the socket to.
socket_outgoing_speed_limitThe maximum number of bytes to write to the socket, per second.
socket_timeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
socket_use_ipv6Enables or disables IP protocol version 6.
tls_auto_validate_certificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
tls_base_configurationSelects the base configuration for the TLS settings.
tls_ciphersuitesA list of ciphersuites separated with commas or semicolons.
tls_ec_curvesDefines the elliptic curves to enable.
tls_extensionsProvides access to TLS extensions.
tls_force_resume_if_destination_changesWhether to force TLS session resumption when the destination address changes.
tls_pre_shared_identityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
tls_pre_shared_keyContains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
tls_pre_shared_key_ciphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
tls_renegotiation_attack_prevention_modeSelects the renegotiation attack prevention mechanism.
tls_revocation_checkSpecifies the kind(s) of revocation check to perform.
tls_ssl_optionsVarious SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
tls_tls_modeSpecifies the TLS mode to use.
tls_use_extended_master_secretEnables the Extended Master Secret Extension, as defined in RFC 7627.
tls_use_session_resumptionEnables or disables the TLS session resumption capability.
tls_versionsThe SSL/TLS versions to enable by default.
user_countThe number of records in the User arrays.
user_associated_dataContains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
user_base_pathBase path for this user in the server's file system.
user_certContains the user's certificate.
user_dataContains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
user_handleAllows to get or set a 'handle', a unique identifier of the underlying property object.
user_hash_algorithmSpecifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
user_incoming_speed_limitSpecifies the incoming speed limit for this user.
user_otp_algorithmThe algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
user_otp_valueThe user's time interval (TOTP) or Counter (HOTP).
user_outgoing_speed_limitSpecifies the outgoing speed limit for this user.
user_passwordThe user's authentication password.
user_password_lenSpecifies the length of the user's OTP password.
user_shared_secretContains the user's secret key, which is essentially a shared secret between the client and server.
user_ssh_keyContains the user's SSH key.
user_usernameThe registered name (login) of the user.
website_nameSpecifies the web site name to use in the certificate.

Method List


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

configSets or retrieves a configuration setting.
do_actionPerforms an additional action.
drop_clientTerminates a client connection.
get_client_bufferObtains a pending connection buffer.
get_request_bytesReturns the contents of the client's HTTP request.
get_request_headerReturns a request header value.
get_request_stringReturns the contents of the client's HTTP request.
get_request_usernameReturns the username for a connection.
get_response_headerReturns a response header value.
list_clientsEnumerates the connected clients.
pin_clientTakes a snapshot of the connection's properties.
process_generic_requestProcesses a generic HTTP request.
set_client_bufferCommits a data buffer to the connection.
set_client_file_entryCommits a file entry to the connection.
set_response_bytesSets a byte array to be served as a response.
set_response_fileSets a file to be served as a response.
set_response_headerSets a response header.
set_response_statusSets an HTTP status to be sent with the response.
set_response_stringSets a string to be served as a response.
startStarts the server.
stopStops the server.

Event List


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

on_acceptReports an incoming connection.
on_after_browseWebDAVServer uses this event to notify the application about the completion of the browsing operation.
on_after_copy_objectThis event notifies the application about the completion of the copy operation.
on_after_create_calendarThis event reports the completion of calendar creation request.
on_after_create_collectionWebDAVServer uses this event to report completion of the collection creation operation.
on_after_custom_requestThis event reports the completion of the custom request.
on_after_lock_objectReports the completion of the object locking operation.
on_after_refresh_lockReports the completion of the lock refresh operation.
on_after_remove_objectThis event notifies the application about the completion of object deletion operation.
on_after_rename_objectThe class uses this event to notify the application about the completion of the object rename operation.
on_after_set_attributesWebDAVServer fires this event to notify the application of the completion of the attribute assignment operation.
on_after_unlock_objectNotifies the application about the completion of the object unlocking operation.
on_auth_attemptFires when a connected client makes an authentication attempt.
on_before_browseFires when a Browse request is received.
on_before_copy_objectFires when a Copy Object request is received.
on_before_create_calendarFires when a Create Calendar request is received from a client.
on_before_create_collectionFires when a Create Collection request is received from a client.
on_before_custom_requestNotifies the application about an incoming custom request.
on_before_download_objectFires when an object download request is received.
on_before_lock_objectFires when a lock request is received.
on_before_refresh_lockReports the receipt of lock refresh request.
on_before_remove_objectFires when an object deletion request is received.
on_before_rename_objectReports object renaming requests.
on_before_requestFires before a DAV request is processed.
on_before_set_attributesNotifies the application about attribute change request.
on_before_unlock_objectFires when an unlock request is received.
on_before_upload_objectFires when an object upload request is received.
on_clear_attributeReports an attribute clearance request.
on_connectReports an accepted connection.
on_copy_objectLets the application handle the Copy Object request.
on_create_calendarLets the application handle a calendar creation request.
on_create_collectionLets the application respond to collection creation request.
on_custom_requestUse this event to respond to non-standard DAV requests.
on_dataSupplies a data chunk received from a client.
on_disconnectFires to report a disconnected client.
on_download_objectAllows the application respond to Download Object request.
on_download_object_completedThis event is fired when a download operation completes.
on_errorInformation about errors during data delivery.
on_external_signHandles remote or external signing initiated by the server protocol.
on_file_errorReports a file access error to the application.
on_headers_preparedFires when the response headers have been formed and are ready to be sent to the server.
on_list_attributesRequests object attributes from the application in fraCustom handling mode.
on_list_sub_objectsRequests a list of sub-objects of an object. The class uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF.
on_lock_objectVirtualizes the object locking operation.
on_notificationThis event notifies the application about an underlying control flow event.
on_query_quotaReflects a quota enquiry by a client.
on_read_attributeRequests value of an attribute from the application in fraCustom mode.
on_read_objectRequests a piece of object data from the application.
on_refresh_lockNotifies the application about a lock refresh request.
on_remove_objectNotifies the application about object deletion requests.
on_rename_objectNotifies the application about object name change requests.
on_resource_accessReports an attempt to access a resource.
on_set_attributeLets the application customize attribute assignment requests.
on_tls_cert_validateFires when a client certificate needs to be validated.
on_tls_establishedReports the setup of a TLS session.
on_tls_handshakeFires when a newly established client connection initiates a TLS handshake.
on_tls_pskRequests a pre-shared key for TLS-PSK.
on_tls_shutdownReports closure of a TLS session.
on_unlock_objectVirtualizes the object unlocking operation.
on_upload_objectLets the application respond to the Upload Object request.
on_upload_object_completedThis event is fired when a upload operation completes.
on_write_objectHands a piece of object data to the application.

Config Settings


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

ClientAuthEnables or disables certificate-based client authentication.
DualStackAllows the use of ip4 and ip6 simultaneously.
HostThe host to bind to.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
WebsiteNameThe website name for the TLS certificate.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

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.

auth_basic Property

Enables or disables basic authentication.

Syntax

def get_auth_basic() -> bool: ...
def set_auth_basic(value: bool) -> None: ...

auth_basic = property(get_auth_basic, set_auth_basic)

Default Value

FALSE

Remarks

Use this property to enable or disable basic user authentication in the HTTP server.

auth_digest Property

Enables or disables digest authentication.

Syntax

def get_auth_digest() -> bool: ...
def set_auth_digest(value: bool) -> None: ...

auth_digest = property(get_auth_digest, set_auth_digest)

Default Value

FALSE

Remarks

Use this property to enable or disable digest-based user authentication in the HTTP server.

auth_digest_expire Property

Specifies digest expiration time for digest authentication.

Syntax

def get_auth_digest_expire() -> int: ...
def set_auth_digest_expire(value: int) -> None: ...

auth_digest_expire = property(get_auth_digest_expire, set_auth_digest_expire)

Default Value

20

Remarks

Use this property to specify the digest expiration time for digest authentication, in seconds.

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.

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.

client_auth Property

Enables or disables certificate-based client authentication.

Syntax

def get_client_auth() -> int: ...
def set_client_auth(value: int) -> None: ...

client_auth = property(get_client_auth, set_client_auth)

Default Value

0

Remarks

Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;

client_file_entry_a_time Property

Contains the last access time for this object, in UTC.

Syntax

def get_client_file_entry_a_time() -> str: ...
def set_client_file_entry_a_time(value: str) -> None: ...

client_file_entry_a_time = property(get_client_file_entry_a_time, set_client_file_entry_a_time)

Default Value

""

Remarks

Contains the last access time for this object, in UTC.

client_file_entry_content_type Property

The object's content type.

Syntax

def get_client_file_entry_content_type() -> str: ...
def set_client_file_entry_content_type(value: str) -> None: ...

client_file_entry_content_type = property(get_client_file_entry_content_type, set_client_file_entry_content_type)

Default Value

""

Remarks

The object's content type.

client_file_entry_c_time Property

Contains this object's creation time, in UTC.

Syntax

def get_client_file_entry_c_time() -> str: ...
def set_client_file_entry_c_time(value: str) -> None: ...

client_file_entry_c_time = property(get_client_file_entry_c_time, set_client_file_entry_c_time)

Default Value

""

Remarks

Contains this object's creation time, in UTC.

client_file_entry_directory Property

Specifies whether this object is a directory.

Syntax

def get_client_file_entry_directory() -> bool: ...
def set_client_file_entry_directory(value: bool) -> None: ...

client_file_entry_directory = property(get_client_file_entry_directory, set_client_file_entry_directory)

Default Value

FALSE

Remarks

Specifies whether this object is a directory.

client_file_entry_display_name Property

Contains the display name of the object.

Syntax

def get_client_file_entry_display_name() -> str: ...
def set_client_file_entry_display_name(value: str) -> None: ...

client_file_entry_display_name = property(get_client_file_entry_display_name, set_client_file_entry_display_name)

Default Value

""

Remarks

Contains the display name of the object.

client_file_entry_e_tag Property

An e-tag of the object.

Syntax

def get_client_file_entry_e_tag() -> str: ...
def set_client_file_entry_e_tag(value: str) -> None: ...

client_file_entry_e_tag = property(get_client_file_entry_e_tag, set_client_file_entry_e_tag)

Default Value

""

Remarks

An e-tag of the object.

client_file_entry_full_url Property

A full path to the object.

Syntax

def get_client_file_entry_full_url() -> str: ...
def set_client_file_entry_full_url(value: str) -> None: ...

client_file_entry_full_url = property(get_client_file_entry_full_url, set_client_file_entry_full_url)

Default Value

""

Remarks

A full path to the object.

client_file_entry_m_time Property

The last modification time of the object, in UTC.

Syntax

def get_client_file_entry_m_time() -> str: ...
def set_client_file_entry_m_time(value: str) -> None: ...

client_file_entry_m_time = property(get_client_file_entry_m_time, set_client_file_entry_m_time)

Default Value

""

Remarks

The last modification time of the object, in UTC.

client_file_entry_parent_url Property

Specifies the object's parent URL.

Syntax

def get_client_file_entry_parent_url() -> str: ...
def set_client_file_entry_parent_url(value: str) -> None: ...

client_file_entry_parent_url = property(get_client_file_entry_parent_url, set_client_file_entry_parent_url)

Default Value

""

Remarks

Specifies the object's parent URL.

client_file_entry_size Property

The size of the object in bytes.

Syntax

def get_client_file_entry_size() -> int: ...
def set_client_file_entry_size(value: int) -> None: ...

client_file_entry_size = property(get_client_file_entry_size, set_client_file_entry_size)

Default Value

0

Remarks

The size of the object in bytes.

client_file_entry_supports_exclusive_lock Property

Indicates whether the entry supports exclusive locking.

Syntax

def get_client_file_entry_supports_exclusive_lock() -> bool: ...
def set_client_file_entry_supports_exclusive_lock(value: bool) -> None: ...

client_file_entry_supports_exclusive_lock = property(get_client_file_entry_supports_exclusive_lock, set_client_file_entry_supports_exclusive_lock)

Default Value

FALSE

Remarks

Indicates whether the entry supports exclusive locking.

client_file_entry_supports_shared_lock Property

Indicates whether the entry supports shared lock.

Syntax

def get_client_file_entry_supports_shared_lock() -> bool: ...
def set_client_file_entry_supports_shared_lock(value: bool) -> None: ...

client_file_entry_supports_shared_lock = property(get_client_file_entry_supports_shared_lock, set_client_file_entry_supports_shared_lock)

Default Value

FALSE

Remarks

Indicates whether the entry supports shared lock.

client_file_entry_url Property

A URL of the object.

Syntax

def get_client_file_entry_url() -> str: ...
def set_client_file_entry_url(value: str) -> None: ...

client_file_entry_url = property(get_client_file_entry_url, set_client_file_entry_url)

Default Value

""

Remarks

A URL of the object.

document_root Property

The document root of the server.

Syntax

def get_document_root() -> str: ...
def set_document_root(value: str) -> None: ...

document_root = property(get_document_root, set_document_root)

Default Value

""

Remarks

Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory).

error_origin Property

Indicates the endpoint where the error originates from.

Syntax

def get_error_origin() -> int: ...
def set_error_origin(value: int) -> None: ...

error_origin = property(get_error_origin, set_error_origin)

Default Value

0

Remarks

Use this property to establish whether the reported error originates from a local or remote endpoint.

eoLocal0
eoRemote1

error_severity Property

The severity of the error that happened.

Syntax

def get_error_severity() -> int: ...
def set_error_severity(value: int) -> None: ...

error_severity = property(get_error_severity, set_error_severity)

Default Value

1

Remarks

Use this property to establish whether the error is fatal.

esWarning1
esFatal2

external_crypto_async_document_id Property

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

def get_external_crypto_async_document_id() -> str: ...
def set_external_crypto_async_document_id(value: str) -> None: ...

external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

external_crypto_custom_params Property

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

def get_external_crypto_custom_params() -> str: ...
def set_external_crypto_custom_params(value: str) -> None: ...

external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

external_crypto_data Property

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

def get_external_crypto_data() -> str: ...
def set_external_crypto_data(value: str) -> None: ...

external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

external_crypto_external_hash_calculation Property

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

def get_external_crypto_external_hash_calculation() -> bool: ...
def set_external_crypto_external_hash_calculation(value: bool) -> None: ...

external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)

Default Value

FALSE

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

external_crypto_hash_algorithm Property

Specifies the request's signature hash algorithm.

Syntax

def get_external_crypto_hash_algorithm() -> str: ...
def set_external_crypto_hash_algorithm(value: str) -> None: ...

external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

external_crypto_key_id Property

The ID of the pre-shared key used for DC request authentication.

Syntax

def get_external_crypto_key_id() -> str: ...
def set_external_crypto_key_id(value: str) -> None: ...

external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

def get_external_crypto_key_secret() -> str: ...
def set_external_crypto_key_secret(value: str) -> None: ...

external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the external_crypto_key_id topic.

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

def get_external_crypto_method() -> int: ...
def set_external_crypto_method(value: int) -> None: ...

external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

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:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

external_crypto_public_key_algorithm Property

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

def get_external_crypto_public_key_algorithm() -> str: ...
def set_external_crypto_public_key_algorithm(value: str) -> None: ...

external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

fips_mode Property

Reserved.

Syntax

def get_fips_mode() -> bool: ...
def set_fips_mode(value: bool) -> None: ...

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

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.

metadata_flush_timeout Property

Specifies metadata flush timeout.

Syntax

def get_metadata_flush_timeout() -> int: ...
def set_metadata_flush_timeout(value: int) -> None: ...

metadata_flush_timeout = property(get_metadata_flush_timeout, set_metadata_flush_timeout)

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

metadata_root Property

The metadata directory root.

Syntax

def get_metadata_root() -> str: ...
def set_metadata_root(value: str) -> None: ...

metadata_root = property(get_metadata_root, set_metadata_root)

Default Value

""

Remarks

The metadata directory is a dedicated location for storing properties of the files served by the WebDAVServer.

pinned_client_address Property

The client's IP address.

Syntax

def get_pinned_client_address() -> str: ...

pinned_client_address = property(get_pinned_client_address, None)

Default Value

""

Remarks

The client's IP address.

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:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

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:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

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_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_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_port Property

The remote port of the client connection.

Syntax

def get_pinned_client_port() -> int: ...

pinned_client_port = property(get_pinned_client_port, None)

Default Value

0

Remarks

The remote port of the client connection.

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_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_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_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:

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 Property

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Syntax

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

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints 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_ca_key_id Property

A unique identifier (fingerprint) of the CA certificate's private 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 private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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_crl_distribution_points Property

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

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

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

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_curve Property

Specifies the elliptic curve of the EC public key.

Syntax

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

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

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) -> bytes: ...

Remarks

Contains the fingerprint (a hash imprint) of this 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_friendly_name Property

Contains an associated alias (friendly name) of the certificate.

Syntax

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

Default Value

""

Remarks

Contains an associated alias (friendly name) of 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_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_hash_algorithm Property

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Syntax

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

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

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.

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 collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

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

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

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.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

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.

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.

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 fingerprint of the public key contained in the certificate.

Syntax

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

Remarks

Returns a fingerprint 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_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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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_valid Property

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

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

Default Value

FALSE

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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_ocsp_locations Property

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

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

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the 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_ocsp_no_check Property

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

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

Default Value

FALSE

Remarks

Accessor to the value of the certificate's ocsp-no-check 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_origin Property

Returns the origin of this certificate.

Syntax

def get_pinned_client_cert_origin(pinned_client_cert_index: int) -> int: ...

Default Value

0

Remarks

Returns the origin of this 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_policy_i_ds Property

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

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

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

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_private_key_bytes Property

Contains the certificate's private key.

Syntax

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

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

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_private_key_exists Property

Indicates whether the certificate has an associated private key.

Syntax

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

Default Value

FALSE

Remarks

Indicates whether the certificate has an associated private 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_private_key_extractable Property

Indicates whether the private key is extractable.

Syntax

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

Default Value

FALSE

Remarks

Indicates whether the private key is extractable.

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.

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_qualified_statements Property

Returns the qualified status of the certificate.

Syntax

def get_pinned_client_cert_qualified_statements(pinned_client_cert_index: int) -> int: ...

Default Value

0

Remarks

Returns the qualified status of 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 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.

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.

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_alternative_name Property

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

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

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of 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_subject_key_id Property

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

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

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public 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_subject_rdn Property

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

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

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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.

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 repored 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 repored in bound_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 repored in bound_port.

server_cert_count Property

The number of records in the ServerCert arrays.

Syntax

def get_server_cert_count() -> int: ...
def set_server_cert_count(value: int) -> None: ...

server_cert_count = property(get_server_cert_count, set_server_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

server_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

def get_server_cert_bytes(server_cert_index: int) -> bytes: ...

Remarks

Returns the raw certificate data in DER format.

The server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_count property.

This property is read-only.

server_cert_handle Property

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

Syntax

def get_server_cert_handle(server_cert_index: int) -> int: ...
def set_server_cert_handle(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 server_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the server_cert_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.

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.

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

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_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

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

tls_revocation_check Property

Specifies the kind(s) of revocation check to perform.

Syntax

def get_tls_revocation_check() -> int: ...
def set_tls_revocation_check(value: int) -> None: ...

tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

tls_ssl_options Property

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

def get_tls_ssl_options() -> int: ...
def set_tls_ssl_options(value: int) -> None: ...

tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

tls_tls_mode Property

Specifies the TLS mode to use.

Syntax

def get_tls_tls_mode() -> int: ...
def set_tls_tls_mode(value: int) -> None: ...

tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)

Default Value

0

Remarks

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

tls_use_extended_master_secret Property

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

def get_tls_use_extended_master_secret() -> bool: ...
def set_tls_use_extended_master_secret(value: bool) -> None: ...

tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)

Default Value

FALSE

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

tls_use_session_resumption Property

Enables or disables the TLS session resumption capability.

Syntax

def get_tls_use_session_resumption() -> bool: ...
def set_tls_use_session_resumption(value: bool) -> None: ...

tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

tls_versions Property

The SSL/TLS versions to enable by default.

Syntax

def get_tls_versions() -> int: ...
def set_tls_versions(value: int) -> None: ...

tls_versions = property(get_tls_versions, set_tls_versions)

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

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:

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_cert Property

Contains the user's certificate.

Syntax

def get_user_cert(user_index: int) -> bytes: ...
def set_user_cert(user_index: int, value: bytes) -> None: ...

Remarks

Contains the user's certificate.

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:

SB_MAC_ALGORITHM_HMAC_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

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_otp_algorithm Property

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).

Syntax

def get_user_otp_algorithm(user_index: int) -> int: ...
def set_user_otp_algorithm(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

oaHmac0
oaTime1

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_otp_value Property

The user's time interval (TOTP) or Counter (HOTP).

Syntax

def get_user_otp_value(user_index: int) -> int: ...
def set_user_otp_value(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

The user's time interval (TOTP) or Counter (HOTP).

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_password_len Property

Specifies the length of the user's OTP password.

Syntax

def get_user_password_len(user_index: int) -> int: ...
def set_user_password_len(user_index: int, value: int) -> None: ...

Default Value

0

Remarks

Specifies the length of the user's OTP 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_ssh_key Property

Contains the user's SSH key.

Syntax

def get_user_ssh_key(user_index: int) -> bytes: ...
def set_user_ssh_key(user_index: int, value: bytes) -> None: ...

Remarks

Contains the user's SSH key.

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

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.

get_client_buffer Method

Obtains a pending connection buffer.

Syntax

def get_client_buffer(connection_id: int) -> bytes: ...

Remarks

Use this method to obtain a pending connection buffer from your on_write_file event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

get_request_bytes Method

Returns the contents of the client's HTTP request.

Syntax

def get_request_bytes(connection_id: int, request_filter: str) -> bytes: ...

Remarks

Use this method to get the body of the client's HTTP request in your on_custom_request event handler. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

The RequestFilter parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

paramsRequest query parameters only.
params[Index]A specific request parameter, by index.
params['Name']A specific request parameter, by name.
parts[Index]The body of a particular part of a multipart message.

get_request_header Method

Returns a request header value.

Syntax

def get_request_header(connection_id: int, header_name: str) -> str: ...

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as on_before_lock_object or on_custom_request.

get_request_string Method

Returns the contents of the client's HTTP request.

Syntax

def get_request_string(connection_id: int, request_filter: str) -> str: ...

Remarks

Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty.

The RequestFilter parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

paramsRequest query parameters only.
params[Index]A specific request parameter, by index.
params['Name']A specific request parameter, by name.
parts[Index]The body of a particular part of a multipart message.

get_request_username Method

Returns the username for a connection.

Syntax

def get_request_username(connection_id: int) -> str: ...

Remarks

Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection.

get_response_header Method

Returns a response header value.

Syntax

def get_response_header(connection_id: int, header_name: str) -> str: ...

Remarks

Use this method to get the value of a response header. A good place to call this method is on_headers_prepared event. Call the method with empty HeaderName to get the whole response header.

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.

process_generic_request Method

Processes a generic HTTP request.

Syntax

def process_generic_request(connection_id: int, request_bytes: bytes) -> bytes: ...

Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. ConnectionId allows to identify the request in the events.

The method returns the complete HTTP response including HTTP headers.

set_client_buffer Method

Commits a data buffer to the connection.

Syntax

def set_client_buffer(connection_id: int, value: bytes) -> None: ...

Remarks

Use this method from your on_read_file event handler to commit a chunk of file data to the server component.

set_client_file_entry Method

Commits a file entry to the connection.

Syntax

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

Remarks

Use this method to commit a file details entry provided in client_file_entry property to ConnectionID connection. This method is supposed to be used from a on_find_next event handler.

Please note that events like on_find_next may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in client_file_entry.

set_response_bytes Method

Sets a byte array to be served as a response.

Syntax

def set_response_bytes(connection_id: int, bytes: bytes, content_type: str, response_filter: str) -> None: ...

Remarks

Use this property to provide the response content in a byte array when serving custom requests in your on_custom_request handler. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

parts[Index]The body of a particular part of a multipart response.

set_response_file Method

Sets a file to be served as a response.

Syntax

def set_response_file(connection_id: int, file_name: str, content_type: str, response_filter: str) -> None: ...

Remarks

Use this property to provide the response content in a file. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

parts[Index]The body of a particular part of a multipart response.

set_response_header Method

Sets a response header.

Syntax

def set_response_header(connection_id: int, header_name: str, value: str) -> bool: ...

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as on_lock_object or on_custom_request.

set_response_status Method

Sets an HTTP status to be sent with the response.

Syntax

def set_response_status(connection_id: int, status_code: int) -> None: ...

Remarks

Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as on_custom_request.

set_response_string Method

Sets a string to be served as a response.

Syntax

def set_response_string(connection_id: int, data_str: str, content_type: str, response_filter: str) -> None: ...

Remarks

Use this property to provide the response content in a string. The ResponseFilter parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is parts:

parts[Index]The body of a particular part of a multipart response.

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 WebDAVServerAcceptEventParams(object):
  @property
  def remote_address() -> str: ...

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

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

# In class WebDAVServer:
@property
def on_accept() -> Callable[[WebDAVServerAcceptEventParams], None]: ...
@on_accept.setter
def on_accept(event_hook: Callable[[WebDAVServerAcceptEventParams], 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_after_browse Event

WebDAVServer uses this event to notify the application about the completion of the browsing operation.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_after_browse() -> Callable[[WebDAVServerAfterBrowseEventParams], None]: ...
@on_after_browse.setter
def on_after_browse(event_hook: Callable[[WebDAVServerAfterBrowseEventParams], None]) -> None: ...

Remarks

The ConnectionID parameter identifies the client connection, and the Path parameter specifies the browsing path.

This event is typically fired after the on_before_browse event.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_copy_object Event

This event notifies the application about the completion of the copy operation.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_after_copy_object() -> Callable[[WebDAVServerAfterCopyObjectEventParams], None]: ...
@on_after_copy_object.setter
def on_after_copy_object(event_hook: Callable[[WebDAVServerAfterCopyObjectEventParams], None]) -> None: ...

Remarks

AfterCopyObject is typically preceded by on_before_copy_object and on_copy_object events. The OldPath and NewPath parameters contain the origin and destination names of the copied object.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_create_calendar Event

This event reports the completion of calendar creation request.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_after_create_calendar() -> Callable[[WebDAVServerAfterCreateCalendarEventParams], None]: ...
@on_after_create_calendar.setter
def on_after_create_calendar(event_hook: Callable[[WebDAVServerAfterCreateCalendarEventParams], None]) -> None: ...

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_create_collection Event

WebDAVServer uses this event to report completion of the collection creation operation.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_after_create_collection() -> Callable[[WebDAVServerAfterCreateCollectionEventParams], None]: ...
@on_after_create_collection.setter
def on_after_create_collection(event_hook: Callable[[WebDAVServerAfterCreateCollectionEventParams], None]) -> None: ...

Remarks

This event is preceded by on_before_create_collection and on_create_collection events. It lets you alter the operation status passed back to the client.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_custom_request Event

This event reports the completion of the custom request.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_after_custom_request() -> Callable[[WebDAVServerAfterCustomRequestEventParams], None]: ...
@on_after_custom_request.setter
def on_after_custom_request(event_hook: Callable[[WebDAVServerAfterCustomRequestEventParams], None]) -> None: ...

Remarks

Use this event to track the completion of an earlier reported custom request and adjust the operation status through the OperationStatus parameter as required.

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_lock_object Event

Reports the completion of the object locking operation.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_after_lock_object() -> Callable[[WebDAVServerAfterLockObjectEventParams], None]: ...
@on_after_lock_object.setter
def on_after_lock_object(event_hook: Callable[[WebDAVServerAfterLockObjectEventParams], None]) -> None: ...

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_refresh_lock Event

Reports the completion of the lock refresh operation.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_after_refresh_lock() -> Callable[[WebDAVServerAfterRefreshLockEventParams], None]: ...
@on_after_refresh_lock.setter
def on_after_refresh_lock(event_hook: Callable[[WebDAVServerAfterRefreshLockEventParams], None]) -> None: ...

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_remove_object Event

This event notifies the application about the completion of object deletion operation.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_after_remove_object() -> Callable[[WebDAVServerAfterRemoveObjectEventParams], None]: ...
@on_after_remove_object.setter
def on_after_remove_object(event_hook: Callable[[WebDAVServerAfterRemoveObjectEventParams], None]) -> None: ...

Remarks

This event follows on_before_remove_object and on_remove_object events. It is fired upon completion of the operation and lets you adjust the operation status if required:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_rename_object Event

The class uses this event to notify the application about the completion of the object rename operation.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_after_rename_object() -> Callable[[WebDAVServerAfterRenameObjectEventParams], None]: ...
@on_after_rename_object.setter
def on_after_rename_object(event_hook: Callable[[WebDAVServerAfterRenameObjectEventParams], None]) -> None: ...

Remarks

The OldPath and NewPath provide the old and new path of the renamed object respectively.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_set_attributes Event

WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_after_set_attributes() -> Callable[[WebDAVServerAfterSetAttributesEventParams], None]: ...
@on_after_set_attributes.setter
def on_after_set_attributes(event_hook: Callable[[WebDAVServerAfterSetAttributesEventParams], None]) -> None: ...

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_after_unlock_object Event

Notifies the application about the completion of the object unlocking operation.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_after_unlock_object() -> Callable[[WebDAVServerAfterUnlockObjectEventParams], None]: ...
@on_after_unlock_object.setter
def on_after_unlock_object(event_hook: Callable[[WebDAVServerAfterUnlockObjectEventParams], None]) -> None: ...

Remarks

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_auth_attempt Event

Fires when a connected client makes an authentication attempt.

Syntax

class WebDAVServerAuthAttemptEventParams(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 WebDAVServer:
@property
def on_auth_attempt() -> Callable[[WebDAVServerAuthAttemptEventParams], None]: ...
@on_auth_attempt.setter
def on_auth_attempt(event_hook: Callable[[WebDAVServerAuthAttemptEventParams], 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_before_browse Event

Fires when a Browse request is received.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_browse() -> Callable[[WebDAVServerBeforeBrowseEventParams], None]: ...
@on_before_browse.setter
def on_before_browse(event_hook: Callable[[WebDAVServerBeforeBrowseEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application that a Browse request has been received from the client. The Path parameter contains the path parameter from the request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a series of events that request the details of the object residing at Path: on_list_attributes, on_list_sub_objects, and on_read_attribute.

on_before_copy_object Event

Fires when a Copy Object request is received.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_before_copy_object() -> Callable[[WebDAVServerBeforeCopyObjectEventParams], None]: ...
@on_before_copy_object.setter
def on_before_copy_object(event_hook: Callable[[WebDAVServerBeforeCopyObjectEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application that a Copy Object request was received. The OldPath and NewPath parameters specify the source and destination paths for the object to be copied. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_copy_object call, allowing you to virtualize the copy operation.

on_before_create_calendar Event

Fires when a Create Calendar request is received from a client.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_create_calendar() -> Callable[[WebDAVServerBeforeCreateCalendarEventParams], None]: ...
@on_before_create_calendar.setter
def on_before_create_calendar(event_hook: Callable[[WebDAVServerBeforeCreateCalendarEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received Create Calendar request. The Path parameter specifies the location of the new calendar. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_create_calendar call, allowing you to virtualize the calendar creation operation.

on_before_create_collection Event

Fires when a Create Collection request is received from a client.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_create_collection() -> Callable[[WebDAVServerBeforeCreateCollectionEventParams], None]: ...
@on_before_create_collection.setter
def on_before_create_collection(event_hook: Callable[[WebDAVServerBeforeCreateCollectionEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application about an incoming collection creation request. The Path parameter advises on the location of the new collection. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_create_collection call.

on_before_custom_request Event

Notifies the application about an incoming custom request.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_before_custom_request() -> Callable[[WebDAVServerBeforeCustomRequestEventParams], None]: ...
@on_before_custom_request.setter
def on_before_custom_request(event_hook: Callable[[WebDAVServerBeforeCustomRequestEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the user code about an incoming custom request (a generic request, unknown to the server, and not covered by the other handlers). The RequestMethod parameter specifies the HTTP request method used (GET, POST, PUT, ...), and Path indicates the requested path. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_custom_request call, allowing you to respond to the request.

on_before_download_object Event

Fires when an object download request is received.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_download_object() -> Callable[[WebDAVServerBeforeDownloadObjectEventParams], None]: ...
@on_before_download_object.setter
def on_before_download_object(event_hook: Callable[[WebDAVServerBeforeDownloadObjectEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about an incoming object download request. The Path parameter contains the path of the requested object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by on_download_object, on_read_object, and on_download_object_completed calls, allowing you to supply the object data to the client.

on_before_lock_object Event

Fires when a lock request is received.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_lock_object() -> Callable[[WebDAVServerBeforeLockObjectEventParams], None]: ...
@on_before_lock_object.setter
def on_before_lock_object(event_hook: Callable[[WebDAVServerBeforeLockObjectEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application that an object lock request was received. The Path parameter contains the path to be locked. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_lock_object call which expects you to perform the locking as required.

on_before_refresh_lock Event

Reports the receipt of lock refresh request.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_refresh_lock() -> Callable[[WebDAVServerBeforeRefreshLockEventParams], None]: ...
@on_before_refresh_lock.setter
def on_before_refresh_lock(event_hook: Callable[[WebDAVServerBeforeRefreshLockEventParams], None]) -> None: ...

Remarks

Use this event to be notified about refresh requests for existing locks. The Path parameter contains the path on which to refresh the lock. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_refresh_lock call, allowing you to virtualize the operation.

on_before_remove_object Event

Fires when an object deletion request is received.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_remove_object() -> Callable[[WebDAVServerBeforeRemoveObjectEventParams], None]: ...
@on_before_remove_object.setter
def on_before_remove_object(event_hook: Callable[[WebDAVServerBeforeRemoveObjectEventParams], None]) -> None: ...

Remarks

Use this event to track object deletion requests. The Path parameter contains the path of the object to be deleted. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_remove_object call, allowing you to virtualize the deletion operation.

on_before_rename_object Event

Reports object renaming requests.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_before_rename_object() -> Callable[[WebDAVServerBeforeRenameObjectEventParams], None]: ...
@on_before_rename_object.setter
def on_before_rename_object(event_hook: Callable[[WebDAVServerBeforeRenameObjectEventParams], None]) -> None: ...

Remarks

The server uses this event to notify the application about incoming object rename requests. OldPath and NewPath contain the existing and the new path for the object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_rename_object call, where your code is expected to perform the renaming operation.

on_before_request Event

Fires before a DAV request is processed.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_before_request() -> Callable[[WebDAVServerBeforeRequestEventParams], None]: ...
@on_before_request.setter
def on_before_request(event_hook: Callable[[WebDAVServerBeforeRequestEventParams], None]) -> None: ...

Remarks

This event fires before an incoming request is processed. ConnectionID indicates the client's unique connection ID; HTTPMethod specifies the HTTP method being used to submit the request, and URL signifies the object's URL.

Use Accept parameter to accept or reject the request.

on_before_set_attributes Event

Notifies the application about attribute change request.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_set_attributes() -> Callable[[WebDAVServerBeforeSetAttributesEventParams], None]: ...
@on_before_set_attributes.setter
def on_before_set_attributes(event_hook: Callable[[WebDAVServerBeforeSetAttributesEventParams], None]) -> None: ...

Remarks

Use this event to react to object attributes change requests. The Path parameter contains the object path. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a series of on_set_attribute and/or on_clear_attribute calls, for each attribute to be set or cleared.

on_before_unlock_object Event

Fires when an unlock request is received.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_unlock_object() -> Callable[[WebDAVServerBeforeUnlockObjectEventParams], None]: ...
@on_before_unlock_object.setter
def on_before_unlock_object(event_hook: Callable[[WebDAVServerBeforeUnlockObjectEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application about the received unlock request. The Path parameter contains the path to be unlocked. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by a on_unlock_object call.

on_before_upload_object Event

Fires when an object upload request is received.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_before_upload_object() -> Callable[[WebDAVServerBeforeUploadObjectEventParams], None]: ...
@on_before_upload_object.setter
def on_before_upload_object(event_hook: Callable[[WebDAVServerBeforeUploadObjectEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about an incoming object upload request. The Path parameter contains the path of the requested object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:

fraAuto1Handle the requested action automatically by the server

fraCustom2Override the action using the user code logic

fraAbort3Abort the requested action

If fraCustom Action is chosen, this event will be followed by on_upload_object, on_write_object, and on_upload_object_completed calls, allowing your code to process/store the object data.

on_clear_attribute Event

Reports an attribute clearance request.

Syntax

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

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

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

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

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

# In class WebDAVServer:
@property
def on_clear_attribute() -> Callable[[WebDAVServerClearAttributeEventParams], None]: ...
@on_clear_attribute.setter
def on_clear_attribute(event_hook: Callable[[WebDAVServerClearAttributeEventParams], None]) -> None: ...

Remarks

This event fires to notify the application about an attribute clearance (removal) request. Use this handler to respond to this request by making the necessary changes to the locally stored resource attributes. The ConnectionID specifies the unique client ID, Path contains the resource path, and the NS:Name pair specifies the attribute to be cleared.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_connect Event

Reports an accepted connection.

Syntax

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

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

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

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

Remarks

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_get_request or on_auth_attempt.

on_copy_object Event

Lets the application handle the Copy Object request.

Syntax

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

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

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

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

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

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

# In class WebDAVServer:
@property
def on_copy_object() -> Callable[[WebDAVServerCopyObjectEventParams], None]: ...
@on_copy_object.setter
def on_copy_object(event_hook: Callable[[WebDAVServerCopyObjectEventParams], None]) -> None: ...

Remarks

Use this event handler to respond to the received Copy Object request by creating a copy of OldPath resource at NewPath.

ConnectionID specifies the unique client connection identifier, Overwrite indicates whether any existing resource(s) should be overwritten, and Depth specifies the depth of the resource tree to be copied.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_create_calendar Event

Lets the application handle a calendar creation request.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_create_calendar() -> Callable[[WebDAVServerCreateCalendarEventParams], None]: ...
@on_create_calendar.setter
def on_create_calendar(event_hook: Callable[[WebDAVServerCreateCalendarEventParams], None]) -> None: ...

Remarks

Use this method to respond to a calendar creation request with a custom action. This event fires if fraCustom action was returned from the preceding on_before_create_calendar call.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_create_collection Event

Lets the application respond to collection creation request.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_create_collection() -> Callable[[WebDAVServerCreateCollectionEventParams], None]: ...
@on_create_collection.setter
def on_create_collection(event_hook: Callable[[WebDAVServerCreateCollectionEventParams], None]) -> None: ...

Remarks

The class uses this event to let the application respond to collection creation requests. This event fires if fraCustom action was returned from the preceding on_before_create_collection call. The handler of this event is expected to create a new collection at Path.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_custom_request Event

Use this event to respond to non-standard DAV requests.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_custom_request() -> Callable[[WebDAVServerCustomRequestEventParams], None]: ...
@on_custom_request.setter
def on_custom_request(event_hook: Callable[[WebDAVServerCustomRequestEventParams], None]) -> None: ...

Remarks

This event allows the application to respond in a virtualized manner to non-standard DAV requests. It will fire if fraCustom action was selected in the earlier on_before_custom_request call.

The RequestMethod specifies the HTTP method used for this request (GET, PUT, POST etc.), and the Path contains the requested path.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_data Event

Supplies a data chunk received from a client.

Syntax

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

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

# In class WebDAVServer:
@property
def on_data() -> Callable[[WebDAVServerDataEventParams], None]: ...
@on_data.setter
def on_data(event_hook: Callable[[WebDAVServerDataEventParams], None]) -> None: ...

Remarks

This event is fired to supply another piece of data received from a client. This event may fire multiple times.

on_disconnect Event

Fires to report a disconnected client.

Syntax

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

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

Remarks

class fires this event when a connected client disconnects.

on_download_object Event

Allows the application respond to Download Object request.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_download_object() -> Callable[[WebDAVServerDownloadObjectEventParams], None]: ...
@on_download_object.setter
def on_download_object(event_hook: Callable[[WebDAVServerDownloadObjectEventParams], None]) -> None: ...

Remarks

Use this event to implement custom handler of the Download operation. This event is followed by a series of on_read_object calls, which are then followed by on_download_object_completed that signifies completion of the transfer operation.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_download_object_completed Event

This event is fired when a download operation completes.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_download_object_completed() -> Callable[[WebDAVServerDownloadObjectCompletedEventParams], None]: ...
@on_download_object_completed.setter
def on_download_object_completed(event_hook: Callable[[WebDAVServerDownloadObjectCompletedEventParams], None]) -> None: ...

Remarks

This event is fired when a download operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with on_before_download_file event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_error() -> Callable[[WebDAVServerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[WebDAVServerErrorEventParams], 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 WebDAVServerExternalSignEventParams(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 WebDAVServer:
@property
def on_external_sign() -> Callable[[WebDAVServerExternalSignEventParams], None]: ...
@on_external_sign.setter
def on_external_sign(event_hook: Callable[[WebDAVServerExternalSignEventParams], 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_file_error Event

Reports a file access error to the application.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_file_error() -> Callable[[WebDAVServerFileErrorEventParams], None]: ...
@on_file_error.setter
def on_file_error(event_hook: Callable[[WebDAVServerFileErrorEventParams], None]) -> None: ...

Remarks

class uses this event to report a file access errors. FileName and ErrorCode contain the file path and the error code respectively.

on_headers_prepared Event

Fires when the response headers have been formed and are ready to be sent to the server.

Syntax

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

# In class WebDAVServer:
@property
def on_headers_prepared() -> Callable[[WebDAVServerHeadersPreparedEventParams], None]: ...
@on_headers_prepared.setter
def on_headers_prepared(event_hook: Callable[[WebDAVServerHeadersPreparedEventParams], None]) -> None: ...

Remarks

The class fires this event when the response headers are ready to be sent to the server. ConnectionID indicates the connection that processed the request.

Use get_response_header method with an empty header name to get the whole response header.

on_list_attributes Event

Requests object attributes from the application in fraCustom handling mode.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_list_attributes() -> Callable[[WebDAVServerListAttributesEventParams], None]: ...
@on_list_attributes.setter
def on_list_attributes(event_hook: Callable[[WebDAVServerListAttributesEventParams], None]) -> None: ...

Remarks

The class uses this event to request a set of attributes supported/kept for the object at Path. Return the list via the Attributes parameter as a string of CRLF-separated attribute names.

After firing this event, the class may request values for individual attributes via a series of on_read_attribute calls.

This event only fires if fraCustom action type was returned from the preceding on_before_browse event call.

on_list_sub_objects Event

Requests a list of sub-objects of an object. The class uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF.

Syntax

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

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

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

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

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

# In class WebDAVServer:
@property
def on_list_sub_objects() -> Callable[[WebDAVServerListSubObjectsEventParams], None]: ...
@on_list_sub_objects.setter
def on_list_sub_objects(event_hook: Callable[[WebDAVServerListSubObjectsEventParams], None]) -> None: ...

Remarks

Set the status of the operation through the OperationStatus parameter as required:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_lock_object Event

Virtualizes the object locking operation.

Syntax

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

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

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

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

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

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

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

# In class WebDAVServer:
@property
def on_lock_object() -> Callable[[WebDAVServerLockObjectEventParams], None]: ...
@on_lock_object.setter
def on_lock_object(event_hook: Callable[[WebDAVServerLockObjectEventParams], None]) -> None: ...

Remarks

The class uses this event to request a lock on the object at Path from the application. This event is only fired if fraCustom action was returned from the preceding on_before_lock_object call.

The Owner, Exclusive, Depth, and Timeout parameters specify the respective parameters of the requested lock. In response to this event, generate a lock token and return it via the Token parameter.

on_notification Event

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

Syntax

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

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

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

Reflects a quota enquiry by a client.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_query_quota() -> Callable[[WebDAVServerQueryQuotaEventParams], None]: ...
@on_query_quota.setter
def on_query_quota(event_hook: Callable[[WebDAVServerQueryQuotaEventParams], None]) -> None: ...

Remarks

This event fires in response to a client's enquire about their quota status. Subscribe to this event to react to such enquiries in a customized manner. Use Available and Used properties to report the respective amounts back to the client.

on_read_attribute Event

Requests value of an attribute from the application in fraCustom mode.

Syntax

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

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

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

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

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

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

# In class WebDAVServer:
@property
def on_read_attribute() -> Callable[[WebDAVServerReadAttributeEventParams], None]: ...
@on_read_attribute.setter
def on_read_attribute(event_hook: Callable[[WebDAVServerReadAttributeEventParams], None]) -> None: ...

Remarks

The class fires this event to request value of the NS:Name attribute of the object residing at Path. In the event handler, pass the attribute value via the Value parameter and set OperationStatus as required.

This event only fires if fraCustom action type was returned from the preceding on_before_browse event call.

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_read_object Event

Requests a piece of object data from the application.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_read_object() -> Callable[[WebDAVServerReadObjectEventParams], None]: ...
@on_read_object.setter
def on_read_object(event_hook: Callable[[WebDAVServerReadObjectEventParams], None]) -> None: ...

Remarks

The class fires this event repeatedly during an overridden download operation to request object data from the application.

The handler of this event should read up to Size bytes from the downloaded object, and pass them to the component with a set_client_buffer call.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_refresh_lock Event

Notifies the application about a lock refresh request.

Syntax

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

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

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

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

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

# In class WebDAVServer:
@property
def on_refresh_lock() -> Callable[[WebDAVServerRefreshLockEventParams], None]: ...
@on_refresh_lock.setter
def on_refresh_lock(event_hook: Callable[[WebDAVServerRefreshLockEventParams], None]) -> None: ...

Remarks

The class uses this event to request extension of a lock on the object at Path. This event only fires if fraCustom action was returned from the preceding on_before_refresh_lock call.

In response to this event, check the validity of the provided Token for the object at Path, and extend the lock by Timeout milliseconds if the values match. Set the LockFound result as required.

on_remove_object Event

Notifies the application about object deletion requests.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_remove_object() -> Callable[[WebDAVServerRemoveObjectEventParams], None]: ...
@on_remove_object.setter
def on_remove_object(event_hook: Callable[[WebDAVServerRemoveObjectEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application about an incoming deletion request for the object at Path. This event only fires if fraCustom action was returned from the preceding on_before_remove_object call.

The handler of this event should remove the object, if appropriate, and set the OperationStatus parameter to signify the actual operation result.

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_rename_object Event

Notifies the application about object name change requests.

Syntax

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

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

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

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

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

# In class WebDAVServer:
@property
def on_rename_object() -> Callable[[WebDAVServerRenameObjectEventParams], None]: ...
@on_rename_object.setter
def on_rename_object(event_hook: Callable[[WebDAVServerRenameObjectEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application about an incoming rename request for the object at OldPath. The Overwrite parameter advises whether any objects currently existing at NewPath should be overwritten. This event only fires if fraCustom action was returned from the preceding on_before_rename_object call.

The handler of this event should rename the object to NewPath (if appropriate) and set the OperationStatus parameter to signify the actual operation result.

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_resource_access Event

Reports an attempt to access a resource.

Syntax

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

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

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

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

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

# In class WebDAVServer:
@property
def on_resource_access() -> Callable[[WebDAVServerResourceAccessEventParams], None]: ...
@on_resource_access.setter
def on_resource_access(event_hook: Callable[[WebDAVServerResourceAccessEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a request received from the client. The HTTPMethod parameter indicates the HTTP method used (GET, POST, etc.)

ConnectionID indicates the connection that sent the request and URI suggests the requested resource.

Set Allow to false to prevent the client from accessing the resource. The class will automatically send a "forbidden" status code (403).

Set a non-empty value to RedirectURI to notify the client that the resource has moved to another place. The class will automatically send a "found" status code (302). If Allow is set to false, the value of RedirectURI is ignored.

on_set_attribute Event

Lets the application customize attribute assignment requests.

Syntax

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

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

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

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

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

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

# In class WebDAVServer:
@property
def on_set_attribute() -> Callable[[WebDAVServerSetAttributeEventParams], None]: ...
@on_set_attribute.setter
def on_set_attribute(event_hook: Callable[[WebDAVServerSetAttributeEventParams], None]) -> None: ...

Remarks

The class uses this event to pass attribute assignment requests to the application. This event may fire multiple times after a on_before_set_attributes call, one for each attribute, if fraCustom action was chosen.

In the handler of this event, assign Value to the attribute NS:Name of the object at Path. Set OperationStatus in accordance with the outcome of the operation.

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_tls_cert_validate Event

Fires when a client certificate needs to be validated.

Syntax

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

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

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

Remarks

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 WebDAVServerTLSEstablishedEventParams(object):
  @property
  def connection_id() -> int: ...

# In class WebDAVServer:
@property
def on_tls_established() -> Callable[[WebDAVServerTLSEstablishedEventParams], None]: ...
@on_tls_established.setter
def on_tls_established(event_hook: Callable[[WebDAVServerTLSEstablishedEventParams], 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 WebDAVServerTLSHandshakeEventParams(object):
  @property
  def connection_id() -> int: ...

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

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

# In class WebDAVServer:
@property
def on_tls_handshake() -> Callable[[WebDAVServerTLSHandshakeEventParams], None]: ...
@on_tls_handshake.setter
def on_tls_handshake(event_hook: Callable[[WebDAVServerTLSHandshakeEventParams], 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 WebDAVServerTLSPSKEventParams(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 WebDAVServer:
@property
def on_tls_psk() -> Callable[[WebDAVServerTLSPSKEventParams], None]: ...
@on_tls_psk.setter
def on_tls_psk(event_hook: Callable[[WebDAVServerTLSPSKEventParams], 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 WebDAVServerTLSShutdownEventParams(object):
  @property
  def connection_id() -> int: ...

# In class WebDAVServer:
@property
def on_tls_shutdown() -> Callable[[WebDAVServerTLSShutdownEventParams], None]: ...
@on_tls_shutdown.setter
def on_tls_shutdown(event_hook: Callable[[WebDAVServerTLSShutdownEventParams], 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_unlock_object Event

Virtualizes the object unlocking operation.

Syntax

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

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

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

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

# In class WebDAVServer:
@property
def on_unlock_object() -> Callable[[WebDAVServerUnlockObjectEventParams], None]: ...
@on_unlock_object.setter
def on_unlock_object(event_hook: Callable[[WebDAVServerUnlockObjectEventParams], None]) -> None: ...

Remarks

The class uses this event to notify the application of the incoming unlock request. This event only fires if fraCustom action was returned from the preceding on_before_unlock_object call.

In response to this event, check the validity of the provided Token for the object at Path, and cancel the lock if the values match. Set the LockFound result as required.

on_upload_object Event

Lets the application respond to the Upload Object request.

Syntax

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

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

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

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

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

# In class WebDAVServer:
@property
def on_upload_object() -> Callable[[WebDAVServerUploadObjectEventParams], None]: ...
@on_upload_object.setter
def on_upload_object(event_hook: Callable[[WebDAVServerUploadObjectEventParams], None]) -> None: ...

Remarks

Use this event handler to respond to the received Upload Object request by reserving a place for the new object at Path. This event, if OperationStatus allows, will be followed by a series of on_write_object calls, passing object data in chunks, before a on_upload_object_completed call signals completion of the upload operation.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_upload_object_completed Event

This event is fired when a upload operation completes.

Syntax

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

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

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

# In class WebDAVServer:
@property
def on_upload_object_completed() -> Callable[[WebDAVServerUploadObjectCompletedEventParams], None]: ...
@on_upload_object_completed.setter
def on_upload_object_completed(event_hook: Callable[[WebDAVServerUploadObjectCompletedEventParams], None]) -> None: ...

Remarks

This event is fired when a upload operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with on_before_upload_file event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

on_write_object Event

Hands a piece of object data to the application.

Syntax

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

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

# In class WebDAVServer:
@property
def on_write_object() -> Callable[[WebDAVServerWriteObjectEventParams], None]: ...
@on_write_object.setter
def on_write_object(event_hook: Callable[[WebDAVServerWriteObjectEventParams], None]) -> None: ...

Remarks

The class fires this event repeatedly during an overridden upload operation to pass object data to the application.

The handler of this event should retrieve the pending data buffer with a get_client_buffer call, and write it to the end of the object that is being uploaded.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:

ostOk1
ostNoSuchFile2
ostAccessDenied3
ostWriteProtect4
ostUnsupported5
ostInvalidParameter6
ostEOF7

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

WebDAVServer Config Settings

ClientAuth:   Enables or disables certificate-based client authentication.

Set this property to one of the below values to tune up the client authentication logic:

0No client authentication (the default setting)
1Request certificates. The server will ask connecting clients for their certificates. Non-authenticated client connections will be accepted anyway.
2Require certificates. The server will ask connecting clients for their certificates. If a client fails to provide a certificate, the server will terminate the connection.

If this property is set to 1 or 2, the component will request certificates from the connecting clients. Depending on the setting, the clients that fail to provide their certificate in response will be allowed or disallowed to proceed with the connection. The server signals about a received certificate by firing its on_certificate_validate event. Use pin_client method in the event handler to pin the client details, and access the provided certificate chain via the pinned_client_chain property.

Note that this event is fired from the connecting clients threads, so please make sure you avoid bottlenecks in the event handler and put appropriate thread safety measures in place.

Unlike the client-side components, the server component does not perform automated certificate validation against the local security policy. You must perform appropriate certificate validation steps in your on_certificate_validate event handler.

DualStack:   Allows the use of ip4 and ip6 simultaneously.

This setting specifies a socket can use ip4 and ip6 simultaneously.

Host:   The host to bind to.

Specifies a specific interface the server should listen on.

ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

WebsiteName:   The website name for the TLS certificate.

Assign this property with a name to put in a self-generated TLS certificate.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

WebDAVServer Errors

WebDAVServer Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)