OFTPServer Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class ipworksedi.OFTPServer

Remarks

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

Sending and Receiving Files

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

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

Next, specify values for server_ssid_code, server_sfid_code, server_password.

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

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

oftpserver1.SetOFTPConnectionDownloadDirectory(e->ConnectionId, "C:\\Downloads");

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

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

TLS/SSL Notes

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

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

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

Example Code

MyOftpserver server;

server.SetServerSSIDCode("SERVERSSID");
server.SetServerSFIDCode("SERVERSFID");
server.SetServerPassword("SERVER");

server.SetListening(true);

...
//Within the main loop of the application call server.DoEvents() in a loop
//to process events.

//When the ReadyToSend event fires the server can then send files to the client. To do this call the SendFile method.
//Alternatively, monitor server.GetOFTPConnectionReadyToSend(<ConnectionId>) to determine when files can be sent.
class MyOFTPServer : public OFTPServer {
public:
    MyOFTPServer() {}

    virtual int FireAcceptConnection(OFTPServerAcceptConnectionEventParams* e) {
        clientConnectionId = e->ConnectionId;
        clientSSIDCode = strdup(e->ClientSSIDCode);

        this->SetOFTPConnectionDownloadDirectory(e->ConnectionId, INCOMING_DIR);

        return 0;
    }
    virtual int FireAcceptFile(OFTPServerAcceptFileEventParams* e) {
        //e->Accept = False; //To reject a file set e->Accept to false
        return 0;
    }

    virtual int FirePITrail(OFTPServerPITrailEventParams* e) {
        char logmsg[MAX_PATH];
        if (e->Direction == 0) {
            sprintf(logmsg, "CLIENT: %s : %s", e->CommandId, e->CommandDescription);
        }
        else {
            sprintf(logmsg, "SERVER: %s : %s", e->CommandId, e->CommandDescription);
        }
        printf(logmsg);
        return 0;
    }

    virtual int FireError(OFTPServerErrorEventParams* e) {
        printf("[%d] %s\n", e->ErrorCode,strdup(e->Description));
        return 0;
    }
};