# OFTPServer Module The OFTPServer module implements the server side of the Odette File Transfer Protocol. ## Syntax ```text IPWorksEDI.OFTPServer ``` ## Remarks The OFTPServer component implements an OFTP server. It is a lightweight server that supports version 1.2, 1.3, 1.4, and 2.0 of OFTP. **Sending and Receiving Files** To use the class first decide if you will support TLS/SSL connections or not. If [UseSSL](#usessl-property-oftpserver-module) is set to true, all clients will be expected to connect in TLS/SSL. If [UseSSL](#usessl-property-oftpserver-module) is set to false (default), all clients are expected to connect in plaintext. If [UseSSL](#usessl-property-oftpserver-module) is true, only clients that support Version 2.0 of the protocol can connect. Once you have decided whether or not to support TLS/SSL, specify the port you wish the server to listen on in [LocalPort](#localport-property-oftpserver-module). By default this value is 3305. Next, specify values for [ServerSSIDCode](#serverssidcode-property-oftpserver-module), [ServerSFIDCode](#serversfidcode-property-oftpserver-module), [ServerPassword](#serverpassword-property-oftpserver-module). Then set [Listening](#listening-property-oftpserver-module) to true to start listening for incoming requests. When a client connects, you will have an opportunity to authenticate the client before continuing the connection. This is done when the [AcceptConnection](#acceptconnection-event-oftpserver-module) event fires. Within this event you can validate that the connecting client has access based on rules you determine. If you wish to reject the connection set the Accept parameter to false. Within this event you can also specify the directory to which files sent by the client to the server are saved. It is necessary to specify the directory within this event, as the client can start sending files as soon as the connection is complete. To specify the download directory set the ConnectionsDownloadDirectory property. For instance: ```text oftpserver1.SetOFTPConnectionDownloadDirectory(e->ConnectionId, "C:\\Downloads"); ``` When the connection is complete, the client may send files. If the client does send a file the [AcceptFile](#acceptfile-event-oftpserver-module) event will fire and you will have the opportunity to reject the file by setting the Accept parameter of the event. In addition you will have a chance to change the filename by setting the Filename parameter if desired. After the client has sent all the files it is configured to send, it will pass control to the server. At that time the [ReadyToSend](#readytosend-event-oftpserver-module) event will fire, and the ConnectionsReadyToSend property will be set to true. After this, you can either end the session with the client by calling [Logoff](#logoff-method-oftpserver-module) or send files to the client. To send files to the client simply call the [SendFile](#sendfile-method-oftpserver-module) method with the specified parameters. **TLS/SSL Notes** When [UseSSL](#usessl-property-oftpserver-module) is set to true, the server must be configured with a TLS/SSL certificate before it is started. Set [SSLCert](#sslcert-property-oftpserver-module) to a valid certificate with corresponding private key before setting [Listening](#listening-property-oftpserver-module) to true. This may be a PFX file, PEM key, or a certificate in a windows certificate store. See the [SSLCert](#sslcert-property-oftpserver-module) property for more information. After [SSLCert](#sslcert-property-oftpserver-module) is set to a valid certificate and [Listening](#listening-property-oftpserver-module) is set to true, when a client connects the [SSLStatus](#sslstatus-event-oftpserver-module) event will fire during the TLS/SSL negotiation. This is purely informational, if there is an error the [Error](#error-event-oftpserver-module) event will fire. If you want to require TLS/SSL client authentication, set [SSLAuthenticateClients](#sslauthenticateclients-property-oftpserver-module) to true before setting [Listening](#listening-property-oftpserver-module) to true. This will force clients to present a certificate during TLS/SSL negotiation to be used for authorization. In this case the [SSLClientAuthentication](#sslclientauthentication-event-oftpserver-module) event will fire and you must set the Accept parameter within the event to true in order to accept the client's certificate and proceed with the connection. **Example Code** ```text MyOftpserver server; server.SetServerSSIDCode("SERVERSSID"); server.SetServerSFIDCode("SERVERSFID"); server.SetServerPassword("SERVER"); server.SetListening(true); ... //Within the main loop of the application call server.DoEvents() in a loop //to process events. //When the ReadyToSend event fires the server can then send files to the client. To do this call the SendFile method. //Alternatively, monitor server.GetOFTPConnectionReadyToSend() to determine when files can be sent. class MyOFTPServer : public OFTPServer { public: MyOFTPServer() {} virtual int FireAcceptConnection(OFTPServerAcceptConnectionEventParams* e) { clientConnectionId = e->ConnectionId; clientSSIDCode = strdup(e->ClientSSIDCode); this->SetOFTPConnectionDownloadDirectory(e->ConnectionId, INCOMING_DIR); return 0; } virtual int FireAcceptFile(OFTPServerAcceptFileEventParams* e) { //e->Accept = False; //To reject a file set e->Accept to false return 0; } virtual int FirePITrail(OFTPServerPITrailEventParams* e) { char logmsg[MAX_PATH]; if (e->Direction == 0) { sprintf(logmsg, "CLIENT: %s : %s", e->CommandId, e->CommandDescription); } else { sprintf(logmsg, "SERVER: %s : %s", e->CommandId, e->CommandDescription); } printf(logmsg); return 0; } virtual int FireError(OFTPServerErrorEventParams* e) { printf("[%d] %s\n", e->ErrorCode,strdup(e->Description)); return 0; } }; ``` ## Property List *The following is the full list of the properties of the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Certificate](#certificate-property-oftpserver-module) | The certificate used for session authentication, signing, and decryption. | | [ConnectionBacklog](#connectionbacklog-property-oftpserver-module) | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. | | [Connections](#connections-property-oftpserver-module) | A collection of currently connected clients. | | [DefaultTimeout](#defaulttimeout-property-oftpserver-module) | An initial timeout value to be used by incoming connections. | | [Listening](#listening-property-oftpserver-module) | This property indicates whether the module is listening for incoming connections on LocalPort. | | [LocalHost](#localhost-property-oftpserver-module) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LocalPort](#localport-property-oftpserver-module) | The TCP port in the local host where the module listens. | | [ServerPassword](#serverpassword-property-oftpserver-module) | The server's password. | | [ServerSFIDCode](#serversfidcode-property-oftpserver-module) | Server's SFID code. | | [ServerSSIDCode](#serverssidcode-property-oftpserver-module) | The server's SSID code. | | [SSLAuthenticateClients](#sslauthenticateclients-property-oftpserver-module) | If set to True, the server asks the client(s) for a certificate. | | [SSLCert](#sslcert-property-oftpserver-module) | The certificate to be used during Secure Sockets Layer (SSL) negotiation. | | [TrustedCerts](#trustedcerts-property-oftpserver-module) | A collection of trusted CA certificates. | | [UseSSL](#usessl-property-oftpserver-module) | Use SSL to access the RemoteHost . | ## Method List *The following is the full list of the methods of the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ChangeDirection](#changedirection-method-oftpserver-module) | Sends a Change Direction (CD) command. | | [Config](#config-method-oftpserver-module) | Sets or retrieves a configuration setting. | | [Disconnect](#disconnect-method-oftpserver-module) | This method disconnects the specified client. | | [DoEvents](#doevents-method-oftpserver-module) | This method processes events from the internal message queue. | | [ExchangeCertificate](#exchangecertificate-method-oftpserver-module) | Exchange a certificate with the remote host. | | [ImportTrustedCerts](#importtrustedcerts-method-oftpserver-module) | Imports a list of trusted CA certificates. | | [Interrupt](#interrupt-method-oftpserver-module) | This method interrupts a synchronous send to the remote host. | | [Logoff](#logoff-method-oftpserver-module) | Ends a session with the connection client. | | [Reset](#reset-method-oftpserver-module) | Resets the state of the control. | | [SendEndResponse](#sendendresponse-method-oftpserver-module) | Sends an EERP/NERP asynchronously. | | [SendFile](#sendfile-method-oftpserver-module) | Sends a file to the specified client. | | [Shutdown](#shutdown-method-oftpserver-module) | This method shuts down the server. | | [StartListening](#startlistening-method-oftpserver-module) | This method starts listening for incoming connections. | | [StopListening](#stoplistening-method-oftpserver-module) | This method stops listening for new connections. | | [ValidateCert](#validatecert-method-oftpserver-module) | Validates the certificate with private key. | | [ValidateRecipientCert](#validaterecipientcert-method-oftpserver-module) | Validates the recipient certificate. | ## Event List *The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AcceptConnection](#acceptconnection-event-oftpserver-module) | Fired when a client connects. | | [AcceptFile](#acceptfile-event-oftpserver-module) | Fired when the client sends a file. | | [CertificateReceived](#certificatereceived-event-oftpserver-module) | Fired when a certificate is received from the remote host. | | [Connected](#connected-event-oftpserver-module) | This event is fired immediately after a connection completes (or fails). | | [ConnectionRequest](#connectionrequest-event-oftpserver-module) | This event is fired when a request for connection comes from a remote host. | | [Disconnected](#disconnected-event-oftpserver-module) | This event is fired when a connection is closed. | | [EndResponse](#endresponse-event-oftpserver-module) | Fired every time an end response is received from the client. | | [EndTransfer](#endtransfer-event-oftpserver-module) | Fired when a file finishes transferring. | | [Error](#error-event-oftpserver-module) | Information about errors during data delivery. | | [Log](#log-event-oftpserver-module) | Fires once for each log message. | | [PITrail](#pitrail-event-oftpserver-module) | Fired when any protocol level communication occurs. | | [ReadyToSend](#readytosend-event-oftpserver-module) | Fired when the module is ready to send data. | | [SSLClientAuthentication](#sslclientauthentication-event-oftpserver-module) | This event is fired when the client presents its credentials to the server. | | [SSLConnectionRequest](#sslconnectionrequest-event-oftpserver-module) | This event fires when a Secure Sockets Layer (SSL) connection is requested. | | [SSLStatus](#sslstatus-event-oftpserver-module) | This event is fired to show the progress of the secure connection. | | [StartTransfer](#starttransfer-event-oftpserver-module) | Fired when a document starts transferring. | | [Transfer](#transfer-event-oftpserver-module) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the module with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AllowRetry\[ConnectionId\]](#AllowRetry[ConnectionId]) | Whether to send a retry indicator when rejecting a file. | | [CDAfterSendEndResponse\[ConnectionId\]](#CDAfterSendEndResponse[ConnectionId]) | Whether to issue a CD command after sending an asynchronous EERP. | | [CertificateStore\[ConnectionId\]](#CertificateStore[ConnectionId]) | The name of the certificate store. | | [CertificateStorePassword\[ConnectionId\]](#CertificateStorePassword[ConnectionId]) | The certificate password. | | [CertificateStoreType\[ConnectionId\]](#CertificateStoreType[ConnectionId]) | The type of certificate store. | | [CertificateSubject\[ConnectionId\]](#CertificateSubject[ConnectionId]) | The certificate subject. | | [CertificateType](#CertificateType) | Specifies the type of certificate being supplied. | | [CertificateType\[ConnectionId\]](#CertificateType[ConnectionId]) | Specifies the type of certificate being supplied. | | [ConnectionType\[ConnectionId\]](#ConnectionType[ConnectionId]) | Specifies the type of connection that will be created. | | [CreditCount\[ConnectionId\]](#CreditCount[ConnectionId]) | Specifies the maximum credit value. | | [DefaultIdleTimeout](#DefaultIdleTimeout) | The default idle timeout for inactive clients. | | [DefaultReceiptHashAlgorithm](#DefaultReceiptHashAlgorithm) | The receipt hash algorithm to request when sending a file. | | [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. | | [ExchangeBufferSize\[ConnectionId\]](#ExchangeBufferSize[ConnectionId]) | 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\[ConnectionId\]](#FileDescription[ConnectionId]) | Additional description information sent with the file. | | [FileHashAlgorithm\[ConnectionId\]](#FileHashAlgorithm[ConnectionId]) | 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. | | [IdleTimeout](#IdleTimeout) | The idle timeout for this connection. | | [KeepAlive](#KeepAlive) | This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity. | | [Linger](#Linger) | This property controls how a connection is closed. The default is True. In this case the connection is closed only after all the data is sent. Setting it to False forces an abrupt (hard) disconnection. Any data that was in the sending queue may be lost. | | [LogLevel](#LogLevel) | The level of information to log. | | [ReceivedConnectionType\[ConnectionId\]](#ReceivedConnectionType[ConnectionId]) | Returns the connection type specified by the client. | | [ReceivedFileDateTime\[ConnectionId\]](#ReceivedFileDateTime[ConnectionId]) | The datetime of the file being received. | | [ReceivedFileDescription\[ConnectionId\]](#ReceivedFileDescription[ConnectionId]) | Additional description information received with the file. | | [ReceivedFileEncryptionAlg\[ConnectionId\]](#ReceivedFileEncryptionAlg[ConnectionId]) | The encryption algorithm used for the file being received. | | [ReceivedFileName\[ConnectionId\]](#ReceivedFileName[ConnectionId]) | Returns the name of the received file. | | [ReceivedFileNameFormat](#ReceivedFileNameFormat) | The name format of received files. | | [ReceivedFileNameFormat\[ConnectionId\]](#ReceivedFileNameFormat[ConnectionId]) | The name format of received files. | | [RecipientCertificateType](#RecipientCertificateType) | Specifies the type of recipient certificate being supplied. | | [Retry\[ConnectionId\]](#Retry[ConnectionId]) | Indicates whether the recipient allows the send to be retried. | | [SecureAuthentication](#SecureAuthentication) | Specifies secure authentication requirements for connecting clients. | | [SendCDAfterEFPA](#SendCDAfterEFPA) | Specifies whether a CD is always sent after receiving an EFPA. | | [ServerPassword\[ConnectionId\]](#ServerPassword[ConnectionId]) | Sets or gets the ServerPassword for a particular connection. | | [ServerSFIDCode\[ConnectionId\]](#ServerSFIDCode[ConnectionId]) | Sets or gets the ServerSFIDCode for a particular connection. | | [ServerSSIDCode\[ConnectionId\]](#ServerSSIDCode[ConnectionId]) | Sets the ServerSSIDCode for a particular connection. | | [TempPath\[ConnectionId\]](#TempPath[ConnectionId]) | 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. | | [AllowedClients](#AllowedClients) | A comma-separated list of host names or IP addresses that can access the module. | | [BindExclusively](#BindExclusively) | Whether or not the module considers a local port reserved for exclusive use. | | [BlockedClients](#BlockedClients) | A comma-separated list of host names or IP addresses that cannot access the module. | | [DefaultConnectionTimeout](#DefaultConnectionTimeout) | The inactivity timeout applied to the SSL handshake. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [MaxConnections](#MaxConnections) | The maximum number of connections available. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [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. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # Certificate Property ([OFTPServer](#oftpserver-module) Module) The certificate used for session authentication, signing, and decryption. ## Syntax ```text public var certificate: Certificate { get {...} set {...} } ``` ## Default Value False ## Remarks Set this property to a valid [Certificate](#certificate-type) object with private key to perform various security related operations. Once specified, this certificate will be used for: - Session authentication if a client requests secure authentication. - Signing files sent to the client if ConnectionsVirtualFileFormat is set to slEncryptedAndSigned or slSigned. - Signing receipts sent to the client. - Decrypting files received from the client. Note that all of the above operations are only supported in OFTP Version 2.0. # ConnectionBacklog Property ([OFTPServer](#oftpserver-module) Module) This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. ## Syntax ```text public var connectionBacklog: Int32 { get {...} set {...} } ``` ## Default Value 5 ## Remarks This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable. # Connections Property ([OFTPServer](#oftpserver-module) Module) A collection of currently connected clients. ## Syntax ```text public var connections: [Int32: OFTPConnection] { get {...} } ``` ## Default Value False ## Remarks This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the [OFTPConnection](#oftpconnection-type) type. This collection is a hashtable type of collection, in which the ConnectionId string is used as the key to the desired connection. You may acquire the key for a given connection through the [Connected](#connected-event-oftpserver-module) event. **Example (Setting the Download Directory)** ```text oftpserver1.SetOFTPConnectionDownloadDirectory(123456789, "C:\\Downloads"); ``` # DefaultTimeout Property ([OFTPServer](#oftpserver-module) Module) An initial timeout value to be used by incoming connections. ## Syntax ```text public var defaultTimeout: Int32 { get {...} set {...} } ``` ## Default Value 60 ## Remarks If the DefaultTimeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If DefaultTimeout is set to a positive value, the class will wait for the operation to complete before returning control. The class will use [DoEvents](#doevents-method-oftpserver-module) 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 . 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 DefaultTimeout property is 60 (seconds). # Listening Property ([OFTPServer](#oftpserver-module) Module) This property indicates whether the module is listening for incoming connections on LocalPort. ## Syntax ```text public var listening: Bool { get {...} } ``` ## Default Value False ## Remarks This property indicates whether the class is listening for connections on the port specified by the [LocalPort](#localport-property-oftpserver-module) property. Use the [StartListening](#startlistening-method-oftpserver-module) and [StopListening](#stoplistening-method-oftpserver-module) methods to control whether the class is listening. This property is read-only. If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error: ```text public func setListening(listening: Bool) throws ``` # LocalHost Property ([OFTPServer](#oftpserver-module) Module) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax ```text public var localHost: String { get {...} set {...} } ``` ## 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 LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window. # LocalPort Property ([OFTPServer](#oftpserver-module) Module) The TCP port in the local host where the module listens. ## Syntax ```text public var localPort: Int32 { get {...} set {...} } ``` ## Default Value 3305 ## Remarks This property must be set before OFTPServer starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after OFTPServer is in listening mode (after successfully assigning True to the [Listening](#listening-property-oftpserver-module) property). The service port is not shared among servers (i.e. there can be only one OFTPServer 'listening' on a particular port at one time). The default value for plaintext communication is 3305. If [UseSSL](#usessl-property-oftpserver-module) is set to true, set this value to 6619 (the default port for SSL communication). # ServerPassword Property ([OFTPServer](#oftpserver-module) Module) The server's password. ## Syntax ```text public var serverPassword: String { get {...} set {...} } ``` ## 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. # ServerSFIDCode Property ([OFTPServer](#oftpserver-module) Module) Server's SFID code. ## Syntax ```text public var serverSFIDCode: String { get {...} set {...} } ``` ## 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. # ServerSSIDCode Property ([OFTPServer](#oftpserver-module) Module) The server's SSID code. ## Syntax ```text public var serverSSIDCode: String { get {...} set {...} } ``` ## 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. | # SSLAuthenticateClients Property ([OFTPServer](#oftpserver-module) Module) If set to True, the server asks the client(s) for a certificate. ## Syntax ```text public var sslAuthenticateClients: Bool { get {...} set {...} } ``` ## Default Value False ## Remarks This property is used in conjunction with the [SSLClientAuthentication](#sslclientauthentication-event-oftpserver-module) event. Please refer to the documentation of the [SSLClientAuthentication](#sslclientauthentication-event-oftpserver-module) event for details. # SSLCert Property ([OFTPServer](#oftpserver-module) Module) The certificate to be used during Secure Sockets Layer (SSL) negotiation. ## Syntax ```text public var sslCert: Certificate { get {...} set {...} } ``` ## Default Value False ## Remarks This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields. # TrustedCerts Property ([OFTPServer](#oftpserver-module) Module) A collection of trusted CA certificates. ## Syntax ```text public var trustedCerts: Array { get {...} } ``` ## Default Value False ## Remarks If this collection is populated the class will validate any certificates that are loaded against the CA certificates specified here. If this collection is not populated no validation will occur. Certificates are imported into this collection by calling the [ImportTrustedCerts](#importtrustedcerts-method-oftpserver-module) method. See also [FailOnUntrustedCert](#FailOnUntrustedCert) and [TrustedCertsData](#TrustedCertsData). # UseSSL Property ([OFTPServer](#oftpserver-module) Module) Use SSL to access the RemoteHost . ## Syntax ```text public var useSSL: Bool { get {...} set {...} } ``` ## Default Value False ## Remarks Use this property to determine whether the class uses SSL when clients connect. This property is only valid when using version 2.0 of the protocol. If set to true, all clients that connect must use version 2.0. # ChangeDirection Method ([OFTPServer](#oftpserver-module) Module) Sends a Change Direction (CD) command. ## Syntax ```text public func changeDirection(connectionId: Int32) throws -> Void ``` ## Remarks This method sends a Change Direction (CD) command to the client when called. In normal operation this should not be used. This should only be used if a condition arises where you must manually change the speaker when communicating with the client. For instance: ```text component.ChangeDirection(MyConnectionId); ``` # Config Method ([OFTPServer](#oftpserver-module) Module) Sets or retrieves a configuration setting. ## Syntax ```text public func config(configurationString: String) throws -> String ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-oftpserver-module) 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](#config-settings-oftpserver-module), you must call *Config("PROPERTY")*. The value will be returned as a string. # Disconnect Method ([OFTPServer](#oftpserver-module) Module) This method disconnects the specified client. ## Syntax ```text public func disconnect(connectionId: Int32) throws -> Void ``` ## Remarks Calling this method will disconnect the client specified by the *ConnectionId* parameter. # DoEvents Method ([OFTPServer](#oftpserver-module) Module) This method processes events from the internal message queue. ## Syntax ```text public func doEvents() throws -> Void ``` ## Remarks When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # ExchangeCertificate Method ([OFTPServer](#oftpserver-module) Module) Exchange a certificate with the remote host. ## Syntax ```text public func exchangeCertificate(connectionId: Int32, clientSFIDCode: String, certificateStore: String, certificateExchangeType: Int32) throws -> Void ``` ## 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 [CertificateReceived](#certificatereceived-event-oftpserver-module) event. # ImportTrustedCerts Method ([OFTPServer](#oftpserver-module) Module) Imports a list of trusted CA certificates. ## Syntax ```text public func importTrustedCerts() throws -> Void ``` ## Remarks When ImportTrustedCerts is called the class will import the CA certificates from the source specified by [TrustedCertsData](#TrustedCertsData) into the [TrustedCerts](#trustedcerts-property-oftpserver-module) 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 ([OFTPServer](#oftpserver-module) Module) This method interrupts a synchronous send to the remote host. ## Syntax ```text public func interrupt(connectionId: Int32) throws -> Void ``` ## Remarks This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the class. If you use [SendFile](#sendfile-method-oftpserver-module) to upload a file, the class will run synchronously on that Connection Id until it is completed. # Logoff Method ([OFTPServer](#oftpserver-module) Module) Ends a session with the connection client. ## Syntax ```text public func logoff(connectionId: Int32) throws -> Void ``` ## Remarks This method will attempt to end the session with the client if the client has acknowledged it is finished sending files to the server. If the client still wishes to process commands, the method will give control back to the client and ConnectionsReadyToSend will be false. When ConnectionsReadyToSend is true, calling this method will end the session. # Reset Method ([OFTPServer](#oftpserver-module) Module) Resets the state of the control. ## Syntax ```text public func reset() throws -> Void ``` ## Remarks **Reset** resets the state of the class. All properties will be set to their default values. # SendEndResponse Method ([OFTPServer](#oftpserver-module) Module) Sends an EERP/NERP asynchronously. ## Syntax ```text public func sendEndResponse(connectionId: Int32, virtualFileName: String, virtualFileDate: String, destination: String, originator: String, creator: String, reasonCode: Int32, reasonText: String, fileHash: String, signature: String) throws -> Void ``` ## 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 [EndTransfer](#endtransfer-event-oftpserver-module) event to False. This instructs the class to not send a response automatically. Within the [EndTransfer](#endtransfer-event-oftpserver-module) 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 [EndResponse](#endresponse-event-oftpserver-module) 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 | # SendFile Method ([OFTPServer](#oftpserver-module) Module) Sends a file to the specified client. ## Syntax ```text public func sendFile(connectionId: Int32, clientSFIDCode: String, fileName: String, virtualFileName: String) throws -> Void ``` ## Remarks This method sends a file to the client specified by the ConnectionId parameter. After the [ReadyToSend](#readytosend-event-oftpserver-module) event fires or when the ConnectionsReadyToSend property is true, this method can be used to send a file to the connected client specified by the *ConnectionId* parameter. The *ClientSFIDCode* corresponds to the destination. *FileName* must be the full path to the file which will be sent. *VirtualFileName* may be specified to indicate the name of the file that the client will see when receiving the file. If ConnectionsUploadStream is set, pass empty string as the value for the FileName parameter. When this method is called, the class will fire the [StartTransfer](#starttransfer-event-oftpserver-module), [Transfer](#transfer-event-oftpserver-module), and [EndTransfer](#endtransfer-event-oftpserver-module) events that can be monitored to check the status of the send. The SendFile method will not return until either the transfer is complete or an error was encountered. # Shutdown Method ([OFTPServer](#oftpserver-module) Module) This method shuts down the server. ## Syntax ```text public func shutdown() throws -> Void ``` ## Remarks This method shuts down the server. Calling this method is equivalent to calling [StopListening](#stoplistening-method-oftpserver-module) and then breaking every client connection by calling [Disconnect](#disconnect-method-oftpserver-module). # StartListening Method ([OFTPServer](#oftpserver-module) Module) This method starts listening for incoming connections. ## Syntax ```text public func startListening() throws -> Void ``` ## Remarks This method begins listening for incoming connections on the port specified by [LocalPort](#localport-property-oftpserver-module). Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [StopListening](#stoplistening-method-oftpserver-module). To stop listening for new connections and to disconnect all existing clients, call [Shutdown](#shutdown-method-oftpserver-module). # StopListening Method ([OFTPServer](#oftpserver-module) Module) This method stops listening for new connections. ## Syntax ```text public func stopListening() throws -> Void ``` ## Remarks This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections. To stop listening and to disconnect all existing clients, call [Shutdown](#shutdown-method-oftpserver-module) instead. # ValidateCert Method ([OFTPServer](#oftpserver-module) Module) Validates the certificate with private key. ## Syntax ```text public func validateCert() throws -> Bool ``` ## Remarks This method optionally validates the certificate specified by [Certificate](#certificate-property-oftpserver-module). 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 [ImportTrustedCerts](#importtrustedcerts-method-oftpserver-module) 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 [TrustedCerts](#trustedcerts-property-oftpserver-module) 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. # ValidateRecipientCert Method ([OFTPServer](#oftpserver-module) Module) Validates the recipient certificate. ## Syntax ```text public func validateRecipientCert(connectionId: Int32) throws -> Bool ``` ## Remarks This method optionally validates the certificate specified by ConnectionsRecipientCertSubject. 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 [ImportTrustedCerts](#importtrustedcerts-method-oftpserver-module) 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 [TrustedCerts](#trustedcerts-property-oftpserver-module) 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. # AcceptConnection Event ([OFTPServer](#oftpserver-module) Module) Fired when a client connects. ## Syntax ```text func onAcceptConnection(connectionId: Int32, clientSSIDCode: String, clientPassword: String, clientVersion: Int32, serverVersion: inout Int32, accept: inout Bool, errorCode: inout Int32, errorDescription: inout String) ``` ## Remarks This event fires when a new OFTP connection is made to the server. Use the parameters of this event to verify the identify of the client identified by the ConnectionId. By default the connection will be accepted. To reject the connection set *Accept* to false. *ClientVersion* specifies the OFTP protocol version the client supports. By default the class will use the version requested by the client for the connection. If you wish to restrict connections to a specific OFTP protocol version use this value when determining whether or not to accept the connection. When rejecting the connection based on the OFTP protocol version use *ErrorCode* 10. Possible values are: | | | | --- | --- | | 0 | OFTP 1.2 | | 1 | OFTP 1.3 | | 2 | OFTP 1.4 | | 3 | OFTP 2.0 | *ServerVersion* specifies the OFTP protocol version the server will use for the connection. By default this will be the same as *ClientVersion*. This may be set to a different version which will be sent back to the client. Possible values are: | | | | --- | --- | | 0 | OFTP 1.2 | | 1 | OFTP 1.3 | | 2 | OFTP 1.4 | | 3 | OFTP 2.0 | When rejecting a connection the *ErrorCode* and *ErrorDescription* may optionally be set. Possible common values are: | | | | --- | --- | | ErrorCode | ErrorDescription | | 3 | User Code Not Known | | 4 | Invalid Password | | 9 | Unspecified Reason | | 10 | Mode or capabilities incompatible | | 99 | Unspecified Reason | # AcceptFile Event ([OFTPServer](#oftpserver-module) Module) Fired when the client sends a file. ## Syntax ```text func onAcceptFile(connectionId: Int32, virtualFileName: String, virtualFileDate: String, destination: String, originator: String, accept: inout Bool, fileName: inout String, overwrite: inout Bool, errorCode: inout Int32, errorDescription: inout String) ``` ## Remarks This event controls the behavior when the client sends a file to the server. *VirtualFileName* holds the name of the file being received. *VirtualFileDate* holds the date associated with the file in the format specified by [VirtualFileDateFormat](#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 [ServerSFIDCode](#serversfidcode-property-oftpserver-module) *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 ConnectionsDownloadDirectory 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. | # CertificateReceived Event ([OFTPServer](#oftpserver-module) Module) Fired when a certificate is received from the remote host. ## Syntax ```text func onCertificateReceived(connectionId: Int32, certificateFileName: String, certificateExchangeType: Int32) ``` ## 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 DownloadDirectory. After the file is written to DownloadDirectory 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 [ExchangeCertificate](#exchangecertificate-method-oftpserver-module) method using a CertificateExchangeType of 3 (Deliver). The response may be in a separate session. | | 1 | Replace: The class received a certificate from the remote host. No response is expected. The certificate received here invalidates any previously stored certificates for this configuration. | | 2 | Deliver: The class received a certificate from the remote host. This is either a response to a certificate request, or a new additional certificates from the remote host. This will not invalidate previous certificates stored for this configuration. | *ConnectionId* identifies the connected client. # Connected Event ([OFTPServer](#oftpserver-module) Module) This event is fired immediately after a connection completes (or fails). ## Syntax ```text func onConnected(connectionId: Int32, statusCode: Int32, description: String) ``` ## Remarks If the connection is made normally, *StatusCode* is 0, and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the system. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the system error. Please refer to the [Error Codes](#trappable-errors-oftpserver-module) section for more information. # ConnectionRequest Event ([OFTPServer](#oftpserver-module) Module) This event is fired when a request for connection comes from a remote host. ## Syntax ```text func onConnectionRequest(address: String, port: Int32, accept: inout Bool) ``` ## Remarks This event indicates an incoming connection. The connection is accepted by default. *Address* and *Port* will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the *Accept* parameter to False. # Disconnected Event ([OFTPServer](#oftpserver-module) Module) This event is fired when a connection is closed. ## Syntax ```text func onDisconnected(connectionId: Int32, statusCode: Int32, description: String) ``` ## Remarks If the connection is broken normally, *StatusCode* is 0, and *Description* is "OK". If the connection is broken for any other reason, *StatusCode* has the error code returned by the system. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the system error. Please refer to the [Error Codes](#trappable-errors-oftpserver-module) section for more information. # EndResponse Event ([OFTPServer](#oftpserver-module) Module) Fired every time an end response is received from the client. ## Syntax ```text func onEndResponse(connectionId: Int32, virtualFileName: String, virtualFileDate: String, destination: String, originator: String, creator: String, reasonCode: Int32, reasonText: String, fileHash: inout String, signature: String, direction: Int32) ``` ## 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 [EndTransfer](#endtransfer-event-oftpserver-module) 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 [SendEndResponse](#sendendresponse-method-oftpserver-module) method. *ReasonCode* and *ReasonText* identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are: | | | | --- | --- | | ReasonCode | ReasonText | | 3 | User Code Not Known | | 4 | Invalid Password | | 9 | Unspecified Reason | | 11 | Invalid FileName | | 12 | Invalid Destination | | 13 | Invalid Origin | | 14 | Invalid Storage Record Format | | 15 | Maximum Record Length Not Supported | | 16 | File Size Too Big | | 20 | Invalid Record Count | | 21 | Invalid Byte Count | | 22 | Access Method Failure | | 23 | Duplicate File | | 24 | File Direction Refused | | 25 | Cipher Suite Not Supported | | 26 | Encrypted File Not Allowed | | 27 | Unencrypted File Not Allowed | | 28 | Compression Not Allowed | | 29 | Signed File Not Allowed | | 30 | Unsigned File Not Allowed | | 31 | File Signature Not Valid | | 32 | File Decompression Failed | | 33 | File Decryption Failed | | 34 | File Processing Failed | | 35 | Not Delivered To Recipient | | 36 | Not Acknowledged By Recipient | | 50 | Transmission Stopped By The Operator | | 90 | File Size Incompatible With Recipient's Protocol Version | | 99 | Unspecified Reason | *ConnectionId* identifies the connected client. # EndTransfer Event ([OFTPServer](#oftpserver-module) Module) Fired when a file finishes transferring. ## Syntax ```text func onEndTransfer(connectionId: Int32, direction: Int32, localFile: String, virtualFileName: String, virtualFileDate: String, destination: String, originator: String, reasonCode: Int32, reasonText: String, fileSize: Int64, fileHash: String, sendEndResponse: inout Bool) ``` ## Remarks The EndTransfer 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 [SendEndResponse](#sendendresponse-method-oftpserver-module) method to send the response at a later time. See [SendEndResponse](#sendendresponse-method-oftpserver-module) 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 [SendEndResponse](#sendendresponse-method-oftpserver-module). See [SendEndResponse](#sendendresponse-method-oftpserver-module) for more details. *LocalFile* holds the full path to the file that will be written. *ReasonCode* and *ReasonText* identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are: | | | | --- | --- | | ReasonCode | ReasonText | | 3 | User Code Not Known | | 4 | Invalid Password | | 9 | Unspecified Reason | | 11 | Invalid FileName | | 12 | Invalid Destination | | 13 | Invalid Origin | | 14 | Invalid Storage Record Format | | 15 | Maximum Record Length Not Supported | | 16 | File Size Too Big | | 20 | Invalid Record Count | | 21 | Invalid Byte Count | | 22 | Access Method Failure | | 23 | Duplicate File | | 24 | File Direction Refused | | 25 | Cipher Suite Not Supported | | 26 | Encrypted File Not Allowed | | 27 | Unencrypted File Not Allowed | | 28 | Compression Not Allowed | | 29 | Signed File Not Allowed | | 30 | Unsigned File Not Allowed | | 31 | File Signature Not Valid | | 32 | File Decompression Failed | | 33 | File Decryption Failed | | 34 | File Processing Failed | | 35 | Not Delivered To Recipient | | 36 | Not Acknowledged By Recipient | | 50 | Transmission Stopped By The Operator | | 90 | File Size Incompatible With Recipient's Protocol Version | | 99 | Unspecified Reason | *ConnectionId* identifies the connected client. # Error Event ([OFTPServer](#oftpserver-module) Module) Information about errors during data delivery. ## Syntax ```text func onError(connectionId: Int32, errorCode: Int32, description: String) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class . *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-oftpserver-module) section. *ConnectionId* contains the Id of the connection to which this error applies. # Log Event ([OFTPServer](#oftpserver-module) Module) Fires once for each log message. ## Syntax ```text func onLog(connectionId: Int32, logLevel: Int32, message: String, logType: String) ``` ## Remarks This event fires once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *ConnectionId* identifies the connected client. *LogLevel* indicates the level of message. Possible values are: | | | | --- | --- | | 0 (None) | No messages are logged. | | 1 (Info - Default) | Informational events such as OFTP commands which are sent and received. | | 2 (Verbose) | Detailed data such as individual packet information is logged. | | 3 (Debug) | Debug data including all relevant sent and received bytes are logged. | *Message* is the log entry. *LogType* identifies the type of log entry. Possible values are: - "Info" - "OFTP" # PITrail Event ([OFTPServer](#oftpserver-module) Module) Fired when any protocol level communication occurs. ## Syntax ```text func onPITrail(connectionId: Int32, direction: Int32, data: Data, commandId: Int32, commandDescription: String) ``` ## 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. # ReadyToSend Event ([OFTPServer](#oftpserver-module) Module) Fired when the component is ready to send data. ## Syntax ```text func onReadyToSend(connectionId: Int32) ``` ## Remarks The ReadyToSend event indicates that the connected client is in a state where it can accept files sent from the server. When a client connects initially it will not be ready to receive files. After the client sends files (if any) to the server it will pass control to the server. At that time the ReadyToSend event will fire. In addition the ConnectionsReadyToSend property will be set to true for the connection. After this event fires [SendFile](#sendfile-method-oftpserver-module) can be called to send files to the connected client. # SSLClientAuthentication Event ([OFTPServer](#oftpserver-module) Module) This event is fired when the client presents its credentials to the server. ## Syntax ```text func onSSLClientAuthentication(connectionId: Int32, certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool) ``` ## Remarks This event enables the server to decide whether or not to continue. The *Accept* parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string "OK"). # SSLConnectionRequest Event ([OFTPServer](#oftpserver-module) Module) This event fires when a Secure Sockets Layer (SSL) connection is requested. ## Syntax ```text func onSSLConnectionRequest(connectionId: Int32, supportedCipherSuites: String, supportedSignatureAlgs: String, certStoreType: inout Int32, certStore: inout String, certPassword: inout String, certSubject: inout String) ``` ## Remarks This event fires when an SSL connection is requested and SSLProvider is set to *Internal*. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to *Platform*. This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities. *ConnectionId* is the connection Id of the client requesting the connection. *SupportedCipherSuites* is a comma-separated list of cipher suites that the client supports. *SupportedSignatureAlgs* is a comma-separated list of certificate signature algorithms that the client supports. *CertStoreType* is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```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](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#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 [](#f_Store) and set [](#f_StorePassword) 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. | *CertStore* is the store name or location of the alternate certificate to use for this connection. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). *CertPassword* is the password of the certificate store containing the alternate certificate to use for this connection. *CertSubject* is the subject of the alternate certificate to use for this connection. The special value *** matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=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. # SSLStatus Event ([OFTPServer](#oftpserver-module) Module) This event is fired to show the progress of the secure connection. ## Syntax ```text func onSSLStatus(connectionId: Int32, message: String) ``` ## Remarks The event is fired for informational and logging purposes only. It is used to track the progress of the connection. # StartTransfer Event ([OFTPServer](#oftpserver-module) Module) Fired when a document starts transferring. ## Syntax ```text func onStartTransfer(connectionId: Int32, direction: Int32, localFile: inout String, virtualFileName: String, virtualFileDate: String, destination: String, originator: String) ``` ## Remarks This event fires when a file transfer begins. *Direction* specifies if the client or server sent the file. | | | | --- | --- | | 0 (Client) | The file originated from the client. | | 1 (Server) | The file originated from the server. | *VirtualFileName* holds the filename. *VirtualFileDate* holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss". *Originator* identifies the sender (SFID) code in the send file request. *Destination* identifies the receiver (SFID) code in the send file request. *LocalFile* holds the full path to the file that will be written. *ConnectionId* identifies the connected client. # Transfer Event ([OFTPServer](#oftpserver-module) Module) Fired while a document transfers (delivers document). ## Syntax ```text func onTransfer(connectionId: Int32, direction: Int32, localFile: String, virtualFileName: String, virtualFileDate: String, destination: String, originator: String, bytesTransferred: Int64, text: Data) ``` ## 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. *ConnectionId* identifies the connected client. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **effectiveDate** *String (read-only)* *Default Value: ""* 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. **expirationDate** *String (read-only)* *Default Value: ""* 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. **extendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **fingerprint** *String (read-only)* *Default Value: ""* 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* **fingerprintSHA1** *String (read-only)* *Default Value: ""* 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* **fingerprintSHA256** *String (read-only)* *Default Value: ""* 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* **issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. **privateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The may be available but not exportable. In this case, returns an empty string. **privateKeyAvailable** *Bool (read-only)* *Default Value: False* Whether a is available for the selected certificate. If is True, the certificate may be used for authentication purposes (e.g., server authentication). **privateKeyContainer** *String (read-only)* *Default Value: ""* The name of the container for the certificate (if available). This functionality is available only on Windows platforms. **publicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **publicKeyAlgorithm** *String (read-only)* *Default Value: ""* 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. **publicKeyLength** *Int32 (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **serialNumber** *String (read-only)* *Default Value: ""* 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. **signatureAlgorithm** *String (read-only)* *Default Value: ""* 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. **storeB** *Data* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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). **store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The property denotes the type of the certificate store specified by . If the store is password-protected, specify the password in . is used in conjunction with the property to specify client certificates. If has a value, and or is set, a search for a certificate is initiated. Please see the 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). **storePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. **storeType** *CertStoreTypes* *Default Value: 0* 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](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#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 [](#f_Store) and set [](#f_StorePassword) 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. | **subjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **thumbprintMD5** *String (read-only)* *Default Value: ""* 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. **thumbprintSHA1** *String (read-only)* *Default Value: ""* 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. **thumbprintSHA256** *String (read-only)* *Default Value: ""* 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. **usage** *String (read-only)* *Default Value: ""* The text description of . 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. **usageFlags** *Int32 (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of 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 property for a text representation of . This functionality currently is not available when the provider is OpenSSL. **version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **subject** *String* *Default Value: ""* 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. **encodedB** *Data* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. **encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The and properties also may be used to specify a certificate. When is set, a search is initiated in the current for the private key of the certificate. If the key is found, is updated to reflect the full subject of the selected certificate; otherwise, is set to an empty string. ## Constructors *Swift Syntax* ```text public init() ``` Creates a instance whose properties can be set. *Swift Syntax* ```text public init(encoded: ) ``` Parses * Encoded * as an X.509 public key. *Swift Syntax* ```text public init(storeType: , store: , storePassword: , subject: ) ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. *Swift Syntax* ```text public init(storeType: , store: , storePassword: , subject: ) ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. # OFTPConnection Type A currently connected client. ## Remarks This type describes the connection of a client which is currently connected to the class. You may use the different fields of this type to manage the connection. The following fields are available: - [Compress](#OFTPConnection_f_Compress) - [Connected](#OFTPConnection_f_Connected) - [ConnectionId](#OFTPConnection_f_ConnectionId) - [DownloadDirectory](#OFTPConnection_f_DownloadDirectory) - [EncryptionAlgorithm](#OFTPConnection_f_EncryptionAlgorithm) - [LocalAddress](#OFTPConnection_f_LocalAddress) - [MaxRecordSize](#OFTPConnection_f_MaxRecordSize) - [ReadyToSend](#OFTPConnection_f_ReadyToSend) - [RecipientCertStore](#OFTPConnection_f_RecipientCertStore) - [RecipientCertStorePassword](#OFTPConnection_f_RecipientCertStorePassword) - [RecipientCertStoreType](#OFTPConnection_f_RecipientCertStoreType) - [RecipientCertSubject](#OFTPConnection_f_RecipientCertSubject) - [RemoteHost](#OFTPConnection_f_RemoteHost) - [RemotePort](#OFTPConnection_f_RemotePort) - [SFIDCode](#OFTPConnection_f_SFIDCode) - [SignedReceipt](#OFTPConnection_f_SignedReceipt) - [SSIDCode](#OFTPConnection_f_SSIDCode) - [Timeout](#OFTPConnection_f_Timeout) - [Version](#OFTPConnection_f_Version) - [VirtualFileDate](#OFTPConnection_f_VirtualFileDate) - [VirtualFileFormat](#OFTPConnection_f_VirtualFileFormat) - [VirtualFileSecurityLevel](#OFTPConnection_f_VirtualFileSecurityLevel) ## Fields **compress** *Bool* *Default Value: False* Whether or not compression is used on the outgoing or incoming file. When sending files to the client, if Compress is true the file will be compressed. When receiving files, query this property to determine whether the file received from the client was compressed or not. Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . **connected** *Bool (read-only)* *Default Value: False* This property indicates the status of individual connections. When *true*, the connection is established. Use the Disconnect method to disconnect an existing connection. **connectionId** *Int32 (read-only)* *Default Value: 0* This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection. **downloadDirectory** *String* *Default Value: ""* The directory to which files will be saved. This specifies the directory where files received by the server will be saved. This must be set before the client begins sending files. Set this in the [Connected](#connected-event-oftpserver-module), [AcceptConnection](#acceptconnection-event-oftpserver-module), or [ConnectionRequest](#connectionrequest-event-oftpserver-module) events, for instance: ```text oftpserver1.SetOFTPConnectionDownloadDirectory(123456789, "C:\\Downloads"); ``` **encryptionAlgorithm** *OFTPServerEncryptionAlgorithms* *Default Value: 0* The encryption algorithm used when sending files to the client. In order to use encryption, you must set the property. The supported algorithms for encryption are: | | | | --- | --- | | 0 (encra3DES - default) | DES (Triple Data Encryption Standard). | | 1 (encraAES) | AES (Advanced Encryption Standard CBC mode with a 256-bit key). | Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . **localAddress** *String (read-only)* *Default Value: ""* This property shows the IP address of the interface through which the connection is passing. is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going. **maxRecordSize** *Int32* *Default Value: 0* This value determines the maximum length for a record in the outgoing virtual file. When 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. **readyToSend** *Bool (read-only)* *Default Value: False* Specifies whether or not the server can send to the client. When the client passes control to the server, this property will be true. Additionally the ReadyToSend event will fire at this time. This must be true before sending files to the client. **recipientCertStoreB** *Data* *Default Value: "MY"* The name of the certificate store for the recipient certificate. The property specifies the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property in order to specify client certificates. If has a value, and is set, a search for a certificate is initiated. Please refer to the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . **recipientCertStore** *String* *Default Value: "MY"* The name of the certificate store for the recipient certificate. The property specifies the type of the certificate store specified by . If the store is password protected, specify the password in . is used in conjunction with the property in order to specify client certificates. If has a value, and is set, a search for a certificate is initiated. Please refer to the property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . **recipientCertStorePassword** *String* *Default Value: ""* If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . **recipientCertStoreType** *CertStoreTypes* *Default Value: 0* 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](default.md#Type_Certificate) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#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 [](#f_Store) and set [](#f_StorePassword) 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. | Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . **recipientCertSubject** *String* *Default Value: ""* The subject of the recipient certificate. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=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. Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . **remoteHost** *String (read-only)* *Default Value: ""* This property shows the IP address of the remote host through which the connection is coming. The connection must be valid or an error will be fired. If the class is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. **remotePort** *Int32 (read-only)* *Default Value: 0* This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. The connection must be valid or an error will be fired. **sfidCode** *String* *Default Value: ""* The connected client's SFID code. The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination. When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary. **signedReceipt** *Bool* *Default Value: False* Indicates whether a signed receipt is requested. When sending files, if this is set to true a signed receipt will be requested. In that case , , and must be set to specify the public certificate that will be used to verify the signature on the receipt returned by the client after [SendFile](#sendfile-method-oftpserver-module) is called. The class will automatically verify the signature on the returned receipt. When receiving files, query this property to determine if the client requested a signed receipt. If true, the [Certificate](#certificate-property-oftpserver-module) property must be set to a certificate with private key in order to sign the receipt that will be returned to the client. The class will sign and deliver the receipt automatically. Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . **ssidCode** *String* *Default Value: ""* The connected client's SSID code. **timeout** *Int32* *Default Value: 0* A timeout for the class. If the property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If is set to a positive value, the class will wait for the operation to complete before returning control. The class will use DoEvents 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 . 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 is specified by the DefaultTimeout property. **version** *TOFTPVersions (read-only)* *Default Value: 0* This holds the version of OFTP supported by the client. This value cannot be changed. All communication with the client is performed using the version returned by this property. Possible values are: | | | | --- | --- | | 0 (oftpVer12) | OFTP Version 1.2 | | 1 (oftpVer13) | OFTP Version 1.3 | | 2 (oftpVer14) | OFTP Version 1.4 | | 3 (oftpVer20) | OFTP Version 2.0 | **virtualFileDate** *String* *Default Value: ""* 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 **virtualFileFormat** *VirtualFileFormats* *Default Value: 0* The structure of the outgoing or incoming file. When sending files, set this property to specify the format to apply to outgoing files. When receiving files, query this property to determine the structure of the file received from the client. The following values are valid file formats for outgoing virtual files: | | | | --- | --- | | 0 (Unstructured - default) | The outgoing file is binary and has not structure. There are no records in this type of file. | | 1 (Text) | The outgoing file is a text file that consists of lines containing no more than 2048 characters terminated by CRLF. This type contains no records. | | 2 (Fixed) | The outgoing file is in fixed file format, which means all records are of the same length. For fixed files, the class expects the file to be in text format with each line containing the MaxRecordSize 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 MaxRecordSize. 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 MaxRecordSize characters. | Note: When either has been set to a value other than *slNone* or has been set to true, all files become *ffUnstructured* except *ffVariable* files. **virtualFileSecurityLevel** *VirtualFileSecurityLevels* *Default Value: 0* Specifies security options for the outgoing or incoming file. When receiving files, query this property to determine the security level of the file received from the client. When sending files to the client, this property will be used to determine what security options apply to the outgoing file. Possible values are: | | | | --- | --- | | 0 (slNone - default) | The file will not be signed nor encrypted. | | 1 (slEncrypted) | The file will be encrypted using the certificate specified by the [](#f_RecipientCertSubject). property | | 2 (slSigned) | The file will be signed using the certificate specified by the [Certificate](#certificate-property-oftpserver-module) property; | | 3 (slEncryptedAndSigned) | The file will be both signed and encrypted. | Note that this is only applicable when Version 2.0 of the protocol is used as indicated by . ## Constructors *Swift Syntax* ```text public init() ``` # Config Settings ([OFTPServer](#oftpserver-module) Module) 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-oftpserver-module) method. ### OFTPServer Config Settings **AllowRetry[ConnectionId]**: Whether to send a retry indicator when rejecting a file.When rejecting a file from within the [AcceptFile](#acceptfile-event-oftpserver-module) event if this setting is set to True the class will send a retry indicator value to the client to specify the file may be retried later. This should be set from within the [AcceptFile](#acceptfile-event-oftpserver-module) event. For instance: ```text component.Config("AllowRetry[" + e->ConnectionId + "]"); ``` When set to False (default) the component will send a value indicating the client should not retry the send operation. **CDAfterSendEndResponse[ConnectionId]**: Whether to issue a CD command after sending an asynchronous EERP.By default the class will send a CD command after sending an asynchronous EERP and getting back a RTR (Ready to Receive) response. This gives control of the connection back to the client. If sending multiple asynchronous EERPs set this to False. After sending all of the EERPs use the [ChangeDirection](#changedirection-method-oftpserver-module) method to explicitly change the speaker for the connection if desired. **CertificateStore[ConnectionId]**: The name of the certificate store.The name of the certificate store. This is used when specifying an alternative [Certificate](#certificate-property-oftpserver-module) for the specified connection. The [CertificateStoreType](#CertificateStoreType) specifies the type of the certificate store specified by [CertificateStore](#CertificateStore). If the store is password protected, specify the password in [CertificateStorePassword](#CertificateStorePassword). [CertificateStore](#CertificateStore) is used in conjunction with the [CertificateSubject](#CertificateSubject) field in order to specify the certificate. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **CertificateStorePassword[ConnectionId]**: The certificate password.If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. This is used when specifying an alternative [Certificate](#certificate-property-oftpserver-module) for the specified connection. **CertificateStoreType[ConnectionId]**: The type of certificate store.This specifies the type of certificate store. This is used when specifying an alternative [Certificate](#certificate-property-oftpserver-module) for the specified connection. Possible values are: | | | | --- | --- | | 0 | User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. | | 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. | | 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. | | 5 | JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is available only in Java. | | 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. | | 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. | **CertificateSubject[ConnectionId]**: The certificate subject.The subject of the certificate. This is used when specifying an alternative [Certificate](#certificate-property-oftpserver-module) for the specified connection. 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. **CertificateType**: Specifies the type of certificate being supplied.By default the class will use the certificate set in the [Certificate](#certificate-property-oftpserver-module) 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](#certificate-property-oftpserver-module) 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 | **CertificateType[ConnectionId]**: Specifies the type of certificate being supplied.By default the class will use the alternate certificate specified by the [CertificateSubject](#CertificateSubject) setting 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* configuration settings. For instance: ```text component.Config("CertificateType[ConnectionId]=3"); component.Config("CertificateStoreType[ConnectionId]=2"); component.Config("CertificateStore[ConnectionId]=C:\\mycert.pfx"); component.Config("CertificateStorePassword[ConnectionId]=password"); component.Config("CertificateSubject[ConnectionId]=*"); ``` Possible values are: | | | | --- | --- | | 0 (default) | All Operations | | 1 | Session Authentication | | 2 | Decryption | | 3 | Signing | | 4 | Receipt Signing | **ConnectionType[ConnectionId]**: Specifies the type of connection that will be created.Specifies the type of connection that is created. 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). This may be set within the [AcceptConnection](#acceptconnection-event-oftpserver-module) event. It only applies to the connection parameters sent by the server to the client. It does not return the value sent by the client to the server. Valid values are: | | | | --- | --- | | 0 | Both (Default) | | 1 | Send Only | | 2 | Receive Only | For instance: ```text component.Config("ConnectionType[" + e->ConnectionId + "]=1"); ``` To check the value sent by the client to the server query [ReceivedConnectionType](#ReceivedConnectionType)[ConnectionId]; instead. **CreditCount[ConnectionId]**: Specifies the maximum 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. This setting may be used within the [AcceptConnection](#acceptconnection-event-oftpserver-module) event. Querying this setting inside the event will return the value provided by the connecting client. You may set this value within the event to specify the credit count that will be sent to the client. When establishing a connection the smaller of the two values provided by the client and the server will be used. This setting may also be queried after a connection is established to determine the negotiated value. For instance: ```text string receivedCreditCount = component.Config("CreditCount[" + e->ConnectionId + "]"); component.Config("CreditCount[" + e->ConnectionId + "]=55"); ``` **DefaultIdleTimeout**: The default idle timeout for inactive clients.This property specifies the idle timeout (in seconds) for clients. When set to a positive value the class will disconnect idle clients after the specified timeout. This only applies to clients that have not sent or received data within DefaultIdleTimeout seconds. If set to 0 (default) no idle timeout is applied. Note: [DoEvents](#doevents-method-oftpserver-module) must be called in order for the class to check existing connections. **DefaultReceiptHashAlgorithm**: 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 | **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 DownloadDirectory. 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 DownloadDirectory. **DisconnectAfterEndSession**: Determines if the connection is closed immediately after ending the session.By default when [Logoff](#logoff-method-oftpserver-module) 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. **ExchangeBufferSize[ConnectionId]**: 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. This setting may be used within the [AcceptConnection](#acceptconnection-event-oftpserver-module) event. Querying this setting inside the event will return the value provided by the connecting client. You may set this value within the event to specify the data exchange buffer size that will be sent to the client. When establishing a connection the smaller of the two values provided by the client and the server will be used. This setting may also be queried after a connection is established to determine the negotiated value. For instance: ```text string receivedExchangeBufferSize = component.Config("ExchangeBufferSize[" + e->ConnectionId + "]"); component.Config("ExchangeBufferSize[" + e->ConnectionId + "]=1024"); ``` **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 [ExchangeCertificate](#exchangecertificate-method-oftpserver-module). 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 [ExchangeCertificate](#exchangecertificate-method-oftpserver-module). For a list of possible values please see [CertStoreType](#OFTPServer_p_CertStoreType). 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 [ExchangeCertificate](#exchangecertificate-method-oftpserver-module) 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 [TrustedCerts](#trustedcerts-property-oftpserver-module) is populated the class will validate that loaded certificates were issued by a trusted CA in [TrustedCerts](#trustedcerts-property-oftpserver-module). 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 [Error](#error-event-oftpserver-module) event but the error will not be fatal and the operation will be allowed to continue. **FileDescription[ConnectionId]**: 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). This setting is only applicable when sending files. For instance: ```text component.Config("FileDescription[myConnectionId]=My File Description"); ``` To obtain the FileDescription when receiving files use [ReceivedFileDescription](#ReceivedFileDescription)[ConnectionId]; instead. **FileHashAlgorithm[ConnectionId]**: 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 [EndResponse](#endresponse-event-oftpserver-module) event for both sent and received end responses. If set to False the [EndResponse](#endresponse-event-oftpserver-module) event will fire only for received (incoming) end responses. The *Direction* parameter of [EndResponse](#endresponse-event-oftpserver-module) 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 [ImportTrustedCerts](#importtrustedcerts-method-oftpserver-module) 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 [PITrail](#pitrail-event-oftpserver-module) 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. **IdleTimeout**: The idle timeout for this connection.This field is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This field specifies the idle timeout (in seconds) for the connected client. When set to a positive value the component will disconnect idle clients after the specified timeout. This only applies to clients that have not send to received data within the specified number of seconds. If set to 0 (default) no idle timeout is applied. For instance: ```text component.Config("IdleTimeout[" + e->ConnectionId + "]=1"); ``` Note: [DoEvents](#doevents-method-oftpserver-module) must be called in order for the class to check existing connections. **KeepAlive**: This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.The default value is False. When True, KEEPALIVE packets are enabled (for long connections). Please note that system TCP/IP stack implementations are not required to support SO_KEEPALIVE. This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **Linger**: This property controls how a connection is closed. The default is True. In this case the connection is closed only after all the data is sent. Setting it to False forces an abrupt (hard) disconnection. Any data that was in the sending queue may be lost.When set to True, connections are terminated gracefully. The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the class returns control immediately, the system might indefinitely hold system resources until all pending data is sent (even after your application closes). This means that valuable system resources might be wasted. Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action. This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **LogLevel**: The level of information to log.This setting specifies the level of detail that is logged to the [Log](#log-event-oftpserver-module) 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. | **ReceivedConnectionType[ConnectionId]**: Returns the connection type specified by the client.This setting returns the connection type specified by the client. It may be queried to determine the type of connection requested by the client. This setting returns the type of connection being created. This may be queried within the [AcceptConnection](#acceptconnection-event-oftpserver-module) event or any time after. It only applies to the connection parameters sent by the client to the server. Valid values are: | | | | --- | --- | | 0 | Both (Default) | | 1 | Send Only | | 2 | Receive Only | For instance: ```text string receivedConnectionType = component.Config("ReceivedConnectionType[" + e->ConnectionId + "]"); ``` **ReceivedFileDateTime[ConnectionId]**: The datetime of the file being received.This setting may be queried to obtain the datetime of the received file. **ReceivedFileDescription[ConnectionId]**: Additional description information received with the file.Query this setting after receiving a file to obtain any additional information provided by the client. The data will be UTF-8 decoded by the class. For instance: ```text string receivedFileDescription = component.Config("ReceivedFileDescription[" + e->ConnectionId + "]"); ``` **ReceivedFileEncryptionAlg[ConnectionId]**: The encryption algorithm used for the file being received.This setting may be queried inside the [AcceptFile](#acceptfile-event-oftpserver-module) or [EndTransfer](#endtransfer-event-oftpserver-module) events to obtain the encryption algorithm used by the client 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[ConnectionId]**: Returns the name of the received file.This setting may be queried inside the [EndTransfer](#endtransfer-event-oftpserver-module) 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%" **ReceivedFileNameFormat[ConnectionId]**: 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 RecipientCert 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 RecipientCert 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[ConnectionId]**: 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. **SecureAuthentication**: Specifies secure authentication requirements for connecting clients.This setting specifies the secure authentication requirements for connecting clients. Secure auth can be allowed, required, or disallowed. Possible values are: | | | | --- | --- | | 0 | Disallowed. Secure authentication is not allowed and will result in an error. | | 1 | Required. Secure authentication is required. If secure authentication is not supported by the client the connection will result in an error. | | 2 (default) | Automatic. Secure authentication is allowed but not required. | **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. **ServerPassword[ConnectionId]**: Sets or gets the ServerPassword for a particular connection.This setting may be used to override the default [ServerPassword](#serverpassword-property-oftpserver-module). This allows for different ServerPasswords to be used for different connected clients. This can be changed at any time, for instance within the [AcceptConnection](#acceptconnection-event-oftpserver-module). **ServerSFIDCode[ConnectionId]**: Sets or gets the ServerSFIDCode for a particular connection.This setting may be used to override the default [ServerSFIDCode](#serversfidcode-property-oftpserver-module) when calling [SendFile](#sendfile-method-oftpserver-module). This allows for different ServerSFIDCodes to be used for different connected clients. This can be changed at any time prior to calling [SendFile](#sendfile-method-oftpserver-module). When receiving files this will be populated with the ServerSFIDCode received from the client. **ServerSSIDCode[ConnectionId]**: Sets the ServerSSIDCode for a particular connection.This setting may be used to override the default [ServerSSIDCode](#serverssidcode-property-oftpserver-module). This allows for different ServerSSIDCodes to be used for different connected clients. This can be set from within the [AcceptConnection](#acceptconnection-event-oftpserver-module) event. **TempPath[ConnectionId]**: 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 when sending a file to the client if any of the following conditions are true. - ConnectionsCompress is true - ConnectionsVirtualFileSecurityLevel is set to slEncrypted - ConnectionsVirtualFileSecurityLevel is set to slSigned - ConnectionsVirtualFileSecurityLevel is set to slEncryptedAndSigned Note that ConnectionsVirtualFileSecurityLevel is only applicable when ConnectionsVersion is set to oftpVer20. This configuration setting can be set with or without a ConnectionId specified. When the ConnectionId is specified, this will cause temporary files for that connection to be written to the specified directory. Otherwise, if no ConnectionId is specified, temporary files for all connections will be written to the given folder. **TrustedCertsData**: Specifies the source to be used when importing trusted certificates.When [ImportTrustedCerts](#importtrustedcerts-method-oftpserver-module) 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 [SendEndResponse](#sendendresponse-method-oftpserver-module) the value saved from within the [EndTransfer](#endtransfer-event-oftpserver-module) event has the necessary data when sending a response. ### TCPServer Config Settings **AllowedClients**: A comma-separated list of host names or IP addresses that can access the class.This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the class. The wildcard character "*" is supported. The default value is "*" and all connections are accepted. When a client connects, the client's address is checked against the list defined here. If there is no match, the [ConnectionRequest](#connectionrequest-event-oftpserver-module) event fires with an *Accept* value set to *false*. If no action is taken within the [ConnectionRequest](#connectionrequest-event-oftpserver-module) event, the client will be disconnected. **BindExclusively**: Whether or not the component considers a local port reserved for exclusive use.If this is *true* (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure. **BlockedClients**: A comma-separated list of host names or IP addresses that cannot access the class.This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the class.The default value is "" and all connections are accepted. When a client connects, the client's address is checked against the list defined here. If there is a match, the [ConnectionRequest](#connectionrequest-event-oftpserver-module) event fires with an *Accept* value set to *false*. If no action is taken within the [ConnectionRequest](#connectionrequest-event-oftpserver-module) event, the client will not be connected. **DefaultConnectionTimeout**: The inactivity timeout applied to the SSL handshake.This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value, if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied. NOTE: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so. **InBufferSize**: The size in bytes of the incoming queue of the socket. This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the [InBufferSize](#InBufferSize) setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated, the [InBufferSize](#InBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. [InBufferSize](#InBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.A TCP keep-alive packet will be sent after a period of inactivity, as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. If this value is not specified here, the system default is 1 second. This setting is applicable to all connections. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections. **MaxConnections**: The maximum number of connections available. This is the maximum number of connections available. This setting must be set before [Listening](#listening-property-oftpserver-module) is set to *true*, and once set, it can no longer be changed for the current instance of the class. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may affect performance. The default value is 1000. NOTE: Unix/Linux operating systems limit the number of simultaneous connections to 1024. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the [OutBufferSize](#OutBufferSize) setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the [OutBufferSize](#OutBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. [OutBufferSize](#OutBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. When set to 2, the class will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 Only | | 1 | IPv6 Only | | 2 | IPv6 and IPv4 | ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When SSLProvider is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-oftpserver-module) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if SSLProvider is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When SSLProvider is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#sslcert-property-oftpserver-module) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class . When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class . When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-oftpserver-module) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when [SSLAuthenticateClients](#sslauthenticateclients-property-oftpserver-module) is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when SSLProvider is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when SSLProvider is set to *Platform* include the following: - CALG_3DES - CALG_3DES_112 - CALG_AES - CALG_AES_128 - CALG_AES_192 - CALG_AES_256 - CALG_AGREEDKEY_ANY - CALG_CYLINK_MEK - CALG_DES - CALG_DESX - CALG_DH_EPHEM - CALG_DH_SF - CALG_DSS_SIGN - CALG_ECDH - CALG_ECDH_EPHEM - CALG_ECDSA - CALG_ECMQV - CALG_HASH_REPLACE_OWF - CALG_HUGHES_MD5 - CALG_HMAC - CALG_KEA_KEYX - CALG_MAC - CALG_MD2 - CALG_MD4 - CALG_MD5 - CALG_NO_SIGN - CALG_OID_INFO_CNG_ONLY - CALG_OID_INFO_PARAMETERS - CALG_PCT1_MASTER - CALG_RC2 - CALG_RC4 - CALG_RC5 - CALG_RSA_KEYX - CALG_RSA_SIGN - CALG_SCHANNEL_ENC_KEY - CALG_SCHANNEL_MAC_KEY - CALG_SCHANNEL_MASTER_HASH - CALG_SEAL - CALG_SHA - CALG_SHA1 - CALG_SHA_256 - CALG_SHA_384 - CALG_SHA_512 - CALG_SKIPJACK - CALG_SSL2_MASTER - CALG_SSL3_MASTER - CALG_SSL3_SHAMD5 - CALG_TEK - CALG_TLS1_MASTER - CALG_TLS1PRF Example values when SSLProvider is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when SSLProvider is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the SSLProvider is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when SSLProvider is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when SSLProvider is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class . The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and SSLProvider is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### 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*. **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. This setting is set to *false* by default on all platforms. # Trappable Errors ([OFTPServer](#oftpserver-module) Module) ### OFTPServer Errors | | | | --- | --- | | 671 | OFTP protocol error. | | 672 | ServerSSID must be set before Listening is set to true. | | 673 | ServerSFID must be set before Listening is set to true. | | 675 | Session terminated by client. Unknown SSID. | | 675 | Session terminated by client. Unknown SFID. | | 677 | Session terminated by client. Unknown Password. | | 678 | Error building packet to send. | | 679 | Error reading file specified. | | 680 | Invalid date timestamp. | | 681 | Local file exists and overwrite is set to false. | | 682 | Invalid hash value. | | 683 | Invalid signature. | | 684 | Cryptographic operation failed. | | 685 | No encryption certificate was specified. | | 686 | No signing certificate was specified. | | 687 | Send failed. Check the description for more details. | | 688 | The requested feature is only supported in OFTP Version 2.0. Check the description for more details. | | 689 | A required certificate was not provided. The error descriptions indicates which property must be set. | | 690 | Invalid Certificate. | | 691 | Failed to import trusted certificates. | ### TCPServer Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | TCPServer is already listening. | | 106 | Cannot change [LocalPort](#localport-property-oftpserver-module) when TCPServer is listening. | | 107 | Cannot change [LocalHost](#localhost-property-oftpserver-module) when TCPServer is listening. | | 108 | Cannot change [MaxConnections](#MaxConnections) when TCPServer is listening. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 126 | Invalid ConnectionId. | | 135 | Operation would block. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |