SFTPServer Module

Properties   Methods   Events   Config Settings   Errors  

The SFTPServer module is used to create a SFTP Server.

Syntax

IPWorksSFTP.Sftpserver

Remarks

The SFTPServer class provides a simple way to create a 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 private key in the SSHCert property.

Optionally set the RootDirectory property to a valid local path. If this property is set the class 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 class 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 re-authenticates. 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 and 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, etc), 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 in order 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 class's functionality. When a client attempts to connect, open a file, authenticate to the server, etc, 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 module with short descriptions. Click on the links for further details.

ConnectionBacklogThis property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.
ConnectionsA collection of currently connected SFTP clients.
DefaultAuthMethodsSpecifies the supported authentication methods.
DefaultTimeoutAn initial timeout value to be used by incoming connections.
KeyboardInteractiveMessageThe instructions to send to the client during keyboard-interactive authentication.
KeyboardInteractivePromptsA collection of prompts to present to the user for keyboard-interactive authentication.
ListeningIf set to True, the module accepts incoming connections on LocalPort.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the module listens.
RootDirectoryThe root directory for the entire SFTP server.
SSHCertEncodedThis is the certificate (PEM/base64 encoded).
SSHCertStoreThis is the name of the certificate store for the client certificate.
SSHCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSHCertStoreTypeThis is the type of certificate store for this certificate.
SSHCertSubjectThis is the subject of the certificate used for client authentication.
SSHCompressionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable encryption algorithms.

Method List


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

ConfigSets or retrieves a configuration setting.
DisconnectThis method disconnects the specified client.
DoEventsProcesses events from the internal message queue.
ExchangeKeysCauses the module to exchange a new set of session keys on the specified connection.
ResetReset the module.
SetFileListSets the file list for a connection during a directory listing request.
ShutdownThis method shuts down the server.
StartListeningThis method starts listening for incoming connections.
StopListeningThis method stops listening for new connections.

Event List


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

ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionRequestThis event is fired when a request for connection comes from a remote host.
DirCreateFires when a client wants to create a new directory.
DirListFires when a client attempts to open a directory for listing.
DirRemoveFires when a client wants to delete a directory.
DisconnectedThis event is fired when a connection is closed.
ErrorInformation about errors during data delivery.
FileCloseFires when a client attempts to close an open file or directory handle.
FileOpenFires when a client wants to open or create a file.
FileReadFires when a client wants to read from an open file.
FileRemoveFires when a client wants to delete a file.
FileRenameFires when a client wants to rename a file.
FileWriteFires when a client wants to write to an open file.
GetAttributesFires when a client needs to get file information.
LogFires once for each log message.
ResolvePathFires when a client attempts to canonicalize a path.
SetAttributesFires when a client attempts to set file or directory attributes.
SSHStatusShows the progress of the secure connection.
SSHUserAuthRequestFires when a client attempts to authenticate a connection.

Config Settings


The following is a list of config settings for the module 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.
MaskSensitiveMasks passwords in logs.
ProtocolVersionThe highest allowable SFTP version to use.
RestrictUserToHomeDir[ConnectionId]Whether to restrict the user to their home directory.
ServerEOLSpecifies the line endings used in files on the server.
SFTPErrorMessage[ConnectionId]Specifies the error message to be returned to the client.
UnixStyleDateFormatControls whether to use the Unix-style date format in directory listings.
UserRootDirectory[ConnectionId]The path of the server root directory for a particular user.
AltSSHCertCountThe 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.
FireAuthRequestAfterSigWhether to fire an informational event after the public key signature has been verified.
KeyboardInteractivePrompts[ConnectionId]Specifies custom keyboard-interactive prompts for particular connections.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
LogLevelSpecifies the level of detail that is logged.
MaxAuthAttemptsThe maximum authentication attempts allowed before forcing a disconnect.
NegotiatedStrictKex[ConnectionId]Returns whether strict key exchange was negotiated to be used.
ServerSSHVersionStringThe SSH version string sent to connecting clients.
SSHKeepAliveCountMaxThe maximum number of keep alive packets to send without a response.
SSHKeepAliveIntervalThe interval between keep alive packets.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
SSHPubKeyAuthSigAlgorithmsSpecifies the allowed signature algorithms used by a client performing public key authentication.
SSHPublicKeyAlgorithmsSpecifies the supported public key algorithms for the server's public key.
SSHVersionPatternThe pattern used to match the remote host's version string.
UserAuthBanner[ConnectionId]A custom user authentication banner.
UseStrictKeyExchangeSpecifies how strict key exchange is supported.
AllowedClientsA comma-separated list of host names or IP addresses that can access the module.
BindExclusivelyWhether or not the module considers a local port reserved for exclusive use.
BlockedClientsA comma-separated list of host names or IP addresses that cannot access the module.
DefaultConnectionTimeoutThe inactivity timeout applied to the SSL handshake.
InBufferSizeThe size in bytes of the incoming queue of the socket.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
MaxConnectionsThe maximum number of connections available.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the module whether or not to use the system security libraries or an internal implementation.

ConnectionBacklog Property (SFTPServer Module)

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

Syntax

public var connectionBacklog: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connectionBacklog,setter=setConnectionBacklog:) int connectionBacklog;

- (int)connectionBacklog;
- (void)setConnectionBacklog :(int)newConnectionBacklog;

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

Connections Property (SFTPServer Module)

A collection of currently connected SFTP clients.

Syntax

public var connections: Array<SFTPConnection> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SFTPConnectionCount) int SFTPConnectionCount;

- (int)SFTPConnectionCount;

- (BOOL)SFTPConnectionConnected:(int)connectionId;
- (void)setSFTPConnectionConnected:(int)connectionId :(BOOL)newSFTPConnectionConnected;

- (NSString*)SFTPConnectionErrorMessage:(int)connectionId;

- (NSString*)SFTPConnectionFileData:(int)connectionId;
- (void)setSFTPConnectionFileData:(int)connectionId :(NSString*)newSFTPConnectionFileData;

- (NSData*)SFTPConnectionFileDataB:(int)connectionId;
- (void)setSFTPConnectionFileDataB:(int)connectionId :(NSData*)newSFTPConnectionFileData;
- (NSString*)SFTPConnectionLocalAddress:(int)connectionId;

- (int)SFTPConnectionProtocolVersion:(int)connectionId;

- (NSString*)SFTPConnectionRemoteHost:(int)connectionId;

- (int)SFTPConnectionRemotePort:(int)connectionId;

- (int)SFTPConnectionTimeout:(int)connectionId;
- (void)setSFTPConnectionTimeout:(int)connectionId :(int)newSFTPConnectionTimeout;

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,aes256-cbc,aes192-cbc,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,arcfour256,arcfour128,arcfour,cast128-cbc,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

This property is a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the SFTPConnection type.

DefaultAuthMethods Property (SFTPServer Module)

Specifies the supported authentication methods.

Syntax

public var defaultAuthMethods: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultAuthMethods,setter=setDefaultAuthMethods:) NSString* defaultAuthMethods;

- (NSString*)defaultAuthMethods;
- (void)setDefaultAuthMethods :(NSString*)newDefaultAuthMethods;

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

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 class:

noneThis 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.
passwordAuthParam will contain the user-supplied password. If the password is correct, set Accept to true.
publickeyAuthParam will contain an SSH2 public key blob. If the user's public key is acceptable, set Accept or PartialSuccess to . The class will then handle verifying the digital signature and will respond to the client accordingly.
keyboard-interactiveSSHUserAuthRequest 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.

DefaultTimeout Property (SFTPServer Module)

An initial timeout value to be used by incoming connections.

Syntax

public var defaultTimeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultTimeout,setter=setDefaultTimeout:) int defaultTimeout;

- (int)defaultTimeout;
- (void)setDefaultTimeout :(int)newDefaultTimeout;

Default Value

60

Remarks

This property is used by the class 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 class will behave synchronously.

KeyboardInteractiveMessage Property (SFTPServer Module)

The instructions to send to the client during keyboard-interactive authentication.

Syntax

public var keyboardInteractiveMessage: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=keyboardInteractiveMessage,setter=setKeyboardInteractiveMessage:) NSString* keyboardInteractiveMessage;

- (NSString*)keyboardInteractiveMessage;
- (void)setKeyboardInteractiveMessage :(NSString*)newKeyboardInteractiveMessage;

Default Value

""

Remarks

This property should be set to the main instructions to send to the client during keyboard-interactive authentication.

KeyboardInteractivePrompts Property (SFTPServer Module)

A collection of prompts to present to the user for keyboard-interactive authentication.

Syntax

public var keyboardInteractivePrompts: Array<SSHPrompt> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=keyboardInteractivePromptCount,setter=setKeyboardInteractivePromptCount:) int keyboardInteractivePromptCount;

- (int)keyboardInteractivePromptCount;
- (void)setKeyboardInteractivePromptCount :(int)newKeyboardInteractivePromptCount;

- (BOOL)keyboardInteractivePromptEcho:(int)promptIndex;
- (void)setKeyboardInteractivePromptEcho:(int)promptIndex :(BOOL)newKeyboardInteractivePromptEcho;

- (NSString*)keyboardInteractivePromptPrompt:(int)promptIndex;
- (void)setKeyboardInteractivePromptPrompt:(int)promptIndex :(NSString*)newKeyboardInteractivePromptPrompt;

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,aes256-cbc,aes192-cbc,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,arcfour256,arcfour128,arcfour,cast128-cbc,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

This property is a collection of prompts to present to the user during keyboard-authentication. It is used together with the KeyboardInteractiveMessage property.

Listening Property (SFTPServer Module)

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

Syntax

public var listening: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=listening,setter=setListening:) BOOL listening;

- (BOOL)listening;
- (void)setListening :(BOOL)newListening;

Default Value

False

Remarks

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setListening(listening: Bool) throws

LocalHost Property (SFTPServer Module)

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

Syntax

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

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

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

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

LocalPort Property (SFTPServer Module)

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

Syntax

public var localPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;

- (int)localPort;
- (void)setLocalPort :(int)newLocalPort;

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

RootDirectory Property (SFTPServer Module)

The root directory for the entire SFTP server.

Syntax

public var rootDirectory: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=rootDirectory,setter=setRootDirectory:) NSString* rootDirectory;

- (NSString*)rootDirectory;
- (void)setRootDirectory :(NSString*)newRootDirectory;

Default Value

""

Remarks

RootDirectory specifies the root of the SFTP server ('/'). If a value is provided, the class 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.

SSHCertEncoded Property (SFTPServer Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var sshCertEncoded: String {
  get {...}
  set {...}
}

public var sshCertEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSHCertEncoded,setter=setSSHCertEncoded:) NSString* SSHCertEncoded;

- (NSString*)SSHCertEncoded;
- (void)setSSHCertEncoded :(NSString*)newSSHCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSHCertEncodedB,setter=setSSHCertEncodedB:) NSData* SSHCertEncodedB;

- (NSData*)SSHCertEncodedB;
- (void)setSSHCertEncodedB :(NSData*)newSSHCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSHCertEncodedB(sshCertEncoded: Data) throws
public func setSSHCertEncoded(sshCertEncoded: String) throws

SSHCertStore Property (SFTPServer Module)

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

Syntax

public var sshCertStore: String {
  get {...}
  set {...}
}

public var sshCertStoreB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=SSHCertStore,setter=setSSHCertStore:) NSString* SSHCertStore;

- (NSString*)SSHCertStore;
- (void)setSSHCertStore :(NSString*)newSSHCertStore;

@property (nonatomic,readwrite,assign,getter=SSHCertStoreB,setter=setSSHCertStoreB:) NSData* SSHCertStoreB;

- (NSData*)SSHCertStoreB;
- (void)setSSHCertStoreB :(NSData*)newSSHCertStore;

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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).

SSHCertStorePassword Property (SFTPServer Module)

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

Syntax

public var sshCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHCertStorePassword,setter=setSSHCertStorePassword:) NSString* SSHCertStorePassword;

- (NSString*)SSHCertStorePassword;
- (void)setSSHCertStorePassword :(NSString*)newSSHCertStorePassword;

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.

SSHCertStoreType Property (SFTPServer Module)

This is the type of certificate store for this certificate.

Syntax

public var sshCertStoreType: SftpserverSSHCertStoreTypes {
  get {...}
  set {...}
}

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

@property (nonatomic,readwrite,assign,getter=SSHCertStoreType,setter=setSSHCertStoreType:) int SSHCertStoreType;

- (int)SSHCertStoreType;
- (void)setSSHCertStoreType :(int)newSSHCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

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 class. 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: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.

SSHCertSubject Property (SFTPServer Module)

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

Syntax

public var sshCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHCertSubject,setter=setSSHCertSubject:) NSString* SSHCertSubject;

- (NSString*)SSHCertSubject;
- (void)setSSHCertSubject :(NSString*)newSSHCertSubject;

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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSHCertSubject(sshCertSubject: String) throws

SSHCompressionAlgorithms Property (SFTPServer Module)

A comma-separated list containing all allowable compression algorithms.

Syntax

public var sshCompressionAlgorithms: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHCompressionAlgorithms,setter=setSSHCompressionAlgorithms:) NSString* SSHCompressionAlgorithms;

- (NSString*)SSHCompressionAlgorithms;
- (void)setSSHCompressionAlgorithms :(NSString*)newSSHCompressionAlgorithms;

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 class 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 class:

  • zlib
  • zlib@openssh.com
  • none

SSHEncryptionAlgorithms Property (SFTPServer Module)

A comma-separated list containing all allowable encryption algorithms.

Syntax

public var sshEncryptionAlgorithms: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSHEncryptionAlgorithms,setter=setSSHEncryptionAlgorithms:) NSString* SSHEncryptionAlgorithms;

