FTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The FTPServer class provides server-side functionality for FTP and FTPS protocols.

Syntax

class secureblackbox.FTPServer

Remarks

FTPServer supports FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations on the server over Transport Layer Security (TLS). TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

active Property

Whether the server is active and can accept incoming connections.

Syntax

def get_active() -> bool: ...

active = property(get_active, None)

Default Value

FALSE

Remarks

This read-only property returns True if the FTPS server is running and listening for incoming connections, and False otherwise.

This property is read-only.

allow_anonymous Property

Allows and disallows anonymous connections.

Syntax

def get_allow_anonymous() -> bool: ...
def set_allow_anonymous(value: bool) -> None: ...

allow_anonymous = property(get_allow_anonymous, set_allow_anonymous)

Default Value

FALSE

Remarks

Use this property to enable and disable support for anonymous connections.

client_file_entry_entry_format Property

The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 .

Syntax

def get_client_file_entry_entry_format() -> int: ...
def set_client_file_entry_entry_format(value: int) -> None: ...

client_file_entry_entry_format = property(get_client_file_entry_entry_format, set_client_file_entry_entry_format)

Default Value

0

Remarks

The file listing format:

client_file_entry_file_date Property

Specifies the creation and/or last modification times for the file entry.

Syntax

def get_client_file_entry_file_date() -> str: ...
def set_client_file_entry_file_date(value: str) -> None: ...

client_file_entry_file_date = property(get_client_file_entry_file_date, set_client_file_entry_file_date)

Default Value

""

Remarks

Specifies the creation and/or last modification times for the file entry.

When used on the server side, you can provide both the creation and last modification times by separating the two values with a semicolon:

Entry.FileDate = "2023-01-01 12:34:56.789;2023-06-30 11:15:15.123";

Where only one entry is provided, it specifies the creation time of the file:

Entry.FileDate = "2023-01-01 12:34:56.789";

client_file_entry_file_type Property

The type of the entry: cfetUnknown 0 cfetDirectory 1 cfetFile 2 cfetSymlink 3 cfetSpecial 4 cfetCurrentDirectory 5 cfetParentDirectory 6 .

Syntax

def get_client_file_entry_file_type() -> int: ...
def set_client_file_entry_file_type(value: int) -> None: ...

client_file_entry_file_type = property(get_client_file_entry_file_type, set_client_file_entry_file_type)

Default Value

0

Remarks

The type of the entry:

client_file_entry_handle Property

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

Syntax

def get_client_file_entry_handle() -> int: ...
def set_client_file_entry_handle(value: int) -> None: ...

client_file_entry_handle = property(get_client_file_entry_handle, set_client_file_entry_handle)

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

client_file_entry_name Property

The file or directory name.

Syntax

def get_client_file_entry_name() -> str: ...
def set_client_file_entry_name(value: str) -> None: ...

client_file_entry_name = property(get_client_file_entry_name, set_client_file_entry_name)

Default Value

""

Remarks

The file or directory name.

client_file_entry_path Property

The full path to the file or directory.

Syntax

def get_client_file_entry_path() -> str: ...
def set_client_file_entry_path(value: str) -> None: ...

client_file_entry_path = property(get_client_file_entry_path, set_client_file_entry_path)

Default Value

""

Remarks

The full path to the file or directory.

client_file_entry_raw_data Property

The unparsed entry as returned by the server.

Syntax

def get_client_file_entry_raw_data() -> str: ...
def set_client_file_entry_raw_data(value: str) -> None: ...

client_file_entry_raw_data = property(get_client_file_entry_raw_data, set_client_file_entry_raw_data)

Default Value

""

Remarks

The unparsed entry as returned by the server.

client_file_entry_size Property

File size 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

File size in bytes.

data_host Property

Host address for incoming data channel connections.

Syntax

def get_data_host() -> str: ...
def set_data_host(value: str) -> None: ...

data_host = property(get_data_host, set_data_host)

Default Value

""

Remarks

Use this property to specify the address for incoming data channel connections, if it is different to host.

In some network environments, in particular, where the server is behind a NAT, there may be a requirement to use a different host address for data connections.

data_port_range_from Property

Specifies the lower port range bound for passive mode data connections.

Syntax

def get_data_port_range_from() -> int: ...
def set_data_port_range_from(value: int) -> None: ...

data_port_range_from = property(get_data_port_range_from, set_data_port_range_from)

