OFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The OFTPServer class implements the server side of the Odette File Transfer Protocol.

Syntax

class ipworksedi.OFTPServer

Remarks

The OFTPServer component implements an OFTP server. It is a lightweight server that supports version 1.2, 1.3, 1.4, and 2.0 of OFTP.

Sending and Receiving Files

To use the class first decide if you will support TLS/SSL connections or not. If use_ssl is set to true, all clients will be expected to connect in TLS/SSL. If use_ssl is set to false (default), all clients are expected to connect in plaintext. If use_ssl is true, only clients that support Version 2.0 of the protocol can connect.

Once you have decided whether or not to support TLS/SSL, specify the port you wish the server to listen on in local_port. By default this value is 3305.

Next, specify values for server_ssid_code, server_sfid_code, server_password.

Then set listening to true to start listening for incoming requests.

When a client connects, you will have an opportunity to authenticate the client before continuing the connection. This is done when the on_accept_connection event fires. Within this event you can validate that the connecting client has access based on rules you determine. If you wish to reject the connection set the Accept parameter to false. Within this event you can also specify the directory to which files sent by the client to the server are saved. It is necessary to specify the directory within this event, as the client can start sending files as soon as the connection is complete. To specify the download directory set the oftp_connection_download_directory property. For instance: oftpserver1.SetOFTPConnectionDownloadDirectory(e->ConnectionId, "C:\\Downloads");

When the connection is complete, the client may send files. If the client does send a file the on_accept_file event will fire and you will have the opportunity to reject the file by setting the Accept parameter of the event. In addition you will have a chance to change the filename by setting the Filename parameter if desired.

After the client has sent all the files it is configured to send, it will pass control to the server. At that time the on_ready_to_send event will fire, and the oftp_connection_ready_to_send property will be set to true. After this, you can either end the session with the client by calling logoff or send files to the client. To send files to the client simply call the send_file method with the specified parameters.

TLS/SSL Notes

When use_ssl is set to true, the server must be configured with a TLS/SSL certificate before it is started. Set ssl_cert to a valid certificate with corresponding private key before setting listening to true. This may be a PFX file, PEM key, or a certificate in a windows certificate store. See the ssl_cert property for more information.

After ssl_cert is set to a valid certificate and listening is set to true, when a client connects the on_ssl_status event will fire during the TLS/SSL negotiation. This is purely informational, if there is an error the on_error event will fire.

If you want to require TLS/SSL client authentication, set ssl_authenticate_clients to true before setting listening to true. This will force clients to present a certificate during TLS/SSL negotiation to be used for authorization. In this case the on_ssl_client_authentication event will fire and you must set the Accept parameter within the event to true in order to accept the client's certificate and proceed with the connection.

Example Code

MyOftpserver server; server.SetServerSSIDCode("SERVERSSID"); server.SetServerSFIDCode("SERVERSFID"); server.SetServerPassword("SERVER"); server.SetListening(true); ... //Within the main loop of the application call server.DoEvents() in a loop //to process events. //When the ReadyToSend event fires the server can then send files to the client. To do this call the SendFile method. //Alternatively, monitor server.GetOFTPConnectionReadyToSend(<ConnectionId>) to determine when files can be sent. class MyOFTPServer : public OFTPServer { public: MyOFTPServer() {} virtual int FireAcceptConnection(OFTPServerAcceptConnectionEventParams* e) { clientConnectionId = e->ConnectionId; clientSSIDCode = strdup(e->ClientSSIDCode); this->SetOFTPConnectionDownloadDirectory(e->ConnectionId, INCOMING_DIR); return 0; } virtual int FireAcceptFile(OFTPServerAcceptFileEventParams* e) { //e->Accept = False; //To reject a file set e->Accept to false return 0; } virtual int FirePITrail(OFTPServerPITrailEventParams* e) { char logmsg[MAX_PATH]; if (e->Direction == 0) { sprintf(logmsg, "CLIENT: %s : %s", e->CommandId, e->CommandDescription); } else { sprintf(logmsg, "SERVER: %s : %s", e->CommandId, e->CommandDescription); } printf(logmsg); return 0; } virtual int FireError(OFTPServerErrorEventParams* e) { printf("[%d] %s\n", e->ErrorCode,strdup(e->Description)); return 0; } };

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.

cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_cert_encoded() -> bytes: ...
def set_cert_encoded(value: bytes) -> None: ...