- (NSString*)SSHEncryptionAlgorithms;
- (void)setSSHEncryptionAlgorithms :(NSString*)newSSHEncryptionAlgorithms;

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,aes256-cbc,aes192-cbc,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,arcfour256,arcfour128,arcfour,cast128-cbc,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 class 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 class:

aes256-ctr256-bit AES encryption in CTR mode
aes256-cbc256-bit AES encryption in CBC mode
aes192-ctr192-bit AES encryption in CTR mode
aes192-cbc192-bit AES encryption in CBC mode
aes128-ctr128-bit AES encryption in CTR mode
aes128-cbc128-bit AES encryption in CBC mode
3des-ctr192-bit (3-key) triple DES encryption in CTR mode
3des-cbc192-bit (3-key) triple DES encryption in CBC mode
cast128-cbcCAST-128 encryption
blowfish-cbcBlowfish encryption
arcfourARC4 encryption
arcfour128128-bit ARC4 encryption
arcfour256256-bit ARC4 encryption
aes256-gcm@openssh.com256-bit AES encryption in GCM mode.
aes128-gcm@openssh.com128-bit AES encryption in GCM mode.
chacha20-poly1305@openssh.comChaCha20 with Poly1305-AES encryption.

Config Method (SFTPServer Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String
- (NSString*)config:(NSString*)configurationString;

Remarks

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

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

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

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

Disconnect Method (SFTPServer Module)

This method disconnects the specified client.

Syntax

public func disconnect(connectionId: Int32) throws -> Void
- (void)disconnect:(int)connectionId;

Remarks

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

DoEvents Method (SFTPServer Module)

Processes events from the internal message queue.

Syntax

public func doEvents() throws -> Void
- (void)doEvents;

Remarks

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

ExchangeKeys Method (SFTPServer Module)

Causes the component to exchange a new set of session keys on the specified connection.

Syntax

public func exchangeKeys(connectionId: Int32) throws -> Void
- (void)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 Module)

Reset the component.

Syntax

public func reset() throws -> Void
- (void)reset;

Remarks

This method will reset the class's properties to their default values.

SetFileList Method (SFTPServer Module)

Sets the file list for a connection during a directory listing request.

Syntax

public func setFileList(connectionId: Int32, list: String) throws -> Void
- (void)setFileList:(int)connectionId :(NSString*)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 Module)

This method shuts down the server.

Syntax

public func shutdown() throws -> Void
- (void)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 Module)

This method starts listening for incoming connections.

Syntax

public func startListening() throws -> Void
- (void)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 Module)

This method stops listening for new connections.

Syntax

public func stopListening() throws -> Void
- (void)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 Module)

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

Syntax

func onConnected(connectionId: Int32, statusCode: Int32, description: String, certStoreType: inout Int32, certStore: inout String, certPassword: inout String, certSubject: inout String)
- (void)onConnected:(int)connectionId :(int)statusCode :(NSString*)description :(int*)certStoreType :(NSString**)certStore :(NSString**)certPassword :(NSString**)certSubject;

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 class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

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 class. 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: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

ConnectionRequest Event (SFTPServer Module)

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

Syntax

func onConnectionRequest(address: String, port: Int32, accept: inout Bool)
- (void)onConnectionRequest:(NSString*)address :(int)port :(int*)accept;

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

Fires when a client wants to create a new directory.

Syntax

func onDirCreate(connectionId: Int32, user: String, path: String, fileType: Int32, fileSize: Int64, fileOwner: String, fileGroup: String, filePermissions: Int32, fileATime: Int64, fileCreateTime: Int64, fileMTime: Int64, fileAttribBits: Int32, fileAttribBitsValid: Int32, otherAttributes: String, beforeExec: Bool, statusCode: inout Int32)
- (void)onDirCreate:(int)connectionId :(NSString*)user :(NSString*)path :(int)fileType :(long long)fileSize :(NSString*)fileOwner :(NSString*)fileGroup :(int)filePermissions :(long long)fileATime :(long long)fileCreateTime :(long long)fileMTime :(int)fileAttribBits :(int)fileAttribBitsValid :(NSString*)otherAttributes :(BOOL)beforeExec :(int*)statusCode;

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

Fires when a client attempts to open a directory for listing.

Syntax

func onDirList(connectionId: Int32, user: String, path: String, beforeExec: Bool, statusCode: inout Int32)
- (void)onDirList:(int)connectionId :(NSString*)user :(NSString*)path :(BOOL)beforeExec :(int*)statusCode;

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

Fires when a client wants to delete a directory.

Syntax

func onDirRemove(connectionId: Int32, user: String, path: String, beforeExec: Bool, statusCode: inout Int32)
- (void)onDirRemove:(int)connectionId :(NSString*)user :(NSString*)path :(BOOL)beforeExec :(int*)statusCode;

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

This event is fired when a connection is closed.

Syntax

func onDisconnected(connectionId: Int32, statusCode: Int32, description: String)
- (void)onDisconnected:(int)connectionId :(int)statusCode :(NSString*)description;

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

Information about errors during data delivery.

Syntax

func onError(connectionId: Int32, errorCode: Int32, description: String)
- (void)onError:(int)connectionId :(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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

Fires when a client attempts to close an open file or directory handle.

Syntax

func onFileClose(connectionId: Int32, user: String, path: String, handle: String, statusCode: inout Int32)
- (void)onFileClose:(int)connectionId :(NSString*)user :(NSString*)path :(NSString*)handle :(int*)statusCode;

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

Fires when a client wants to open or create a file.

Syntax

func onFileOpen(connectionId: Int32, user: String, path: String, desiredAccess: Int32, flags: Int32, fileType: Int32, fileSize: Int64, fileOwner: String, fileGroup: String, filePermissions: Int32, fileATime: Int64, fileCreateTime: Int64, fileMTime: Int64, fileAttribBits: Int32, fileAttribBitsValid: Int32, otherAttributes: String, handle: inout String, beforeExec: Bool, statusCode: inout Int32)
- (void)onFileOpen:(int)connectionId :(NSString*)user :(NSString*)path :(int)desiredAccess :(int)flags :(int)fileType :(long long)fileSize :(NSString*)fileOwner :(NSString*)fileGroup :(int)filePermissions :(long long)fileATime :(long long)fileCreateTime :(long long)fileMTime :(int)fileAttribBits :(int)fileAttribBitsValid :(NSString*)otherAttributes :(NSString**)handle :(BOOL)beforeExec :(int*)statusCode;

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 class 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)
Please see RFC 3010 for more information on the semantics of these values.

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

Fires when a client wants to read from an open file.

Syntax

func onFileRead(connectionId: Int32, user: String, handle: String, fileOffset: Int64, length: Int32, statusCode: inout Int32)
- (void)onFileRead:(int)connectionId :(NSString*)user :(NSString*)handle :(long long)fileOffset :(int)length :(int*)statusCode;

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 ConnectionsFileData

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

Fires when a client wants to delete a file.

Syntax

func onFileRemove(connectionId: Int32, user: String, path: String, beforeExec: Bool, statusCode: inout Int32)
- (void)onFileRemove:(int)connectionId :(NSString*)user :(NSString*)path :(BOOL)beforeExec :(int*)statusCode;

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

Fires when a client wants to rename a file.

Syntax

func onFileRename(connectionId: Int32, user: String, path: String, newPath: String, flags: Int32, beforeExec: Bool, statusCode: inout Int32)
- (void)onFileRename:(int)connectionId :(NSString*)user :(NSString*)path :(NSString*)newPath :(int)flags :(BOOL)beforeExec :(int*)statusCode;

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

Fires when a client wants to write to an open file.

Syntax

func onFileWrite(connectionId: Int32, user: String, handle: String, fileOffset: Int64, beforeExec: Bool, statusCode: inout Int32)
- (void)onFileWrite:(int)connectionId :(NSString*)user :(NSString*)handle :(long long)fileOffset :(BOOL)beforeExec :(int*)statusCode;

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 ConnectionsFileData

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

Fires when a client needs to get file information.

Syntax

func onGetAttributes(connectionId: Int32, user: String, path: String, flags: Int32, fileType: inout Int32, fileSize: inout Int64, fileOwner: inout String, fileGroup: inout String, filePermissions: inout Int32, fileATime: inout Int64, fileCreateTime: inout Int64, fileMTime: inout Int64, fileAttribBits: inout Int32, fileAttribBitsValid: inout Int32, otherAttributes: inout String, statusCode: inout Int32)
- (void)onGetAttributes:(int)connectionId :(NSString*)user :(NSString*)path :(int)flags :(int*)fileType :(long long*)fileSize :(NSString**)fileOwner :(NSString**)fileGroup :(int*)filePermissions :(long long*)fileATime :(long long*)fileCreateTime :(long long*)fileMTime :(int*)fileAttribBits :(int*)fileAttribBitsValid :(NSString**)otherAttributes :(int*)statusCode;

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

Fires once for each log message.

Syntax

func onLog(connectionId: Int32, logLevel: Int32, message: String, logType: String)
- (void)onLog:(int)connectionId :(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event fires once for each log messages generated by the class. 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 Module)

Fires when a client attempts to canonicalize a path.

Syntax

func onResolvePath(connectionId: Int32, user: String, originalPath: String, controlFlags: Int32, realPath: inout String, statusCode: inout Int32)
- (void)onResolvePath:(int)connectionId :(NSString*)user :(NSString*)originalPath :(int)controlFlags :(NSString**)realPath :(int*)statusCode;

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

Fires when a client attempts to set file or directory attributes.

Syntax

func onSetAttributes(connectionId: Int32, user: String, path: String, fileType: Int32, fileSize: Int64, fileOwner: String, fileGroup: String, filePermissions: Int32, fileATime: Int64, fileCreateTime: Int64, fileMTime: Int64, fileAttribBits: Int32, fileAttribBitsValid: Int32, otherAttributes: String, beforeExec: Bool, statusCode: inout Int32)
- (void)onSetAttributes:(int)connectionId :(NSString*)user :(NSString*)path :(int)fileType :(long long)fileSize :(NSString*)fileOwner :(NSString*)fileGroup :(int)filePermissions :(long long)fileATime :(long long)fileCreateTime :(long long)fileMTime :(int)fileAttribBits :(int)fileAttribBitsValid :(NSString*)otherAttributes :(BOOL)beforeExec :(int*)statusCode;

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

Shows the progress of the secure connection.

Syntax

func onSSHStatus(connectionId: Int32, message: String)
- (void)onSSHStatus:(int)connectionId :(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

SSHUserAuthRequest Event (SFTPServer Module)

Fires when a client attempts to authenticate a connection.

Syntax

func onSSHUserAuthRequest(connectionId: Int32, user: String, service: String, authMethod: String, authParam: String, accept: inout Bool, partialSuccess: inout Bool, availableMethods: inout String, homeDir: inout String, keyAlgorithm: String)
- (void)onSSHUserAuthRequest:(int)connectionId :(NSString*)user :(NSString*)service :(NSString*)authMethod :(NSString*)authParam :(int*)accept :(int*)partialSuccess :(NSString**)availableMethods :(NSString**)homeDir :(NSString*)keyAlgorithm;

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 class:

noneThis 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.
passwordAuthParam will contain the user-supplied password. If the password is correct, set Accept to true.
publickeyAuthParam will contain an SSH2 public key blob. If the user's public key is acceptable, set Accept or PartialSuccess to . The class will then handle verifying the digital signature and will respond to the client accordingly.
keyboard-interactiveSSHUserAuthRequest 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.

SFTPConnection Type

A currently connected client.

Remarks

This type describes the connection of a client which is currently connected to the class. You may use the different fields of this type to manage the connection.

Fields

connected
Bool

Default Value: False

Used to disconnect individual connections and/or show their status.

The is used to close connections.

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

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

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

connectionId
String (read-only)

Default Value: ""

An id generated by the class to identify each connection. This id is unique to this connection.

errorMessage
String

Default Value: ""

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 class will set a default message based on the returned status code.

fileDataB
Data

Default Value: ""

The should be set or read when processing read/write file events.

fileData
String

Default Value: ""

The should be set or read when processing read/write file events.

localAddress
String (read-only)

Default Value: ""

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

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

protocolVersion
Int32 (read-only)

Default Value: 3

The shows the SFTP protocol version negotiated with the client when the SFTP connection was established.

remoteHost
String (read-only)

Default Value: ""

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

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

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

remotePort
Int32 (read-only)

Default Value: 0

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

timeout
Int32

Default Value: 0

A timeout for the class.

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 class will automatically retry each operation that would otherwise result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class .

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

The default value for the Timeout property is 0 (asynchronous operation).

Constructors

public init()

SSHPrompt Type

A prompt to provide to the client during keyboard-interactive authentication.

Remarks

This type describes a prompt the SSH daemon will send to the client when requesting keyboard-interactive authentication.

Fields

echo
Bool

Default Value: False

Specifies if the client should echo the value entered by the user or not.

prompt
String

Default Value: ""

The prompt label/text the client should present to the user.

Constructors

public init()
public init(prompt: , echo: )

Config Settings (SFTPServer Module)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SFTPServer Config Settings

DirListBufferSize[ConnectionId]:   The number of entries to be returned in one response to a request for a directory listing.

The default value for this configuration setting is 1, which means that the class will return one entry at a time in response to a request for a directory listing. Changing this value will allow the class to bundle multiple entries into a single response.

MaskSensitive:   Masks passwords in logs.

The default value is True. When set to True, the class will mask passwords that otherwise would appear in its logs.

ProtocolVersion:   The highest allowable SFTP version to use.

This governs the highest allowable SFTP version to use when negotiating the version with the client. The default value is 3 as this is the most common version. The class supports values from 3 to 6.

RestrictUserToHomeDir[ConnectionId]:   Whether to restrict the user to their home directory.

When True, this setting will restrict the user to the path specified by the "HomeDir" parameter in the SSHUserAuthRequest event. When False (default), the user will be able to navigate outside of the home directory. "ConnectionId" specifies the connection to which the restriction applies.

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
    testfolder
When 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

/testfolder
The 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.

ServerEOL:   Specifies the line endings used in files on the server.

This setting is used to inform the connecting client what line endings are used in the files on the system. This is only applicable when ProtocolVersion is set to 4 or higher and a connecting client negotiates protocol version 4 or higher. When a client negotiates version 4 or higher this value is reported using the "newline" protocol convention. The client may use that to transform line endings when downloading. The default value is CrLF.

SFTPErrorMessage[ConnectionId]:   Specifies the error message to be returned to the client.

If an SFTP operation would return an error to the client (e.g., permission denied, file does not exist, etc) then this configuration option can be used to specify the error message to be returned to the client. This configuration option is only effective when set within an event that uses the "StatusCode" field.

UnixStyleDateFormat:   Controls whether to use the Unix-style date format in directory listings.

When set to true, the class will report entries in the Unix-style date format: if the modification time is within the previous 180 days, the date will be formatted as "Mmm dd hh:mm", otherwise it will be formatted as "Mmm dd yyyy".

UserRootDirectory[ConnectionId]:   The path of the server root directory for a particular user.

When set to a subdirectory of the server root, this setting will override the server RootDirectory for a particular user. The "HomeDir" parameter of the SSHUserAuthRequest event will represent the initial path of the client relative to the UserRootDirectory. "ConnectionId" specifies the connection to which the restriction applies. 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
    testfolder
When 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: /

/testfolder
The 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

AltSSHCertCount:   The number of records in the AltSSHCert configuration settings.

This configuration setting controls the size of the following arrays:

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

AltSSHCertStore[i]:   The name of the certificate store.

The name of the certificate store. This is used when specifying an alternative SSHCert.

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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).

AltSSHCertStorePassword[i]:   The password used to open the certificate store.

If the certificate store is of a type that requires a password, this setting can be used to specify that password. This is used when specifying an alternative SSHCert

AltSSHCertStoreType[i]:   The type of certificate store.

This specifies the type of certificate store. This is used when specifying an alternate SSHCert. Possible values are:

0 User - This is the default for Windows. This specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 Machine - For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is available only in Java.
5 JKSBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: This store type is available only in Java.
6 PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
14 PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 XMLFile - The certificate store is the name of a file that contains a certificate in XML format.
17 XMLBlob - The certificate store is a string that contains a certificate in XML format.
AltSSHCertSubject[i]:   The alternative certificate subject.

The subject of the certificate. This is used when specifying an alternative SSHCert. The special value of * may be used to select the first certificate in the store.

ClientSSHVersionString[ConnectionId]:   The client's version string.

This setting returns a connected client's SSH version string. It may be queried inside SSHUserAuthRequest. sftpserver1.OnSSHUserAuthRequest += (obj, ev) => { Console.WriteLine(sftpserver1.Config("ClientSSHVersionString[" + ev.ConnectionId + "]")); };

FireAuthRequestAfterSig:   Whether to fire an informational event after the public key signature has been verified.

When performing public key authentication the connecting client will present both the public key itself as well as a signature to verify ownership of the corresponding private key. The class will automatically verify the signature and respond to the client to indicate whether the signature could be verified and the connection can continue. This setting controls whether an additional informational event fires to report the result of the signature verification.

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.

KeyboardInteractivePrompts[ConnectionId]:   Specifies custom keyboard-interactive prompts for particular connections.

By default, setting the KeyboardInteractivePrompts property will cause those prompts to be used for every user attempting to connect. This setting can be used to override the KeyboardInteractivePrompts property and provide unique prompts for certain connections.

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.

KeyRenegotiationThreshold:   Sets the threshold for the SSH Key Renegotiation.

This property allows you to specify the threshold, in the number of bytes, for the SSH Key Renegotiation. The default value for this property is set to 1 GB.

Example (for setting the threshold to 500 MB): SSHComponent.Config("KeyRenegotiationThreshold=524288000")

LogLevel:   Specifies the level of detail that is logged.

This setting controls the level of detail that is logged through the Log event. 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.

MaxAuthAttempts:   The maximum authentication attempts allowed before forcing a disconnect.

This setting specifies the maximum amount of authentication attempts that will be allowed before forcibly disconnecting the client.

NegotiatedStrictKex[ConnectionId]:   Returns whether strict key exchange was negotiated to be used.

