OFTPServer Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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 control first decide if you will support TLS/SSL connections or not. If UseSSL is set to true, all clients will be expected to connect in TLS/SSL. If UseSSL is set to false (default), all clients are expected to connect in plaintext. If UseSSL 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. By default this value is 3305.

Next, specify values for ServerSSIDCode, ServerSFIDCode, ServerPassword.

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 AcceptConnection 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 OFTPConnectionDownloadDirectory 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 AcceptFile 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 event will fire, and the OFTPConnectionReadyToSend 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 SendFile method with the specified parameters.

TLS/SSL Notes

When UseSSL is set to true, the server must be configured with a TLS/SSL certificate before it is started. Set SSLCert 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 SSLCert property for more information.

After SSLCert is set to a valid certificate and Listening is set to true, when a client connects the SSLStatus event will fire during the TLS/SSL negotiation. This is purely informational, if there is an error the Error event will fire.

If you want to require TLS/SSL client authentication, set SSLAuthenticateClients 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 SSLClientAuthentication event will fire and you must set the Accept parameter within the event to true in order to accept the client's certificate and proceed with the connection.

Example Code

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

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

CertEncoded Property (OFTPServer Control)

This is the certificate (PEM/Base64 encoded).

Syntax

oftpservercontrol.CertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertEncodedB.

This property is not available at design time.

Data Type

Binary String

CertStore Property (OFTPServer Control)

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

Syntax

oftpservercontrol.CertStore[=string]

Default Value

"MY"

Remarks

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

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertStoreB.

Data Type

Binary String

CertStorePassword Property (OFTPServer Control)

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

Syntax

oftpservercontrol.CertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

CertStoreType Property (OFTPServer Control)

This is the type of certificate store for this certificate.

Syntax

oftpservercontrol.CertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

CertSubject Property (OFTPServer Control)

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

Syntax

oftpservercontrol.CertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

ConnectionBacklog Property (OFTPServer Control)

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

Syntax

oftpservercontrol.ConnectionBacklog[=integer]

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.

This property is not available at design time.

Data Type

Integer

OFTPConnectionCount Property (OFTPServer Control)

The number of records in the OFTPConnection arrays.

Syntax

oftpservercontrol.OFTPConnectionCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• OFTPConnectionCompress
• OFTPConnectionConnected
• OFTPConnectionConnectionId
• OFTPConnectionDownloadDirectory
• OFTPConnectionEncryptionAlgorithm
• OFTPConnectionLocalAddress
• OFTPConnectionMaxRecordSize
• OFTPConnectionReadyToSend
• OFTPConnectionRecipientCertStore
• OFTPConnectionRecipientCertStorePassword
• OFTPConnectionRecipientCertStoreType
• OFTPConnectionRecipientCertSubject
• OFTPConnectionRemoteHost
• OFTPConnectionRemotePort
• OFTPConnectionSFIDCode
• OFTPConnectionSignedReceipt
• OFTPConnectionSSIDCode
• OFTPConnectionTimeout
• OFTPConnectionVersion
• OFTPConnectionVirtualFileDate
• OFTPConnectionVirtualFileFormat
• OFTPConnectionVirtualFileSecurityLevel

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

This property is read-only and not available at design time.

Data Type

Integer

OFTPConnectionCompress Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionCompress(ConnectionId)[=boolean]

Default Value

False

Remarks

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

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

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Boolean

OFTPConnectionConnected Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionConnected(ConnectionId)[=boolean]

Default Value

False

Remarks

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

The OFTPConnectionConnected property may be set to to close the connection.

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

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Boolean

OFTPConnectionConnectionId Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionConnectionId(ConnectionId)

Default Value

""

Remarks

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

OFTPConnectionDownloadDirectory Property (OFTPServer Control)

The directory to which files will be saved.

Syntax

oftpservercontrol.OFTPConnectionDownloadDirectory(ConnectionId)[=string]

Default Value

""

Remarks

The directory to which files will be saved.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionEncryptionAlgorithm Property (OFTPServer Control)

The encryption algorithm used when sending files to the client.

Syntax

oftpservercontrol.OFTPConnectionEncryptionAlgorithm(ConnectionId)[=integer]

Possible Values

conencra3DES(0), 
conencraAES(1)

Default Value

0

Remarks

The encryption algorithm used when sending files to the client.

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionLocalAddress Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionLocalAddress(ConnectionId)

Default Value

""

Remarks

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

OFTPConnectionMaxRecordSize Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionMaxRecordSize(ConnectionId)[=integer]

Default Value

0