cert_encoded = property(get_cert_encoded, set_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The cert_store and cert_subject properties also may be used to specify a certificate.

When cert_encoded is set, a search is initiated in the current cert_store for the private key of the certificate. If the key is found, cert_subject is updated to reflect the full subject of the selected certificate; otherwise, cert_subject is set to an empty string.

cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_cert_store() -> bytes: ...
def set_cert_store(value: bytes) -> None: ...

cert_store = property(get_cert_store, set_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The cert_store_type property denotes the type of the certificate store specified by cert_store. If the store is password protected, specify the password in cert_store_password.

cert_store is used in conjunction with the cert_subject property to specify client certificates. If cert_store has a value, and cert_subject or cert_encoded is set, a search for a certificate is initiated. Please see the cert_subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_cert_store_password() -> str: ...
def set_cert_store_password(value: str) -> None: ...

cert_store_password = property(get_cert_store_password, set_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_cert_store_type() -> int: ...
def set_cert_store_type(value: int) -> None: ...

cert_store_type = property(get_cert_store_type, set_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_cert_subject() -> str: ...
def set_cert_subject(value: str) -> None: ...

cert_subject = property(get_cert_subject, set_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

connection_backlog Property

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Syntax

def get_connection_backlog() -> int: ...
def set_connection_backlog(value: int) -> None: ...

connection_backlog = property(get_connection_backlog, set_connection_backlog)

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

oftp_connection_count Property

The number of records in the OFTPConnection arrays.

Syntax

def get_oftp_connection_count() -> int: ...

oftp_connection_count = property(get_oftp_connection_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• oftp_connection_compress
• oftp_connection_connected
• oftp_connection_connection_id
• oftp_connection_download_directory
• oftp_connection_encryption_algorithm
• oftp_connection_local_address
• oftp_connection_max_record_size
• oftp_connection_ready_to_send
• oftp_connection_recipient_cert_store
• oftp_connection_recipient_cert_store_password
• oftp_connection_recipient_cert_store_type
• oftp_connection_recipient_cert_subject
• oftp_connection_remote_host
• oftp_connection_remote_port
• oftp_connection_sfid_code
• oftp_connection_signed_receipt
• oftp_connection_ssid_code
• oftp_connection_timeout
• oftp_connection_version
• oftp_connection_virtual_file_date
• oftp_connection_virtual_file_format
• oftp_connection_virtual_file_security_level

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

This property is read-only.

oftp_connection_compress Property

Whether or not compression is used on the outgoing or incoming file.

Syntax

def get_oftp_connection_compress(connection_id: int) -> bool: ...
def set_oftp_connection_compress(connection_id: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether or not compression is used on the outgoing or incoming file.

When sending files to the client, if Compress is true the file will be compressed.

When receiving files, query this property to determine whether the file received from the client was compressed or not.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by oftp_connection_version.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_connected Property

This property is used to disconnect individual connections or to show their status.

Syntax

def get_oftp_connection_connected(connection_id: int) -> bool: ...
def set_oftp_connection_connected(connection_id: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

This property is used to disconnect individual connections or to show their status.

The oftp_connection_connected property may be set to False to close the connection.

oftp_connection_connected also shows the status of a particular connection (connected/disconnected).

How and when the connection is closed is controlled by the linger property. Please refer to its description for more information.

Note: It is recommended to use the disconnect method instead of setting this property.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_connection_id Property

This property contains an identifier generated by the class to identify each connection.

Syntax

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

Default Value

""

Remarks

This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

This property is read-only.

oftp_connection_download_directory Property

The directory to which files will be saved.

Syntax

def get_oftp_connection_download_directory(connection_id: int) -> str: ...
def set_oftp_connection_download_directory(connection_id: int, value: str) -> None: ...

Default Value

""

Remarks

The directory to which files will be saved.

This specifies the directory where files received by the server will be saved. This must be set before the client begins sending files. Set this in the on_connected, on_accept_connection, or on_connection_request events, for instance: oftpserver1.SetOFTPConnectionDownloadDirectory(123456789, "C:\\Downloads");

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_encryption_algorithm Property

The encryption algorithm used when sending files to the client.

Syntax

def get_oftp_connection_encryption_algorithm(connection_id: int) -> int: ...
def set_oftp_connection_encryption_algorithm(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

The encryption algorithm used when sending files to the client.

In order to use encryption, you must set the oftp_connection_virtual_file_security_level property. The supported algorithms for encryption are:

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by oftp_connection_version.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_local_address Property

This property shows the IP address of the interface through which the connection is passing.

Syntax

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

Default Value

""

Remarks

This property shows the IP address of the interface through which the connection is passing.

oftp_connection_local_address is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

This property is read-only.

oftp_connection_max_record_size Property

This value determines the maximum length for a record in the outgoing virtual file.

Syntax

def get_oftp_connection_max_record_size(connection_id: int) -> int: ...
def set_oftp_connection_max_record_size(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

This value determines the maximum length for a record in the outgoing virtual file. When oftp_connection_virtual_file_format has been set to ffUnstructured or ffText, this value must be zero. When ffFixed or ffVariable, this must be set to a value greater than 0, containing the maximum line length of the outgoing file.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_ready_to_send Property

Specifies whether or not the server can send to the client.

Syntax

def get_oftp_connection_ready_to_send(connection_id: int) -> bool: ...

Default Value

FALSE

Remarks

Specifies whether or not the server can send to the client.

When the client passes control to the server, this property will be true. Additionally the on_ready_to_send event will fire at this time. This must be true before sending files to the client.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

This property is read-only.

oftp_connection_recipient_cert_store Property

The name of the certificate store for the recipient certificate.

Syntax

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

Default Value

"MY"

Remarks

The name of the certificate store for the recipient certificate.

The oftp_connection_recipient_cert_store_type property specifies the type of the certificate store specified by oftp_connection_recipient_cert_store. If the store is password protected, specify the password in oftp_connection_recipient_cert_store_password.

oftp_connection_recipient_cert_store is used in conjunction with the oftp_connection_recipient_cert_subject property in order to specify client certificates. If oftp_connection_recipient_cert_store has a value, and oftp_connection_recipient_cert_subject is set, a search for a certificate is initiated. Please refer to the oftp_connection_recipient_cert_subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by oftp_connection_version.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_recipient_cert_store_password Property

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Syntax

def get_oftp_connection_recipient_cert_store_password(connection_id: int) -> str: ...
def set_oftp_connection_recipient_cert_store_password(connection_id: int, value: str) -> None: ...

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by oftp_connection_version.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_recipient_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_oftp_connection_recipient_cert_store_type(connection_id: int) -> int: ...
def set_oftp_connection_recipient_cert_store_type(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by oftp_connection_version.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_recipient_cert_subject Property

The subject of the recipient certificate.

Syntax

def get_oftp_connection_recipient_cert_subject(connection_id: int) -> str: ...
def set_oftp_connection_recipient_cert_subject(connection_id: int, value: str) -> None: ...

Default Value

""

Remarks

The subject of the recipient certificate.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by oftp_connection_version.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_remote_host Property

This property shows the IP address of the remote host through which the connection is coming.

Syntax

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

Default Value

""

Remarks

This property shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

This property is read-only.

oftp_connection_remote_port Property

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Syntax

def get_oftp_connection_remote_port(connection_id: int) -> int: ...

Default Value

0

Remarks

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

This property is read-only.

oftp_connection_sfid_code Property

The connected client's SFID code.

Syntax

def get_oftp_connection_sfid_code(connection_id: int) -> str: ...
def set_oftp_connection_sfid_code(connection_id: int, value: str) -> None: ...

Default Value

""

Remarks

The connected client's SFID code.

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_signed_receipt Property

Indicates whether a signed receipt is requested.

Syntax

def get_oftp_connection_signed_receipt(connection_id: int) -> bool: ...
def set_oftp_connection_signed_receipt(connection_id: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Indicates whether a signed receipt is requested.

When sending files, if this is set to true a signed receipt will be requested. In that case oftp_connection_recipient_cert_store_type, oftp_connection_recipient_cert_store, and oftp_connection_recipient_cert_subject must be set to specify the public certificate that will be used to verify the signature on the receipt returned by the client after send_file is called. The class will automatically verify the signature on the returned receipt.

When receiving files, query this property to determine if the client requested a signed receipt. If true, the certificate property must be set to a certificate with private key in order to sign the receipt that will be returned to the client. The class will sign and deliver the receipt automatically.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by oftp_connection_version.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_ssid_code Property

The connected client's SSID code.

Syntax

def get_oftp_connection_ssid_code(connection_id: int) -> str: ...
def set_oftp_connection_ssid_code(connection_id: int, value: str) -> None: ...

Default Value

""

Remarks

The connected client's SSID code.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_timeout Property

A timeout for the class.

Syntax

def get_oftp_connection_timeout(connection_id: int) -> int: ...
def set_oftp_connection_timeout(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

A timeout for the class.

If the oftp_connection_timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If oftp_connection_timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for oftp_connection_timeout is specified by the default_timeout property.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_version Property

This holds the version of OFTP supported by the client.

Syntax

def get_oftp_connection_version(connection_id: int) -> int: ...

Default Value

0

Remarks

This holds the version of OFTP supported by the client. This value cannot be changed. All communication with the client is performed using the version returned by this property. Possible values are:

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

This property is read-only.

oftp_connection_virtual_file_date Property

Set this to the date/time stamp for the virtual file before sending.

Syntax

def get_oftp_connection_virtual_file_date(connection_id: int) -> str: ...
def set_oftp_connection_virtual_file_date(connection_id: int, value: str) -> None: ...

Default Value

""

Remarks

Set this to the date/time stamp for the virtual file before sending. If this is not set when sending a file, the current date/time will be used. This property will accept various date formats, but will return the following format only: "MM/dd/yyyy HH:mm:ss".

Supported date formats:

• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• d MMM yy HH:mm:ss zzz
• d MMM yyyy HH:mm:ss zzz
• dd-MMM-yyyy HH:mm:ss
• ddd, d MMM yy HH:mm:ss zz
• ddd, d MMM yyyy HH:mm:ss zz
• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• ddd, d MMM yy HH:mm:ss z
• ddd, d MMM yyyy HH:mm:ss z
• ddd, dd MMM yyyy HH:mm:ss 'GMT'
• dddd, MMMM dd, yyyy h:mm:ss tt
• dddd, MMMM dd yyyy h:mm tt
• yyMMddHHmmssZ
• yyyyMMddHHmmssZ
• yyMMddHHmmsszzzz
• yyyyMMddHHmmsszzzz
• yyyyMMddHHmmssffff
• MM/dd/yyyy HH:mm:ss

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_virtual_file_format Property

The structure of the outgoing or incoming file.

Syntax

def get_oftp_connection_virtual_file_format(connection_id: int) -> int: ...
def set_oftp_connection_virtual_file_format(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

The structure of the outgoing or incoming file.

When sending files, set this property to specify the format to apply to outgoing files.

When receiving files, query this property to determine the structure of the file received from the client.

The following values are valid file formats for outgoing virtual files:

Note: When either oftp_connection_virtual_file_security_level has been set to a value other than slNone or oftp_connection_compress has been set to true, all files become ffUnstructured except ffVariable files.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

oftp_connection_virtual_file_security_level Property

Specifies security options for the outgoing or incoming file.

Syntax

def get_oftp_connection_virtual_file_security_level(connection_id: int) -> int: ...
def set_oftp_connection_virtual_file_security_level(connection_id: int, value: int) -> None: ...

Default Value

0

Remarks

Specifies security options for the outgoing or incoming file.

When receiving files, query this property to determine the security level of the file received from the client.

When sending files to the client, this property will be used to determine what security options apply to the outgoing file. Possible values are:

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by oftp_connection_version.

The connection_id parameter specifies the index of the item in the array. The size of the array is controlled by the oftp_connection_count property.

default_timeout Property

An initial timeout value to be used by incoming connections.

Syntax

def get_default_timeout() -> int: ...
def set_default_timeout(value: int) -> None: ...

default_timeout = property(get_default_timeout, set_default_timeout)

Default Value

60

Remarks

If the default_timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If default_timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the default_timeout property is 60 (seconds).

listening Property

If set to True, the class accepts incoming connections on LocalPort.

Syntax

def get_listening() -> bool: ...
def set_listening(value: bool) -> None: ...

listening = property(get_listening, set_listening)

Default Value

FALSE

Remarks

This property indicates whether the class is listening for connections on the port specified by the local_port property.

Note: Use the start_listening and stop_listening methods to control whether the class is listening.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

local_port Property

The TCP port in the local host where the class listens.

Syntax

def get_local_port() -> int: ...
def set_local_port(value: int) -> None: ...

local_port = property(get_local_port, set_local_port)

Default Value

3305

Remarks

This property must be set before OFTPServer starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after OFTPServer is in listening mode (after successfully assigning True to the listening property).

The service port is not shared among servers (i.e. there can be only one OFTPServer 'listening' on a particular port at one time).

The default value for plaintext communication is 3305. If use_ssl is set to true, set this value to 6619 (the default port for SSL communication).

server_password Property

The server's password.

Syntax

def get_server_password() -> str: ...
def set_server_password(value: str) -> None: ...

server_password = property(get_server_password, set_server_password)

Default Value

""

Remarks

The password assigned to the server in the bilateral agreement. This property must be a string of no more than 8 characters long.

server_sfid_code Property

Server's SFID code.

Syntax

def get_server_sfid_code() -> str: ...
def set_server_sfid_code(value: str) -> None: ...

server_sfid_code = property(get_server_sfid_code, set_server_sfid_code)

Default Value

""

Remarks

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

server_ssid_code Property

The server's SSID code.

Syntax

def get_server_ssid_code() -> str: ...
def set_server_ssid_code(value: str) -> None: ...

server_ssid_code = property(get_server_ssid_code, set_server_ssid_code)

Default Value

""

Remarks

The identification code of the server. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:

ssl_authenticate_clients Property

If set to True, the server asks the client(s) for a certificate.

Syntax

def get_ssl_authenticate_clients() -> bool: ...
def set_ssl_authenticate_clients(value: bool) -> None: ...

ssl_authenticate_clients = property(get_ssl_authenticate_clients, set_ssl_authenticate_clients)

Default Value

FALSE

Remarks

This property is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

trusted_cert_count Property

The number of records in the TrustedCert arrays.

Syntax

def get_trusted_cert_count() -> int: ...
def set_trusted_cert_count(value: int) -> None: ...

trusted_cert_count = property(get_trusted_cert_count, set_trusted_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• trusted_cert_encoded
• trusted_cert_store
• trusted_cert_store_password
• trusted_cert_store_type
• trusted_cert_subject

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

trusted_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_trusted_cert_encoded(trusted_cert_index: int) -> bytes: ...
def set_trusted_cert_encoded(trusted_cert_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The trusted_cert_store and trusted_cert_subject properties also may be used to specify a certificate.

When trusted_cert_encoded is set, a search is initiated in the current trusted_cert_store for the private key of the certificate. If the key is found, trusted_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, trusted_cert_subject is set to an empty string.

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

trusted_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_trusted_cert_store(trusted_cert_index: int) -> bytes: ...
def set_trusted_cert_store(trusted_cert_index: int, value: bytes) -> None: ...

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The trusted_cert_store_type property denotes the type of the certificate store specified by trusted_cert_store. If the store is password protected, specify the password in trusted_cert_store_password.

trusted_cert_store is used in conjunction with the trusted_cert_subject property to specify client certificates. If trusted_cert_store has a value, and trusted_cert_subject or trusted_cert_encoded is set, a search for a certificate is initiated. Please see the trusted_cert_subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

trusted_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_trusted_cert_store_password(trusted_cert_index: int) -> str: ...
def set_trusted_cert_store_password(trusted_cert_index: int, value: str) -> None: ...

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

trusted_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_trusted_cert_store_type(trusted_cert_index: int) -> int: ...
def set_trusted_cert_store_type(trusted_cert_index: int, value: int) -> None: ...

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

trusted_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_trusted_cert_subject(trusted_cert_index: int) -> str: ...
def set_trusted_cert_subject(trusted_cert_index: int, value: str) -> None: ...

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

The trusted_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the trusted_cert_count property.

use_ssl Property

Use SSL to access the RemoteHost .

Syntax

def get_use_ssl() -> bool: ...
def set_use_ssl(value: bool) -> None: ...

use_ssl = property(get_use_ssl, set_use_ssl)

Default Value

FALSE

Remarks

Use this property to determine whether the class uses SSL when clients connect.

This property is only valid when using version 2.0 of the protocol. If set to true, all clients that connect must use version 2.0.

change_direction Method

Sends a Change Direction (CD) command.

Syntax

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

Remarks

This method sends a Change Direction (CD) command to the client when called. In normal operation this should not be used. This should only be used if a condition arises where you must manually change the speaker when communicating with the client. For instance: component.ChangeDirection(MyConnectionId);

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.

disconnect Method

This method disconnects the specified client.

Syntax

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

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

exchange_certificate Method

Exchange a certificate with the remote host.

Syntax

def exchange_certificate(connection_id: int, client_sfid_code: str, certificate_store: str, certificate_exchange_type: int) -> None: ...

Remarks

If the remote host supports the certificate exchange feature of OFTP 2.0 this method may be used to send and/or request certificates.

The CertificateStore parameter specifies the location of the certificate to be exchanged. In most cases this will be the path to a .cer file on disk. If the certificate is in another format or is installed to the Windows certificate store please see ExchangeCertStoreType and ExchangeCertSubject for more information.

The CertificateExchangeType parameter determines the type of request. Possible values are:

import_trusted_certs Method

Imports a list of trusted CA certificates.

Syntax

def import_trusted_certs() -> None: ...

Remarks

When import_trusted_certs is called the class will import the CA certificates from the source specified by TrustedCertsData into the trusted_certs collection.

The class will then validate the trust of certificates when they are loaded.

If trusted CA certificates are not imported no validation will occur (default).

See also FailOnUntrustedCert.

interrupt Method

This method interrupts a synchronous send to the remote host.

Syntax

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

Remarks

This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the class. If you use send_file to upload a file, the class will run synchronously on that Connection Id until it is completed.

logoff Method

Ends a session with the connection client.

Syntax

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

Remarks

This method will attempt to end the session with the client if the client has acknowledged it is finished sending files to the server. If the client still wishes to process commands, the method will give control back to the client and oftp_connection_ready_to_send will be false. When oftp_connection_ready_to_send is true, calling this method will end the session.

reset Method

Resets the state of the control.

Syntax

def reset() -> None: ...

Remarks

Reset resets the state of the class. All properties will be set to their default values.

send_end_response Method

Sends an EERP/NERP asynchronously.

Syntax

def send_end_response(connection_id: int, virtual_file_name: str, virtual_file_date: str, destination: str, originator: str, creator: str, reason_code: int, reason_text: str, file_hash: str, signature: str) -> None: ...

Remarks

This method sends an EERP/NERP. By default the class will automatically respond with an EERP/NERP when receiving a file. To respond asynchronously instead this method may be used.

To respond asynchronously first set the SendEndResponse parameter of the on_end_transfer event to False. This instructs the class to not send a response automatically. Within the on_end_transfer event you must also save the values that are required parameters for this method. This includes FileHash, VirtualFileDate, and VirtualFileName. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

Destination should be set to the SFID of the remote host.

Originator should be set to the SFID of the local system. In the case that the class is being used as part of a gateway process to forward traffic to another OFTP host this may be set to the SFID of that host instead.

Creator should be set to the SFID of the local system.

Signature is only applicable if the application is acting as a routing application. In all other cases this should be set to empty string. In the case where the application is acting as a routing application the end response is being forwarded to another entity for processing. The Signature should be set to the value received in the on_end_response event (if populated).

ReasonCode and ReasonText are used to specify error information. If ReasonCode is set to 0 the class will send an EERP. If ReasonCode is set to any non-zero value the class will send a NERP. Common values are:

send_file Method

Sends a file to the specified client.

Syntax

def send_file(connection_id: int, client_sfid_code: str, file_name: str, virtual_file_name: str) -> None: ...

Remarks

This method sends a file to the client specified by the ConnectionId parameter.

After the on_ready_to_send event fires or when the oftp_connection_ready_to_send property is true, this method can be used to send a file to the connected client specified by the ConnectionId parameter.

The ClientSFIDCode corresponds to the destination.

FileName must be the full path to the file which will be sent.

VirtualFileName may be specified to indicate the name of the file that the client will see when receiving the file.

If connections_upload_stream is set, pass empty string as the value for the FileName parameter.

When this method is called, the class will fire the on_start_transfer, on_transfer, and on_end_transfer events that can be monitored to check the status of the send. The send_file method will not return until either the transfer is complete or an error was encountered.

shutdown Method

This method shuts down the server.

Syntax

def shutdown() -> None: ...

Remarks

This method shuts down the server. Calling this method is equivalent to calling stop_listening and then breaking every client connection by calling disconnect.

start_listening Method

This method starts listening for incoming connections.

Syntax

def start_listening() -> None: ...

Remarks

This method begins listening for incoming connections on the port specified by local_port. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.

stop_listening Method

This method stops listening for new connections.

Syntax

def stop_listening() -> None: ...

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call shutdown instead.

validate_cert Method

Validates the certificate with private key.

Syntax

def validate_cert() -> bool: ...

Remarks

This method optionally validates the certificate specified by certificate. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call import_trusted_certs to load the trusted certification information.

When this method is called the class:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the trusted_certs collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

validate_recipient_cert Method

Validates the recipient certificate.

Syntax

def validate_recipient_cert(connection_id: int) -> bool: ...

Remarks

This method optionally validates the certificate specified by oftp_connection_recipient_cert_subject. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call import_trusted_certs to load the trusted certification information.

When this method is called the class:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the trusted_certs collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

on_accept_connection Event

Fired when a client connects.

Syntax

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

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

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

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

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

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

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

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

# In class OFTPServer:
@property
def on_accept_connection() -> Callable[[OFTPServerAcceptConnectionEventParams], None]: ...
@on_accept_connection.setter
def on_accept_connection(event_hook: Callable[[OFTPServerAcceptConnectionEventParams], None]) -> None: ...

Remarks

This event fires when a new OFTP connection is made to the server. Use the parameters of this event to verify the identify of the client identified by the ConnectionId. By default the connection will be accepted. To reject the connection set Accept to false.

ClientVersion specifies the OFTP protocol version the client supports. By default the class will use the version requested by the client for the connection. If you wish to restrict connections to a specific OFTP protocol version use this value when determining whether or not to accept the connection. When rejecting the connection based on the OFTP protocol version use ErrorCode 10. Possible values are:

ServerVersion specifies the OFTP protocol version the server will use for the connection. By default this will be the same as ClientVersion. This may be set to a different version which will be sent back to the client. Possible values are:

When rejecting a connection the ErrorCode and ErrorDescription may optionally be set. Possible common values are:

on_accept_file Event

Fired when the client sends a file.

Syntax

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

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

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

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

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

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

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

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

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

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

# In class OFTPServer:
@property
def on_accept_file() -> Callable[[OFTPServerAcceptFileEventParams], None]: ...
@on_accept_file.setter
def on_accept_file(event_hook: Callable[[OFTPServerAcceptFileEventParams], None]) -> None: ...

Remarks

This event controls the behavior when the client sends a file to the server.

VirtualFileName holds the name of the file being received.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination identifies the receiver (SFID) code in the send file request. If the file was intended for this server this will match the value in server_sfid_code

Originator identifies the sender (SFID) code in the send file request.

Accept is true by default, and must be set to False in order to reject the file.

Filename will be populated with the full path and filename that will be written. It may be changed within this event to specify a new location. The Filename is determined by combining the path specified in oftp_connection_download_directory and the name received from the client.

Overwrite is false by default, but may be set to true to overwrite existing files on disk.

ErrorCode controls the error returned to the client when Accept is set to False. If this is not set the class will use a value of 99 to indicate a general error.

ErrorDescription may also be set to include an error message. If this is not set the class will automatically include an error message based on the ErrorCode specified. Common error codes and their corresponding error messages are listed below.

on_certificate_received Event

Fired when a certificate is received from the remote host.

Syntax

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

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

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

# In class OFTPServer:
@property
def on_certificate_received() -> Callable[[OFTPServerCertificateReceivedEventParams], None]: ...
@on_certificate_received.setter
def on_certificate_received(event_hook: Callable[[OFTPServerCertificateReceivedEventParams], None]) -> None: ...

Remarks

This event provides information about the certificate file that was sent by the remote host.

When the remote host sends a certificate using the Certificate Exchange feature of OFTP 2.0, this event provides information about it. The certificate file will be written to the download_directory. After the file is written to download_directory this event will fire.

The CertificateFilemame parameter holds the filename of the received certificate.

The CertificateExchangeType parameter identifies the type of request associated with the certificate. Possible values are:

ConnectionId identifies the connected client.

on_connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

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

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

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

# In class OFTPServer:
@property
def on_connected() -> Callable[[OFTPServerConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[OFTPServerConnectedEventParams], None]) -> None: ...

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

on_connection_request Event

This event is fired when a request for connection comes from a remote host.

Syntax

class OFTPServerConnectionRequestEventParams(object):
  @property
  def address() -> str: ...

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

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

# In class OFTPServer:
@property
def on_connection_request() -> Callable[[OFTPServerConnectionRequestEventParams], None]: ...
@on_connection_request.setter
def on_connection_request(event_hook: Callable[[OFTPServerConnectionRequestEventParams], None]) -> None: ...

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

on_disconnected Event

This event is fired when a connection is closed.

Syntax

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

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

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

# In class OFTPServer:
@property
def on_disconnected() -> Callable[[OFTPServerDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[OFTPServerDisconnectedEventParams], None]) -> None: ...

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

on_end_response Event

Fired every time an end response is received from the client.

Syntax

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

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

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

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

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

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

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

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

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

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

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

# In class OFTPServer:
@property
def on_end_response() -> Callable[[OFTPServerEndResponseEventParams], None]: ...
@on_end_response.setter
def on_end_response(event_hook: Callable[[OFTPServerEndResponseEventParams], None]) -> None: ...

Remarks

This event contains information received from an either an End-To-End Response or a Negative End Response received from the server.

An End-To-End Response will not contain values for the ReasonCode, ReasonText, or Creator parameters.

VirtualFileName specifies the name of the file.

VirtualFileDate holds the VirtualFileDate value in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination is the SFID of the destination system (this class).

Originator identifies the system that originated the end response. This is typically the same as Creator and holds the remote system's SFID.

Creator is the SFID of the remote system.

Direction specifies whether the end response is being received or sent. Possible values are:

FileHash is populated if the OFTP Version is 2.0 and a signed receipt was originally requested. FileHash may also be specified with the expected value in the case where an asynchronous EndResponse is received. The expected value may be obtained from the on_end_transfer event when initially sending the file.

Signature is only applicable when the OFTP version is 2.0 and the application is acting as a routing application where the end response will be forwarded on to another entity. In this case Signature will be populated if the end response is signed. This should be stored and supplied when forwarding the response with the send_end_response method.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

ConnectionId identifies the connected client.

on_end_transfer Event

Fired when a file finishes transferring.

Syntax

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

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

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

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

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

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

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

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

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

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

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

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

# In class OFTPServer:
@property
def on_end_transfer() -> Callable[[OFTPServerEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[OFTPServerEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when a file is sent or received by the class.

The FileSize parameter gives the size of the file that was sent or received.

The Direction parameter shows whether the client or the server is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

SendEndResponse indicates whether the EERP/NERP for this request should be sent synchronously or asynchronously. When this parameter is True (default) the class will automatically respond with an EERP/NERP synchronously. To respond asynchronously set this parameter to False. You may then use the send_end_response method to send the response at a later time. See send_end_response for more details. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

FileHash holds the hash of the file being transmitted. This is only applicable when the OFTP version is 2.0 and the sender requested a signed receipt. When receiving files this value should be saved if you wish to respond asynchronously using send_end_response. See send_end_response for more details.

LocalFile holds the full path to the file that will be written.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

ConnectionId identifies the connected client.

on_error Event

Information about errors during data delivery.

Syntax

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

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

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

# In class OFTPServer:
@property
def on_error() -> Callable[[OFTPServerErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[OFTPServerErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 Error Codes section.

ConnectionId contains the Id of the connection to which this error applies.

on_log Event

Fires once for each log message.

Syntax

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

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

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

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

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

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

ConnectionId identifies the connected client.

LogLevel indicates the level of message. Possible values are:

Message is the log entry.

LogType identifies the type of log entry. Possible values are:

• "Info"
• "OFTP"

on_pi_trail Event

Fired when any protocol level communication occurs.

Syntax

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

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

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

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

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

# In class OFTPServer:
@property
def on_pi_trail() -> Callable[[OFTPServerPITrailEventParams], None]: ...
@on_pi_trail.setter
def on_pi_trail(event_hook: Callable[[OFTPServerPITrailEventParams], None]) -> None: ...

Remarks

This event provides information about the protocol level communication between the client and server.

The Direction parameter specifies who sent the command.

The CommandId and CommandDescription parameters specify which command was sent. The table below shows possible values.

The Data parameter contains the raw OFTP packet.

on_ready_to_send Event

Fired when the class is ready to send data.

Syntax

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

# In class OFTPServer:
@property
def on_ready_to_send() -> Callable[[OFTPServerReadyToSendEventParams], None]: ...
@on_ready_to_send.setter
def on_ready_to_send(event_hook: Callable[[OFTPServerReadyToSendEventParams], None]) -> None: ...

Remarks

The on_ready_to_send event indicates that the connected client is in a state where it can accept files sent from the server. When a client connects initially it will not be ready to receive files. After the client sends files (if any) to the server it will pass control to the server. At that time the ReadyToSend event will fire. In addition the oftp_connection_ready_to_send property will be set to true for the connection.

After this event fires send_file can be called to send files to the connected client.

on_ssl_client_authentication Event

This event is fired when the client presents its credentials to the server.

Syntax

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

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

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

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

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

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

# In class OFTPServer:
@property
def on_ssl_client_authentication() -> Callable[[OFTPServerSSLClientAuthenticationEventParams], None]: ...
@on_ssl_client_authentication.setter
def on_ssl_client_authentication(event_hook: Callable[[OFTPServerSSLClientAuthenticationEventParams], None]) -> None: ...

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

on_ssl_connection_request Event

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Syntax

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

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

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

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

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

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

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

# In class OFTPServer:
@property
def on_ssl_connection_request() -> Callable[[OFTPServerSSLConnectionRequestEventParams], None]: ...
@on_ssl_connection_request.setter
def on_ssl_connection_request(event_hook: Callable[[OFTPServerSSLConnectionRequestEventParams], None]) -> None: ...

Remarks

This event fires when an SSL connection is requested and ssl_provider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when ssl_provider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

on_ssl_status Event

This event is fired to show the progress of the secure connection.

Syntax

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

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

# In class OFTPServer:
@property
def on_ssl_status() -> Callable[[OFTPServerSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[OFTPServerSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

on_start_transfer Event

Fired when a document starts transferring.

Syntax

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

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

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

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

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

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

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

# In class OFTPServer:
@property
def on_start_transfer() -> Callable[[OFTPServerStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[OFTPServerStartTransferEventParams], None]) -> None: ...

Remarks

This event fires when a file transfer begins.

Direction specifies if the client or server sent the file.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

ConnectionId identifies the connected client.

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

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

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

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

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

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

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

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

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

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

# In class OFTPServer:
@property
def on_transfer() -> Callable[[OFTPServerTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[OFTPServerTransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being retrieved. It is empty if data is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

ConnectionId identifies the connected client.

OFTPServer Config Settings

OFTPServer Config Settings

TCPServer Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Base Config Settings

OFTPServer Errors

OFTPServer Errors

TCPServer Errors

TCP/IP Errors