Returns whether strict key exchange (strict kex) was negotiated during the SSH handshake. This is a per-connection setting accessed by passing the ConnectionId. If strict kex is being used, then this will return "True". If strict kex is not being used, then this will return "False".

component.Config("NegotiatedStrictKex[connId]")

ServerSSHVersionString:   The SSH version string sent to connecting clients.

This setting specifies the version string value that is sent to all connecting clients. This may be set to specify server specific information. The default value is "SSH-2.0-IPWorks SSH Daemon 2022". When setting your own value it must begin with "SSH-2.0-" as this is a standard format that specifies the supported SSH version.

SSHKeepAliveCountMax:   The maximum number of keep alive packets to send without a response.

This setting specifies the maximum number of keep alive packets to send when no response is received. Normally a response to a keep alive packet is received right away. If no response is received the class will continue to send keep alive packets until SSHKeepAliveCountMax is reached. If this is reached the class will assume the connection is broken and disconnect. The default value is 5.

SSHKeepAliveInterval:   The interval between keep alive packets.

This setting specifies the number of seconds between keep alive packets. If set to a positive value the class will send a SSH keep alive packet after KeepAliveInterval seconds of inactivity. This setting only takes effect when there is no activity, if any data is sent or received over the connection it will reset the timer.

The default value is 0 meaning no keep alives will be sent.

Note: The SSHREVERSETUNNEL class uses a default value of 30.

SSHKeyExchangeAlgorithms:   Specifies the supported key exchange algorithms.

This may be used to specify the list of supported key exchange algorithms used during SSH negotiation. The value should contain a comma separated list of algorithms. Supported algorithms are:

  • 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==
The default value is: curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,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==.
SSHMacAlgorithms:   Specifies the supported Mac algorithms.

This may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma separated list of algorithms. Supported algorithms are:

  • 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 default value is hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,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.
SSHPubKeyAuthSigAlgorithms:   Specifies the allowed signature algorithms used by a client performing public key authentication.

This setting specifies a list of signature algorithms that a client is allowed to use when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client.

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.

SSHPublicKeyAlgorithms:   Specifies the supported public key algorithms for the server's public key.

This setting specifies the allowed public key algorithms for the server's public key. This list controls only the public key algorithm used when authenticating the server's public key. This list has no bearing on the public key algorithms that can be used by the client when performing public key authentication to the server. The default value is ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss.

SSHVersionPattern:   The pattern used to match the remote host's version string.

This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the below value would accept connections for SSH 1.99, 2.0, and 2.99 hosts.

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
UserAuthBanner[ConnectionId]:   A custom user authentication banner.

This setting specifies a custom user authentication banner, which may be sent to give the client more information regarding an authentication attempt. "connectionId" specifies the particular connection to send the message to. This configuration option is only effective when set within the SSHUserAuthRequest event.

UseStrictKeyExchange:   Specifies how strict key exchange is supported.

This setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the class will indicate support for strict key exchange by automatically including the pseudo-algorithm kex-strict-c-v00@openssh.com for client classes and kex-strict-s-v00@openssh.com for server classes in the list of supported key exchange algorithms.

Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are:

0Disabled. Strict key exchange is not supported in the class.
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.
2Enabled, 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.
3Required. If the remote host does not support strict key exchange the connection will fail.

TCPServer Config Settings

AllowedClients:   A comma-separated list of host names or IP addresses that can access the class.

This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the class. The wildcard character "*" is supported. The default value is "*" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is no match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will be disconnected.

BindExclusively:   Whether or not the component considers a local port reserved for exclusive use.

If this is True (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure.

BlockedClients:   A comma-separated list of host names or IP addresses that cannot access the class.

This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the class.The default value is "" and all connections are accepted.

When a client connects, the client's address is checked against the list defined here. If there is a match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will not be connected.

DefaultConnectionTimeout:   The inactivity timeout applied to the SSL handshake.

This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value, if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied.

Note: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so.

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated, the InBufferSize 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.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

A TCP keep-alive packet will be sent after a period of inactivity, as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. If this value is not specified here, the system default is 1 second. This setting is applicable to all connections.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections.

MaxConnections:   The maximum number of connections available.

This is the maximum number of connections available. This property must be set before Listening is set to True, and once set, it can no longer be changed for the current instance of the class. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may affect performance. The default value is 1000.

Note: Unix/Linux operating systems limit the number of simultaneous connections to 1024.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize 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.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. When set to 2, the class will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are as follows:

0 IPv4 Only
1 IPv6 Only
2 IPv6 and IPv4

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (SFTPServer Module)

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.

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 non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't 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] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory 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 not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).