# OFTPClient Class The OFTPClient class implements the Odette File Transfer Protocol. ## Syntax ```text class ipworksedi.OFTPClient ``` ## Remarks The OFTPClient component may be used to send and receive OFTP files to and from an OFTP server. **Receiving Files** The OFTPClient [receive_files](#receive_files-method) function requires certain server properties be set. You must set the [remote_host](#remote_host-property) property to the remote location of the desired OFTP server. You may also set a [remote_port](#remote_port-property) if the server is not set to the default protocol port. For client authorization, you must set the [client_ssid_code](#client_ssid_code-property), [client_sfid_code](#client_sfid_code-property), and [client_password](#client_password-property) properties. And, for server authentication, you must set the [server_ssid_code](#server_ssid_code-property), [server_sfid_code](#server_sfid_code-property), and [server_password](#server_password-property) properties. The class will connect to the OFTP server and download all files in the server's outgoing queue, and write these files to the directory specified by [download_directory](#download_directory-property). The class creates a default location on the local machine based on the values of the [download_directory](#download_directory-property) and the Virtual Filename as received from the server. If a different location is preferred, you may set the **LocalFile** parameter of the [on_start_transfer](#on_start_transfer-event) event. **Sending Files** The OFTPClient [send_file](#send_file-method) function requires the same server and authentication properties to be set as the [receive_files](#receive_files-method) function. The class will connect to the OFTP server and upload the file contained by the **LocalFile** parameter. It uses the name specified by **VirtualFileName** when sending to the server. If this is not specified, the filename of the local file is parsed and used as the virtual filename. ## 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_effective_date](#cert_effective_date-property) | The date on which this certificate becomes valid. | | [cert_encoded](#cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [cert_expiration_date](#cert_expiration_date-property) | The date on which the certificate expires. | | [cert_extended_key_usage](#cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [cert_fingerprint](#cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [cert_fingerprint_sha1](#cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [cert_fingerprint_sha256](#cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [cert_issuer](#cert_issuer-property) | The issuer of the certificate. | | [cert_private_key](#cert_private_key-property) | The private key of the certificate (if available). | | [cert_private_key_available](#cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [cert_private_key_container](#cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [cert_public_key](#cert_public_key-property) | The public key of the certificate. | | [cert_public_key_algorithm](#cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [cert_public_key_length](#cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [cert_serial_number](#cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [cert_signature_algorithm](#cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [cert_store](#cert_store-property) | The name of the certificate store for the client certificate. | | [cert_store_password](#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. | | [cert_store_type](#cert_store_type-property) | The type of certificate store for this certificate. | | [cert_subject](#cert_subject-property) | The subject of the certificate used for client authentication. | | [cert_subject_alt_names](#cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [cert_thumbprint_md5](#cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [cert_thumbprint_sha1](#cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [cert_thumbprint_sha256](#cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [cert_usage](#cert_usage-property) | The text description of UsageFlags . | | [cert_usage_flags](#cert_usage_flags-property) | The flags that show intended use for the certificate. | | [cert_version](#cert_version-property) | The certificate's version number. | | [client_password](#client_password-property) | The client's password. | | [client_sfid_code](#client_sfid_code-property) | Client's SFID code. | | [client_ssid_code](#client_ssid_code-property) | The client's SSID code. | | [compress](#compress-property) | Whether or not to compress the outgoing file. | | [connected](#connected-property) | Shows whether the class is connected. | | [download_directory](#download_directory-property) | Download directory. | | [encryption_algorithm](#encryption_algorithm-property) | The encryption algorithm. | | [firewall_auto_detect](#firewall_auto_detect-property) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_host](#firewall_host-property) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_type](#firewall_type-property) | The type of firewall to connect through. | | [firewall_user](#firewall_user-property) | A username if authentication is to be used when connecting through a firewall. | | [local_host](#local_host-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [max_record_size](#max_record_size-property) | The maximum length of a given record. | | [overwrite](#overwrite-property) | Whether or not the class should overwrite files during transfer. | | [recipient_cert_effective_date](#recipient_cert_effective_date-property) | The date on which this certificate becomes valid. | | [recipient_cert_encoded](#recipient_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [recipient_cert_expiration_date](#recipient_cert_expiration_date-property) | The date on which the certificate expires. | | [recipient_cert_extended_key_usage](#recipient_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [recipient_cert_fingerprint](#recipient_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha1](#recipient_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha256](#recipient_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [recipient_cert_issuer](#recipient_cert_issuer-property) | The issuer of the certificate. | | [recipient_cert_private_key](#recipient_cert_private_key-property) | The private key of the certificate (if available). | | [recipient_cert_private_key_available](#recipient_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [recipient_cert_private_key_container](#recipient_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [recipient_cert_public_key](#recipient_cert_public_key-property) | The public key of the certificate. | | [recipient_cert_public_key_algorithm](#recipient_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [recipient_cert_public_key_length](#recipient_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [recipient_cert_serial_number](#recipient_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [recipient_cert_signature_algorithm](#recipient_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [recipient_cert_store](#recipient_cert_store-property) | The name of the certificate store for the client certificate. | | [recipient_cert_store_password](#recipient_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. | | [recipient_cert_store_type](#recipient_cert_store_type-property) | The type of certificate store for this certificate. | | [recipient_cert_subject](#recipient_cert_subject-property) | The subject of the certificate used for client authentication. | | [recipient_cert_subject_alt_names](#recipient_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [recipient_cert_thumbprint_md5](#recipient_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [recipient_cert_thumbprint_sha1](#recipient_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [recipient_cert_thumbprint_sha256](#recipient_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [recipient_cert_usage](#recipient_cert_usage-property) | The text description of UsageFlags . | | [recipient_cert_usage_flags](#recipient_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [recipient_cert_version](#recipient_cert_version-property) | The certificate's version number. | | [remote_host](#remote_host-property) | The domain name or IP address of the OFTP server. | | [remote_port](#remote_port-property) | The port for the OFTP service (default is 3305). | | [secure_authentication](#secure_authentication-property) | Whether or not the class should perform secure Odette authentication. | | [server_password](#server_password-property) | The server's password. | | [server_sfid_code](#server_sfid_code-property) | Server's SFID code. | | [server_ssid_code](#server_ssid_code-property) | The server's SSID code. | | [signed_receipt](#signed_receipt-property) | Whether or not to require signed receipts. | | [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property) | The public key of the certificate. | | [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_accept_server_cert_store_password](#ssl_accept_server_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. | | [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property) | The certificate's version number. | | [ssl_cert_effective_date](#ssl_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_cert_encoded](#ssl_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#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. | | [ssl_cert_store_type](#ssl_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_cert_subject](#ssl_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property) | The certificate's version number. | | [timeout](#timeout-property) | This property includes the timeout for the class. | | [trusted_cert_count](#trusted_cert_count-property) | The number of records in the TrustedCert arrays. | | [trusted_cert_effective_date](#trusted_cert_effective_date-property) | The date on which this certificate becomes valid. | | [trusted_cert_encoded](#trusted_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [trusted_cert_expiration_date](#trusted_cert_expiration_date-property) | The date on which the certificate expires. | | [trusted_cert_extended_key_usage](#trusted_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [trusted_cert_fingerprint](#trusted_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [trusted_cert_fingerprint_sha1](#trusted_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [trusted_cert_fingerprint_sha256](#trusted_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [trusted_cert_issuer](#trusted_cert_issuer-property) | The issuer of the certificate. | | [trusted_cert_private_key](#trusted_cert_private_key-property) | The private key of the certificate (if available). | | [trusted_cert_private_key_available](#trusted_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [trusted_cert_private_key_container](#trusted_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [trusted_cert_public_key](#trusted_cert_public_key-property) | The public key of the certificate. | | [trusted_cert_public_key_algorithm](#trusted_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [trusted_cert_public_key_length](#trusted_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [trusted_cert_serial_number](#trusted_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [trusted_cert_signature_algorithm](#trusted_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [trusted_cert_store](#trusted_cert_store-property) | The name of the certificate store for the client certificate. | | [trusted_cert_store_password](#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. | | [trusted_cert_store_type](#trusted_cert_store_type-property) | The type of certificate store for this certificate. | | [trusted_cert_subject](#trusted_cert_subject-property) | The subject of the certificate used for client authentication. | | [trusted_cert_subject_alt_names](#trusted_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [trusted_cert_thumbprint_md5](#trusted_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [trusted_cert_thumbprint_sha1](#trusted_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [trusted_cert_thumbprint_sha256](#trusted_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [trusted_cert_usage](#trusted_cert_usage-property) | The text description of UsageFlags . | | [trusted_cert_usage_flags](#trusted_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [trusted_cert_version](#trusted_cert_version-property) | The certificate's version number. | | [use_ssl](#use_ssl-property) | Use SSL to access the RemoteHost . | | [version](#version-property) | Which version of the OFTP protocol the class is using. | | [virtual_file_date](#virtual_file_date-property) | The date/time stamp for the virtual file. | | [virtual_file_format](#virtual_file_format-property) | The structure of the outgoing file. | | [virtual_file_security_level](#virtual_file_security_level-property) | The level of security for the file. | ## 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](#change_direction-method) | Sends a Change Direction (CD) command. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [connect](#connect-method) | This method connects to the FTP server without logging in. | | [disconnect](#disconnect-method) | This method disconnects from the server without first logging off. | | [do_events](#do_events-method) | This method processes events from the internal message queue. | | [exchange_certificate](#exchange_certificate-method) | Exchange a certificate with the remote host. | | [import_trusted_certs](#import_trusted_certs-method) | Imports a list of trusted CA certificates. | | [interrupt](#interrupt-method) | This method interrupts the current action. | | [logoff](#logoff-method) | Logoff from the OFTP server. | | [logon](#logon-method) | Logon to the OFTP RemoteHost using the current client credentials. | | [receive_files](#receive_files-method) | Receive any files queued to be sent from the server. | | [reset](#reset-method) | Resets the state of the control. | | [send_end_response](#send_end_response-method) | Sends an EERP/NERP asynchronously. | | [send_file](#send_file-method) | Send the specified file to the server. | | [validate_cert](#validate_cert-method) | Validates the certificate with private key. | | [validate_recipient_cert](#validate_recipient_cert-method) | 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_file](#on_accept_file-event) | Fired when the client receives a file. | | [on_certificate_received](#on_certificate_received-event) | Fired when a certificate is received from the remote host. | | [on_end_response](#on_end_response-event) | Fired every time an end response is received from the server. | | [on_end_transfer](#on_end_transfer-event) | Fired when a file finishes transferring. | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_log](#on_log-event) | Fires once for each log message. | | [on_pi_trail](#on_pi_trail-event) | Fired when any protocol level communication occurs. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event) | Fired when secure connection progress messages are available. | | [on_start_transfer](#on_start_transfer-event) | Fired when a document starts transferring. | | [on_transfer](#on_transfer-event) | 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.* | | | | --- | --- | | [AcceptAnySFIDCode](#AcceptAnySFIDCode) | Indicates that all SFID codes are acceptable. | | [AllowRetry](#AllowRetry) | Whether to send a retry indicator when rejecting a file. | | [CertificateType](#CertificateType) | Specifies the type of certificate being supplied. | | [ConnectionType](#ConnectionType) | Specifies the type of connection that will be created. | | [CreditCount](#CreditCount) | Specifies the credit value. | | [DeleteOnError](#DeleteOnError) | Whether received files are deleted when there is an error during processing. | | [DisconnectAfterEndSession](#DisconnectAfterEndSession) | Determines if the connection is closed immediately after ending the session. | | [EnforceProtocolVersion](#EnforceProtocolVersion) | Requires the server to support the same OFTP version. | | [ExchangeBufferSize](#ExchangeBufferSize) | Specifies the data exchange buffer size in bytes. | | [ExchangeCertStoreType](#ExchangeCertStoreType) | Specifies the store type when loading a certificate to be exchanged. | | [ExchangeCertSubject](#ExchangeCertSubject) | The subject of the certificate being exchanged. | | [FailOnUntrustedCert](#FailOnUntrustedCert) | Whether or not to throw an exception when untrusted certificates are used. | | [FileDescription](#FileDescription) | Additional description information sent with the file. | | [FileHashAlgorithm](#FileHashAlgorithm) | The hash algorithm to use when sending a file. | | [FireEndResponseOnSend](#FireEndResponseOnSend) | Determines if the EndResponse event is fired for outgoing EERP and NERPs. | | [FollowRedirects](#FollowRedirects) | Determines behavior when importing trusted certificates and a HTTP redirect is returned. | | [FriendlyLogFormat](#FriendlyLogFormat) | Determines if a more friendly format is applied to PITrail event out. | | [LogLevel](#LogLevel) | The level of information to log. | | [MaskSensitiveData](#MaskSensitiveData) | Masks passwords in logs. | | [ReceiptHashAlgorithm](#ReceiptHashAlgorithm) | The receipt hash algorithm to request when sending a file. | | [ReceivedFileDateTime](#ReceivedFileDateTime) | The datetime of the file being received. | | [ReceivedFileDescription](#ReceivedFileDescription) | Additional description information received with the file. | | [ReceivedFileEncryptionAlg](#ReceivedFileEncryptionAlg) | The encryption algorithm used for the file being received. | | [ReceivedFileName](#ReceivedFileName) | Returns the name of the received file. | | [ReceivedFileNameFormat](#ReceivedFileNameFormat) | The name format of received files. | | [ReceivedFileNameFormat](#ReceivedFileNameFormat) | The name format of received files. | | [RecipientCertificateType](#RecipientCertificateType) | Specifies the type of recipient certificate being supplied. | | [Retry](#Retry) | Indicates whether the recipient allows the send to be retried. | | [SendCDAfterEFPA](#SendCDAfterEFPA) | Specifies whether a CD is always sent after receiving an EFPA. | | [TempPath](#TempPath) | The path of a directory where temporary files will be created. | | [TrustedCertsData](#TrustedCertsData) | Specifies the source to be used when importing trusted certificates. | | [VirtualFileDateFormat](#VirtualFileDateFormat) | The DateTime format of received files. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_cert_effective_date() -> str: ... cert_effective_date = property(get_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. # cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text 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](#cert_store-property) and [cert_subject](#cert_subject-property) properties also may be used to specify a certificate. When [cert_encoded](#cert_encoded-property) is set, a search is initiated in the current [cert_store](#cert_store-property) for the private key of the certificate. If the key is found, [cert_subject](#cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [cert_subject](#cert_subject-property) is set to an empty string. # cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_cert_expiration_date() -> str: ... cert_expiration_date = property(get_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. # cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_cert_extended_key_usage() -> str: ... cert_extended_key_usage = property(get_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. # cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint() -> str: ... cert_fingerprint = property(get_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. # cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint_sha1() -> str: ... cert_fingerprint_sha1 = property(get_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. # cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_cert_fingerprint_sha256() -> str: ... cert_fingerprint_sha256 = property(get_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. # cert_issuer property The issuer of the certificate. ## Syntax ```text def get_cert_issuer() -> str: ... cert_issuer = property(get_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. # cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_cert_private_key() -> str: ... cert_private_key = property(get_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 [cert_private_key](#cert_private_key-property) may be available but not exportable. In this case, [cert_private_key](#cert_private_key-property) returns an empty string. This property is read-only. # cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_cert_private_key_available() -> bool: ... cert_private_key_available = property(get_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [cert_private_key](#cert_private_key-property) is available for the selected certificate. If [cert_private_key_available](#cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_cert_private_key_container() -> str: ... cert_private_key_container = property(get_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [cert_private_key](#cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # cert_public_key property The public key of the certificate. ## Syntax ```text def get_cert_public_key() -> str: ... cert_public_key = property(get_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. # cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_cert_public_key_algorithm() -> str: ... cert_public_key_algorithm = property(get_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. # cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_cert_public_key_length() -> int: ... cert_public_key_length = property(get_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. # cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_cert_serial_number() -> str: ... cert_serial_number = property(get_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. # cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_cert_signature_algorithm() -> str: ... cert_signature_algorithm = property(get_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. # cert_store property The name of the certificate store for the client certificate. ## Syntax ```text 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](#cert_store_type-property) property denotes the type of the certificate store specified by [cert_store](#cert_store-property). If the store is password-protected, specify the password in [cert_store_password](#cert_store_password-property). [cert_store](#cert_store-property) is used in conjunction with the [cert_subject](#cert_subject-property) property to specify client certificates. If [cert_store](#cert_store-property) has a value, and [cert_subject](#cert_subject-property) or [cert_encoded](#cert_encoded-property) is set, a search for a certificate is initiated. Please see the [cert_subject](#cert_subject-property) 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 ```text 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 ```text 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) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [cert_store_type](#cert_store_type-property), the full path of the PKCS#11 DLL as the [cert_store](#cert_store-property), and the PIN as the [cert_store_password](#cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [cert_store](#cert_store-property) and set [cert_store_password](#cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 ```text 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=example@email.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_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_cert_subject_alt_names() -> str: ... cert_subject_alt_names = property(get_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_md5() -> str: ... cert_thumbprint_md5 = property(get_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. # cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_sha1() -> str: ... cert_thumbprint_sha1 = property(get_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. # cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_cert_thumbprint_sha256() -> str: ... cert_thumbprint_sha256 = property(get_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. # cert_usage property The text description of UsageFlags . ## Syntax ```text def get_cert_usage() -> str: ... cert_usage = property(get_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [cert_usage_flags](#cert_usage_flags-property). 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. # cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_cert_usage_flags() -> int: ... cert_usage_flags = property(get_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [cert_usage_flags](#cert_usage_flags-property) 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 [cert_usage](#cert_usage-property) property for a text representation of [cert_usage_flags](#cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # cert_version property The certificate's version number. ## Syntax ```text def get_cert_version() -> str: ... cert_version = property(get_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. # client_password property The client's password. ## Syntax ```text def get_client_password() -> str: ... def set_client_password(value: str) -> None: ... client_password = property(get_client_password, set_client_password) ``` ## Default Value "" ## Remarks The password assigned to the client in the bilateral agreement. This property must be a string of no more than 8 characters long. # client_sfid_code property Client's SFID code. ## Syntax ```text def get_client_sfid_code() -> str: ... def set_client_sfid_code(value: str) -> None: ... client_sfid_code = property(get_client_sfid_code, set_client_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. # client_ssid_code property The client's SSID code. ## Syntax ```text def get_client_ssid_code() -> str: ... def set_client_ssid_code(value: str) -> None: ... client_ssid_code = property(get_client_ssid_code, set_client_ssid_code) ``` ## Default Value "" ## Remarks The identification code of the client. 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. | # compress property Whether or not to compress the outgoing file. ## Syntax ```text def get_compress() -> bool: ... def set_compress(value: bool) -> None: ... compress = property(get_compress, set_compress) ``` ## Default Value FALSE ## Remarks When sending a file to the trading partner, set this to true for the class to compress the file before sending. The file will first be compressed to a temporary file before being sent. Note that this is only applicable when Version 2.0 of the protocol is used as indicated by [version](#version-property). # connected property Shows whether the class is connected. ## Syntax ```text def get_connected() -> bool: ... connected = property(get_connected, None) ``` ## Default Value FALSE ## Remarks Use this property to determine whether the class is connected to the remote host or not. Use the [connect](#connect-method) and [disconnect](#disconnect-method) methods to manage the connection. This property is read-only. # download_directory property Download directory. ## Syntax ```text def get_download_directory() -> str: ... def set_download_directory(value: str) -> None: ... download_directory = property(get_download_directory, set_download_directory) ``` ## Default Value "./" ## Remarks This property contains the location on disk of the folder the class will write received files to. The default for this property is "./", which is the current working directory. Note: If this property is set to empty string data will not be written to disk and instead will be available through the [on_transfer](#on_transfer-event) event. # encryption_algorithm property The encryption algorithm. ## Syntax ```text def get_encryption_algorithm() -> int: ... def set_encryption_algorithm(value: int) -> None: ... encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm) ``` ## Possible Values ```text 0 # 3DES1 # AES ``` ## Default Value 0 ## Remarks In order to use encryption, you must set the [virtual_file_security_level](#virtual_file_security_level-property) property. The supported algorithms for encryption are: | | | | --- | --- | | 3DES (0) | Triple Data Encryption Standard. | | AES (1) | Advanced Encryption Standard CBC mode with a 256-bit key. | # firewall_auto_detect property Whether to automatically detect and use firewall system settings, if available. ## Syntax ```text def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ... firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use firewall system settings, if available. # firewall_host property The name or IP address of the firewall (optional). ## Syntax ```text def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ... firewall_host = property(get_firewall_host, set_firewall_host) ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error. # firewall_password property A password if authentication is to be used when connecting through the firewall. ## Syntax ```text def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ... firewall_password = property(get_firewall_password, set_firewall_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property) is specified, the [firewall_user](#firewall_user-property) and [firewall_password](#firewall_password-property) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. # firewall_port property The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax ```text def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ... firewall_port = property(get_firewall_port, set_firewall_port) ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property). See the description of the [firewall_host](#firewall_host-property) property for details. NOTE: This property is set automatically when [firewall_type](#OFTPClient_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#OFTPClient_p_FirewallFirewallType) property for details. # firewall_type property The type of firewall to connect through. ## Syntax ```text def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ... firewall_type = property(get_firewall_type, set_firewall_type) ``` ## Possible Values ```text 0 # None1 # Tunnel2 # SOCKS43 # SOCKS510 # SOCKS4A ``` ## Default Value 0 ## Remarks The type of firewall to connect through. The applicable values are as follows: | | | | --- | --- | | fwNone (0) | No firewall (default setting). | | fwTunnel (1) | Connect through a tunneling proxy. [firewall_port](#firewall_port-property) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property) is set to 1080. | # firewall_user property A username if authentication is to be used when connecting through a firewall. ## Syntax ```text def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ... firewall_user = property(get_firewall_user, set_firewall_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property) is specified, this property and the [firewall_password](#firewall_password-property) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error. # local_host property The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text 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 classes) 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. # max_record_size property The maximum length of a given record. ## Syntax ```text def get_max_record_size() -> int: ... def set_max_record_size(value: int) -> None: ... max_record_size = property(get_max_record_size, set_max_record_size) ``` ## Default Value 0 ## Remarks This value determines the maximum length for a record in the outgoing virtual file. When [virtual_file_format](#virtual_file_format-property) 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. # overwrite property Whether or not the class should overwrite files during transfer. ## Syntax ```text def get_overwrite() -> bool: ... def set_overwrite(value: bool) -> None: ... overwrite = property(get_overwrite, set_overwrite) ``` ## Default Value FALSE ## Remarks This property is a value indicating whether or not the class should overwrite downloaded files. If overwrite is false, an error will be thrown whenever the local file exists before a receive operation. # recipient_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_recipient_cert_effective_date() -> str: ... recipient_cert_effective_date = property(get_recipient_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. # recipient_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_recipient_cert_encoded() -> bytes: ... def set_recipient_cert_encoded(value: bytes) -> None: ... recipient_cert_encoded = property(get_recipient_cert_encoded, set_recipient_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [recipient_cert_store](#recipient_cert_store-property) and [recipient_cert_subject](#recipient_cert_subject-property) properties also may be used to specify a certificate. When [recipient_cert_encoded](#recipient_cert_encoded-property) is set, a search is initiated in the current [recipient_cert_store](#recipient_cert_store-property) for the private key of the certificate. If the key is found, [recipient_cert_subject](#recipient_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [recipient_cert_subject](#recipient_cert_subject-property) is set to an empty string. # recipient_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_recipient_cert_expiration_date() -> str: ... recipient_cert_expiration_date = property(get_recipient_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. # recipient_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_recipient_cert_extended_key_usage() -> str: ... recipient_cert_extended_key_usage = property(get_recipient_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. # recipient_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint() -> str: ... recipient_cert_fingerprint = property(get_recipient_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. # recipient_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint_sha1() -> str: ... recipient_cert_fingerprint_sha1 = property(get_recipient_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. # recipient_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_recipient_cert_fingerprint_sha256() -> str: ... recipient_cert_fingerprint_sha256 = property(get_recipient_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. # recipient_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_recipient_cert_issuer() -> str: ... recipient_cert_issuer = property(get_recipient_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. # recipient_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_recipient_cert_private_key() -> str: ... recipient_cert_private_key = property(get_recipient_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 [recipient_cert_private_key](#recipient_cert_private_key-property) may be available but not exportable. In this case, [recipient_cert_private_key](#recipient_cert_private_key-property) returns an empty string. This property is read-only. # recipient_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_recipient_cert_private_key_available() -> bool: ... recipient_cert_private_key_available = property(get_recipient_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [recipient_cert_private_key](#recipient_cert_private_key-property) is available for the selected certificate. If [recipient_cert_private_key_available](#recipient_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # recipient_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_recipient_cert_private_key_container() -> str: ... recipient_cert_private_key_container = property(get_recipient_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [recipient_cert_private_key](#recipient_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # recipient_cert_public_key property The public key of the certificate. ## Syntax ```text def get_recipient_cert_public_key() -> str: ... recipient_cert_public_key = property(get_recipient_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. # recipient_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_recipient_cert_public_key_algorithm() -> str: ... recipient_cert_public_key_algorithm = property(get_recipient_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. # recipient_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_recipient_cert_public_key_length() -> int: ... recipient_cert_public_key_length = property(get_recipient_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. # recipient_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_recipient_cert_serial_number() -> str: ... recipient_cert_serial_number = property(get_recipient_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. # recipient_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_recipient_cert_signature_algorithm() -> str: ... recipient_cert_signature_algorithm = property(get_recipient_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. # recipient_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_recipient_cert_store() -> bytes: ... def set_recipient_cert_store(value: bytes) -> None: ... recipient_cert_store = property(get_recipient_cert_store, set_recipient_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [recipient_cert_store_type](#recipient_cert_store_type-property) property denotes the type of the certificate store specified by [recipient_cert_store](#recipient_cert_store-property). If the store is password-protected, specify the password in [recipient_cert_store_password](#recipient_cert_store_password-property). [recipient_cert_store](#recipient_cert_store-property) is used in conjunction with the [recipient_cert_subject](#recipient_cert_subject-property) property to specify client certificates. If [recipient_cert_store](#recipient_cert_store-property) has a value, and [recipient_cert_subject](#recipient_cert_subject-property) or [recipient_cert_encoded](#recipient_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [recipient_cert_subject](#recipient_cert_subject-property) 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). # recipient_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 ```text def get_recipient_cert_store_password() -> str: ... def set_recipient_cert_store_password(value: str) -> None: ... recipient_cert_store_password = property(get_recipient_cert_store_password, set_recipient_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. # recipient_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_recipient_cert_store_type() -> int: ... def set_recipient_cert_store_type(value: int) -> None: ... recipient_cert_store_type = property(get_recipient_cert_store_type, set_recipient_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [recipient_cert_store_type](#recipient_cert_store_type-property), the full path of the PKCS#11 DLL as the [recipient_cert_store](#recipient_cert_store-property), and the PIN as the [recipient_cert_store_password](#recipient_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [recipient_cert_store](#recipient_cert_store-property) and set [recipient_cert_store_password](#recipient_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | # recipient_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_recipient_cert_subject() -> str: ... def set_recipient_cert_subject(value: str) -> None: ... recipient_cert_subject = property(get_recipient_cert_subject, set_recipient_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=example@email.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. # recipient_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_recipient_cert_subject_alt_names() -> str: ... recipient_cert_subject_alt_names = property(get_recipient_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # recipient_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_md5() -> str: ... recipient_cert_thumbprint_md5 = property(get_recipient_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. # recipient_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_sha1() -> str: ... recipient_cert_thumbprint_sha1 = property(get_recipient_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. # recipient_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_recipient_cert_thumbprint_sha256() -> str: ... recipient_cert_thumbprint_sha256 = property(get_recipient_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. # recipient_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_recipient_cert_usage() -> str: ... recipient_cert_usage = property(get_recipient_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property). 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. # recipient_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_recipient_cert_usage_flags() -> int: ... recipient_cert_usage_flags = property(get_recipient_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property) 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 [recipient_cert_usage](#recipient_cert_usage-property) property for a text representation of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # recipient_cert_version property The certificate's version number. ## Syntax ```text def get_recipient_cert_version() -> str: ... recipient_cert_version = property(get_recipient_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. # remote_host property The domain name or IP address of the OFTP server. ## Syntax ```text def get_remote_host() -> str: ... def set_remote_host(value: str) -> None: ... remote_host = property(get_remote_host, set_remote_host) ``` ## Default Value "" ## Remarks The remote_host property specifies the IP address (IP number in dotted internet format) or Domain Name of the OFTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress. If the remote_host property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the remote_host property is set to the corresponding address. If the search is not successful, an error is returned. 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. # remote_port property The port for the OFTP service (default is 3305). ## Syntax ```text def get_remote_port() -> int: ... def set_remote_port(value: int) -> None: ... remote_port = property(get_remote_port, set_remote_port) ``` ## Default Value 3305 ## Remarks A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error. When [use_ssl](#use_ssl-property) is set to True this property will be set to 6619. # secure_authentication property Whether or not the class should perform secure Odette authentication. ## Syntax ```text def get_secure_authentication() -> bool: ... def set_secure_authentication(value: bool) -> None: ... secure_authentication = property(get_secure_authentication, set_secure_authentication) ``` ## Default Value FALSE ## Remarks If true, the class will perform secure authentication when connecting to the server. The secure authentication consists of encrypting and decrypting data sent to and from the server, and verifying that this occurred successfully. Secure authentication may be performed in plaintext or SSL mode. Both certificate and recipient_cert properties must be populated when this property is set to true. This is only valid for version 2.0 of the protocol. # server_password property The server's password. ## Syntax ```text 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 ```text 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 ```text 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. | # signed_receipt property Whether or not to require signed receipts. ## Syntax ```text def get_signed_receipt() -> bool: ... def set_signed_receipt(value: bool) -> None: ... signed_receipt = property(get_signed_receipt, set_signed_receipt) ``` ## Default Value FALSE ## Remarks When sending a file to a trading partner, set this to true if the file receipt should be signed by the server. When this receipt is received by the class, it will be verified during processing. NOTE: If the server does not attach the public certificate in the signed message, the server's public key must be specified in the recipient_cert property in order for verification to succeed. # ssl_accept_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_accept_server_cert_effective_date() -> str: ... ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_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_accept_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ... ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is set to an empty string. # ssl_accept_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_accept_server_cert_expiration_date() -> str: ... ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_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_accept_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_accept_server_cert_extended_key_usage() -> str: ... ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_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_accept_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint() -> str: ... ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_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_accept_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ... ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_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_accept_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ... ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_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_accept_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_issuer() -> str: ... ssl_accept_server_cert_issuer = property(get_ssl_accept_server_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_accept_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key() -> str: ... ssl_accept_server_cert_private_key = property(get_ssl_accept_server_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_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_accept_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_accept_server_cert_private_key_available() -> bool: ... ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_accept_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key_container() -> str: ... ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_accept_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_public_key() -> str: ... ssl_accept_server_cert_public_key = property(get_ssl_accept_server_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_accept_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_accept_server_cert_public_key_algorithm() -> str: ... ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_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_accept_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_accept_server_cert_public_key_length() -> int: ... ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_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_accept_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_accept_server_cert_serial_number() -> str: ... ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_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_accept_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_accept_server_cert_signature_algorithm() -> str: ... ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_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_accept_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ... ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) 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_accept_server_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 ```text def get_ssl_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ... ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_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_accept_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ... ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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_accept_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ... ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_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=example@email.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_accept_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_subject_alt_names() -> str: ... ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_accept_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_md5() -> str: ... ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_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_accept_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ... ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_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_accept_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ... ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_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_accept_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_accept_server_cert_usage() -> str: ... ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). 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_accept_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_usage_flags() -> int: ... ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) 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_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_accept_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_accept_server_cert_version() -> str: ... ssl_accept_server_cert_version = property(get_ssl_accept_server_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_effective_date property The date on which this certificate becomes valid. ## Syntax ```text 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_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text 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](#ssl_cert_store-property) and [ssl_cert_subject](#ssl_cert_subject-property) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property) is set to an empty string. # ssl_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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](#ssl_cert_private_key-property) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property) 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 ```text 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](#ssl_cert_private_key-property) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) 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 ```text 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](#ssl_cert_private_key-property) 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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 ```text 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](#ssl_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property). [ssl_cert_store](#ssl_cert_store-property) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property) has a value, and [ssl_cert_subject](#ssl_cert_subject-property) or [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property) 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 ```text 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 ```text 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) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property) and set [ssl_cert_store_password](#ssl_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 property The subject of the certificate used for client authentication. ## Syntax ```text 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=example@email.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_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text 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 ```text 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 ```text 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 ```text 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 ```text 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](#ssl_cert_usage_flags-property). 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 ```text 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](#ssl_cert_usage_flags-property) 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](#ssl_cert_usage-property) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). 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 ```text 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. # timeout property This property includes the timeout for the class. ## Syntax ```text def get_timeout() -> int: ... def set_timeout(value: int) -> None: ... timeout = property(get_timeout, set_timeout) ``` ## Default Value 60 ## Remarks If the timeout property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately. If timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of timeout seconds. The class will use [do_events](#do_events-method) 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 timeout property is 60 seconds. # trusted_cert_count property The number of records in the TrustedCert arrays. ## Syntax ```text 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_effective_date](#trusted_cert_effective_date-property) - [trusted_cert_encoded](#trusted_cert_encoded-property) - [trusted_cert_expiration_date](#trusted_cert_expiration_date-property) - [trusted_cert_extended_key_usage](#trusted_cert_extended_key_usage-property) - [trusted_cert_fingerprint](#trusted_cert_fingerprint-property) - [trusted_cert_fingerprint_sha1](#trusted_cert_fingerprint_sha1-property) - [trusted_cert_fingerprint_sha256](#trusted_cert_fingerprint_sha256-property) - [trusted_cert_issuer](#trusted_cert_issuer-property) - [trusted_cert_private_key](#trusted_cert_private_key-property) - [trusted_cert_private_key_available](#trusted_cert_private_key_available-property) - [trusted_cert_private_key_container](#trusted_cert_private_key_container-property) - [trusted_cert_public_key](#trusted_cert_public_key-property) - [trusted_cert_public_key_algorithm](#trusted_cert_public_key_algorithm-property) - [trusted_cert_public_key_length](#trusted_cert_public_key_length-property) - [trusted_cert_serial_number](#trusted_cert_serial_number-property) - [trusted_cert_signature_algorithm](#trusted_cert_signature_algorithm-property) - [trusted_cert_store](#trusted_cert_store-property) - [trusted_cert_store_password](#trusted_cert_store_password-property) - [trusted_cert_store_type](#trusted_cert_store_type-property) - [trusted_cert_subject](#trusted_cert_subject-property) - [trusted_cert_subject_alt_names](#trusted_cert_subject_alt_names-property) - [trusted_cert_thumbprint_md5](#trusted_cert_thumbprint_md5-property) - [trusted_cert_thumbprint_sha1](#trusted_cert_thumbprint_sha1-property) - [trusted_cert_thumbprint_sha256](#trusted_cert_thumbprint_sha256-property) - [trusted_cert_usage](#trusted_cert_usage-property) - [trusted_cert_usage_flags](#trusted_cert_usage_flags-property) - [trusted_cert_version](#trusted_cert_version-property) The array indices start at *0* and end at *trusted_cert_count - 1*. # trusted_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_trusted_cert_effective_date(trusted_cert_index: int) -> str: ... ``` ## 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text 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](#trusted_cert_store-property) and [trusted_cert_subject](#trusted_cert_subject-property) properties also may be used to specify a certificate. When [trusted_cert_encoded](#trusted_cert_encoded-property) is set, a search is initiated in the current [trusted_cert_store](#trusted_cert_store-property) for the private key of the certificate. If the key is found, [trusted_cert_subject](#trusted_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [trusted_cert_subject](#trusted_cert_subject-property) 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](#trusted_cert_count-property) property. # trusted_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_trusted_cert_expiration_date(trusted_cert_index: int) -> str: ... ``` ## 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_trusted_cert_extended_key_usage(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_trusted_cert_fingerprint(trusted_cert_index: int) -> str: ... ``` ## 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* 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_trusted_cert_fingerprint_sha1(trusted_cert_index: int) -> str: ... ``` ## 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* 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_trusted_cert_fingerprint_sha256(trusted_cert_index: int) -> str: ... ``` ## 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* 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_trusted_cert_issuer(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_trusted_cert_private_key(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [trusted_cert_private_key](#trusted_cert_private_key-property) may be available but not exportable. In this case, [trusted_cert_private_key](#trusted_cert_private_key-property) returns 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_trusted_cert_private_key_available(trusted_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Whether a [trusted_cert_private_key](#trusted_cert_private_key-property) is available for the selected certificate. If [trusted_cert_private_key_available](#trusted_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_trusted_cert_private_key_container(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The name of the [trusted_cert_private_key](#trusted_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_public_key property The public key of the certificate. ## Syntax ```text def get_trusted_cert_public_key(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_trusted_cert_public_key_algorithm(trusted_cert_index: int) -> str: ... ``` ## 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_trusted_cert_public_key_length(trusted_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_trusted_cert_serial_number(trusted_cert_index: int) -> str: ... ``` ## 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_trusted_cert_signature_algorithm(trusted_cert_index: int) -> str: ... ``` ## 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text 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](#trusted_cert_store_type-property) property denotes the type of the certificate store specified by [trusted_cert_store](#trusted_cert_store-property). If the store is password-protected, specify the password in [trusted_cert_store_password](#trusted_cert_store_password-property). [trusted_cert_store](#trusted_cert_store-property) is used in conjunction with the [trusted_cert_subject](#trusted_cert_subject-property) property to specify client certificates. If [trusted_cert_store](#trusted_cert_store-property) has a value, and [trusted_cert_subject](#trusted_cert_subject-property) or [trusted_cert_encoded](#trusted_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [trusted_cert_subject](#trusted_cert_subject-property) 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](#trusted_cert_count-property) 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 ```text 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](#trusted_cert_count-property) property. # trusted_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_trusted_cert_store_type(trusted_cert_index: int) -> int: ... def set_trusted_cert_store_type(trusted_cert_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [trusted_cert_store_type](#trusted_cert_store_type-property), the full path of the PKCS#11 DLL as the [trusted_cert_store](#trusted_cert_store-property), and the PIN as the [trusted_cert_store_password](#trusted_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [trusted_cert_store](#trusted_cert_store-property) and set [trusted_cert_store_password](#trusted_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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](#trusted_cert_count-property) property. # trusted_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text 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=example@email.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](#trusted_cert_count-property) property. # trusted_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_trusted_cert_subject_alt_names(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_trusted_cert_thumbprint_md5(trusted_cert_index: int) -> str: ... ``` ## 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_trusted_cert_thumbprint_sha1(trusted_cert_index: int) -> str: ... ``` ## 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_trusted_cert_thumbprint_sha256(trusted_cert_index: int) -> str: ... ``` ## 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_trusted_cert_usage(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The text description of [trusted_cert_usage_flags](#trusted_cert_usage_flags-property). 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. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_trusted_cert_usage_flags(trusted_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [trusted_cert_usage_flags](#trusted_cert_usage_flags-property) 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 [trusted_cert_usage](#trusted_cert_usage-property) property for a text representation of [trusted_cert_usage_flags](#trusted_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. 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](#trusted_cert_count-property) property. This property is read-only. # trusted_cert_version property The certificate's version number. ## Syntax ```text def get_trusted_cert_version(trusted_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". 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](#trusted_cert_count-property) property. This property is read-only. # use_ssl property Use SSL to access the RemoteHost . ## Syntax ```text 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 to connect with the [remote_host](#remote_host-property). This property is only valid when using version 2.0 of the protocol. Note: Setting this property to True will set [remote_port](#remote_port-property) to 6619. # version property Which version of the OFTP protocol the class is using. ## Syntax ```text def get_version() -> int: ... def set_version(value: int) -> None: ... version = property(get_version, set_version) ``` ## Possible Values ```text 0 # Ver121 # Ver132 # Ver143 # Ver20 ``` ## Default Value 3 ## Remarks This property specifies which version of the OFTP protocol to use. Possible values are: | | | | --- | --- | | 0 (oftpVer12) | 1.2 | | 1 (oftpVer13) | 1.3 | | 2 (oftpVer14) | 1.4 | | 3 (oftpVer20 - default) | 2.0 | The default value is oftpVer20 (Version 2.0). Note: Version 2.0 (oftpVer20) of the protocol must be used when using security functions. The following properties are only applicable when using Version 2.0: - [use_ssl](#use_ssl-property) - [secure_authentication](#secure_authentication-property) - [virtual_file_security_level](#virtual_file_security_level-property) - [compress](#compress-property) # virtual_file_date property The date/time stamp for the virtual file. ## Syntax ```text def get_virtual_file_date() -> str: ... def set_virtual_file_date(value: str) -> None: ... virtual_file_date = property(get_virtual_file_date, set_virtual_file_date) ``` ## 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 # virtual_file_format property The structure of the outgoing file. ## Syntax ```text def get_virtual_file_format() -> int: ... def set_virtual_file_format(value: int) -> None: ... virtual_file_format = property(get_virtual_file_format, set_virtual_file_format) ``` ## Possible Values ```text 0 # Unstructured1 # Text2 # Fixed3 # Variable ``` ## Default Value 0 ## Remarks 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](#max_record_size-property) 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](#max_record_size-property). 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](#max_record_size-property) characters. | Note: When either [virtual_file_security_level](#virtual_file_security_level-property) has been set to a value other than *slNone* or [compress](#compress-property) has been set to true, all files become *ffUnstructured* except *ffVariable* files. # virtual_file_security_level property The level of security for the file. ## Syntax ```text def get_virtual_file_security_level() -> int: ... def set_virtual_file_security_level(value: int) -> None: ... virtual_file_security_level = property(get_virtual_file_security_level, set_virtual_file_security_level) ``` ## Possible Values ```text 0 # None1 # Encrypted2 # Signed3 # EncryptedAndSigned ``` ## Default Value 0 ## Remarks When sending files, set this value to the level of security for the next virtual file to send. After receiving a file, this will be set to the level of security of the last file received. When encrypting a file, recipient_cert must be set, and when signing a file, the certificate must be set. The file will be processed to a temporary file before being sent. This is only valid for version 2.0 of the protocol. # change_direction method Sends a Change Direction (CD) command. ## Syntax ```text def change_direction() -> None: ... ``` ## Remarks This method sends a Change Direction (CD) command to the remote host 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 remote host. # config method Sets or retrieves a configuration setting. ## Syntax ```text 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](#oftpclient-config-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](#oftpclient-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # connect method This method connects to the FTP server without logging in. ## Syntax ```text def connect() -> None: ... ``` ## Remarks This method establishes a connection with the [remote_host](#remote_host-property) but does not log in. In most cases, it is recommended to use the [logon](#logon-method) method, which will both establish a connection and log in to the server. This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, confirming that a host is available by first creating the connection. # disconnect method This method disconnects from the server without first logging off. ## Syntax ```text def disconnect() -> None: ... ``` ## Remarks This method immediately disconnects from the server without first logging off. In most cases, the [logoff](#logoff-method) method should be used to log off and disconnect from the server. Call the disconnect method in cases in which it is desirable to immediately disconnect without first logging off. # do_events method This method processes events from the internal message queue. ## Syntax ```text 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 ```text def exchange_certificate(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](#ExchangeCertStoreType) and [ExchangeCertSubject](#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. | When the remote host sends a certificate to the class the received certificate will be provided through the [on_certificate_received](#on_certificate_received-event) event. # import_trusted_certs method Imports a list of trusted CA certificates. ## Syntax ```text 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](#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](#FailOnUntrustedCert). # interrupt method This method interrupts the current action. ## Syntax ```text def interrupt() -> None: ... ``` ## Remarks This method interrupts the current action. If you use [send_file](#send_file-method) to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host. # logoff method Logoff from the OFTP server. ## Syntax ```text def logoff() -> None: ... ``` ## Remarks Logoff from the OFTP server. If that fails, the connection is terminated by the local host. # logon method Logon to the OFTP RemoteHost using the current client credentials. ## Syntax ```text def logon() -> None: ... ``` ## Remarks Logon to the OFTP server using the current [client_ssid_code](#client_ssid_code-property), [client_sfid_code](#client_sfid_code-property), and [client_password](#client_password-property). The component will also check the corresponding server credentials, [server_ssid_code](#server_ssid_code-property), [server_sfid_code](#server_sfid_code-property), and [server_password](#server_password-property). # receive_files method Receive any files queued to be sent from the server. ## Syntax ```text def receive_files() -> None: ... ``` ## Remarks This method connects to the server, and receives any files the server has in its outgoing queue to this particular partner. The files are downloaded to the directory specified by the [download_directory](#download_directory-property) property. # reset method Resets the state of the control. ## Syntax ```text 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 ```text def send_end_response(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](#on_end_transfer-event) event to False. This instructs the class to not send a response automatically. Within the [on_end_transfer](#on_end_transfer-event) event you must also save the values that are required parameters for this method. This includes *FileHash*, *VirtualFileDate*, and *VirtualFileName*. Note: [VirtualFileDateFormat](#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](#on_end_response-event) 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 Send the specified file to the server. ## Syntax ```text def send_file(local_file: str, virtual_file_name: str) -> None: ... ``` ## Remarks This method connects to the server, and uploads the specified file to the server. The *LocalFile* parameter contains the path and name of the file to send to the server. The *VirtualFileName* parameter contains the virtual file name of the file being sent. If this parameter is left as an empty string, the component will use the filename contained in the *LocalFile* parameter by default. Note: When set_upload_stream has been called with a valid input stream, the data will be uploaded from there instead of the *LocalFile*. # validate_cert method Validates the certificate with private key. ## Syntax ```text 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](#import_trusted_certs-method) 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 ```text def validate_recipient_cert() -> bool: ... ``` ## Remarks This method optionally validates the certificate specified by recipient_cert. 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](#import_trusted_certs-method) 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_file event Fired when the client receives a file. ## Syntax ```text class OFTPClientAcceptFileEventParams(object): @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 OFTPClient: @property def on_accept_file() -> Callable[[OFTPClientAcceptFileEventParams], None]: ... @on_accept_file.setter def on_accept_file(event_hook: Callable[[OFTPClientAcceptFileEventParams], None]) -> None: ... ``` ## Remarks This event controls the behavior when the client receives a file. *VirtualFileName* holds the name of the file being received. *VirtualFileDate* holds the date associated with the file in the format specified by [VirtualFileDateFormat](#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](#server_sfid_code-property) *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](#OFTPClient_p_OFTPConnectionDownloadDirectory) 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 ```text class OFTPClientCertificateReceivedEventParams(object): @property def certificate_file_name() -> str: ... @property def certificate_exchange_type() -> int: ... # In class OFTPClient: @property def on_certificate_received() -> Callable[[OFTPClientCertificateReceivedEventParams], None]: ... @on_certificate_received.setter def on_certificate_received(event_hook: Callable[[OFTPClientCertificateReceivedEventParams], 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](#download_directory-property). After the file is written to [download_directory](#download_directory-property) this event will fire. The *CertificateFilename* 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](#exchange_certificate-method) 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. | # on_end_response event Fired every time an end response is received from the server. ## Syntax ```text class OFTPClientEndResponseEventParams(object): @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 OFTPClient: @property def on_end_response() -> Callable[[OFTPClientEndResponseEventParams], None]: ... @on_end_response.setter def on_end_response(event_hook: Callable[[OFTPClientEndResponseEventParams], 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](#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 | By default the class will only fire this event for received end responses. To configure the class to fire the event for both send and received end responses set [FireEndResponseOnSend](#FireEndResponseOnSend) to True. *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](#on_end_transfer-event) 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](#send_end_response-method) 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 | # on_end_transfer event Fired when a file finishes transferring. ## Syntax ```text class OFTPClientEndTransferEventParams(object): @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 OFTPClient: @property def on_end_transfer() -> Callable[[OFTPClientEndTransferEventParams], None]: ... @on_end_transfer.setter def on_end_transfer(event_hook: Callable[[OFTPClientEndTransferEventParams], 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](#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](#send_end_response-method) method to send the response at a later time. See [send_end_response](#send_end_response-method) for more details. Note: [VirtualFileDateFormat](#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](#send_end_response-method). See [send_end_response](#send_end_response-method) 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 | # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class OFTPClientErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class OFTPClient: @property def on_error() -> Callable[[OFTPClientErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[OFTPClientErrorEventParams], None]) -> None: ... ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. The *error_code* parameter contains an error code, and the *description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#oftpclient-errors) section. # on_log event Fires once for each log message. ## Syntax ```text class OFTPClientLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class OFTPClient: @property def on_log() -> Callable[[OFTPClientLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[OFTPClientLogEventParams], None]) -> None: ... ``` ## Remarks This event fires once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *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 ```text class OFTPClientPITrailEventParams(object): @property def direction() -> int: ... @property def data() -> bytes: ... @property def command_id() -> int: ... @property def command_description() -> str: ... # In class OFTPClient: @property def on_pi_trail() -> Callable[[OFTPClientPITrailEventParams], None]: ... @on_pi_trail.setter def on_pi_trail(event_hook: Callable[[OFTPClientPITrailEventParams], 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_ssl_server_authentication event Fired after the server presents its certificate to the client. ## Syntax ```text class OFTPClientSSLServerAuthenticationEventParams(object): @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 OFTPClient: @property def on_ssl_server_authentication() -> Callable[[OFTPClientSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[OFTPClientSSLServerAuthenticationEventParams], None]) -> None: ... ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *accept* parameter is a recommendation on whether to continue or 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*). If it is decided to continue, you can override and accept the certificate by setting the *accept* parameter to True. # on_ssl_status event Fired when secure connection progress messages are available. ## Syntax ```text class OFTPClientSSLStatusEventParams(object): @property def message() -> str: ... # In class OFTPClient: @property def on_ssl_status() -> Callable[[OFTPClientSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[OFTPClientSSLStatusEventParams], None]) -> None: ... ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # on_start_transfer event Fired when a document starts transferring. ## Syntax ```text class OFTPClientStartTransferEventParams(object): @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 OFTPClient: @property def on_start_transfer() -> Callable[[OFTPClientStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[OFTPClientStartTransferEventParams], 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. # on_transfer event Fired while a document transfers (delivers document). ## Syntax ```text class OFTPClientTransferEventParams(object): @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 OFTPClient: @property def on_transfer() -> Callable[[OFTPClientTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[OFTPClientTransferEventParams], 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](#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. # OFTPClient 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](#config-method) method. ### OFTPClient Config Settings **AcceptAnySFIDCode**: Indicates that all SFID codes are acceptable.This setting controls whether the class checks the SFID codes when receiving files. When set to False (Default) and a file is received the class will check the client and server SFID codes sent by the server against the values specified in [client_sfid_code](#client_sfid_code-property) and [server_sfid_code](#server_sfid_code-property). If they do not match an error is returned. In some situations it is necessary to consider any SFID code valid. To disable checking the SFID codes sent by the server set this to True. **AllowRetry**: Whether to send a retry indicator when rejecting a file.When the server sends a file and it is rejected for any reason, if this setting is set to True the class will send a retry indicator value to the server to specify the file may be retried later. When set to False (default) the component will send a value indicating the server should not retry the send operation. **CertificateType**: Specifies the type of certificate being supplied.By default the class will use the certificate set in the certificate property for all operations that require a certificate. This setting allows for different certificates to be set for specific operations. First, specify the CertificateType via this setting and then set the certificate property. For instance: ```text component.Config("CertificateType=3"); component.Certificate = mySigningCertificate; ``` Possible values are: | | | | --- | --- | | 0 (default) | All Operations | | 1 | Session Authentication | | 2 | Decryption | | 3 | Signing | | 4 | Receipt Signing | **ConnectionType**: Specifies the type of connection that will be created.Use the [ConnectionType](#ConnectionType) setting to tell the class which type of connection to create. The default value is 0 (Both) in which the class can both send and receive files. However you can limit the class to only be able to send or receive files by specifying a value of 1 (Send Only) or 2 (Receive Only). Valid values are: | | | | --- | --- | | 0 | Both (Default) | | 1 | Send Only | | 2 | Receive Only | **CreditCount**: Specifies the credit value.This setting defines the maximum credit value to be sent in the initial connection (SSID command). The default value is 99 and the maximum value is 999. When connecting, the server will also indicate the value it wishes to use for the credit count. The smaller of the two values will be used. This setting may be queried after connecting to determine the negotiated value. **DeleteOnError**: Whether received files are deleted when there is an error during processing.By default this value is True. When set to False and receiving a file, if the file is encrypted, signed, or compressed the file will be decrypted, verified, or decompressed. If there is an error during processing the original unprocessed file will be placed in [download_directory](#download_directory-property). In that case you may choose what to do with the file based on the error reported during processing. 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](#download_directory-property). **DisconnectAfterEndSession**: Determines if the connection is closed immediately after ending the session.By default when [logoff](#logoff-method) is called the class will close the TCP connection after ending the session (the ESID command is sent). To let the other side close the connection after it has received the end session command (ESID), set this to False. **EnforceProtocolVersion**: Requires the server to support the same OFTP version.This settings controls the behavior when the server's OFTP version is different from the requested version. During the logon process the class will supply its OFTP [version](#version-property) to the server. The server will respond with the OFTP version it is using for the connection. If the version is not the same, the action of the class depends on this setting. When set to True, if the server's OFTP version does not match the client's [version](#version-property), the class fails with an error. When set to False (default), if the server's OFTP version does not match the client's [version](#version-property), the class will use the lowest mutually supported version. **ExchangeBufferSize**: Specifies the data exchange buffer size in bytes.This setting defines the data exchange buffer size to be sent in the initial connection (SSID command) in bytes. The default value is 2048. When connecting, the server will also indicate the value it wishes to use for the data exchange buffer size. The smaller of the two values will be used. This setting may be queried after connecting to determine the negotiated value. **ExchangeCertStoreType**: Specifies the store type when loading a certificate to be exchanged.This specifies the certificate store type when loading a certificate that will be sent to the remote party. This is only applicable when calling [exchange_certificate](#exchange_certificate-method). The default value is "8" which indicates the certificate will be loaded from a file on disk. When the certificate is not in a .cer format or is located in the Windows certificate store this setting should be set to the appropriate value before calling [exchange_certificate](#exchange_certificate-method). For a list of possible values please see [cert_store_type](#cert_store_type-property). Also see [ExchangeCertSubject](#ExchangeCertSubject). **ExchangeCertSubject**: The subject of the certificate being exchanged.This specifies the subject of the certificate being exchanged. This will be used to load the appropriate certificate when [exchange_certificate](#exchange_certificate-method) is called. This is used in conjunction with [ExchangeCertStoreType](#ExchangeCertStoreType) and is only necessary when loading a certificate from a store that may hold more than one certificate (such as a Windows certificate store). **FailOnUntrustedCert**: Whether or not to throw an exception when untrusted certificates are used.When trusted_certs is populated the class will validate that loaded certificates were issued by a trusted CA in trusted_certs. This setting controls the behavior when an untrusted certificate is found. By default this value is True and the class will throw an exception. If this is set to False the class will fire the [on_error](#on_error-event) event but the error will not be fatal and the operation will be allowed to continue. **FileDescription**: Additional description information sent with the file.When sending a file this setting may be set to specify additional information. There is no restriction on the type of data supplied here. It may be set to a longer filename, or simply additional text data that you wish to pass to the receiver. The data supplied will be UTF-8 encoded by the class. The maximum length is 999 bytes (after UTF-8 encoding). **FileHashAlgorithm**: The hash algorithm to use when sending a file.The file hash algorithm specified in this setting is used to calculate the hash sent along with an outgoing file. Possible values are: | | | | --- | --- | | 0 | sha1 | | 1 | sha256 (Default) | | 2 | sha512 | **FireEndResponseOnSend**: Determines if the EndResponse event is fired for outgoing EERP and NERPs.If set to True (default) the class will fire the [on_end_response](#on_end_response-event) event for both sent and received end responses. If set to False the [on_end_response](#on_end_response-event) event will fire only for received (incoming) end responses. The *Direction* parameter of [on_end_response](#on_end_response-event) determines if the end response is being sent or received. The default value is True. **FollowRedirects**: Determines behavior when importing trusted certificates and a HTTP redirect is returned.When [TrustedCertsData](#TrustedCertsData) holds a URL and [import_trusted_certs](#import_trusted_certs-method) is called the class makes a HTTP request to obtain the trusted certificates. If the server returns a HTTP redirect this setting specifies how the class will handle it. Possible values are: | | | | --- | --- | | 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://). | **FriendlyLogFormat**: Determines if a more friendly format is applied to PITrail event out.This setting effects the content of the Data parameter of the [on_pi_trail](#on_pi_trail-event) event. By default this setting is true and a format designed to be more easily read is used. If set to false the Data parameter will hold the raw unformatted protocol level content. **LogLevel**: The level of information to log.This setting specifies the level of detail that is logged to the [on_log](#on_log-event) event. 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. | **MaskSensitiveData**: Masks passwords in logs.The default value is True. When set to True, the class will mask passwords that otherwise would appear in its logs. **ReceiptHashAlgorithm**: The receipt hash algorithm to request when sending a file.The receipt hash algorithm specified in this setting is sent to the receiving party when a file is sent, and the receiving party should use this value when calculating the hash returned in the EERP or NERP receipt. Possible values are: | | | | --- | --- | | 0 | sha1 (Default) | | 1 | sha256 | | 2 | sha512 | **ReceivedFileDateTime**: The datetime of the file being received.This setting may be queried to obtain the datetime of the received file. **ReceivedFileDescription**: Additional description information received with the file.Query this setting after receiving a file to obtain any additional information provided by the server. The data will be UTF-8 decoded by the class. **ReceivedFileEncryptionAlg**: The encryption algorithm used for the file being received.This setting may be queried to obtain the encryption algorithm used for encryption of the file being received. The possible values are: | | | | --- | --- | | 0 | 3DES (Triple Data Encryption Standard). | | 1 | AES (Advanced Encryption Standard CBC mode with a 256-bit key). | **ReceivedFileName**: Returns the name of the received file.This setting may be queried inside the [on_end_transfer](#on_end_transfer-event) event to obtain the name of the received file on disk. This includes the full path to the file on disk. **ReceivedFileNameFormat**: The name format of received files.This setting specifies the format used when determining the local filename of a received file. The use of macros is supported to provide flexibility. This setting may include one or more of the following values: - %VirtualFileName% - %VirtualFileDate% - %Originator% - %Destination% - %UserData% - %CurrentTime% - %GUID% An example value is "%VirtualFileName%_%VirtualFileDate%_%Destination%". The default value is "%VirtualFileName%". 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% For example: "%VirtualFileDate:yyyyMMddHHmmssffff%" The name format of received files.This setting specifies the format used when determining the local filename of a received file. The use of macros is supported to provide flexibility. This setting may include one or more of the following values: - %VirtualFileName% - %VirtualFileDate% - %Originator% - %Destination% - %UserData% - %CurrentTime% - %GUID% An example value is "%VirtualFileName%_%VirtualFileDate%_%Destination%". The default value is "%VirtualFileName%". 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% For example: "%VirtualFileDate:yyyyMMddHHmmssffff%" **ReceivedFileNameFormat**: The name format of received files.This setting specifies the format used when determining the local filename of a received file. The use of macros is supported to provide flexibility. This setting may include one or more of the following values: - %VirtualFileName% - %VirtualFileDate% - %Originator% - %Destination% - %UserData% - %CurrentTime% - %GUID% An example value is "%VirtualFileName%_%VirtualFileDate%_%Destination%". The default value is "%VirtualFileName%". 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% For example: "%VirtualFileDate:yyyyMMddHHmmssffff%" The name format of received files.This setting specifies the format used when determining the local filename of a received file. The use of macros is supported to provide flexibility. This setting may include one or more of the following values: - %VirtualFileName% - %VirtualFileDate% - %Originator% - %Destination% - %UserData% - %CurrentTime% - %GUID% An example value is "%VirtualFileName%_%VirtualFileDate%_%Destination%". The default value is "%VirtualFileName%". 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% For example: "%VirtualFileDate:yyyyMMddHHmmssffff%" **RecipientCertificateType**: Specifies the type of recipient certificate being supplied.By default the class will use the certificate set in the recipient_cert property for all operations that require a certificate. This setting allows for different certificates to be set for specific operations. First, specify the RecipientCertificateType via this setting and then set the recipient_cert property. For instance: ```text 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 | **Retry**: Indicates whether the recipient allows the send to be retried.When sending files the recipient may reject the file for a number of reasons. The recipient may indicate that the operation can be re-attempted later. Query this setting after a send attempt was rejected to determine if the recipient allows retries. This setting will return either True or False. **SendCDAfterEFPA**: Specifies whether a CD is always sent after receiving an EFPA.When sending a file the recipient will respond with an EFPA once the file is received. Within this response is an indicator which tells the sender whether to issue a CD (Change Direction) command. The indicator is read by the class and a CD command is sent if requested. If a CD is not requested then no CD is sent. 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. **TempPath**: The path of a directory where temporary files will be created.Under certain conditions, the class will create temporary files before processing a file. The location of the temporary files is determined by this setting. Temporary files are created if any of the following conditions are true. - [compress](#compress-property) is true - [virtual_file_security_level](#virtual_file_security_level-property) is set to slEncrypted - [virtual_file_security_level](#virtual_file_security_level-property) is set to slSigned - [virtual_file_security_level](#virtual_file_security_level-property) is set to slEncryptedAndSigned Note that [virtual_file_security_level](#virtual_file_security_level-property) is only applicable when [version](#version-property) is set to oftpVer20. **TrustedCertsData**: Specifies the source to be used when importing trusted certificates.When [import_trusted_certs](#import_trusted_certs-method) is called it will attempt to import certificates from the location specified here. By default this is the URL provided by Odette (http://www.odette.org/TSL/TSL_OFTP2.XML). This is the live list of CA certificates hosted by Odette. This may also be set to an absolute file path to load certificates from an offline source, or a string value containing the trusted CA certificates. **VirtualFileDateFormat**: The DateTime format of received files.This setting specifies the DateTime format used by the class when reporting the VirtualFileDate of received files. The default format is "MM/dd/yyyy HH:mm:ss". 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](#send_end_response-method) the value saved from within the [on_end_transfer](#on_end_transfer-event) event has the necessary data when sending a response. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). 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 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | 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 | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - 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. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [do_events](#do_events-method) is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *True*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. 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](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the class will use the system security libraries by default to perform cryptographic functions where applicable. 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](platforms.md) section. # OFTPClient Errors ### OFTPClient Errors | | | | --- | --- | | 671 | OFTP protocol error. | | 672 | Server supplied an invalid SSID code. | | 673 | Server supplied an invalid SFID code. | | 674 | Server supplied an invalid password. | | 675 | Server returned an invalid client SSID code. | | 676 | Server returned an invalid client SFID code. | | 677 | Server returned an invalid client password. | | 678 | "Error building packet to send." | | 679 | Error reading files 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. | ### TCPClient Errors | | | | --- | --- | | 100 | You cannot change the [remote_port](#remote_port-property) at this time. A connection is in progress. | | 101 | You cannot change the [remote_host](#remote_host-property) (Server) at this time. A connection is in progress. | | 102 | The [remote_host](#remote_host-property) address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the local_port at this time. A connection is in progress. | | 107 | You cannot change the [local_host](#local_host-property) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | [remote_port](#remote_port-property) cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 302 | Could not open file. | | 434 | Unable to convert string to selected CodePage. | | 1105 | Already connecting. If you want to reconnect, close the current connection first. | | 1117 | You need to connect first. | | 1119 | You cannot change the LocalHost at this time. A connection is in progress. | | 1120 | Connection dropped by remote host. | ### 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). |