Default Value

0

Remarks

Use this property in combination with DataPortRangeT to limit the port range for passive mode data connections. The value of 0 (zero) stands for no lower bound.

data_port_range_to Property

Specifies the upper port range bound for passive mode data connections.

Syntax

def get_data_port_range_to() -> int: ...
def set_data_port_range_to(value: int) -> None: ...

data_port_range_to = property(get_data_port_range_to, set_data_port_range_to)

Default Value

0

Remarks

Use this property in combination with DataPortRangeFrom to limit the port range for passive mode data connections. The value of 0 (zero) stands for no upper bound.

external_crypto_async_document_id Property

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

Syntax

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

external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id)

Default Value

""

Remarks

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

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

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

external_crypto_custom_params Property

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

Syntax

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

external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params)

Default Value

""

Remarks

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

external_crypto_data Property

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

Syntax

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

external_crypto_data = property(get_external_crypto_data, set_external_crypto_data)

Default Value

""

Remarks

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

external_crypto_external_hash_calculation Property

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

Syntax

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

external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation)

Default Value

FALSE

Remarks

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

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

external_crypto_hash_algorithm Property

Specifies the request's signature hash algorithm.

Syntax

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

external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm)

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

external_crypto_key_id Property

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

Syntax

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

external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id)

Default Value

""

Remarks

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

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

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

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

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

external_crypto_key_secret Property

The pre-shared key used for DC request authentication.

Syntax

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

external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret)

Default Value

""

Remarks

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

Read more about configuring authentication in the external_crypto_key_id topic.

external_crypto_method Property

Specifies the asynchronous signing method.

Syntax

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

external_crypto_method = property(get_external_crypto_method, set_external_crypto_method)

Default Value

0

Remarks

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

Available options:

external_crypto_mode Property

Specifies the external cryptography mode.

Syntax

def get_external_crypto_mode() -> int: ...
def set_external_crypto_mode(value: int) -> None: ...

external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode)

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

external_crypto_public_key_algorithm Property

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

Syntax

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

external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm)

Default Value

""

Remarks

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

fips_mode Property

Reserved.

Syntax

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

fips_mode = property(get_fips_mode, set_fips_mode)

Default Value

FALSE

Remarks

This property is reserved for future use.

handshake_timeout Property

Specifies the handshake timeout in milliseconds.

Syntax

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

handshake_timeout = property(get_handshake_timeout, set_handshake_timeout)

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

host Property

Specifies the server host.

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 for incoming FTP connections. Use port to specify the listening port number.

implicit_ssl Property

Enables or disables implicit SSL mode.

Syntax

def get_implicit_ssl() -> bool: ...
def set_implicit_ssl(value: bool) -> None: ...

implicit_ssl = property(get_implicit_ssl, set_implicit_ssl)

Default Value

FALSE

Remarks

The server can only work in one mode, explicit or implicit. Explicit mode, also called AUTH TLS, supports both TLS and plain connections. Implicit mode, also called 'dedicated port mode,' only supports TLS connections.

passive_mode_host Property

The IP address of the passive mode host.

Syntax

def get_passive_mode_host() -> str: ...
def set_passive_mode_host(value: str) -> None: ...

passive_mode_host = property(get_passive_mode_host, set_passive_mode_host)

Default Value

""

Remarks

Use this property to specify the address on which to listen for passive mode connections.

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:

This property is read-only.

pinned_client_chain_validation_result Property

The outcome of a certificate chain validation routine.

Syntax

def get_pinned_client_chain_validation_result() -> int: ...

pinned_client_chain_validation_result = property(get_pinned_client_chain_validation_result, None)

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

pinned_client_ciphersuite Property

The cipher suite employed by this connection.

Syntax

def get_pinned_client_ciphersuite() -> str: ...

pinned_client_ciphersuite = property(get_pinned_client_ciphersuite, None)

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only.

pinned_client_client_authenticated Property

Specifies whether client authentication was performed during this connection.

Syntax

def get_pinned_client_client_authenticated() -> bool: ...

pinned_client_client_authenticated = property(get_pinned_client_client_authenticated, None)

Default Value

FALSE

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

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

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

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

This property is read-only.

pinned_client_cert_bytes Property

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

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

This property is read-only.

pinned_client_cert_ca_key_id Property

A unique identifier (fingerprint) of the CA certificate's 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_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_handle Property

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

Syntax

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

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

This property is read-only.

pinned_client_cert_issuer Property

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

Syntax

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

Default Value

""

Remarks

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

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.

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:

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

The port number to listen for incoming connections on.

Syntax

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

port = property(get_port, set_port)

Default Value

21

Remarks

Use this property to specify the port number to listen for incoming connections on.

read_only Property

Makes the server's file system read-only for all users.

Syntax

def get_read_only() -> bool: ...
def set_read_only(value: bool) -> None: ...

read_only = property(get_read_only, set_read_only)

Default Value

FALSE

Remarks

Set this property to true to present the server's file system as read-only for all connecting users.

root_directory Property

Specifies the server's root directory.

Syntax

def get_root_directory() -> str: ...
def set_root_directory(value: str) -> None: ...

root_directory = property(get_root_directory, set_root_directory)

Default Value

""

Remarks

Use this property to specify the shared root directory for all client sessions.

security_options Property

Various options of the secure connection.

Syntax

def get_security_options() -> int: ...
def set_security_options(value: int) -> None: ...

security_options = property(get_security_options, set_security_options)

Default Value

63

Remarks

Various options of the secure connection:

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:

• server_cert_bytes
• server_cert_handle

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.

session_timeout Property

Specifies the session timeout in milliseconds.

Syntax

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

session_timeout = property(get_session_timeout, set_session_timeout)

Default Value

360000

Remarks

Specifies the maximum inactivity time (in milliseconds) after which the session will be forcebly closed.

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.

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:

tls_revocation_check Property

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

Syntax

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

tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check)

Default Value

1

Remarks

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

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

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

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

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

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

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

tls_ssl_options Property

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

Syntax

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

tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options)

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

tls_tls_mode Property

Specifies the TLS mode to use.

Syntax

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

tls_tls_mode = property(get_tls_tls_mode, set_tls_tls_mode)

Default Value

0

Remarks

Specifies the TLS mode to use.

tls_use_extended_master_secret Property

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

Syntax

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

tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret)

Default Value

FALSE

Remarks

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

tls_use_session_resumption Property

Enables or disables the TLS session resumption capability.

Syntax

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

tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption)

Default Value

FALSE

Remarks

Enables or disables the TLS session resumption capability.

tls_versions Property

The SSL/TLS versions to enable by default.

Syntax

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

tls_versions = property(get_tls_versions, set_tls_versions)

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

user_count Property

The number of records in the User arrays.

Syntax

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

user_count = property(get_user_count, set_user_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

user_associated_data Property

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

Syntax

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

Remarks

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

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

user_base_path Property

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

user_incoming_speed_limit Property

Specifies the incoming speed limit for this user.

Syntax

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

Default Value

0

Remarks

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

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

user_outgoing_speed_limit Property

Specifies the outgoing speed limit for this user.

Syntax

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

Default Value

0

Remarks

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

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

user_password Property

The user's authentication password.

Syntax

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

Default Value

""

Remarks

The user's authentication password.

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

user_shared_secret Property

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

Syntax

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

Remarks

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

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

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

user_username Property

The registered name (login) of the user.

Syntax

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

Default Value

""

Remarks

The registered name (login) of the user.

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

use_utf8 Property

Enables or disables UTF8 file name conversions.

Syntax

def get_use_utf8() -> bool: ...
def set_use_utf8(value: bool) -> None: ...

use_utf8 = property(get_use_utf8, set_use_utf8)

Default Value

TRUE

Remarks

Use this property to enable and disable UTF8 file name conversion. The server typically adjusts to the right setting automatically, but you may use this property to enforce the needed behaviour.

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.

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.

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.

start Method

Starts the server.

Syntax

def start() -> None: ...

Remarks

Call this method to start listening for incoming connections on port port. Call stop to deactivate the server.

stop Method

Stops the server.

Syntax

def stop() -> None: ...

Remarks

Call this method to terminate all active sessions and stop listening for new incoming connections.

on_accept Event

Reports an incoming connection.

Syntax

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

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

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

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

Signals the completion of a directory change operation.

Syntax

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

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

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

# In class FTPServer:
@property
def on_after_change_directory() -> Callable[[FTPServerAfterChangeDirectoryEventParams], None]: ...
@on_after_change_directory.setter
def on_after_change_directory(event_hook: Callable[[FTPServerAfterChangeDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event upon completion of a directory change operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

on_after_create_directory Event

Signals the completion of a directory creation operation.

Syntax

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

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

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

# In class FTPServer:
@property
def on_after_create_directory() -> Callable[[FTPServerAfterCreateDirectoryEventParams], None]: ...
@on_after_create_directory.setter
def on_after_create_directory(event_hook: Callable[[FTPServerAfterCreateDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event upon completion of a directory creation operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

on_after_remove_directory Event

Signals the completion of a directory removal operation.

Syntax

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

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

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

# In class FTPServer:
@property
def on_after_remove_directory() -> Callable[[FTPServerAfterRemoveDirectoryEventParams], None]: ...
@on_after_remove_directory.setter
def on_after_remove_directory(event_hook: Callable[[FTPServerAfterRemoveDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event upon completion of a directory removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

on_after_remove_file Event

Signals the completion of a file removal operation.

Syntax

class FTPServerAfterRemoveFileEventParams(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 FTPServer:
@property
def on_after_remove_file() -> Callable[[FTPServerAfterRemoveFileEventParams], None]: ...
@on_after_remove_file.setter
def on_after_remove_file(event_hook: Callable[[FTPServerAfterRemoveFileEventParams], None]) -> None: ...

Remarks

The class fires this event upon completion of a file removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

on_after_rename_file Event

Signals the completion of a file renaming operation.

Syntax

class FTPServerAfterRenameFileEventParams(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 FTPServer:
@property
def on_after_rename_file() -> Callable[[FTPServerAfterRenameFileEventParams], None]: ...
@on_after_rename_file.setter
def on_after_rename_file(event_hook: Callable[[FTPServerAfterRenameFileEventParams], None]) -> None: ...

Remarks

The class fires this event upon completion of a file renaming operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

on_after_request_attributes Event

Signals the completion of an attribute request.

Syntax

class FTPServerAfterRequestAttributesEventParams(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 FTPServer:
@property
def on_after_request_attributes() -> Callable[[FTPServerAfterRequestAttributesEventParams], None]: ...
@on_after_request_attributes.setter
def on_after_request_attributes(event_hook: Callable[[FTPServerAfterRequestAttributesEventParams], None]) -> None: ...

Remarks

The class fires this event upon completion of an attribute request. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

on_auth_attempt Event

Fires when a connected client makes an authentication attempt.

Syntax

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

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

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

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

# In class FTPServer:
@property
def on_auth_attempt() -> Callable[[FTPServerAuthAttemptEventParams], None]: ...
@on_auth_attempt.setter
def on_auth_attempt(event_hook: Callable[[FTPServerAuthAttemptEventParams], 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, and Username and Password contain the professed credentials.

on_before_change_directory Event

Notifies about an incoming change directory request.

Syntax

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

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

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

# In class FTPServer:
@property
def on_before_change_directory() -> Callable[[FTPServerBeforeChangeDirectoryEventParams], None]: ...
@on_before_change_directory.setter
def on_before_change_directory(event_hook: Callable[[FTPServerBeforeChangeDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received directory change 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. Subscribe to on_change_directory to be notified when to perform the request. It is the on_change_directory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_after_change_directory event will be fired.

Choose Action as one of the following values:

on_before_create_directory Event

Notifies about an incoming create directory request.

Syntax

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

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

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

# In class FTPServer:
@property
def on_before_create_directory() -> Callable[[FTPServerBeforeCreateDirectoryEventParams], None]: ...
@on_before_create_directory.setter
def on_before_create_directory(event_hook: Callable[[FTPServerBeforeCreateDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received MKDIR 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. Subscribe to on_create_directory to be notified when to perform the request. It is the on_create_directory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_after_create_directory event will be fired.

Choose Action as one of the following values:

on_before_download_file Event

Notifies about an incoming file download request.

Syntax

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

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

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

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

# In class FTPServer:
@property
def on_before_download_file() -> Callable[[FTPServerBeforeDownloadFileEventParams], None]: ...
@on_before_download_file.setter
def on_before_download_file(event_hook: Callable[[FTPServerBeforeDownloadFileEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received download 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. Subscribe to on_download_file to be notified when to perform the request. It is the on_download_file event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_transfer_completed event will be fired.

Choose Action as one of the following values:

on_before_find Event

Notifies about an incoming file listing request.

Syntax

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

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

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

# In class FTPServer:
@property
def on_before_find() -> Callable[[FTPServerBeforeFindEventParams], None]: ...
@on_before_find.setter
def on_before_find(event_hook: Callable[[FTPServerBeforeFindEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received file listing 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. Subscribe to on_find_init, on_find_next, and on_find_close to be notified when to perform the request. It is the on_find_init and on_find_next events handler where you should perform the overridden listing actions.

Upon completion of the request, either in manual or override mode, the on_find_close event will be fired.

Choose Action as one of the following values:

on_before_remove_directory Event

Notifies about an incoming directory removal request.

Syntax

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

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

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

# In class FTPServer:
@property
def on_before_remove_directory() -> Callable[[FTPServerBeforeRemoveDirectoryEventParams], None]: ...
@on_before_remove_directory.setter
def on_before_remove_directory(event_hook: Callable[[FTPServerBeforeRemoveDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received directory removal 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. Subscribe to on_remove_directory to be notified when to perform the request. It is the on_remove_directory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_after_remove_directory event will be fired.

Choose Action as one of the following values:

on_before_remove_file Event

Notifies about an incoming file removal request.

Syntax

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

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

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

# In class FTPServer:
@property
def on_before_remove_file() -> Callable[[FTPServerBeforeRemoveFileEventParams], None]: ...
@on_before_remove_file.setter
def on_before_remove_file(event_hook: Callable[[FTPServerBeforeRemoveFileEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received file deletion 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. Subscribe to on_remove_file to be notified when to perform the request. It is the on_remove_file event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_after_remove_file event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to on_before_request_attributes and on_request_attributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the deletion procedure. In the virtualized case, you can confirm the existence of the file by returning its details from on_request_attributes call.

on_before_rename_file Event

Notifies about an incoming file rename request.

Syntax

class FTPServerBeforeRenameFileEventParams(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 FTPServer:
@property
def on_before_rename_file() -> Callable[[FTPServerBeforeRenameFileEventParams], None]: ...
@on_before_rename_file.setter
def on_before_rename_file(event_hook: Callable[[FTPServerBeforeRenameFileEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received file rename 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. Subscribe to on_rename_file to be notified when to perform the request. It is the on_rename_file event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_after_rename_file event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to on_before_request_attributes and on_request_attributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the renaming procedure. In the virtualized case, you can confirm the existence of the file by returning its details from on_request_attributes call.

on_before_request_attributes Event

Notifies about an incoming attributes request.

Syntax

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

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

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

# In class FTPServer:
@property
def on_before_request_attributes() -> Callable[[FTPServerBeforeRequestAttributesEventParams], None]: ...
@on_before_request_attributes.setter
def on_before_request_attributes(event_hook: Callable[[FTPServerBeforeRequestAttributesEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received attributes 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. Subscribe to on_request_attributes to be notified when to perform the request. It is the on_request_attributes event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_after_request_attributes event will be fired.

Choose Action as one of the following values:

on_before_send_reply Event

Notifies the application of a command reply being sent.

Syntax

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

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

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

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

# In class FTPServer:
@property
def on_before_send_reply() -> Callable[[FTPServerBeforeSendReplyEventParams], None]: ...
@on_before_send_reply.setter
def on_before_send_reply(event_hook: Callable[[FTPServerBeforeSendReplyEventParams], None]) -> None: ...

Remarks

The class fires this event to tell the application that a command reply is about to be sent. The Command parameter indicates the command that induced the reply, and Code and Reply indicate the pre-generated response.

You can alter the response parameters in your code to send bespoke replies.

on_before_upload_file Event

Notifies about an incoming file upload request.

Syntax

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

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

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

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

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

# In class FTPServer:
@property
def on_before_upload_file() -> Callable[[FTPServerBeforeUploadFileEventParams], None]: ...
@on_before_upload_file.setter
def on_before_upload_file(event_hook: Callable[[FTPServerBeforeUploadFileEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application about a received upload 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. Subscribe to on_upload_file to be notified when to perform the request. It is the on_upload_file event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the on_transfer_completed event will be fired.

Choose Action as one of the following values:

on_change_directory Event

An override for a directory change operation.

Syntax

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

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

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

# In class FTPServer:
@property
def on_change_directory() -> Callable[[FTPServerChangeDirectoryEventParams], None]: ...
@on_change_directory.setter
def on_change_directory(event_hook: Callable[[FTPServerChangeDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application perform an overridden directory change operation.

This event only fires if Action = fraCustom was passed back from on_before_change_directory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by on_after_change_directory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_command_processed Event

Signals that a command has been processed by the server.

Syntax

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

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

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

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

# In class FTPServer:
@property
def on_command_processed() -> Callable[[FTPServerCommandProcessedEventParams], None]: ...
@on_command_processed.setter
def on_command_processed(event_hook: Callable[[FTPServerCommandProcessedEventParams], None]) -> None: ...

Remarks

The class fires this event to signal that a command has been processed by the server, and a reply code has been generated.

You can adjust the reply code and the textual comment associated with it in on_before_send_reply event handler.

on_command_received Event

Signals that a command has been received from the client.

Syntax

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

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

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

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

# In class FTPServer:
@property
def on_command_received() -> Callable[[FTPServerCommandReceivedEventParams], None]: ...
@on_command_received.setter
def on_command_received(event_hook: Callable[[FTPServerCommandReceivedEventParams], None]) -> None: ...

Remarks

The class fires this event to notify the application of an incoming command. Set Ignore to True to stop the server from handling the command.

When the command has been processed, the server will report it via the on_command_processed call.

on_connect Event

Reports an accepted connection.

Syntax

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

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

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

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

Remarks

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

on_create_directory Event

An override for a directory creation operation.

Syntax

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

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

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

# In class FTPServer:
@property
def on_create_directory() -> Callable[[FTPServerCreateDirectoryEventParams], None]: ...
@on_create_directory.setter
def on_create_directory(event_hook: Callable[[FTPServerCreateDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application perform an overridden directory creation operation.

This event only fires if Action = fraCustom was passed back from on_before_create_directory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by on_after_create_directory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_disconnect Event

Fires to report a disconnected client.

Syntax

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

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

Remarks

The class fires this event when a connected client disconnects.

on_download_begin Event

The class fires this event to notify the application about the start of a file download.

Syntax

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

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

# In class FTPServer:
@property
def on_download_begin() -> Callable[[FTPServerDownloadBeginEventParams], None]: ...
@on_download_begin.setter
def on_download_begin(event_hook: Callable[[FTPServerDownloadBeginEventParams], None]) -> None: ...

Remarks

Subscribe to this event to get notified about the beginning of a file download operation. The requested file is specified via the Path property.

on_download_end Event

Reports the completion of the download operation.

Syntax

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

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

# In class FTPServer:
@property
def on_download_end() -> Callable[[FTPServerDownloadEndEventParams], None]: ...
@on_download_end.setter
def on_download_end(event_hook: Callable[[FTPServerDownloadEndEventParams], None]) -> None: ...

Remarks

Use this event to get notified about completion of the early initiated file download operation.

on_download_file Event

An override for a file download initiation operation.

Syntax

class FTPServerDownloadFileEventParams(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 FTPServer:
@property
def on_download_file() -> Callable[[FTPServerDownloadFileEventParams], None]: ...
@on_download_file.setter
def on_download_file(event_hook: Callable[[FTPServerDownloadFileEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application perform an overridden file download initiation operation.

This event only fires if Action = fraCustom was passed back from on_before_download_file event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by a number of on_read_file calls, requesting the file data from your code, followed by a single on_transfer_completed call.

Set OperationStatus to one of the following values:

on_download_progress Event

Reports the progress of an active download operation.

Syntax

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

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

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

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

# In class FTPServer:
@property
def on_download_progress() -> Callable[[FTPServerDownloadProgressEventParams], None]: ...
@on_download_progress.setter
def on_download_progress(event_hook: Callable[[FTPServerDownloadProgressEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified about the progress of an active download operation.

The Path parameter contains the path to the file being downloaded, and Progress and Total reflect the operation progress. Note that the Total parameter may be set to -1 if the size of the downloaded file is not known.

on_error Event

Information about errors during data delivery.

Syntax

class FTPServerErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class FTPServer:
@property
def on_error() -> Callable[[FTPServerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[FTPServerErrorEventParams], 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 FTP section.

on_external_sign Event

Handles remote or external signing initiated by the server protocol.

Syntax

class FTPServerExternalSignEventParams(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 FTPServer:
@property
def on_external_sign() -> Callable[[FTPServerExternalSignEventParams], None]: ...
@on_external_sign.setter
def on_external_sign(event_hook: Callable[[FTPServerExternalSignEventParams], 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_find_close Event

Signals the completion of a directory listing request.

Syntax

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

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

# In class FTPServer:
@property
def on_find_close() -> Callable[[FTPServerFindCloseEventParams], None]: ...
@on_find_close.setter
def on_find_close(event_hook: Callable[[FTPServerFindCloseEventParams], None]) -> None: ...

Remarks

The class fires this event upon completion of a directory listing request. Check the operation status, and alter it, if needed, through the OperationStatus parameter.

on_find_init Event

An override for a directory listing initiation operation.

Syntax

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

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

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

# In class FTPServer:
@property
def on_find_init() -> Callable[[FTPServerFindInitEventParams], None]: ...
@on_find_init.setter
def on_find_init(event_hook: Callable[[FTPServerFindInitEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application prepare for directory listing retrieval.

This event only fires if Action = fraCustom was passed back from on_before_find event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by a number of on_find_next calls, requesting the directory listing entry by entry from your code, followed by a on_find_close call.

Set OperationStatus to one of the following values:

on_find_next Event

An override for a directory listing entry request operation.

Syntax

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

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

# In class FTPServer:
@property
def on_find_next() -> Callable[[FTPServerFindNextEventParams], None]: ...
@on_find_next.setter
def on_find_next(event_hook: Callable[[FTPServerFindNextEventParams], None]) -> None: ...

Remarks

The class fires this event in a loop after calling on_find_init to request one directory entry from the application.

This event only fires if Action = fraCustom was passed back from on_before_find event. No default listing operation will be performed by the server component.

Inside the handler, pass the entry details to the server component by tuning up the client_file_entry object to contain the details of the requested entry, and committing those details to the component with set_client_file_entry method.

Use the OperationStatus parameter to return the operation result back to the server. After submitting all the directory entries to the component, set OperationStatus to ostEOF to tell the components that no more entries are left.

This event will be followed by on_find_close call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_notification Event

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

Syntax

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

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

# In class FTPServer:
@property
def on_notification() -> Callable[[FTPServerNotificationEventParams], None]: ...
@on_notification.setter
def on_notification(event_hook: Callable[[FTPServerNotificationEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

on_read_file Event

Requests a piece of file data from the application.

Syntax

class FTPServerReadFileEventParams(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 FTPServer:
@property
def on_read_file() -> Callable[[FTPServerReadFileEventParams], None]: ...
@on_read_file.setter
def on_read_file(event_hook: Callable[[FTPServerReadFileEventParams], None]) -> None: ...

Remarks

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

The handler of this event should read up to Size bytes from the downloaded file, 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. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more on_read_file calls are needed.

Set OperationStatus to one of the following values:

on_remove_directory Event

An override for a directory removal operation.

Syntax

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

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

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

# In class FTPServer:
@property
def on_remove_directory() -> Callable[[FTPServerRemoveDirectoryEventParams], None]: ...
@on_remove_directory.setter
def on_remove_directory(event_hook: Callable[[FTPServerRemoveDirectoryEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application perform an overridden directory removal operation.

This event only fires if Action = fraCustom was passed back from on_before_remove_directory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by on_after_remove_directory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_remove_file Event

An override for a file remove operation.

Syntax

class FTPServerRemoveFileEventParams(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 FTPServer:
@property
def on_remove_file() -> Callable[[FTPServerRemoveFileEventParams], None]: ...
@on_remove_file.setter
def on_remove_file(event_hook: Callable[[FTPServerRemoveFileEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application perform an overridden file removal operation.

This event only fires if Action = fraCustom was passed back from on_before_remove_file event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by on_after_remove_file call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file removals in the on_before_remove_file topic.

on_rename_file Event

An override for a file rename operation.

Syntax

class FTPServerRenameFileEventParams(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 FTPServer:
@property
def on_rename_file() -> Callable[[FTPServerRenameFileEventParams], None]: ...
@on_rename_file.setter
def on_rename_file(event_hook: Callable[[FTPServerRenameFileEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application perform an overridden file rename operation.

This event only fires if Action = fraCustom was passed back from on_before_rename_file event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by on_after_rename_file call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file renamings in the on_before_rename_file topic.

on_request_attributes Event

An override for an attribute request.

Syntax

class FTPServerRequestAttributesEventParams(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 FTPServer:
@property
def on_request_attributes() -> Callable[[FTPServerRequestAttributesEventParams], None]: ...
@on_request_attributes.setter
def on_request_attributes(event_hook: Callable[[FTPServerRequestAttributesEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application handle an overridden attribute request operation.

This event only fires if Action = fraCustom was passed back from on_before_request_attributes event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by on_after_request_attributes call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

on_tls_cert_validate Event

Fires when a client certificate needs to be validated.

Syntax

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

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

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

Remarks

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

on_tls_established Event

Reports the setup of a TLS session.

Syntax

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

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

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

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

# In class FTPServer:
@property
def on_tls_handshake() -> Callable[[FTPServerTLSHandshakeEventParams], None]: ...
@on_tls_handshake.setter
def on_tls_handshake(event_hook: Callable[[FTPServerTLSHandshakeEventParams], 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 FTPServerTLSPSKEventParams(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 FTPServer:
@property
def on_tls_psk() -> Callable[[FTPServerTLSPSKEventParams], None]: ...
@on_tls_psk.setter
def on_tls_psk(event_hook: Callable[[FTPServerTLSPSKEventParams], 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 FTPServerTLSShutdownEventParams(object):
  @property
  def connection_id() -> int: ...

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

This event is fired when a customized upload or download operation completes.

Syntax

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

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

# In class FTPServer:
@property
def on_transfer_completed() -> Callable[[FTPServerTransferCompletedEventParams], None]: ...
@on_transfer_completed.setter
def on_transfer_completed(event_hook: Callable[[FTPServerTransferCompletedEventParams], None]) -> None: ...

Remarks

This event is fired when a customized transfer operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with on_before_upload_file or 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.

on_upload_begin Event

The server fires this event to notify the application about the start of a file upload operation.

Syntax

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

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

# In class FTPServer:
@property
def on_upload_begin() -> Callable[[FTPServerUploadBeginEventParams], None]: ...
@on_upload_begin.setter
def on_upload_begin(event_hook: Callable[[FTPServerUploadBeginEventParams], None]) -> None: ...

Remarks

Use this event to get notified about the beginning of a file upload operation. The file that is about to be uploaded is specified via the Path property.

on_upload_end Event

Reports the completion of the upload operation.

Syntax

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

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

# In class FTPServer:
@property
def on_upload_end() -> Callable[[FTPServerUploadEndEventParams], None]: ...
@on_upload_end.setter
def on_upload_end(event_hook: Callable[[FTPServerUploadEndEventParams], None]) -> None: ...

Remarks

Use this event to receive notifications about completion of file upload operations.

on_upload_file Event

An override for a file upload initiation operation.

Syntax

class FTPServerUploadFileEventParams(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 FTPServer:
@property
def on_upload_file() -> Callable[[FTPServerUploadFileEventParams], None]: ...
@on_upload_file.setter
def on_upload_file(event_hook: Callable[[FTPServerUploadFileEventParams], None]) -> None: ...

Remarks

The class fires this event to let the application perform an overridden file upload initiation operation.

This event only fires if Action = fraCustom was passed back from on_before_upload_file event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

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

This event will be followed by a number of on_write_file calls, passing the file data to your code, followed by a single on_transfer_completed call.

Set OperationStatus to one of the following values:

on_upload_progress Event

Reports the progress of an active upload operation.

Syntax

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

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

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

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

# In class FTPServer:
@property
def on_upload_progress() -> Callable[[FTPServerUploadProgressEventParams], None]: ...
@on_upload_progress.setter
def on_upload_progress(event_hook: Callable[[FTPServerUploadProgressEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified about the progress of an active upload operation.

The Path parameter specifies the path to the file being uploaded, and Progress and Total reflect the operation progress. The Total parameter may be set to -1 if the size of the uploaded file is not known.

on_write_file Event

Hands a piece of file data to the application.

Syntax

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

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

# In class FTPServer:
@property
def on_write_file() -> Callable[[FTPServerWriteFileEventParams], None]: ...
@on_write_file.setter
def on_write_file(event_hook: Callable[[FTPServerWriteFileEventParams], None]) -> None: ...

Remarks

The class fires this event repeatedly during an overridden upload operation to pass file 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 file 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:

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

FTPServer Config Settings

Base Config Settings

FTPServer Errors

FTPServer 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) 
	18874368   Unsupported file operation (SB_ERROR_FTP_UNSUPPORTED_FILEOPERATION)