SFTPServer Component
Properties Methods Events Config Settings Errors
The SFTPServer component is used to create a Secure File Transfer Protocol (SFTP) server.
Syntax
TiphSFTPServer
Remarks
The SFTPServer component provides a simple way to create a Secure File Transfer Protocol (SFTP) server. Any SFTP client will be able to connect and transfer files to and from the server.
Getting Started
To begin, first provide a valid certificate with a private key in the SSHCert property.
Optionally set the RootDirectory property to a valid local path. If this property is set, the component will serve files from this location, and when clients connect, they will see this as their initial directory. If this property is not set, then the component will fire events allowing customized responses for each operation.
To start the server, set Listening to True.
Client Authentication
Client authentication is handled through the SSHUserAuthRequest event. Inside this event, the Accept parameter determines whether authentication is accepted; this parameter should be set to True if a successful authentication is detected and False otherwise.
When a client connects, the AuthMethod parameter indicates the method of authentication the client wishes to use. Connecting clients will initially attempt authentication with an AuthMethod of "none". This is done with the expectation that the request will fail and the server will provide a list of support authentication methods. The client then selects an available method and reauthenticates. If AuthMethod is "none", Accept should be set to False.
For password authentication, the User parameter will hold the client's username and the AuthParam parameter will hold the password provided by the client. An external list of known usernames and passwords should be maintained to check these values against.
For publickey authentication, the User parameter will hold the client's username and the AuthParam parameter will hold the key provided by the client. This key should be compared to an external list of known keys and usernames.
For keyboard-interactive authentication, the SSHUserAuthRequest event will fire multiple times; once for each prompt and response sent by the client. The index of the response is specified as a suffix in the AuthMethod parameter (e.g., keyboard-interactive-1, keyboard-interactive-2), and AuthParam will contain the client's response to the prompt. Finally, SSHUserAuthRequest will fire one last time with AuthMethod set to "keyboard-interactive" and AuthParam set to an empty string. The Accept parameter must be set to True each time the event fires for the authentication process to succeed.
Directory Listing
When a client requests a directory listing, the DirList event fires with the Path parameter set to the directory to enumerate. If the directory listing is allowed, the appropriate set of files should be passed to the SetFileList method. The StatusCode parameter should be set according to the status of the operation, and the valid status codes can be found in the documentation for the DirList event.
Handling Events
Event handlers are the primary method of customizing the component's functionality. When a client attempts to connect, open a file, authenticate to the server, and so on, the corresponding SFTPServer event will fire to allow for custom handling of the client's request.
The following events are fired both before and after the requested operation is executed:
Each of these events has a BeforeExec event parameter that is True when the event is fired before execution of the operation, and False after execution of the operation. Handling the event before execution provides an opportunity to use custom logic to determine whether the operation should be denied, diverted, or otherwise modified. Handling the event after execution provides an opportunity to report success or any errors related to the operation to the client.
The following events are fired only after the requested operation is executed:
Any logic to deny opening a file for read or write should be done in the FileOpen event handler.
Note: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, DoEvents should be called in a loop after the server is started.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
ConnectionBacklog | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. |
SFTPConnectionCount | The number of records in the SFTPConnection arrays. |
SFTPConnectionConnected | This property indicates the status of individual connections. |
SFTPConnectionErrorMessage | ErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message. |
SFTPConnectionFileData | The FileData should be set or read when processing read/write file events. |
SFTPConnectionLocalAddress | This property shows the IP address of the interface through which the connection is passing. |
SFTPConnectionProtocolVersion | The ProtocolVersion shows the SFTP protocol version negotiated with the client when the SFTP connection was established. |
SFTPConnectionRemoteHost | The RemoteHost shows the IP address of the remote host through which the connection is coming. |
SFTPConnectionRemotePort | The RemotePort shows the TCP port on the remote host through which the connection is coming. |
SFTPConnectionTimeout | A timeout for the component. |
DefaultAuthMethods | Specifies the supported authentication methods. |
DefaultTimeout | An initial timeout value to be used by incoming connections. |
KeyboardInteractiveMessage | The instructions to send to the client during keyboard-interactive authentication. |
KeyboardInteractivePromptCount | The number of records in the KeyboardInteractivePrompt arrays. |
KeyboardInteractivePromptEcho | Specifies if the client should echo the value entered by the user or not. |
KeyboardInteractivePromptPrompt | The prompt label/text the client should present to the user. |
Listening | This property indicates whether the component is listening for incoming connections on LocalPort. |
LocalHost | This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component listens. |
RootDirectory | The root directory for the entire SFTP server. |
SSHCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSHCertExpirationDate | This is the date the certificate expires. |
SSHCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSHCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSHCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSHCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSHCertIssuer | This is the issuer of the certificate. |
SSHCertPrivateKey | This is the private key of the certificate (if available). |
SSHCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSHCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSHCertPublicKey | This is the public key of the certificate. |
SSHCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSHCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSHCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSHCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSHCertStore | This is the name of the certificate store for the client certificate. |
SSHCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSHCertStoreType | This is the type of certificate store for this certificate. |
SSHCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSHCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSHCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSHCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSHCertUsage | This property contains the text description of UsageFlags . |
SSHCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSHCertVersion | This property contains the certificate's version number. |
SSHCertSubject | This is the subject of the certificate used for client authentication. |
SSHCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSHCompressionAlgorithms | A comma-separated list containing all allowable compression algorithms. |
SSHEncryptionAlgorithms | A comma-separated list containing all allowable encryption algorithms. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Disconnect | This method disconnects the specified client. |
DoEvents | This method processes events from the internal message queue. |
ExchangeKeys | Causes the component to exchange a new set of session keys on the specified connection. |
Reset | This method will reset the component. |
SetFileList | Sets the file list for a connection during a directory listing request. |
Shutdown | This method shuts down the server. |
StartListening | This method starts listening for incoming connections. |
StopListening | This method stops listening for new connections. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Connected | This event is fired immediately after a connection completes (or fails). |
ConnectionRequest | This event is fired when a request for connection comes from a remote host. |
DirCreate | Fires when a client wants to create a new directory. |
DirList | Fires when a client attempts to open a directory for listing. |
DirRemove | Fires when a client wants to delete a directory. |
Disconnected | This event is fired when a connection is closed. |
Error | Information about errors during data delivery. |
FileClose | Fires when a client attempts to close an open file or directory handle. |
FileOpen | Fires when a client wants to open or create a file. |
FileRead | Fires when a client wants to read from an open file. |
FileRemove | Fires when a client wants to delete a file. |
FileRename | Fires when a client wants to rename a file. |
FileWrite | Fires when a client wants to write to an open file. |
GetAttributes | Fires when a client needs to get file information. |
Log | Fires once for each log message. |
ResolvePath | Fires when a client attempts to canonicalize a path. |
SetAttributes | Fires when a client attempts to set file or directory attributes. |
SSHStatus | Shows the progress of the secure connection. |
SSHUserAuthRequest | Fires when a client attempts to authenticate a connection. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
DirListBufferSize[ConnectionId] | The number of entries to be returned in one response to a request for a directory listing. |
MaskSensitiveData | Masks passwords in logs. |
ProtocolVersion | The highest allowable SFTP version to use. |
RestrictUserToHomeDir[ConnectionId] | Whether to restrict the user to their home directory. |
ServerEOL | Specifies the line endings used in files on the server. |
SFTPErrorMessage[ConnectionId] | Specifies the error message to be returned to the client. |
UnixStyleDateFormat | Controls whether to use the Unix-style date format in directory listings. |
UserRootDirectory[ConnectionId] | The path of the server root directory for a particular user. |
AltSSHCertCount | The number of records in the AltSSHCert configuration settings. |
AltSSHCertStore[i] | The name of the certificate store. |
AltSSHCertStorePassword[i] | The password used to open the certificate store. |
AltSSHCertStoreType[i] | The type of certificate store. |
AltSSHCertSubject[i] | The alternative certificate subject. |
ClientSSHVersionString[ConnectionId] | The client's version string. |
FireAuthRequestAfterSig | Whether to fire an informational event after the public key signature has been verified. |
KeyboardInteractivePrompts[ConnectionId] | Specifies custom keyboard-interactive prompts for particular connections. |
KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
LogLevel | Specifies the level of detail that is logged. |
MaxAuthAttempts | The maximum authentication attempts allowed before forcing a disconnect. |
NegotiatedStrictKex[ConnectionId] | Returns whether strict key exchange was negotiated to be used. |
ServerSSHVersionString | The SSH version string sent to connecting clients. |
SSHKeepAliveCountMax | The maximum number of keep alive packets to send without a response. |
SSHKeepAliveInterval | The interval between keep alive packets. |
SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
SSHMacAlgorithms | Specifies the supported Mac algorithms. |
SSHPubKeyAuthSigAlgorithms | Specifies the allowed signature algorithms used by a client performing public key authentication. |
SSHPublicKeyAlgorithms | Specifies the supported public key algorithms for the server's public key. |
SSHVersionPattern | The pattern used to match the remote host's version string. |
UserAuthBanner[ConnectionId] | A custom user authentication banner. |
UseStrictKeyExchange | Specifies how strict key exchange is supported. |
AllowedClients | A comma-separated list of host names or IP addresses that can access the component. |
BindExclusively | Whether or not the component considers a local port reserved for exclusive use. |
BlockedClients | A comma-separated list of host names or IP addresses that cannot access the component. |
DefaultConnectionTimeout | The inactivity timeout applied to the SSL handshake. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
MaxConnections | The maximum number of connections available. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
ConnectionBacklog Property (SFTPServer Component)
This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.
Syntax
__property int ConnectionBacklog = { read=FConnectionBacklog, write=FSetConnectionBacklog };
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
SFTPConnectionCount Property (SFTPServer Component)
The number of records in the SFTPConnection arrays.
Syntax
__property int SFTPConnectionCount = { read=FSFTPConnectionCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- SFTPConnectionConnected
- SFTPConnectionErrorMessage
- SFTPConnectionFileData
- SFTPConnectionLocalAddress
- SFTPConnectionProtocolVersion
- SFTPConnectionRemoteHost
- SFTPConnectionRemotePort
- SFTPConnectionTimeout
This property is read-only and not available at design time.
Data Type
Integer
SFTPConnectionConnected Property (SFTPServer Component)
This property indicates the status of individual connections.
Syntax
__property bool SFTPConnectionConnected[int ConnectionId] = { read=FSFTPConnectionConnected };
Default Value
False
Remarks
This property indicates the status of individual connections.
When true, the connection is established. Use the Disconnect method to disconnect an existing connection.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.
This property is read-only and not available at design time.
Data Type
Boolean
SFTPConnectionErrorMessage Property (SFTPServer Component)
ErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message.
Syntax
__property String SFTPConnectionErrorMessage[int ConnectionId] = { read=FSFTPConnectionErrorMessage };
Default Value
""
Remarks
SFTPConnectionErrorMessage is used together with status codes returned from events to send informative errors back to the SFTP client through the SSH_FXP_STATUS message. If left blank, the component will set a default message based on the returned status code.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
SFTPConnectionFileData Property (SFTPServer Component)
The FileData should be set or read when processing read/write file events.
Syntax
__property String SFTPConnectionFileData[int ConnectionId] = { read=FSFTPConnectionFileData, write=FSetSFTPConnectionFileData }; __property DynamicArray<Byte> SFTPConnectionFileDataB[int ConnectionId] = { read=FSFTPConnectionFileDataB, write=FSetSFTPConnectionFileDataB };
Default Value
""
Remarks
The SFTPConnectionFileData should be set or read when processing read/write file events.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.
This property is not available at design time.
Data Type
Byte Array
SFTPConnectionLocalAddress Property (SFTPServer Component)
This property shows the IP address of the interface through which the connection is passing.
Syntax
__property String SFTPConnectionLocalAddress[int ConnectionId] = { read=FSFTPConnectionLocalAddress };
Default Value
""
Remarks
This property shows the IP address of the interface through which the connection is passing.
SFTPConnectionLocalAddress is important for multihomed hosts where it can be used to find which particular network interface an individual connection is going through.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
SFTPConnectionProtocolVersion Property (SFTPServer Component)
The ProtocolVersion shows the SFTP protocol version negotiated with the client when the SFTP connection was established.
Syntax
__property int SFTPConnectionProtocolVersion[int ConnectionId] = { read=FSFTPConnectionProtocolVersion };
Default Value
3
Remarks
The SFTPConnectionProtocolVersion shows the SFTP protocol version negotiated with the client when the SFTP connection was established.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.
This property is read-only and not available at design time.
Data Type
Integer
SFTPConnectionRemoteHost Property (SFTPServer Component)
The RemoteHost shows the IP address of the remote host through which the connection is coming.
Syntax
__property String SFTPConnectionRemoteHost[int ConnectionId] = { read=FSFTPConnectionRemoteHost };
Default Value
""
Remarks
The SFTPConnectionRemoteHost 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 component 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 SFTPConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
SFTPConnectionRemotePort Property (SFTPServer Component)
The RemotePort shows the TCP port on the remote host through which the connection is coming.
Syntax
__property int SFTPConnectionRemotePort[int ConnectionId] = { read=FSFTPConnectionRemotePort };
Default Value
0
Remarks
The SFTPConnectionRemotePort shows the 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 SFTPConnectionCount property.
This property is read-only and not available at design time.
Data Type
Integer
SFTPConnectionTimeout Property (SFTPServer Component)
A timeout for the component.
Syntax
__property int SFTPConnectionTimeout[int ConnectionId] = { read=FSFTPConnectionTimeout, write=FSetSFTPConnectionTimeout };
Default Value
0
Remarks
A timeout for the component.
If the Timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data can't be sent or received immediately.
If Timeout is set to a positive value, the component will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.
The component 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 component raises an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 0 (asynchronous operation).
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.
This property is not available at design time.
Data Type
Integer
DefaultAuthMethods Property (SFTPServer Component)
Specifies the supported authentication methods.
Syntax
__property String DefaultAuthMethods = { read=FDefaultAuthMethods, write=FSetDefaultAuthMethods };
Default Value
"password,publickey"
Remarks
This property specifies the supported authentication methods. The client will choose one of the supported mechanisms when authenticating to the component.
This must be a comma separated list of values. For more information on authenticating clients see the SSHUserAuthRequest event.
The following is a list of methods implemented by the component:
none | This authentication method is used by most SSH clients to obtain the list of authentication methods available for the user's account. In most cases you should not accept a request using this authentication method. |
password | AuthParam will contain the user-supplied password. If the password is correct, set Accept to true. |
publickey | AuthParam will contain an SSH2 public key blob. If the user's public key is acceptable, set Accept or PartialSuccess to true. The component will then handle verifying the digital signature and will respond to the client accordingly. |
keyboard-interactive | SSHUserAuthRequest will fire multiple times for keyboard-interactive authentication: It will fire once for each response sent by the client in the SSH_MSG_USERAUTH_INFO_RESPONSE packet (one for each prompt specified by the daemon). The index of each response will be specified as a suffix in AuthMethod, with AuthParam containing the response to the corresponding prompt (e.g keyboard-interactive-1, keyboard-interactive-2 and so on). Finally, SSHUserAuthRequest will fire one last time with AuthMethod set to "keyboard-interactive" and AuthParam set to an empty string. The daemon must set Accept to true every time to allow the authentication process to succeed. |
Data Type
String
DefaultTimeout Property (SFTPServer Component)
An initial timeout value to be used by incoming connections.
Syntax
__property int DefaultTimeout = { read=FDefaultTimeout, write=FSetDefaultTimeout };
Default Value
60
Remarks
This property is used by the component to set the operational timeout value of all inbound connections once they are established. If the timeout is set to 0, all inbound connections will behave asynchronously. The default value is 60, meaning the component will behave synchronously.
Data Type
Integer
KeyboardInteractiveMessage Property (SFTPServer Component)
The instructions to send to the client during keyboard-interactive authentication.
Syntax
__property String KeyboardInteractiveMessage = { read=FKeyboardInteractiveMessage, write=FSetKeyboardInteractiveMessage };
Default Value
""
Remarks
This property should be set to the main instructions to send to the client during keyboard-interactive authentication.
Data Type
String
KeyboardInteractivePromptCount Property (SFTPServer Component)
The number of records in the KeyboardInteractivePrompt arrays.
Syntax
__property int KeyboardInteractivePromptCount = { read=FKeyboardInteractivePromptCount, write=FSetKeyboardInteractivePromptCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KeyboardInteractivePromptCount - 1.This property is not available at design time.
Data Type
Integer
KeyboardInteractivePromptEcho Property (SFTPServer Component)
Specifies if the client should echo the value entered by the user or not.
Syntax
__property bool KeyboardInteractivePromptEcho[int PromptIndex] = { read=FKeyboardInteractivePromptEcho, write=FSetKeyboardInteractivePromptEcho };
Default Value
false
Remarks
Specifies if the client should echo the value entered by the user or not.
The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.
This property is not available at design time.
Data Type
Boolean
KeyboardInteractivePromptPrompt Property (SFTPServer Component)
The prompt label/text the client should present to the user.
Syntax
__property String KeyboardInteractivePromptPrompt[int PromptIndex] = { read=FKeyboardInteractivePromptPrompt, write=FSetKeyboardInteractivePromptPrompt };
Default Value
""
Remarks
The prompt label/text the client should present to the user.
The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.
This property is not available at design time.
Data Type
String
Listening Property (SFTPServer Component)
This property indicates whether the component is listening for incoming connections on LocalPort.
Syntax
__property bool Listening = { read=FListening };
Default Value
False
Remarks
This property indicates whether the component is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the component is listening.
This property is read-only and not available at design time.
Data Type
Boolean
LocalHost Property (SFTPServer Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };
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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) 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 component 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.
Data Type
String
LocalPort Property (SFTPServer Component)
The TCP port in the local host where the component listens.
Syntax
__property int LocalPort = { read=FLocalPort, write=FSetLocalPort };
Default Value
22
Remarks
The LocalPort property must be set before TCPServer 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 the LocalPort property after TCPServer 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 TCPServer 'listening' on a particular port at one time).
Data Type
Integer
RootDirectory Property (SFTPServer Component)
The root directory for the entire SFTP server.
Syntax
__property String RootDirectory = { read=FRootDirectory, write=FSetRootDirectory };
Default Value
""
Remarks
RootDirectory specifies the root of the SFTP server ('/'). If a value is provided, the component will handle all requests by doing all file operations itself, but the events will still give you the opportunity to override the default values/operations as necessary.
If a value is not provided, all events must be handled appropriately to ensure correct operation.
Data Type
String
SSHCertEffectiveDate Property (SFTPServer Component)
This is the date on which this certificate becomes valid.
Syntax
__property String SSHCertEffectiveDate = { read=FSSHCertEffectiveDate };
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSHCertExpirationDate Property (SFTPServer Component)
This is the date the certificate expires.
Syntax
__property String SSHCertExpirationDate = { read=FSSHCertExpirationDate };
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSHCertExtendedKeyUsage Property (SFTPServer Component)
This is a comma-delimited list of extended key usage identifiers.
Syntax
__property String SSHCertExtendedKeyUsage = { read=FSSHCertExtendedKeyUsage };
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSHCertFingerprint Property (SFTPServer Component)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSHCertFingerprint = { read=FSSHCertFingerprint };
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSHCertFingerprintSHA1 Property (SFTPServer Component)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSHCertFingerprintSHA1 = { read=FSSHCertFingerprintSHA1 };
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSHCertFingerprintSHA256 Property (SFTPServer Component)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSHCertFingerprintSHA256 = { read=FSSHCertFingerprintSHA256 };
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSHCertIssuer Property (SFTPServer Component)
This is the issuer of the certificate.
Syntax
__property String SSHCertIssuer = { read=FSSHCertIssuer };
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSHCertPrivateKey Property (SFTPServer Component)
This is the private key of the certificate (if available).
Syntax
__property String SSHCertPrivateKey = { read=FSSHCertPrivateKey };
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSHCertPrivateKey may be available but not exportable. In this case, SSHCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSHCertPrivateKeyAvailable Property (SFTPServer Component)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSHCertPrivateKeyAvailable = { read=FSSHCertPrivateKeyAvailable };
Default Value
false
Remarks
This property shows whether a SSHCertPrivateKey is available for the selected certificate. If SSHCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSHCertPrivateKeyContainer Property (SFTPServer Component)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSHCertPrivateKeyContainer = { read=FSSHCertPrivateKeyContainer };
Default Value
""
Remarks
This is the name of the SSHCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSHCertPublicKey Property (SFTPServer Component)
This is the public key of the certificate.
Syntax
__property String SSHCertPublicKey = { read=FSSHCertPublicKey };
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSHCertPublicKeyAlgorithm Property (SFTPServer Component)
This property contains the textual description of the certificate's public key algorithm.
Syntax
__property String SSHCertPublicKeyAlgorithm = { read=FSSHCertPublicKeyAlgorithm };
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSHCertPublicKeyLength Property (SFTPServer Component)
This is the length of the certificate's public key (in bits).
Syntax
__property int SSHCertPublicKeyLength = { read=FSSHCertPublicKeyLength };
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSHCertSerialNumber Property (SFTPServer Component)
This is the serial number of the certificate encoded as a string.
Syntax
__property String SSHCertSerialNumber = { read=FSSHCertSerialNumber };
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSHCertSignatureAlgorithm Property (SFTPServer Component)
The property contains the text description of the certificate's signature algorithm.
Syntax
__property String SSHCertSignatureAlgorithm = { read=FSSHCertSignatureAlgorithm };
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSHCertStore Property (SFTPServer Component)
This is the name of the certificate store for the client certificate.
Syntax
__property String SSHCertStore = { read=FSSHCertStore, write=FSetSSHCertStore }; __property DynamicArray<Byte> SSHCertStoreB = { read=FSSHCertStoreB, write=FSetSSHCertStoreB };
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password protected, specify the password in SSHCertStorePassword.
SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject 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 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).
Data Type
Byte Array
SSHCertStorePassword Property (SFTPServer Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSHCertStorePassword = { read=FSSHCertStorePassword, write=FSetSSHCertStorePassword };
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
SSHCertStoreType Property (SFTPServer Component)
This is the type of certificate store for this certificate.
Syntax
__property TiphSFTPServerSSHCertStoreTypes SSHCertStoreType = { read=FSSHCertStoreType, write=FSetSSHCertStoreType };
enum TiphSFTPServerSSHCertStoreTypes { 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
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSHCertStore and set SSHCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSHCertSubjectAltNames Property (SFTPServer Component)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSHCertSubjectAltNames = { read=FSSHCertSubjectAltNames };
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSHCertThumbprintMD5 Property (SFTPServer Component)
This property contains the MD5 hash of the certificate.
Syntax
__property String SSHCertThumbprintMD5 = { read=FSSHCertThumbprintMD5 };
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHCertThumbprintSHA1 Property (SFTPServer Component)
This property contains the SHA-1 hash of the certificate.
Syntax
__property String SSHCertThumbprintSHA1 = { read=FSSHCertThumbprintSHA1 };
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHCertThumbprintSHA256 Property (SFTPServer Component)
This property contains the SHA-256 hash of the certificate.
Syntax
__property String SSHCertThumbprintSHA256 = { read=FSSHCertThumbprintSHA256 };
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSHCertUsage Property (SFTPServer Component)
This property contains the text description of UsageFlags .
Syntax
__property String SSHCertUsage = { read=FSSHCertUsage };
Default Value
""
Remarks
This property contains the text description of SSHCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSHCertUsageFlags Property (SFTPServer Component)
This property contains the flags that show intended use for the certificate.
Syntax
__property int SSHCertUsageFlags = { read=FSSHCertUsageFlags };
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSHCertUsageFlags 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 SSHCertUsage property for a text representation of SSHCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSHCertVersion Property (SFTPServer Component)
This property contains the certificate's version number.
Syntax
__property String SSHCertVersion = { read=FSSHCertVersion };
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSHCertSubject Property (SFTPServer Component)
This is the subject of the certificate used for client authentication.
Syntax
__property String SSHCertSubject = { read=FSSHCertSubject, write=FSetSSHCertSubject };
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:
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.
Data Type
String
SSHCertEncoded Property (SFTPServer Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSHCertEncoded = { read=FSSHCertEncoded, write=FSetSSHCertEncoded }; __property DynamicArray<Byte> SSHCertEncodedB = { read=FSSHCertEncodedB, write=FSetSSHCertEncodedB };
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHCertStore and SSHCertSubject properties also may be used to specify a certificate.
When SSHCertEncoded is set, a search is initiated in the current SSHCertStore for the private key of the certificate. If the key is found, SSHCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSHCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Byte Array
SSHCompressionAlgorithms Property (SFTPServer Component)
A comma-separated list containing all allowable compression algorithms.
Syntax
__property String SSHCompressionAlgorithms = { read=FSSHCompressionAlgorithms, write=FSetSSHCompressionAlgorithms };
Default Value
"none,zlib"
Remarks
During the SSH handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the component will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following compression algorithms are supported by the component:
- zlib
- zlib@openssh.com
- none
Data Type
String
SSHEncryptionAlgorithms Property (SFTPServer Component)
A comma-separated list containing all allowable encryption algorithms.
Syntax
__property String SSHEncryptionAlgorithms = { read=FSSHEncryptionAlgorithms, write=FSetSSHEncryptionAlgorithms };
Default Value
"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"
Remarks
During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the component will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the component:
aes256-ctr | 256-bit AES encryption in CTR mode |
aes256-cbc | 256-bit AES encryption in CBC mode |
aes192-ctr | 192-bit AES encryption in CTR mode |
aes192-cbc | 192-bit AES encryption in CBC mode |
aes128-ctr | 128-bit AES encryption in CTR mode |
aes128-cbc | 128-bit AES encryption in CBC mode |
3des-ctr | 192-bit (3-key) triple DES encryption in CTR mode |
3des-cbc | 192-bit (3-key) triple DES encryption in CBC mode |
cast128-cbc | CAST-128 encryption |
blowfish-cbc | Blowfish encryption |
arcfour | ARC4 encryption |
arcfour128 | 128-bit ARC4 encryption |
arcfour256 | 256-bit ARC4 encryption |
aes256-gcm@openssh.com | 256-bit AES encryption in GCM mode. |
aes128-gcm@openssh.com | 128-bit AES encryption in GCM mode. |
chacha20-poly1305@openssh.com | ChaCha20 with Poly1305-AES encryption. |
Data Type
String
Config Method (SFTPServer Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (SFTPServer Component)
This method disconnects the specified client.
Syntax
void __fastcall Disconnect(int ConnectionId);
Remarks
Calling this method will disconnect the client specified by the ConnectionId parameter.
DoEvents Method (SFTPServer Component)
This method processes events from the internal message queue.
Syntax
void __fastcall DoEvents();
Remarks
When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.
ExchangeKeys Method (SFTPServer Component)
Causes the component to exchange a new set of session keys on the specified connection.
Syntax
void __fastcall ExchangeKeys(int ConnectionId);
Remarks
SSH key renegotiation can be initiated by either end of an established SSH connection. ExchangeKeys allows the server to start such a renegotiation with the client. During this process, SSHStatus events will fire containing updates regarding the key negotiation process.
The SSH 2.0 specification recommends that key renegotiation be done once for 2 gigabytes (GB) of data processed by the connection, or once every day. This makes it more difficult to break the security of data-intensive or long-lived connections.
Reset Method (SFTPServer Component)
This method will reset the component.
Syntax
void __fastcall Reset();
Remarks
This method will reset the component's properties to their default values.
SetFileList Method (SFTPServer Component)
Sets the file list for a connection during a directory listing request.
Syntax
void __fastcall SetFileList(int ConnectionId, String List);
Remarks
SetFileList should be set when a directory listing is requested by the client. The list parameter should be a string of all the filenames to include, separated by CRLF.
Shutdown Method (SFTPServer Component)
This method shuts down the server.
Syntax
void __fastcall 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 (SFTPServer Component)
This method starts listening for incoming connections.
Syntax
void __fastcall 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 (SFTPServer Component)
This method stops listening for new connections.
Syntax
void __fastcall 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.
Connected Event (SFTPServer Component)
This event is fired immediately after a connection completes (or fails).
Syntax
typedef struct { int ConnectionId; int StatusCode; String Description; int CertStoreType; String CertStore; String CertPassword; String CertSubject; } TiphSFTPServerConnectedEventParams; typedef void __fastcall (__closure *TiphSFTPServerConnectedEvent)(System::TObject* Sender, TiphSFTPServerConnectedEventParams *e); __property TiphSFTPServerConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };
Remarks
If the connection is made normally, StatusCode is 0, and Description is "OK".
If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.
Please refer to the Error Codes section for more information.
ConnectionId is the connection Id of the client requesting the connection.
CertStoreType is the store type of the alternate certificate to use for this connection. The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
CertStore is the store name or location of the alternate certificate to use for this connection.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is 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:
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.
ConnectionRequest Event (SFTPServer Component)
This event is fired when a request for connection comes from a remote host.
Syntax
typedef struct { String Address; int Port; bool Accept; } TiphSFTPServerConnectionRequestEventParams; typedef void __fastcall (__closure *TiphSFTPServerConnectionRequestEvent)(System::TObject* Sender, TiphSFTPServerConnectionRequestEventParams *e); __property TiphSFTPServerConnectionRequestEvent OnConnectionRequest = { read=FOnConnectionRequest, write=FOnConnectionRequest };
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.
DirCreate Event (SFTPServer Component)
Fires when a client wants to create a new directory.
Syntax
typedef struct { int ConnectionId; String User; String Path; int FileType; __int64 FileSize; String FileOwner; String FileGroup; int FilePermissions; __int64 FileATime; __int64 FileCreateTime; __int64 FileMTime; int FileAttribBits; int FileAttribBitsValid; String OtherAttributes; bool BeforeExec; int StatusCode; } TiphSFTPServerDirCreateEventParams; typedef void __fastcall (__closure *TiphSFTPServerDirCreateEvent)(System::TObject* Sender, TiphSFTPServerDirCreateEventParams *e); __property TiphSFTPServerDirCreateEvent OnDirCreate = { read=FOnDirCreate, write=FOnDirCreate };
Remarks
The Path parameter specifies the path and name of the new directory.
This event is fired both before and after the directory is created. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.
File/Directory Attributes are specified using the following values:
FileType: The type of file. Can be one of the following values:
- SSH_FILEXFER_TYPE_REGULAR (1)
- SSH_FILEXFER_TYPE_DIRECTORY (2)
- SSH_FILEXFER_TYPE_SYMLINK (3)
- SSH_FILEXFER_TYPE_SPECIAL (4)
- SSH_FILEXFER_TYPE_UNKNOWN (5)
- SSH_FILEXFER_TYPE_SOCKET (6)
- SSH_FILEXFER_TYPE_CHAR_DEVICE (7)
- SSH_FILEXFER_TYPE_BLOCK_DEVICE (8)
- SSH_FILEXFER_TYPE_FIFO (9)
FileSize: The file size, in bytes.
FileOwner: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4-V6 of the SFTP Protocol allow an arbitrary string.
FileGroup: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4-V6 of the SFTP Protocol allow an arbitrary string.
FilePermissions: The POSIX-style file permissions.
FileATime: The file last-access time, in milliseconds since Jan 1, 1970 in UTC.
FileCreateTime: The file creation time, in milliseconds since Jan 1, 1970 in UTC.
FileMTime: The file last-modified time, in milliseconds since Jan 1, 1970 in UTC.
FileAttrBits: The file attributes, as a combination of the following values:
- SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001)
- SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002)
- SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004)
- SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008)
- SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010)
- SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020)
- SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040)
- SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080)
- SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100)
- SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200)
- SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400)
- SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800)
FileAttrBitsValid: A mask specifying which bits in FileAttrBits are supported by the server.
OtherAttributes: A semi-colon (';') delimited list of Name=Value pairs of other attributes supported by SFTP. These include:
- MIMEType (String)
- AllocationSize (64-bit int)
- ATimeNS (int): ATime nanoseconds
- CreateTimeNS (int): CreateTime nanoseconds
- MTimeNS (int): MTime nanoseconds
- TextHint (8-bit int)
- LinkCount (int)
- UntranslatedName (String)
FileMimeType: The MIME type of the file.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
DirList Event (SFTPServer Component)
Fires when a client attempts to open a directory for listing.
Syntax
typedef struct { int ConnectionId; String User; String Path; bool BeforeExec; int StatusCode; } TiphSFTPServerDirListEventParams; typedef void __fastcall (__closure *TiphSFTPServerDirListEvent)(System::TObject* Sender, TiphSFTPServerDirListEventParams *e); __property TiphSFTPServerDirListEvent OnDirList = { read=FOnDirList, write=FOnDirList };
Remarks
The DirList event fires when an SFTP client sends an SSH_FXP_OPENDIR request. The Path parameter will contain the path of the directory to list.
When necessary, you should call SetFileList with the list of files and directories in Path.
This event is fired both before and after the directory is listed. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
DirRemove Event (SFTPServer Component)
Fires when a client wants to delete a directory.
Syntax
typedef struct { int ConnectionId; String User; String Path; bool BeforeExec; int StatusCode; } TiphSFTPServerDirRemoveEventParams; typedef void __fastcall (__closure *TiphSFTPServerDirRemoveEvent)(System::TObject* Sender, TiphSFTPServerDirRemoveEventParams *e); __property TiphSFTPServerDirRemoveEvent OnDirRemove = { read=FOnDirRemove, write=FOnDirRemove };
Remarks
The Path parameter will specify the directory to delete.
This event is fired both before and after the directory is deleted. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
Disconnected Event (SFTPServer Component)
This event is fired when a connection is closed.
Syntax
typedef struct { int ConnectionId; int StatusCode; String Description; } TiphSFTPServerDisconnectedEventParams; typedef void __fastcall (__closure *TiphSFTPServerDisconnectedEvent)(System::TObject* Sender, TiphSFTPServerDisconnectedEventParams *e); __property TiphSFTPServerDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };
Remarks
If the connection is broken normally, StatusCode is 0, and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.
Please refer to the Error Codes section for more information.
Error Event (SFTPServer Component)
Information about errors during data delivery.
Syntax
typedef struct { int ConnectionId; int ErrorCode; String Description; } TiphSFTPServerErrorEventParams; typedef void __fastcall (__closure *TiphSFTPServerErrorEvent)(System::TObject* Sender, TiphSFTPServerErrorEventParams *e); __property TiphSFTPServerErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
ConnectionId 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.
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.
FileClose Event (SFTPServer Component)
Fires when a client attempts to close an open file or directory handle.
Syntax
typedef struct { int ConnectionId; String User; String Path; String Handle; int StatusCode; } TiphSFTPServerFileCloseEventParams; typedef void __fastcall (__closure *TiphSFTPServerFileCloseEvent)(System::TObject* Sender, TiphSFTPServerFileCloseEventParams *e); __property TiphSFTPServerFileCloseEvent OnFileClose = { read=FOnFileClose, write=FOnFileClose };
Remarks
The FileClose event fires when an SFTP client sends an SSH_FXP_CLOSE request. The Path parameter will contain the path of the file to close.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
FileOpen Event (SFTPServer Component)
Fires when a client wants to open or create a file.
Syntax
typedef struct { int ConnectionId; String User; String Path; int DesiredAccess; int Flags; int FileType; __int64 FileSize; String FileOwner; String FileGroup; int FilePermissions; __int64 FileATime; __int64 FileCreateTime; __int64 FileMTime; int FileAttribBits; int FileAttribBitsValid; String OtherAttributes; String Handle; bool BeforeExec; int StatusCode; } TiphSFTPServerFileOpenEventParams; typedef void __fastcall (__closure *TiphSFTPServerFileOpenEvent)(System::TObject* Sender, TiphSFTPServerFileOpenEventParams *e); __property TiphSFTPServerFileOpenEvent OnFileOpen = { read=FOnFileOpen, write=FOnFileOpen };
Remarks
The Path parameter specifies the path and name of the file to open, create. If the operation can be completed successfully, the Handle parameter should be set to the handle identifying the opened file. Please note that the Handle parameter is limited to a 256 byte string. By default, the component will provide an incremental numeric string value for the Handle.
This event is fired both before and after the file is opened. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.
The Flags parameter specifies file creation and locking options as a bitmask. This may be a combination of the following values:
- SSH_FXF_READ (0x00000001)
- SSH_FXF_WRITE (0x00000002)
- SSH_FXF_APPEND (0x00000004)
- SSH_FXF_CREAT (0x00000008)
- SSH_FXF_TRUNC (0x00000010)
- SSH_FXF_EXCL (0x00000020)
The DesiredAccess parameter is a bitmask containing a combination of values from the ace-mask flags (Only for protocol versions 4 and up). This may be a combination of the following values:
- ACE4_READ_DATA (0x00000001)
- ACE4_LIST_DIRECTORY (0x00000001)
- ACE4_WRITE_DATA (0x00000002)
- ACE4_ADD_FILE (0x00000002)
- ACE4_APPEND_DATA (0x00000004)
- ACE4_ADD_SUBDIRECTORY (0x00000004)
- ACE4_READ_NAMED_ATTRS (0x00000008)
- ACE4_WRITE_NAMED_ATTRS (0x00000010)
- ACE4_EXECUTE (0x00000020)
- ACE4_DELETE_CHILD (0x00000040)
- ACE4_READ_ATTRIBUTES (0x00000080)
- ACE4_WRITE_ATTRIBUTES (0x00000100)
- ACE4_DELETE (0x00010000)
- ACE4_READ_ACL (0x00020000)
- ACE4_WRITE_ACL (0x00040000)
- ACE4_WRITE_OWNER (0x00080000)
- ACE4_SYNCHRONIZE (0x00100000)
File/Directory Attributes are specified using the following values:
FileType: The type of file. Can be one of the following values:
- SSH_FILEXFER_TYPE_REGULAR (1)
- SSH_FILEXFER_TYPE_DIRECTORY (2)
- SSH_FILEXFER_TYPE_SYMLINK (3)
- SSH_FILEXFER_TYPE_SPECIAL (4)
- SSH_FILEXFER_TYPE_UNKNOWN (5)
- SSH_FILEXFER_TYPE_SOCKET (6)
- SSH_FILEXFER_TYPE_CHAR_DEVICE (7)
- SSH_FILEXFER_TYPE_BLOCK_DEVICE (8)
- SSH_FILEXFER_TYPE_FIFO (9)
FileSize: The file size, in bytes.
FileOwner: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4-V6 of the SFTP Protocol allow an arbitrary string.
FileGroup: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4-V6 of the SFTP Protocol allow an arbitrary string.
FilePermissions: The POSIX-style file permissions.
FileATime: The file last-access time, in milliseconds since Jan 1, 1970 in UTC.
FileCreateTime: The file creation time, in milliseconds since Jan 1, 1970 in UTC.
FileMTime: The file last-modified time, in milliseconds since Jan 1, 1970 in UTC.
FileAttrBits: The file attributes, as a combination of the following values:
- SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001)
- SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002)
- SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004)
- SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008)
- SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010)
- SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020)
- SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040)
- SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080)
- SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100)
- SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200)
- SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400)
- SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800)
FileAttrBitsValid: A mask specifying which bits in FileAttrBits are supported by the server.
OtherAttributes: A semi-colon (';') delimited list of Name=Value pairs of other attributes supported by SFTP. These include:
- MIMEType (String)
- AllocationSize (64-bit int)
- ATimeNS (int): ATime nanoseconds
- CreateTimeNS (int): CreateTime nanoseconds
- MTimeNS (int): MTime nanoseconds
- TextHint (8-bit int)
- LinkCount (int)
- UntranslatedName (String)
FileMimeType: The MIME type of the file.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
FileRead Event (SFTPServer Component)
Fires when a client wants to read from an open file.
Syntax
typedef struct { int ConnectionId; String User; String Handle; __int64 FileOffset; int Length; int StatusCode; } TiphSFTPServerFileReadEventParams; typedef void __fastcall (__closure *TiphSFTPServerFileReadEvent)(System::TObject* Sender, TiphSFTPServerFileReadEventParams *e); __property TiphSFTPServerFileReadEvent OnFileRead = { read=FOnFileRead, write=FOnFileRead };
Remarks
The Handle parameter identifies an open file on the server. FileOffset specifies the position from which to read data. Length specifies how much data to read. The data read should be set to through SFTPConnectionFileData
When processing a read request, the server should attempt to read at most Length bytes, but it is OK to read less than Length bytes as well, if no more data is available.
When there is no more data to be read from the file, set StatusCode to SSH_FXS_EOF.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
FileRemove Event (SFTPServer Component)
Fires when a client wants to delete a file.
Syntax
typedef struct { int ConnectionId; String User; String Path; bool BeforeExec; int StatusCode; } TiphSFTPServerFileRemoveEventParams; typedef void __fastcall (__closure *TiphSFTPServerFileRemoveEvent)(System::TObject* Sender, TiphSFTPServerFileRemoveEventParams *e); __property TiphSFTPServerFileRemoveEvent OnFileRemove = { read=FOnFileRemove, write=FOnFileRemove };
Remarks
The Path parameter will specify the file to delete.
This event is fired both before and after the file is removed. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
FileRename Event (SFTPServer Component)
Fires when a client wants to rename a file.
Syntax
typedef struct { int ConnectionId; String User; String Path; String NewPath; int Flags; bool BeforeExec; int StatusCode; } TiphSFTPServerFileRenameEventParams; typedef void __fastcall (__closure *TiphSFTPServerFileRenameEvent)(System::TObject* Sender, TiphSFTPServerFileRenameEventParams *e); __property TiphSFTPServerFileRenameEvent OnFileRename = { read=FOnFileRename, write=FOnFileRename };
Remarks
The Path parameter will specify the file to rename and NewPath will specify the new name. The Flags parameter will be a bit mask of the values SSH_FXF_RENAME_OVERWRITE (0x00000001), SSH_FXF_RENAME_ATOMIC (0x00000002) and SSH_FXF_RENAME_NATIVE (0x00000004)
This event is fired both before and after the file is renamed. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
FileWrite Event (SFTPServer Component)
Fires when a client wants to write to an open file.
Syntax
typedef struct { int ConnectionId; String User; String Handle; __int64 FileOffset; bool BeforeExec; int StatusCode; } TiphSFTPServerFileWriteEventParams; typedef void __fastcall (__closure *TiphSFTPServerFileWriteEvent)(System::TObject* Sender, TiphSFTPServerFileWriteEventParams *e); __property TiphSFTPServerFileWriteEvent OnFileWrite = { read=FOnFileWrite, write=FOnFileWrite };
Remarks
The Handle parameter identifies an open file on the server. FileOffset specifies the position at which to write data. The data to write can be retrieved through SFTPConnectionFileData
This event is fired both before and after the file is written. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
GetAttributes Event (SFTPServer Component)
Fires when a client needs to get file information.
Syntax
typedef struct { int ConnectionId; String User; String Path; int Flags; int FileType; __int64 FileSize; String FileOwner; String FileGroup; int FilePermissions; __int64 FileATime; __int64 FileCreateTime; __int64 FileMTime; int FileAttribBits; int FileAttribBitsValid; String OtherAttributes; int StatusCode; } TiphSFTPServerGetAttributesEventParams; typedef void __fastcall (__closure *TiphSFTPServerGetAttributesEvent)(System::TObject* Sender, TiphSFTPServerGetAttributesEventParams *e); __property TiphSFTPServerGetAttributesEvent OnGetAttributes = { read=FOnGetAttributes, write=FOnGetAttributes };
Remarks
The GetAttributes event fires when an SFTP client sends an SSH_FXP_STAT, SSH_FXP_LSTAT or SSH_FXP_FSTAT request. Path is the file path. Flags specifies the set of file attributes the client is interested in.
File/Directory Attributes are specified using the following values:
FileType: The type of file. Can be one of the following values:
- SSH_FILEXFER_TYPE_REGULAR (1)
- SSH_FILEXFER_TYPE_DIRECTORY (2)
- SSH_FILEXFER_TYPE_SYMLINK (3)
- SSH_FILEXFER_TYPE_SPECIAL (4)
- SSH_FILEXFER_TYPE_UNKNOWN (5)
- SSH_FILEXFER_TYPE_SOCKET (6)
- SSH_FILEXFER_TYPE_CHAR_DEVICE (7)
- SSH_FILEXFER_TYPE_BLOCK_DEVICE (8)
- SSH_FILEXFER_TYPE_FIFO (9)
FileSize: The file size, in bytes.
FileOwner: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4-V6 of the SFTP Protocol allow an arbitrary string.
FileGroup: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4-V6 of the SFTP Protocol allow an arbitrary string.
FilePermissions: The POSIX-style file permissions.
FileATime: The file last-access time, in milliseconds since Jan 1, 1970 in UTC.
FileCreateTime: The file creation time, in milliseconds since Jan 1, 1970 in UTC.
FileMTime: The file last-modified time, in milliseconds since Jan 1, 1970 in UTC.
FileAttrBits: The file attributes, as a combination of the following values:
- SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001)
- SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002)
- SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004)
- SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008)
- SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010)
- SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020)
- SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040)
- SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080)
- SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100)
- SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200)
- SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400)
- SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800)
FileAttrBitsValid: A mask specifying which bits in FileAttrBits are supported by the server.
OtherAttributes: A semi-colon (';') delimited list of Name=Value pairs of other attributes supported by SFTP. These include:
- MIMEType (String)
- AllocationSize (64-bit int)
- ATimeNS (int): ATime nanoseconds
- CreateTimeNS (int): CreateTime nanoseconds
- MTimeNS (int): MTime nanoseconds
- TextHint (8-bit int)
- LinkCount (int)
- UntranslatedName (String)
FileMimeType: The MIME type of the file.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
Log Event (SFTPServer Component)
Fires once for each log message.
Syntax
typedef struct { int ConnectionId; int LogLevel; String Message; String LogType; } TiphSFTPServerLogEventParams; typedef void __fastcall (__closure *TiphSFTPServerLogEvent)(System::TObject* Sender, TiphSFTPServerLogEventParams *e); __property TiphSFTPServerLogEvent OnLog = { read=FOnLog, write=FOnLog };
Remarks
This event fires once for each log messages generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the detail level of the message. Possible values are:
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as SSH handshake messages are logged. |
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 message.
LogType is reserved for future use.
ConnectionId identifies the connection to which the log message applies.
ResolvePath Event (SFTPServer Component)
Fires when a client attempts to canonicalize a path.
Syntax
typedef struct { int ConnectionId; String User; String OriginalPath; int ControlFlags; String RealPath; int StatusCode; } TiphSFTPServerResolvePathEventParams; typedef void __fastcall (__closure *TiphSFTPServerResolvePathEvent)(System::TObject* Sender, TiphSFTPServerResolvePathEventParams *e); __property TiphSFTPServerResolvePathEvent OnResolvePath = { read=FOnResolvePath, write=FOnResolvePath };
Remarks
The ResolvePath event fires when an SFTP client sends an SSH_FXP_REALPATH request. The OriginalPath parameter will contain the path the client wants to canonicalize. ControlFlags can have one of the following values:
SSH_FXP_REALPATH_NO_CHECK (0x00000001) | Server should not check if the path exists. |
SSH_FXP_REALPATH_STAT_IF (0x00000002) | Server should return the file/directory attributes if the path exists and is accessible, but should not fail otherwise. |
SSH_FXP_REALPATH_STAT_ALWAYS (0x00000003) | Server should return the file/directory attributes if the path exists and is accessible, otherwise fail with an error. |
RealPath should be set to the resulting canonicalized path, and StatusCode should be set to indicate success or failure of the operation to the client.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
SetAttributes Event (SFTPServer Component)
Fires when a client attempts to set file or directory attributes.
Syntax
typedef struct { int ConnectionId; String User; String Path; int FileType; __int64 FileSize; String FileOwner; String FileGroup; int FilePermissions; __int64 FileATime; __int64 FileCreateTime; __int64 FileMTime; int FileAttribBits; int FileAttribBitsValid; String OtherAttributes; bool BeforeExec; int StatusCode; } TiphSFTPServerSetAttributesEventParams; typedef void __fastcall (__closure *TiphSFTPServerSetAttributesEvent)(System::TObject* Sender, TiphSFTPServerSetAttributesEventParams *e); __property TiphSFTPServerSetAttributesEvent OnSetAttributes = { read=FOnSetAttributes, write=FOnSetAttributes };
Remarks
The SetAttributes event fires when an SFTP client sends an SSH_FXP_SETSTAT, SSH_FXP_FSETSTAT or SSH_FXP_FSTAT request. Path is the path of the file or directory the client wants to set attributes for.
This event is fired both before and after the attributes are set. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.
File/Directory Attributes are specified using the following values:
FileType: The type of file. Can be one of the following values:
- SSH_FILEXFER_TYPE_REGULAR (1)
- SSH_FILEXFER_TYPE_DIRECTORY (2)
- SSH_FILEXFER_TYPE_SYMLINK (3)
- SSH_FILEXFER_TYPE_SPECIAL (4)
- SSH_FILEXFER_TYPE_UNKNOWN (5)
- SSH_FILEXFER_TYPE_SOCKET (6)
- SSH_FILEXFER_TYPE_CHAR_DEVICE (7)
- SSH_FILEXFER_TYPE_BLOCK_DEVICE (8)
- SSH_FILEXFER_TYPE_FIFO (9)
FileSize: The file size, in bytes.
FileOwner: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4-V6 of the SFTP Protocol allow an arbitrary string.
FileGroup: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4-V6 of the SFTP Protocol allow an arbitrary string.
FilePermissions: The POSIX-style file permissions.
FileATime: The file last-access time, in milliseconds since Jan 1, 1970 in UTC.
FileCreateTime: The file creation time, in milliseconds since Jan 1, 1970 in UTC.
FileMTime: The file last-modified time, in milliseconds since Jan 1, 1970 in UTC.
FileAttrBits: The file attributes, as a combination of the following values:
- SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001)
- SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002)
- SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004)
- SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008)
- SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010)
- SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020)
- SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040)
- SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080)
- SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100)
- SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200)
- SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400)
- SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800)
FileAttrBitsValid: A mask specifying which bits in FileAttrBits are supported by the server.
OtherAttributes: A semi-colon (';') delimited list of Name=Value pairs of other attributes supported by SFTP. These include:
- MIMEType (String)
- AllocationSize (64-bit int)
- ATimeNS (int): ATime nanoseconds
- CreateTimeNS (int): CreateTime nanoseconds
- MTimeNS (int): MTime nanoseconds
- TextHint (8-bit int)
- LinkCount (int)
- UntranslatedName (String)
FileMimeType: The MIME type of the file.
Valid status codes are:
- SSH_FX_OK 0
- SSH_FX_EOF 1
- SSH_FX_NO_SUCH_FILE 2
- SSH_FX_PERMISSION_DENIED 3
- SSH_FX_FAILURE 4
- SSH_FX_BAD_MESSAGE 5
- SSH_FX_NO_CONNECTION 6
- SSH_FX_CONNECTION_LOST 7
- SSH_FX_OP_UNSUPPORTED 8
- SSH_FX_INVALID_HANDLE 9
- SSH_FX_NO_SUCH_PATH 10
- SSH_FX_FILE_ALREADY_EXISTS 11
- SSH_FX_WRITE_PROTECT 12
- SSH_FX_NO_MEDIA 13
- SSH_FX_NO_SPACE_ON_FILESYSTEM 14
- SSH_FX_QUOTA_EXCEEDED 15
- SSH_FX_UNKNOWN_PRINCIPAL 16
- SSH_FX_LOCK_CONFLICT 17
- SSH_FX_DIR_NOT_EMPTY 18
- SSH_FX_NOT_A_DIRECTORY 19
- SSH_FX_INVALID_FILENAME 20
- SSH_FX_LINK_LOOP 21
- SSH_FX_CANNOT_DELETE 22
- SSH_FX_INVALID_PARAMETER 23
- SSH_FX_FILE_IS_A_DIRECTORY 24
- SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
- SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
- SSH_FX_DELETE_PENDING 27
- SSH_FX_FILE_CORRUPT 28
- SSH_FX_OWNER_INVALID 29
- SSH_FX_GROUP_INVALID 30
- SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31
SSHStatus Event (SFTPServer Component)
Shows the progress of the secure connection.
Syntax
typedef struct { int ConnectionId; String Message; } TiphSFTPServerSSHStatusEventParams; typedef void __fastcall (__closure *TiphSFTPServerSSHStatusEvent)(System::TObject* Sender, TiphSFTPServerSSHStatusEventParams *e); __property TiphSFTPServerSSHStatusEvent OnSSHStatus = { read=FOnSSHStatus, write=FOnSSHStatus };
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
SSHUserAuthRequest Event (SFTPServer Component)
Fires when a client attempts to authenticate a connection.
Syntax
typedef struct { int ConnectionId; String User; String Service; String AuthMethod; String AuthParam; bool Accept; bool PartialSuccess; String AvailableMethods; String HomeDir; String KeyAlgorithm; } TiphSFTPServerSSHUserAuthRequestEventParams; typedef void __fastcall (__closure *TiphSFTPServerSSHUserAuthRequestEvent)(System::TObject* Sender, TiphSFTPServerSSHUserAuthRequestEventParams *e); __property TiphSFTPServerSSHUserAuthRequestEvent OnSSHUserAuthRequest = { read=FOnSSHUserAuthRequest, write=FOnSSHUserAuthRequest };
Remarks
The SSHUserAuthRequest event fires when an SSH client attempts to authenticate itself on a particular connection. ConnectionId will identify the connection being authenticated. User will be the name of the account requesting authentication, and Service will contain the name of the service the client is wishing to access.
AuthMethod will denote which method the client is attempting to use to authenticate itself. AuthParam will contain the value of the authentication token used by the client. If the token is acceptable, you may set Accept to true to allow the SFTPServer to authenticate the client. If it is not, set Accept to false.
Connecting clients will initially attempt authentication with an AuthMethod of "none". This is done with the expectation that the request will fail and the server will send a list of supported methods back to the client. In your implementation check the AuthMethod parameter, if it is "none" you should set AvailableMethods and reject the request. The client will select one of the available methods and re-authenticate.
You may set AvailableMethods to a comma-delimited string of authentication methods that are available for the user. This list will be sent back to the client so that it may perform further authentication attempts.
The following is a list of methods implemented by the component:
none | This authentication method is used by most SSH clients to obtain the list of authentication methods available for the user's account. In most cases you should not accept a request using this authentication method. |
password | AuthParam will contain the user-supplied password. If the password is correct, set Accept to true. |
publickey | AuthParam will contain an SSH2 public key blob. If the user's public key is acceptable, set Accept or PartialSuccess to true. The component will then handle verifying the digital signature and will respond to the client accordingly. |
keyboard-interactive | SSHUserAuthRequest will fire multiple times for keyboard-interactive authentication: It will fire once for each response sent by the client in the SSH_MSG_USERAUTH_INFO_RESPONSE packet (one for each prompt specified by the daemon). The index of each response will be specified as a suffix in AuthMethod, with AuthParam containing the response to the corresponding prompt (e.g keyboard-interactive-1, keyboard-interactive-2 and so on). Finally, SSHUserAuthRequest will fire one last time with AuthMethod set to "keyboard-interactive" and AuthParam set to an empty string. The daemon must set Accept to true every time to allow the authentication process to succeed. |
In the case the user authentication succeeds, you may set HomeDir to the virtual path representing the initial directory for the user. If not set, the initial directory will be RootDirectory.
The PartialSuccess parameter is only used when multi-factor authentication is needed. To implement multi-factor authentication when this event fires first verify the AuthParam for the given AuthMethod. If accepted, set PartialSuccess to true and Accept to false. The client should then send the authentication request for a different form of authentication specified in AvailableMethods. You may continue to set PartialSuccess to true until all authentication requirements are satisfied. Once all requirements are satisfied set Accept to true.
KeyAlgorithm hold the signing algorithm used when the client attempts public key authentication. Possible values are:
- ssh-rsa
- rsa-sha2-256
- rsa-sha2-512
- ssh-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
- x509v3-sign-rsa
- x509v3-sign-dss
Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.
Config Settings (SFTPServer Component)
The component 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 component, access to these internal properties is provided through the Config method.SFTPServer Config Settings
sftpserver.Config("RestrictUserToHomeDir[" + e.ConnectionId + "]=true");
Example
If the RootDirectory property of a certain SFTP server is set to /, then the directory structure of the server might look like this...
Root Directory: / bin boot etc home user1 testfolderWhen RestrictUserToHomeDir is set to True and the "HomeDir" parameter is set to /home/user1, User 1 will land in the home directory and see the following file system when it connects:
Home Directory: /home/user1 /testfolderThe client will only be able to perform operations against /home/user1 and its children but the client can see its working directory relative to the server root directory.
sftpserver.Config("UserRootDirectory[" + e.ConnectionId + "]=" + userRootDirectory );
Example
If the RootDirectory property of a certain SFTP server is set to /, then the directory structure of the server might look like this...
Root Directory: / bin boot etc home user1 testfolderWhen UserRootDirectory is set to /home/user1 and the HomeDir event parameter is set to /, when User 1 connects they will land in the home directory and see the following file system:
Home Directory: / /testfolderThe client will only be able to perform operations against / and its children and the client cannot see its working directory relative to the server root directory.
SSHServer Config Settings
The array indices start at 0 and end at AltSSHCertCount - 1.
The AltSSHCert configuration settings are used to specify alternative digital certificates to the one set using the SSHCert. The server will determine the certificate to use during SSH negotiation based on the public key algorithm requested by the connecting client. A certificate with a private key is required for session authentication and encryption. The AltSSHCertSubject setting must be set last. When AltSSHCertSubject is set a search is initiated in the AltSSHCertStore and the certificate is loaded.
These alternative server certificate specified by these settings must be configured prior to setting Listening to true. For example:
sftpserver.Config("AltSSHCertCount =1");
sftpserver.Config("AltSSHCertStoreType[0]=7"); //PEM Key Blob
sftpserver.Config("AltSSHCertStore[0]=" + ed25519Key); //PEM formatted string
sftpserver.Config("AltSSHCertSubject[0]=*"); //Load the first (and only) certificate
The AltSSHCertStoreType specifies the type of the certificate store specified by AltSSHCertStore. IF the store is password protected, specify the password in the AltSSHCertStorePassword.
AltSSHCertStore is used in conjunction with the AltSSHCertSubject 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 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).
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. |
sftpserver1.OnSSHUserAuthRequest += (obj, ev) =>
{
Console.WriteLine(sftpserver1.Config("ClientSSHVersionString[" + ev.ConnectionId + "]"));
};
If set to true, the SSHUserAuthRequest event will fire twice per public key authentication attempt. The first time the event fires for public key authentication as usual. After verification of the signature has taken place the SSHUserAuthRequest will fire again, and the AuthMethod parameter will contain the string sigstatus. The AuthParam parameter will contain a value of 0 (invalid signature) or 1 (valid signature). If the signature is invalid it will always result in a rejected authentication attempt.
This setting takes a list of prompts to display to the client, and each prompt includes an 'echo' parameter to specify whether or not to echo the client's response to the prompt. The prompt itself and the echo parameter should be separated by a comma (","), and each prompt should be separated by a semi-colon (";"). For example:
"KeyboardInteractivePrompts[connId]=First prompt,echo=false;Second prompt,echo=true"
This config can be set anywhere in code, but it is necessary to know the ConnectionId for the specific connection beforehand; as such, it is generally recommended to set this config inside the SSHUserAuthRequest event. Since connecting clients initially attempt to connect with and AuthMethod of 'none' (with the understanding that this attempt will fail, and the SSH server will advertise which authentication methods it supports), It is recommended to check the AuthMethod, User, and ConnectionId parameters of the SSHUserAuthRequest event and set this config accordingly.
When SSHServer displays keyboard-interactive prompts, it will first check to see if this config is populated for the current ConnectionId. If it is, the prompts set here will be used instead of those set in the KeyboardInteractivePrompts property. Otherwise, the KeyboardInteractivePrompts property will function as normal.
Example (for setting the threshold to 500 MB):
SSHComponent.Config("KeyRenegotiationThreshold=524288000")
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as SSH handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information is logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
component.Config("NegotiatedStrictKex[connId]")
The default value is 0 meaning no keep alives will be sent.
Note: The SSHReverseTunnel component uses a default value of 30.
- curve25519-sha256
- curve25519-sha256@libssh.org
- diffie-hellman-group1-sha1
- diffie-hellman-group14-sha1
- diffie-hellman-group14-sha256
- diffie-hellman-group16-sha512
- diffie-hellman-group18-sha512
- diffie-hellman-group-exchange-sha256
- diffie-hellman-group-exchange-sha1
- ecdh-sha2-nistp256
- ecdh-sha2-nistp384
- ecdh-sha2-nistp521
- gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
- gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
- gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==
- hmac-sha1
- hmac-md5
- hmac-sha1-96
- hmac-md5-96
- hmac-sha2-256
- hmac-sha2-256-96
- hmac-sha2-512
- hmac-sha2-512-96
- hmac-ripemd160
- hmac-ripemd160-96
- hmac-sha2-256-etm@openssh.com
- hmac-sha2-512-etm@openssh.com
- umac-64@openssh.com
- umac-64-etm@openssh.com
- umac-128@openssh.com
- umac-128-etm@openssh.com
The setting should be a comma separated list of algorithms. When a client connects the server will verify that the client performing public key authentication has used one of the specified signature algorithms. If the client uses a signature algorithm which is not in the list the connection will be rejected.
Possible values are:
- ssh-rsa
- rsa-sha2-256
- rsa-sha2-512
- ssh-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
- ssh-ed25519
- x509v3-sign-rsa
- x509v3-sign-dss
The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,x509v3-sign-rsa,ssh-dss,x509v3-sign-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.
*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the component provides options to further control the behavior in different scenarios. Possible values for this setting are:
0 | Disabled. Strict key exchange is not supported in the component. |
1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. |
2 | Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack. |
3 | Required. If the remote host does not support strict key exchange the connection will fail. |
TCPServer Config Settings
When a client connects, the client's address is checked against the list defined here. If there is no match, the ConnectionRequest event fires with an Accept value set to false. If no action is taken within the ConnectionRequest event, the client will be disconnected.
When a client connects, the client's address is checked against the list defined here. If there is a match, the ConnectionRequest event fires with an Accept value set to false. If no action is taken within the ConnectionRequest event, the client will not be connected.
Note: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated, the InBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.
InBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.
Note: This value is not applicable in macOS.
Note: Unix/Linux operating systems limit the number of simultaneous connections to 1024.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.
OutBufferSize is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.
By default, this configuration setting is set to False.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 and IPv4 |
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the component 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 (SFTPServer Component)
SFTPServer Errors
118 | Firewall error. Error description contains detailed information. |
2001 | The specified path is invalid. |
2002 | An I/O error occurred. |
2003 | The file attributes could not be set. |
The component may also return one of the following error codes, which are inherited from other components.
SSHServer Errors
1201 | Could not forward connection. A detailed message follows. |
1202 | Could not forward connection/channel data. A detailed message follows. |
1300 | Could not authenticate client. |
1301 | No server certificate was specified or no private key found. |
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 when TCPServer is listening. |
107 | Cannot change LocalHost when TCPServer is listening. |
108 | Cannot change MaxConnections when TCPServer is listening. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | 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). |