Remarks

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionReadyToSend Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionReadyToSend(ConnectionId)

Default Value

False

Remarks

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

OFTPConnectionRecipientCertStore Property (OFTPServer Control)

The name of the certificate store for the recipient certificate.

Syntax

oftpservercontrol.OFTPConnectionRecipientCertStore(ConnectionId)[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the recipient certificate.

The OFTPConnectionRecipientCertStoreType property specifies the type of the certificate store specified by OFTPConnectionRecipientCertStore. If the store is password protected, specify the password in OFTPConnectionRecipientCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .OFTPConnectionRecipientCertStoreB.

This property is not available at design time.

Data Type

Binary String

OFTPConnectionRecipientCertStorePassword Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionRecipientCertStorePassword(ConnectionId)[=string]

Default Value

""

Remarks

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionRecipientCertStoreType Property (OFTPServer Control)

The type of certificate store for this certificate.

Syntax

oftpservercontrol.OFTPConnectionRecipientCertStoreType(ConnectionId)[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionRecipientCertSubject Property (OFTPServer Control)

The subject of the recipient certificate.

Syntax

oftpservercontrol.OFTPConnectionRecipientCertSubject(ConnectionId)[=string]

Default Value

""

Remarks

The subject of the recipient certificate.

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

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

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

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

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

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

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 OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionRemoteHost Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionRemoteHost(ConnectionId)

Default Value

""

Remarks

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

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

OFTPConnectionRemotePort Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionRemotePort(ConnectionId)

Default Value

0

Remarks

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

Integer

OFTPConnectionSFIDCode Property (OFTPServer Control)

The connected client's SFID code.

Syntax

oftpservercontrol.OFTPConnectionSFIDCode(ConnectionId)[=string]

Default Value

""

Remarks

The connected client's SFID code.

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionSignedReceipt Property (OFTPServer Control)

Indicates whether a signed receipt is requested.

Syntax

oftpservercontrol.OFTPConnectionSignedReceipt(ConnectionId)[=boolean]

Default Value

False

Remarks

Indicates whether a signed receipt is requested.

When sending files, if this is set to true a signed receipt will be requested. In that case OFTPConnectionRecipientCertStoreType, OFTPConnectionRecipientCertStore, and OFTPConnectionRecipientCertSubject 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 is called. The control will automatically verify the signature on the returned receipt.

When receiving files, query this property to determine if the client requested a signed receipt. If true, the Certificate property must be set to a certificate with private key in order to sign the receipt that will be returned to the client. The control 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 OFTPConnectionVersion.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Boolean

OFTPConnectionSSIDCode Property (OFTPServer Control)

The connected client's SSID code.

Syntax

oftpservercontrol.OFTPConnectionSSIDCode(ConnectionId)[=string]

Default Value

""

Remarks

The connected client's SSID code.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionTimeout Property (OFTPServer Control)

A timeout for the control.

Syntax

oftpservercontrol.OFTPConnectionTimeout(ConnectionId)[=integer]

Default Value

0

Remarks

A timeout for the control.

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

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

The control 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 control fails with an error.

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

The default value for OFTPConnectionTimeout is specified by the DefaultTimeout property.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionVersion Property (OFTPServer Control)

This holds the version of OFTP supported by the client.

Syntax

oftpservercontrol.OFTPConnectionVersion(ConnectionId)

Possible Values

oftpVer12(0), 
oftpVer13(1), 
oftpVer14(2), 
oftpVer20(3)

Default Value

0

Remarks

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is read-only and not available at design time.

Data Type

Integer

OFTPConnectionVirtualFileDate Property (OFTPServer Control)

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

Syntax

oftpservercontrol.OFTPConnectionVirtualFileDate(ConnectionId)[=string]

Default Value

""

Remarks

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

Supported date formats:

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

String

OFTPConnectionVirtualFileFormat Property (OFTPServer Control)

The structure of the outgoing or incoming file.

Syntax

oftpservercontrol.OFTPConnectionVirtualFileFormat(ConnectionId)[=integer]

Possible Values

ffUnstructured(0), 
ffText(1), 
ffFixed(2), 
ffVariable(3)

Default Value

0

Remarks

The structure of the outgoing or incoming file.

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

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

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

OFTPConnectionVirtualFileSecurityLevel Property (OFTPServer Control)

Specifies security options for the outgoing or incoming file.

Syntax

oftpservercontrol.OFTPConnectionVirtualFileSecurityLevel(ConnectionId)[=integer]

Possible Values

slNone(0), 
slEncrypted(1), 
slSigned(2), 
slEncryptedAndSigned(3)

Default Value

0

Remarks

Specifies security options for the outgoing or incoming file.

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

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the OFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

DefaultTimeout Property (OFTPServer Control)

An initial timeout value to be used by incoming connections.

Syntax

oftpservercontrol.DefaultTimeout[=integer]

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 control will wait for the operation to complete before returning control.

The control 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 control fails with an error.

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

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

Data Type

Integer

Listening Property (OFTPServer Control)

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

Syntax

oftpservercontrol.Listening[=boolean]

Default Value

False

Remarks

This property indicates whether the control is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the control is listening.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (OFTPServer Control)

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

Syntax

oftpservercontrol.LocalHost[=string]

Default Value

""

Remarks

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

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

If the control 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 multi-homed 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.

Data Type

String

LocalPort Property (OFTPServer Control)

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

Syntax

oftpservercontrol.LocalPort[=integer]

Default Value

3305

Remarks

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

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

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

Data Type

Integer

ServerPassword Property (OFTPServer Control)

The server's password.

Syntax

oftpservercontrol.ServerPassword[=string]

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.

Data Type

String

ServerSFIDCode Property (OFTPServer Control)

Server's SFID code.

Syntax

oftpservercontrol.ServerSFIDCode[=string]

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.

Data Type

String

ServerSSIDCode Property (OFTPServer Control)

The server's SSID code.

Syntax

oftpservercontrol.ServerSSIDCode[=string]

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:

Data Type

String

SSLAuthenticateClients Property (OFTPServer Control)

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

Syntax

oftpservercontrol.SSLAuthenticateClients[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

SSLCertEncoded Property (OFTPServer Control)

This is the certificate (PEM/Base64 encoded).

Syntax

oftpservercontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (OFTPServer Control)

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

Syntax

oftpservercontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (OFTPServer Control)

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

Syntax

oftpservercontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (OFTPServer Control)

This is the type of certificate store for this certificate.

Syntax

oftpservercontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (OFTPServer Control)

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

Syntax

oftpservercontrol.SSLCertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

TrustedCertCount Property (OFTPServer Control)

The number of records in the TrustedCert arrays.

Syntax

oftpservercontrol.TrustedCertCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertEncoded
• TrustedCertStore
• TrustedCertStorePassword
• TrustedCertStoreType
• TrustedCertSubject

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

This property is not available at design time.

Data Type

Integer

TrustedCertEncoded Property (OFTPServer Control)

This is the certificate (PEM/Base64 encoded).

Syntax

oftpservercontrol.TrustedCertEncoded(TrustedCertIndex)[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The TrustedCertStore and TrustedCertSubject properties also may be used to specify a certificate.

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

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .TrustedCertEncodedB.

This property is not available at design time.

Data Type

Binary String

TrustedCertStore Property (OFTPServer Control)

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

Syntax

oftpservercontrol.TrustedCertStore(TrustedCertIndex)[=string]

Default Value

"MY"

Remarks

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

The TrustedCertStoreType property denotes the type of the certificate store specified by TrustedCertStore. If the store is password protected, specify the password in TrustedCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .TrustedCertStoreB.

This property is not available at design time.

Data Type

Binary String

TrustedCertStorePassword Property (OFTPServer Control)

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

Syntax

oftpservercontrol.TrustedCertStorePassword(TrustedCertIndex)[=string]

Default Value

""

Remarks

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

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

String

TrustedCertStoreType Property (OFTPServer Control)

This is the type of certificate store for this certificate.

Syntax

oftpservercontrol.TrustedCertStoreType(TrustedCertIndex)[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Integer

TrustedCertSubject Property (OFTPServer Control)

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

Syntax

oftpservercontrol.TrustedCertSubject(TrustedCertIndex)[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

String

UseSSL Property (OFTPServer Control)

Use SSL to access the RemoteHost .

Syntax

oftpservercontrol.UseSSL[=boolean]

Default Value

False

Remarks

Use this property to determine whether the control 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.

This property is not available at design time.

Data Type

Boolean

ChangeDirection Method (OFTPServer Control)

Sends a Change Direction (CD) command.

Syntax

oftpservercontrol.ChangeDirection ConnectionId

Remarks

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

Config Method (OFTPServer Control)

Sets or retrieves a configuration setting.

Syntax

oftpservercontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Disconnect Method (OFTPServer Control)

This method disconnects the specified client.

Syntax

oftpservercontrol.Disconnect ConnectionId

Remarks

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

DoEvents Method (OFTPServer Control)

Processes events from the internal message queue.

Syntax

oftpservercontrol.DoEvents 

Remarks

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

ExchangeCertificate Method (OFTPServer Control)

Exchange a certificate with the remote host.

Syntax

oftpservercontrol.ExchangeCertificate ConnectionId, ClientSFIDCode, CertificateStore, CertificateExchangeType

Remarks

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

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

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

ImportTrustedCerts Method (OFTPServer Control)

Imports a list of trusted CA certificates.

Syntax

oftpservercontrol.ImportTrustedCerts 

Remarks

When ImportTrustedCerts is called the control will import the CA certificates from the source specified by TrustedCertsData into the TrustedCerts collection.

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

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

See also FailOnUntrustedCert.

Interrupt Method (OFTPServer Control)

This method interrupts a synchronous send to the remote host.

Syntax

oftpservercontrol.Interrupt ConnectionId

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 control. If you use SendFile to upload a file, the control will run synchronously on that Connection Id until it is completed.

Logoff Method (OFTPServer Control)

Ends a session with the connection client.

Syntax

oftpservercontrol.Logoff ConnectionId

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 OFTPConnectionReadyToSend will be false. When OFTPConnectionReadyToSend is true, calling this method will end the session.

Reset Method (OFTPServer Control)

Resets the state of the control.

Syntax

oftpservercontrol.Reset 

Remarks

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

SendEndResponse Method (OFTPServer Control)

Sends an EERP/NERP asynchronously.

Syntax

oftpservercontrol.SendEndResponse ConnectionId, VirtualFileName, VirtualFileDate, Destination, Originator, Creator, ReasonCode, ReasonText, FileHash, Signature

Remarks

This method sends an EERP/NERP. By default the control 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 event to False. This instructs the control to not send a response automatically. Within the EndTransfer event you must also save the values that are required parameters for this method. This includes FileHash, VirtualFileDate, and VirtualFileName. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

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

Originator should be set to the SFID of the local system. In the case that the control 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 event (if populated).

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

SendFile Method (OFTPServer Control)

Sends a file to the specified client.

Syntax

oftpservercontrol.SendFile ConnectionId, ClientSFIDCode, FileName, VirtualFileName

Remarks

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

After the ReadyToSend event fires or when the OFTPConnectionReadyToSend 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 control will fire the StartTransfer, Transfer, and EndTransfer 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 Control)

This method shuts down the server.

Syntax

oftpservercontrol.Shutdown 

Remarks

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

StartListening Method (OFTPServer Control)

This method starts listening for incoming connections.

Syntax

oftpservercontrol.StartListening 

Remarks

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

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (OFTPServer Control)

This method stops listening for new connections.

Syntax

oftpservercontrol.StopListening 

Remarks

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

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

ValidateCert Method (OFTPServer Control)

Validates the certificate with private key.

Syntax

oftpservercontrol.ValidateCert 

Remarks

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

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

When this method is called the control:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts 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 Control)

Validates the recipient certificate.

Syntax

oftpservercontrol.ValidateRecipientCert ConnectionId

Remarks

This method optionally validates the certificate specified by OFTPConnectionRecipientCertSubject. 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 to load the trusted certification information.

When this method is called the control:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts 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 Control)

Fired when a client connects.

Syntax

Sub oftpservercontrol_AcceptConnection(ConnectionId As Integer, ClientSSIDCode As String, ClientPassword As String, ClientVersion As Integer, ServerVersion As Integer, Accept As Boolean, ErrorCode As Integer, ErrorDescription As 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 control will use the version requested by the client for the connection. If you wish to restrict connections to a specific OFTP protocol version use this value when determining whether or not to accept the connection. When rejecting the connection based on the OFTP protocol version use ErrorCode 10. Possible values are:

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

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

AcceptFile Event (OFTPServer Control)

Fired when the client sends a file.

Syntax

Sub oftpservercontrol_AcceptFile(ConnectionId As Integer, VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String, Accept As Boolean, Filename As String, Overwrite As Boolean, ErrorCode As Integer, ErrorDescription As 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. 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

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 OFTPConnectionDownloadDirectory and the name received from the client.

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

ErrorCode controls the error returned to the client when Accept is set to False. If this is not set the control 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 control will automatically include an error message based on the ErrorCode specified. Common error codes and their corresponding error messages are listed below.

CertificateReceived Event (OFTPServer Control)

Fired when a certificate is received from the remote host.

Syntax

Sub oftpservercontrol_CertificateReceived(ConnectionId As Integer, CertificateFileName As String, CertificateExchangeType As Integer)

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 CertificateFilemame parameter holds the filename of the received certificate.

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

ConnectionId identifies the connected client.

Connected Event (OFTPServer Control)

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

Syntax

Sub oftpservercontrol_Connected(ConnectionId As Integer, StatusCode As Integer, Description As 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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (OFTPServer Control)

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

Syntax

Sub oftpservercontrol_ConnectionRequest(Address As String, Port As Integer, Accept As Boolean)

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 Control)

This event is fired when a connection is closed.

Syntax

Sub oftpservercontrol_Disconnected(ConnectionId As Integer, StatusCode As Integer, Description As 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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

EndResponse Event (OFTPServer Control)

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

Syntax

Sub oftpservercontrol_EndResponse(ConnectionId As Integer, VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String, Creator As String, ReasonCode As Integer, ReasonText As String, FileHash As String, Signature As String, Direction As Integer)

Remarks

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

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

VirtualFileName specifies the name of the file.

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

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

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

Creator is the SFID of the remote system.

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

FileHash is populated if the OFTP Version is 2.0 and a signed receipt was originally requested. FileHash may also be specified with the expected value in the case where an asynchronous EndResponse is received. The expected value may be obtained from the EndTransfer 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 method.

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

ConnectionId identifies the connected client.

EndTransfer Event (OFTPServer Control)

Fired when a file finishes transferring.

Syntax

Sub oftpservercontrol_EndTransfer(ConnectionId As Integer, Direction As Integer, LocalFile As String, VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String, ReasonCode As Integer, ReasonText As String, FileSize As Long64, FileHash As String, SendEndResponse As Boolean)

Remarks

The EndTransfer event is fired when a file is sent or received by the control.

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

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

VirtualFileName holds the filename.

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

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

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

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

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

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

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

ConnectionId identifies the connected client.

Error Event (OFTPServer Control)

Information about errors during data delivery.

Syntax

Sub oftpservercontrol_Error(ConnectionId As Integer, ErrorCode As Integer, Description As String)

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

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

Log Event (OFTPServer Control)

Fires once for each log message.

Syntax

Sub oftpservercontrol_Log(ConnectionId As Integer, LogLevel As Integer, Message As String, LogType As String)

Remarks

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

ConnectionId identifies the connected client.

LogLevel indicates the level of message. Possible values are:

Message is the log entry.

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

• "Info"
• "OFTP"

PITrail Event (OFTPServer Control)

Fired when any protocol level communication occurs.

Syntax

Sub oftpservercontrol_PITrail(ConnectionId As Integer, Direction As Integer, Data As String, CommandId As Integer, CommandDescription As String)

Remarks

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

The Direction parameter specifies who sent the command.

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

The Data parameter contains the raw OFTP packet.

ReadyToSend Event (OFTPServer Control)

Fired when the control is ready to send data.

Syntax

Sub oftpservercontrol_ReadyToSend(ConnectionId As Integer)

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 OFTPConnectionReadyToSend property will be set to true for the connection.

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

SSLClientAuthentication Event (OFTPServer Control)

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

Syntax

Sub oftpservercontrol_SSLClientAuthentication(ConnectionId As Integer, CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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 Control)

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

Syntax

Sub oftpservercontrol_SSLConnectionRequest(ConnectionId As Integer, SupportedCipherSuites As String, SupportedSignatureAlgs As String, CertStoreType As Integer, CertStore As String, CertPassword As String, CertSubject As 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 control 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 control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

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

Designations of certificate stores are platform dependent.

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

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

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

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

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

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

SSLStatus Event (OFTPServer Control)

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

Syntax

Sub oftpservercontrol_SSLStatus(ConnectionId As Integer, Message As 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 Control)

Fired when a document starts transferring.

Syntax

Sub oftpservercontrol_StartTransfer(ConnectionId As Integer, Direction As Integer, LocalFile As String, VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String)

Remarks

This event fires when a file transfer begins.

Direction specifies if the client or server sent the file.

VirtualFileName holds the filename.

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

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

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

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

ConnectionId identifies the connected client.

Transfer Event (OFTPServer Control)

Fired while a document transfers (delivers document).

Syntax

Sub oftpservercontrol_Transfer(ConnectionId As Integer, Direction As Integer, LocalFile As String, VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String, BytesTransferred As Long64, Text As String)

Remarks

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

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

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

VirtualFileName holds the filename.

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

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

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

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

ConnectionId identifies the connected client.

Config Settings (OFTPServer Control)

OFTPServer Config Settings

TCPServer Config Settings

SSL Config Settings

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

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

Base Config Settings

Trappable Errors (OFTPServer Control)

OFTPServer Errors

TCPServer Errors

TCP/IP Errors