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.
cert_store | The name of the certificate store for the client certificate. |
cert_store_password | 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 | The type of certificate store for this certificate. |
cert_subject | The subject of the certificate used for client authentication. |
cert_encoded | The certificate (PEM/Base64 encoded). |
connection_backlog | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. |
oftp_connection_count | The number of records in the OFTPConnection arrays. |
oftp_connection_compress | Whether or not compression is used on the outgoing or incoming file. |
oftp_connection_connected | This property indicates the status of individual connections. |
oftp_connection_connection_id | This property contains an identifier generated by the class to identify each connection. |
oftp_connection_download_directory | The directory to which files will be saved. |
oftp_connection_encryption_algorithm | The encryption algorithm used when sending files to the client. |
oftp_connection_local_address | This property shows the IP address of the interface through which the connection is passing. |
oftp_connection_max_record_size | This value determines the maximum length for a record in the outgoing virtual file. |
oftp_connection_ready_to_send | Specifies whether or not the server can send to the client. |
oftp_connection_recipient_cert_store | The name of the certificate store for the recipient certificate. |
oftp_connection_recipient_cert_store_password | 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. |
oftp_connection_recipient_cert_store_type | The type of certificate store for this certificate. |
oftp_connection_recipient_cert_subject | The subject of the recipient certificate. |
oftp_connection_remote_host | This property shows the IP address of the remote host through which the connection is coming. |
oftp_connection_remote_port | This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. |
oftp_connection_sfid_code | The connected client's SFID code. |
oftp_connection_signed_receipt | Indicates whether a signed receipt is requested. |
oftp_connection_ssid_code | The connected client's SSID code. |
oftp_connection_timeout | A timeout for the class. |
oftp_connection_version | This holds the version of OFTP supported by the client. |
oftp_connection_virtual_file_date | Set this to the date/time stamp for the virtual file before sending. |
oftp_connection_virtual_file_format | The structure of the outgoing or incoming file. |
oftp_connection_virtual_file_security_level | Specifies security options for the outgoing or incoming file. |
default_timeout | An initial timeout value to be used by incoming connections. |
listening | This property indicates whether the class is listening for incoming connections on LocalPort. |
local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
local_port | The TCP port in the local host where the class listens. |
server_password | The server's password. |
server_sfid_code | Server's SFID code. |
server_ssid_code | The server's SSID code. |
ssl_authenticate_clients | If set to True, the server asks the client(s) for a certificate. |
ssl_cert_effective_date | The date on which this certificate becomes valid. |
ssl_cert_expiration_date | The date on which the certificate expires. |
ssl_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
ssl_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssl_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssl_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssl_cert_issuer | The issuer of the certificate. |
ssl_cert_private_key | The private key of the certificate (if available). |
ssl_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
ssl_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
ssl_cert_public_key | The public key of the certificate. |
ssl_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
ssl_cert_public_key_length | The length of the certificate's public key (in bits). |
ssl_cert_serial_number | The serial number of the certificate encoded as a string. |
ssl_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
ssl_cert_store | The name of the certificate store for the client certificate. |
ssl_cert_store_password | 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 | The type of certificate store for this certificate. |
ssl_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
ssl_cert_thumbprint_md5 | The MD5 hash of the certificate. |
ssl_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
ssl_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
ssl_cert_usage | The text description of UsageFlags . |
ssl_cert_usage_flags | The flags that show intended use for the certificate. |
ssl_cert_version | The certificate's version number. |
ssl_cert_subject | The subject of the certificate used for client authentication. |
ssl_cert_encoded | The certificate (PEM/Base64 encoded). |
trusted_cert_count | The number of records in the TrustedCert arrays. |
trusted_cert_store | The name of the certificate store for the client certificate. |
trusted_cert_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
trusted_cert_store_type | The type of certificate store for this certificate. |
trusted_cert_subject | The subject of the certificate used for client authentication. |
trusted_cert_encoded | The certificate (PEM/Base64 encoded). |
use_ssl | Use SSL to access the RemoteHost . |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
change_direction | Sends a Change Direction (CD) command. |
config | Sets or retrieves a configuration setting. |
disconnect | This method disconnects the specified client. |
do_events | This method processes events from the internal message queue. |
exchange_certificate | Exchange a certificate with the remote host. |
import_trusted_certs | Imports a list of trusted CA certificates. |
interrupt | This method interrupts a synchronous send to the remote host. |
logoff | Ends a session with the connection client. |
reset | Resets the state of the control. |
send_end_response | Sends an EERP/NERP asynchronously. |
send_file | Sends a file to the specified client. |
shutdown | This method shuts down the server. |
start_listening | This method starts listening for incoming connections. |
stop_listening | This method stops listening for new connections. |
validate_cert | Validates the certificate with private key. |
validate_recipient_cert | Validates the recipient certificate. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
on_accept_connection | Fired when a client connects. |
on_accept_file | Fired when the client sends a file. |
on_certificate_received | Fired when a certificate is received from the remote host. |
on_connected | This event is fired immediately after a connection completes (or fails). |
on_connection_request | This event is fired when a request for connection comes from a remote host. |
on_disconnected | This event is fired when a connection is closed. |
on_end_response | Fired every time an end response is received from the client. |
on_end_transfer | Fired when a file finishes transferring. |
on_error | Information about errors during data delivery. |
on_log | Fires once for each log message. |
on_pi_trail | Fired when any protocol level communication occurs. |
on_ready_to_send | Fired when the class is ready to send data. |
on_ssl_client_authentication | This event is fired when the client presents its credentials to the server. |
on_ssl_connection_request | This event fires when a Secure Sockets Layer (SSL) connection is requested. |
on_ssl_status | This event is fired to show the progress of the secure connection. |
on_start_transfer | Fired when a document starts transferring. |
on_transfer | Fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowRetry[ConnectionId] | Whether to send a retry indicator when rejecting a file. |
CDAfterSendEndResponse[ConnectionId] | Whether to issue a CD command after sending an asynchronous EERP. |
CertificateStore[ConnectionId] | The name of the certificate store. |
CertificateStorePassword[ConnectionId] | The certificate password. |
CertificateStoreType[ConnectionId] | The type of certificate store. |
CertificateSubject[ConnectionId] | The certificate subject. |
CertificateType | Specifies the type of certificate being supplied. |
CertificateType[ConnectionId] | Specifies the type of certificate being supplied. |
ConnectionType[ConnectionId] | Specifies the type of connection that will be created. |
CreditCount[ConnectionId] | Specifies the maximum credit value. |
DefaultIdleTimeout | The default idle timeout for inactive clients. |
DefaultReceiptHashAlgorithm | The receipt hash algorithm to request when sending a file. |
DeleteOnError | Whether received files are deleted when there is an error during processing. |
DisconnectAfterEndSession | Determines if the connection is closed immediately after ending the session. |
ExchangeBufferSize[ConnectionId] | Specifies the data exchange buffer size in bytes. |
ExchangeCertStoreType | Specifies the store type when loading a certificate to be exchanged. |
ExchangeCertSubject | The subject of the certificate being exchanged. |
FailOnUntrustedCert | Whether or not to throw an exception when untrusted certificates are used. |
FileDescription[ConnectionId] | Additional description information sent with the file. |
FileHashAlgorithm[ConnectionId] | The hash algorithm to use when sending a file. |
FireEndResponseOnSend | Determines if the EndResponse event is fired for outgoing EERP and NERPs. |
FollowRedirects | Determines behavior when importing trusted certificates and a HTTP redirect is returned. |
FriendlyLogFormat | Determines if a more friendly format is applied to PITrail event out. |
IdleTimeout | The idle timeout for this connection. |
KeepAlive | This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity. |
Linger | This property controls how a connection is closed. The default is True. In this case the connection is closed only after all the data is sent. Setting it to False forces an abrupt (hard) disconnection. Any data that was in the sending queue may be lost. |
LogLevel | The level of information to log. |
ReceivedConnectionType[ConnectionId] | Returns the connection type specified by the client. |
ReceivedFileDateTime[ConnectionId] | The datetime of the file being received. |
ReceivedFileDescription[ConnectionId] | Additional description information received with the file. |
ReceivedFileEncryptionAlg[ConnectionId] | The encryption algorithm used for the file being received. |
ReceivedFileName[ConnectionId] | Returns the name of the received file. |
ReceivedFileNameFormat | The name format of received files. |
ReceivedFileNameFormat[ConnectionId] | The name format of received files. |
RecipientCertificateType | Specifies the type of recipient certificate being supplied. |
Retry[ConnectionId] | Indicates whether the recipient allows the send to be retried. |
SecureAuthentication | Specifies secure authentication requirements for connecting clients. |
SendCDAfterEFPA | Specifies whether a CD is always sent after receiving an EFPA. |
ServerPassword[ConnectionId] | Sets or gets the ServerPassword for a particular connection. |
ServerSFIDCode[ConnectionId] | Sets or gets the ServerSFIDCode for a particular connection. |
ServerSSIDCode[ConnectionId] | Sets the ServerSSIDCode for a particular connection. |
TempPath[ConnectionId] | The path of a directory where temporary files will be created. |
TrustedCertsData | Specifies the source to be used when importing trusted certificates. |
VirtualFileDateFormat | The DateTime format of received files. |
AllowedClients | A comma-separated list of host names or IP addresses that can access the class. |
BindExclusively | Whether or not the class considers a local port reserved for exclusive use. |
BlockedClients | A comma-separated list of host names or IP addresses that cannot access the class. |
ConnectionUID | The unique connectionId for a connection. |
DefaultConnectionTimeout | The inactivity timeout applied to the SSL handshake. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
MaxConnections | The maximum number of connections available. |
MaxReadTime | The maximum time spent reading data from each connection. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIOCP | Whether to use the completion port I/O model. |
UseIPv6 | Whether to use IPv6. |
UseWindowsMessages | Whether to use the WSAAsyncSelect I/O model. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
cert_store Property
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
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 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
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
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the cert_store and set cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
cert_subject Property
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
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
cert_encoded Property
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
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.
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
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 indicates the status of individual connections.
Syntax
def get_oftp_connection_connected(connection_id: int) -> bool: ...
Default Value
FALSE
Remarks
This property indicates the status of individual connections.
When True, the connection is established. Use the disconnect method to disconnect an existing 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_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) -> int: ...
Default Value
0
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:
0 (encra3DES - default) | DES (Triple Data Encryption Standard). |
1 (encraAES) | AES (Advanced Encryption Standard with key length of 128). |
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the oftp_connection_store and set oftp_connection_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats 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_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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
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.
Note: By default, all timeouts are inactivity timeouts, that is, 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:
0 (oftpVer12) | OFTP Version 1.2 |
1 (oftpVer13) | OFTP Version 1.3 |
2 (oftpVer14) | OFTP Version 1.4 |
3 (oftpVer20) | OFTP Version 2.0 |
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:
0 (Unstructured - default) | The outgoing file is binary and has not structure. There are no records in this type of file. |
1 (Text) | The outgoing file is a text file that consists of lines containing no more than 2048 characters terminated by CRLF. This type contains no records. |
2 (Fixed) | The outgoing file is in fixed file format, which means all records are of the same length. For fixed files, the class expects the file to be in text format with each line containing the max_record_size characters terminated by a CRLF. |
3 (Variable) | The outgoing file is a variable file format, meaning all records are of variable length and are no longer than max_record_size. When using this format, the class will parse out each record as a line terminated by CRLF. Thus, this type of file must be a text file, and must contain lines with less than max_record_size characters. |
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:
0 (slNone - default) | The file will not be signed nor encrypted. |
1 (slEncrypted) | The file will be encrypted using the certificate specified by the oftp_connection_recipient_cert_subject. property |
2 (slSigned) | The file will be signed using the certificate specified by the certificate property; |
3 (slEncryptedAndSigned) | The file will be both signed and encrypted. |
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.
Note: By default, all timeouts are inactivity timeouts, that is, 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
This property indicates whether the class is listening for incoming connections on LocalPort.
Syntax
def get_listening() -> bool: ...
listening = property(get_listening, None)
Default Value
FALSE
Remarks
This property indicates whether the class is listening for connections on the port specified by the local_port property. Use the start_listening and stop_listening methods to control whether the class is listening.
This property is read-only.
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
This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
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 multihomed 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:
Code Identifier | 'O' - Indicates ODETTE assigned the Organization Identifier. Other
values can be used for non-ODETTE codes.
NOTE: This field is a fixed length of 1 character. |
International Code | A code forming part of the Organization Identifier.
NOTE: This field may be of variable length up to 4 characters long. |
Organization Code | A code forming part of the Organization Identifier. This field may
contain the letters A to Z, the digits 0 to 9, and space and hyphen
characters.
NOTE: This field may be of variable length up to 14 characters long. |
Computer Sub-Address | A locally assigned address which uniquely identifies a system within
an organization (defined by an Organization Identifier).
NOTE: This field may be of variable length up to 6 characters long. |
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_effective_date Property
The date on which this certificate becomes valid.
Syntax
def get_ssl_cert_effective_date() -> str: ...
ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssl_cert_expiration_date Property
The date on which the certificate expires.
Syntax
def get_ssl_cert_expiration_date() -> str: ...
ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssl_cert_extended_key_usage Property
A comma-delimited list of extended key usage identifiers.
Syntax
def get_ssl_cert_extended_key_usage() -> str: ...
ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssl_cert_fingerprint Property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint() -> str: ...
ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssl_cert_fingerprint_sha1 Property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha1() -> str: ...
ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssl_cert_fingerprint_sha256 Property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssl_cert_fingerprint_sha256() -> str: ...
ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssl_cert_issuer Property
The issuer of the certificate.
Syntax
def get_ssl_cert_issuer() -> str: ...
ssl_cert_issuer = property(get_ssl_cert_issuer, None)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssl_cert_private_key Property
The private key of the certificate (if available).
Syntax
def get_ssl_cert_private_key() -> str: ...
ssl_cert_private_key = property(get_ssl_cert_private_key, None)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.
This property is read-only.
ssl_cert_private_key_available Property
Whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssl_cert_private_key_available() -> bool: ...
ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)
Default Value
FALSE
Remarks
Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssl_cert_private_key_container Property
The name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssl_cert_private_key_container() -> str: ...
ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)
Default Value
""
Remarks
The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssl_cert_public_key Property
The public key of the certificate.
Syntax
def get_ssl_cert_public_key() -> str: ...
ssl_cert_public_key = property(get_ssl_cert_public_key, None)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssl_cert_public_key_algorithm Property
The textual description of the certificate's public key algorithm.
Syntax
def get_ssl_cert_public_key_algorithm() -> str: ...
ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_cert_public_key_length Property
The length of the certificate's public key (in bits).
Syntax
def get_ssl_cert_public_key_length() -> int: ...
ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssl_cert_serial_number Property
The serial number of the certificate encoded as a string.
Syntax
def get_ssl_cert_serial_number() -> str: ...
ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssl_cert_signature_algorithm Property
The text description of the certificate's signature algorithm.
Syntax
def get_ssl_cert_signature_algorithm() -> str: ...
ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssl_cert_store Property
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
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 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
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
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssl_cert_subject_alt_names Property
Comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssl_cert_subject_alt_names() -> str: ...
ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssl_cert_thumbprint_md5 Property
The MD5 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_md5() -> str: ...
ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_thumbprint_sha1 Property
The SHA-1 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha1() -> str: ...
ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_thumbprint_sha256 Property
The SHA-256 hash of the certificate.
Syntax
def get_ssl_cert_thumbprint_sha256() -> str: ...
ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssl_cert_usage Property
The text description of UsageFlags .
Syntax
def get_ssl_cert_usage() -> str: ...
ssl_cert_usage = property(get_ssl_cert_usage, None)
Default Value
""
Remarks
The text description of ssl_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssl_cert_usage_flags Property
The flags that show intended use for the certificate.
Syntax
def get_ssl_cert_usage_flags() -> int: ...
ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssl_cert_version Property
The certificate's version number.
Syntax
def get_ssl_cert_version() -> str: ...
ssl_cert_version = property(get_ssl_cert_version, None)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssl_cert_subject Property
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
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssl_cert_encoded Property
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
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.
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
trusted_cert_store Property
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
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 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
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
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the trusted_cert_store and set trusted_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
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
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
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
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.
trusted_cert_encoded Property
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
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.
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
This 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:
0 | Request: The class will send the certificate file specified. The remote host will respond with a certificate of it's own. The response may be in a separate session. |
1 | Replace: The class will send the certificate file specified. No certificate is expected in response. The certificate sent here invalidates any previous certificates the remote host has stored. |
2 | Deliver: The class will send the certificate file specified. This is used to respond to a certificate request. It may also be used to send new additional certificates to the remote host. This will not invalidate previous certificates the remote host has stored. |
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:
ReasonCode | ReasonText |
3 | User Code Not Known |
4 | Invalid Password |
9 | Unspecified Reason |
11 | Invalid FileName |
12 | Invalid Destination |
13 | Invalid Origin |
14 | Invalid Storage Record Format |
15 | Maximum Record Length Not Supported |
16 | File Size Too Big |
20 | Invalid Record Count |
21 | Invalid Byte Count |
22 | Access Method Failure |
23 | Duplicate File |
24 | File Direction Refused |
25 | Cipher Suite Not Supported |
26 | Encrypted File Not Allowed |
27 | Unencrypted File Not Allowed |
28 | Compression Not Allowed |
29 | Signed File Not Allowed |
30 | Unsigned File Not Allowed |
31 | File Signature Not Valid |
32 | File Decompression Failed |
33 | File Decryption Failed |
34 | File Processing Failed |
35 | Not Delivered To Recipient |
36 | Not Acknowledged By Recipient |
50 | Transmission Stopped By The Operator |
90 | File Size Incompatible With Recipient's Protocol Version |
99 | Unspecified Reason |
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:
0 | OFTP 1.2 |
1 | OFTP 1.3 |
2 | OFTP 1.4 |
3 | OFTP 2.0 |
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:
0 | OFTP 1.2 |
1 | OFTP 1.3 |
2 | OFTP 1.4 |
3 | OFTP 2.0 |
When rejecting a connection the ErrorCode and ErrorDescription may optionally be set. Possible common values are:
ErrorCode | ErrorDescription |
3 | User Code Not Known |
4 | Invalid Password |
9 | Unspecified Reason |
10 | Mode or capabilities incompatible |
99 | Unspecified Reason |
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 file_name() -> str: ... @file_name.setter def file_name(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.
ErrorCode | ErrorMessage |
1 | Invalid filename. |
2 | Invalid destination. |
3 | Invalid origin. |
4 | Storage record format not supported. |
5 | Maximum record length not supported. |
6 | File size is too big. |
10 | Invalid record count. |
11 | Invalid byte count. |
12 | Access method failure. |
13 | Duplicate file. |
14 | File direction refused. |
15 | Cipher suite not supported. |
16 | Encrypted file not allowed. |
17 | Unencrypted file not allowed. |
18 | Compression not allowed. |
19 | Signed file not allowed. |
20 | Unsigned file not allowed. |
99 | Unspecified reason. |
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:
0 | Request: The class received a certificate and request from the remote host. Respond using the exchange_certificate method using a CertificateExchangeType of 3 (Deliver). The response may be in a separate session. |
1 | Replace: The class received a certificate from the remote host. No response is expected. The certificate received here invalidates any previously stored certificates for this configuration. |
2 | Deliver: The class received a certificate from the remote host. This is either a response to a certificate request, or a new additional certificates from the remote host. This will not invalidate previous certificates stored for this configuration. |
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:
0 | Received |
1 | Sent |
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:
ReasonCode | ReasonText |
3 | User Code Not Known |
4 | Invalid Password |
9 | Unspecified Reason |
11 | Invalid FileName |
12 | Invalid Destination |
13 | Invalid Origin |
14 | Invalid Storage Record Format |
15 | Maximum Record Length Not Supported |
16 | File Size Too Big |
20 | Invalid Record Count |
21 | Invalid Byte Count |
22 | Access Method Failure |
23 | Duplicate File |
24 | File Direction Refused |
25 | Cipher Suite Not Supported |
26 | Encrypted File Not Allowed |
27 | Unencrypted File Not Allowed |
28 | Compression Not Allowed |
29 | Signed File Not Allowed |
30 | Unsigned File Not Allowed |
31 | File Signature Not Valid |
32 | File Decompression Failed |
33 | File Decryption Failed |
34 | File Processing Failed |
35 | Not Delivered To Recipient |
36 | Not Acknowledged By Recipient |
50 | Transmission Stopped By The Operator |
90 | File Size Incompatible With Recipient's Protocol Version |
99 | Unspecified Reason |
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.
0 (Client) | The file originated from the client. |
1 (Server) | The file originated from the server. |
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:
ReasonCode | ReasonText |
3 | User Code Not Known |
4 | Invalid Password |
9 | Unspecified Reason |
11 | Invalid FileName |
12 | Invalid Destination |
13 | Invalid Origin |
14 | Invalid Storage Record Format |
15 | Maximum Record Length Not Supported |
16 | File Size Too Big |
20 | Invalid Record Count |
21 | Invalid Byte Count |
22 | Access Method Failure |
23 | Duplicate File |
24 | File Direction Refused |
25 | Cipher Suite Not Supported |
26 | Encrypted File Not Allowed |
27 | Unencrypted File Not Allowed |
28 | Compression Not Allowed |
29 | Signed File Not Allowed |
30 | Unsigned File Not Allowed |
31 | File Signature Not Valid |
32 | File Decompression Failed |
33 | File Decryption Failed |
34 | File Processing Failed |
35 | Not Delivered To Recipient |
36 | Not Acknowledged By Recipient |
50 | Transmission Stopped By The Operator |
90 | File Size Incompatible With Recipient's Protocol Version |
99 | Unspecified Reason |
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:
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as OFTP commands which are sent and received. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
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.
0 (Client) | The command originated from the connected client. |
1 (Server) | The command originated from the server. |
The CommandId and CommandDescription parameters specify which command was sent. The table below shows possible values.
CommandId | CommandDescription |
50 | SFPA (Start File Positive Answer) |
51 | SFNA (Start File Negative Answer) |
52 | EFPA (End File Positive Answer) |
53 | EFNA (End File Negative Answer) |
65 | AUCH (Authentication Challenge) |
67 | CDT (Set Credit) |
68 | DATA (Data Exchange Buffer) |
69 | EERP (End to End Response) |
70 | ESID (End Session) |
72 | SFID (Start File) |
73 | SSRM (Start Session Ready Message) |
74 | SECD (Security Change Direction) |
78 | NERP (Negative End Response) |
80 | RTR (Ready To Receive) |
82 | CD (Change Direction) |
83 | AURP (Authentication Response) |
84 | EFID (End File) |
88 | SSID (Start Session) |
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
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 designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
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.
0 (Client) | The file originated from the client. |
1 (Server) | The file originated from the server. |
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
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.OFTPServer Config Settings
component.Config("AllowRetry[" + e->ConnectionId + "]");
When set to False (default) the component will send a value indicating the client should not retry the send operation.
The CertificateStoreType specifies the type of the certificate store specified by CertificateStore. If the store is password protected, specify the password in CertificateStorePassword.
CertificateStore is used in conjunction with the CertificateSubject field in order to specify the certificate.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
1 | Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java. |
2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. |
3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. |
4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java. |
5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java. |
6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. |
17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. |
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
component.Config("CertificateType=3");
component.Certificate = mySigningCertificate;
Possible values are:
0 (default) | All Operations |
1 | Session Authentication |
2 | Decryption |
3 | Signing |
4 | Receipt Signing |
component.Config("CertificateType[ConnectionId]=3");
component.Config("CertificateStoreType[ConnectionId]=2");
component.Config("CertificateStore[ConnectionId]=C:\\mycert.pfx");
component.Config("CertificateStorePassword[ConnectionId]=password");
component.Config("CertificateSubject[ConnectionId]=*");
Possible values are:
0 (default) | All Operations |
1 | Session Authentication |
2 | Decryption |
3 | Signing |
4 | Receipt Signing |
This may be set within the on_accept_connection event. It only applies to the connection parameters sent by the server to the client. It does not return the value sent by the client to the server. Valid values are:
0 | Both (Default) |
1 | Send Only |
2 | Receive Only |
component.Config("ConnectionType[" + e->ConnectionId + "]=1");
To check the value sent by the client to the server query ReceivedConnectionType[ConnectionId]; instead.
When establishing a connection the smaller of the two values provided by the client and the server will be used. This setting may also be queried after a connection is established to determine the negotiated value.
For instance:
string receivedCreditCount = component.Config("CreditCount[" + e->ConnectionId + "]");
component.Config("CreditCount[" + e->ConnectionId + "]=55");
This only applies to clients that have not sent or received data within default_idle_timeout seconds.
If set to 0 (default) no idle timeout is applied.
Note: do_events must be called in order for the class to check existing connections.
0 | sha1 (Default) |
1 | sha256 |
2 | sha512 |
When this is set to True (default) and there is an error during processing the original unprocessed file will be deleted and no files will be placed in download_directory.
When establishing a connection the smaller of the two values provided by the client and the server will be used. This setting may also be queried after a connection is established to determine the negotiated value.
For instance:
string receivedExchangeBufferSize = component.Config("ExchangeBufferSize[" + e->ConnectionId + "]");
component.Config("ExchangeBufferSize[" + e->ConnectionId + "]=1024");
For a list of possible values please see cert_store_type. Also see ExchangeCertSubject.
For instance:
component.Config("FileDescription[myConnectionId]=My File Description");
To obtain the FileDescription when receiving files use ReceivedFileDescription[ConnectionId]; instead.
0 | sha1 |
1 | sha256 (Default) |
2 | sha512 |
0 (default) | Never follow redirects. An exception will be thrown. |
1 | Always follow redirects. The redirect will be automatically followed. |
2 | Follow same scheme redirects. Follow the redirect if it matches the same scheme (http:// or https://). |
For instance:
component.Config("IdleTimeout[" + e->ConnectionId + "]=1");
Note: do_events must be called in order for the class to check existing connections.
Please note that system TCP/IP stack implementations are not required to support SO_KEEPALIVE.
This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.
The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the class returns control immediately, the system might indefinitely hold system resources until all pending data is sent (even after your application closes). This means that valuable system resources might be wasted.
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.
This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as OFTP commands which are sent and received. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
This setting returns the type of connection being created. This may be queried within the on_accept_connection event or any time after. It only applies to the connection parameters sent by the client to the server. Valid values are:
0 | Both (Default) |
1 | Send Only |
2 | Receive Only |
For instance:
string receivedConnectionType = component.Config("ReceivedConnectionType[" + e->ConnectionId + "]");
For instance:
string receivedFileDescription = component.Config("ReceivedFileDescription[" + e->ConnectionId + "]");
0 | 3DES (Triple Data Encryption Standard). |
1 | AES (Advanced Encryption Standard with key length of 128). |
- %VirtualFileName%
- %VirtualFileDate%
- %Originator%
- %Destination%
- %UserData%
- %CurrentTime%
- %GUID%
The '%VirtualFileDate%' macro also supports date formatting through the use of an optional DateTime format string. The format of the macro with the date format string included is:
- %VirtualFileDate:CustomFormat%
- %VirtualFileName%
- %VirtualFileDate%
- %Originator%
- %Destination%
- %UserData%
- %CurrentTime%
- %GUID%
The '%VirtualFileDate%' macro also supports date formatting through the use of an optional DateTime format string. The format of the macro with the date format string included is:
- %VirtualFileDate:CustomFormat%
component.Config("RecipientCertificateType=3");
component.RecipientCert = mySignatureVerificationCertificate;
Possible values are:
0 (default) | All Operations |
1 | Session Authentication |
2 | Encryption |
3 | Signature Verification |
4 | Receipt Signature Verification |
0 | Disallowed. Secure authentication is not allowed and will result in an error. |
1 | Required. Secure authentication is required. If secure authentication is not supported by the client the connection will result in an error. |
2 (default) | Automatic. Secure authentication is allowed but not required. |
When set to True, this overrides the default behavior and will always send a CD command regardless of whether the indicator is set in the EFPA.
This should only be set if there is a specific reason to do so. In most cases it is not necessary.
- oftp_connection_compress is true
- oftp_connection_virtual_file_security_level is set to slEncrypted
- oftp_connection_virtual_file_security_level is set to slSigned
- oftp_connection_virtual_file_security_level is set to slEncryptedAndSigned
Note that oftp_connection_virtual_file_security_level is only applicable when oftp_connection_version is set to oftpVer20.
This configuration setting can be set with or without a ConnectionId specified. When the ConnectionId is specified, this will cause temporary files for that connection to be written to the specified directory. Otherwise, if no ConnectionId is specified, temporary files for all connections will be written to the given folder.
When using OFTP v2.0 If the class is configured to respond to EERP and NERP messages asynchronously this should be set to the value "yyyyMMddHHmmssffff" or a similar format that includes the same level of accuracy. This is required to ensure that when calling send_end_response the value saved from within the on_end_transfer event has the necessary data when sending a response.
TCPServer Config Settings
When a client connects, the client's address is checked against the list defined here. If there is no match, the on_connection_request event fires with an Accept value set to False. If no action is taken within the on_connection_request event, the client will be disconnected.
When a client connects, the client's address is checked against the list defined here. If there is a match, the on_connection_request event fires with an Accept value set to False. If no action is taken within the on_connection_request event, the client will not be connected.
Connection5UID = obj.config("ConnectionUID[5]")
Note: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated, the InBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.
InBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.
Note: This value is not applicable in macOS.
Note: This configuration setting is available only in the Unix platform, and it is not supported in macOS or FreeBSD.
Note: Unix/Linux operating systems limit the number of simultaneous connections to 1024.
The default value is 50 (milliseconds).
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.
OutBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.
By default, this configuration setting is set to False.
Nothing else is required to begin accepting IOCP connections. One major benefit to using this model is that there will be no thread blocked waiting for a request to complete. The system notifies the process through an Asynchronous Procedure Call (APC) once the device driver finishes servicing the I/O request. IOCP allows a single I/O worker thread handle multiple clients' input/output "fairly".
Note: When set to True, this setting will automatically set UseWindowsMessages to False.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 and IPv4 |
Nothing else is required to begin accepting connections using the Windows message queue. In high-traffic environments, messages will be discarded if the queue is full. Additionally, because a single window procedure will service all events on thousands of sockets, the Windows message queue is not scalable from a performance perspective.
If this setting is set to False, the class will instead use the Winsock select model instead.
SSL Config Settings
When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.
Enabling this configuration setting has no effect if ssl_provider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to True, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is as follows:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.
Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when ssl_provider is set to Platform include the following:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when ssl_provider is set to Platform include the following:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when ssl_provider is set to Internal include the following:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.
In editions that are designed to run on Windows, ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider), please be aware of the following notes:
- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the ssl_provider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and ssl_provider needs to be set to platform.
This configuration setting is applicable only when ssl_provider is set to Internal.
If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when ssl_provider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown certificate authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown certificate authority revocation status. |
0x00000800 | Ignore unknown root revocation status. |
0x00008000 | Allow test root certificate. |
0x00004000 | Trust test root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
OFTPServer Errors
OFTPServer Errors
671 | OFTP protocol error. |
672 | ServerSSID must be set before Listening is set to true. |
673 | ServerSFID must be set before Listening is set to true. |
675 | Session terminated by client. Unknown SSID. |
675 | Session terminated by client. Unknown SFID. |
677 | Session terminated by client. Unknown Password. |
678 | Error building packet to send. |
679 | Error reading file specified. |
680 | Invalid date timestamp. |
681 | Local file exists and overwrite is set to false. |
682 | Invalid hash value. |
683 | Invalid signature. |
684 | Cryptographic operation failed. |
685 | No encryption certificate was specified. |
686 | No signing certificate was specified. |
687 | Send failed. Check the description for more details. |
688 | The requested feature is only supported in OFTP Version 2.0. Check the description for more details. |
689 | A required certificate was not provided. The error descriptions indicates which property must be set. |
690 | Invalid Certificate. |
691 | Failed to import trusted certificates. |
TCPServer Errors
100 | You cannot change the remote_port at this time. A connection is in progress. |
101 | You cannot change the remote_host at this time. A connection is in progress. |
102 | The remote_host address is invalid (0.0.0.0). |
104 | TCPServer is already listening. |
106 | Cannot change local_port when TCPServer is listening. |
107 | Cannot change local_host when TCPServer is listening. |
108 | Cannot change MaxConnections when TCPServer is listening. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | remote_port cannot be zero. Please specify a valid service port number. |
126 | Invalid ConnectionId. |
135 | Operation would block. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |