SFTPServer Module

Properties   Methods   Events   Config Settings   Errors  

The SFTPServer module provides server-side functionality for SFTP connections.

Syntax

SecureBlackbox.Sftpserver

Remarks

SFTPServer is an implementation for SSH File Transfer Protocol server. It works over a secure SSH channel, and should not be confused with the FTP/FTPS protocol.

Property List

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

Method List

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

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.

Config Settings

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

Active Property (SFTPServer Module)

Specifies whether the SFTP server has started and ready to accept connections.

Syntax

• Swift
• Objective-C

public var active: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=active) BOOL active;

- (BOOL)active;

Default Value

False

Remarks

Check this property to find out whether the SFTP server is in active mode. Use Start and Stop methods to activate or deactivate the server.

This property is read-only.

AuthTypes Property (SFTPServer Module)

Defines allowed authentication types.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=authTypes,setter=setAuthTypes:) int authTypes;

- (int)authTypes;
- (void)setAuthTypes :(int)newAuthTypes;

Default Value

30

Remarks

Use this property to define which authentication types are allowed on the server, set of

BaseDir Property (SFTPServer Module)

Specifies the server's base (root) directory.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=baseDir,setter=setBaseDir:) NSString* baseDir;

- (NSString*)baseDir;
- (void)setBaseDir :(NSString*)newBaseDir;

Default Value

""

Remarks

Use this property to set the base (root) directory on the server.

ClientFileEntry Property (SFTPServer Module)

A container for file entry details.

Syntax

• Swift
• Objective-C

public var clientFileEntry: SFTPListEntry {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=clientFileEntryATime,setter=setClientFileEntryATime:) NSString* clientFileEntryATime;

- (NSString*)clientFileEntryATime;
- (void)setClientFileEntryATime :(NSString*)newClientFileEntryATime;

@property (nonatomic,readwrite,assign,getter=clientFileEntryCTime,setter=setClientFileEntryCTime:) NSString* clientFileEntryCTime;

- (NSString*)clientFileEntryCTime;
- (void)setClientFileEntryCTime :(NSString*)newClientFileEntryCTime;

@property (nonatomic,readwrite,assign,getter=clientFileEntryDirectory,setter=setClientFileEntryDirectory:) BOOL clientFileEntryDirectory;

- (BOOL)clientFileEntryDirectory;
- (void)setClientFileEntryDirectory :(BOOL)newClientFileEntryDirectory;

@property (nonatomic,readwrite,assign,getter=clientFileEntryFileType,setter=setClientFileEntryFileType:) int clientFileEntryFileType;

- (int)clientFileEntryFileType;
- (void)setClientFileEntryFileType :(int)newClientFileEntryFileType;

@property (nonatomic,readwrite,assign,getter=clientFileEntryGroupExecute,setter=setClientFileEntryGroupExecute:) BOOL clientFileEntryGroupExecute;

- (BOOL)clientFileEntryGroupExecute;
- (void)setClientFileEntryGroupExecute :(BOOL)newClientFileEntryGroupExecute;

@property (nonatomic,readwrite,assign,getter=clientFileEntryGroupRead,setter=setClientFileEntryGroupRead:) BOOL clientFileEntryGroupRead;

- (BOOL)clientFileEntryGroupRead;
- (void)setClientFileEntryGroupRead :(BOOL)newClientFileEntryGroupRead;

@property (nonatomic,readwrite,assign,getter=clientFileEntryGroupWrite,setter=setClientFileEntryGroupWrite:) BOOL clientFileEntryGroupWrite;

- (BOOL)clientFileEntryGroupWrite;
- (void)setClientFileEntryGroupWrite :(BOOL)newClientFileEntryGroupWrite;

@property (nonatomic,readwrite,assign,getter=clientFileEntryHandle,setter=setClientFileEntryHandle:) long long clientFileEntryHandle;

- (long long)clientFileEntryHandle;
- (void)setClientFileEntryHandle :(long long)newClientFileEntryHandle;

@property (nonatomic,readwrite,assign,getter=clientFileEntryLongName,setter=setClientFileEntryLongName:) NSString* clientFileEntryLongName;

- (NSString*)clientFileEntryLongName;
- (void)setClientFileEntryLongName :(NSString*)newClientFileEntryLongName;

@property (nonatomic,readwrite,assign,getter=clientFileEntryMTime,setter=setClientFileEntryMTime:) NSString* clientFileEntryMTime;

- (NSString*)clientFileEntryMTime;
- (void)setClientFileEntryMTime :(NSString*)newClientFileEntryMTime;

@property (nonatomic,readwrite,assign,getter=clientFileEntryName,setter=setClientFileEntryName:) NSString* clientFileEntryName;

- (NSString*)clientFileEntryName;
- (void)setClientFileEntryName :(NSString*)newClientFileEntryName;

@property (nonatomic,readwrite,assign,getter=clientFileEntryOtherExecute,setter=setClientFileEntryOtherExecute:) BOOL clientFileEntryOtherExecute;

- (BOOL)clientFileEntryOtherExecute;
- (void)setClientFileEntryOtherExecute :(BOOL)newClientFileEntryOtherExecute;

@property (nonatomic,readwrite,assign,getter=clientFileEntryOtherRead,setter=setClientFileEntryOtherRead:) BOOL clientFileEntryOtherRead;

- (BOOL)clientFileEntryOtherRead;
- (void)setClientFileEntryOtherRead :(BOOL)newClientFileEntryOtherRead;

@property (nonatomic,readwrite,assign,getter=clientFileEntryOtherWrite,setter=setClientFileEntryOtherWrite:) BOOL clientFileEntryOtherWrite;

- (BOOL)clientFileEntryOtherWrite;
- (void)setClientFileEntryOtherWrite :(BOOL)newClientFileEntryOtherWrite;

@property (nonatomic,readwrite,assign,getter=clientFileEntryOwner,setter=setClientFileEntryOwner:) NSString* clientFileEntryOwner;

- (NSString*)clientFileEntryOwner;
- (void)setClientFileEntryOwner :(NSString*)newClientFileEntryOwner;

@property (nonatomic,readwrite,assign,getter=clientFileEntryPath,setter=setClientFileEntryPath:) NSString* clientFileEntryPath;

- (NSString*)clientFileEntryPath;
- (void)setClientFileEntryPath :(NSString*)newClientFileEntryPath;

@property (nonatomic,readwrite,assign,getter=clientFileEntrySize,setter=setClientFileEntrySize:) long long clientFileEntrySize;

- (long long)clientFileEntrySize;
- (void)setClientFileEntrySize :(long long)newClientFileEntrySize;

@property (nonatomic,readwrite,assign,getter=clientFileEntryUserExecute,setter=setClientFileEntryUserExecute:) BOOL clientFileEntryUserExecute;

- (BOOL)clientFileEntryUserExecute;
- (void)setClientFileEntryUserExecute :(BOOL)newClientFileEntryUserExecute;

@property (nonatomic,readwrite,assign,getter=clientFileEntryUserRead,setter=setClientFileEntryUserRead:) BOOL clientFileEntryUserRead;

- (BOOL)clientFileEntryUserRead;
- (void)setClientFileEntryUserRead :(BOOL)newClientFileEntryUserRead;

@property (nonatomic,readwrite,assign,getter=clientFileEntryUserWrite,setter=setClientFileEntryUserWrite:) BOOL clientFileEntryUserWrite;

- (BOOL)clientFileEntryUserWrite;
- (void)setClientFileEntryUserWrite :(BOOL)newClientFileEntryUserWrite;

 

Default Value

False

Remarks

This property is a placeholder for file entry details. Use it communicate file details from your code to the server component and back. Pass the contents of ClientFileEntry to the server with SetClientFileEntry method, and retrieve them with GetClientFileEntry method.

This property may come handy when customizing file system operations, such as file listings or attribute requests.

CompressionLevel Property (SFTPServer Module)

Specifies the preferable compression level.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=compressionLevel,setter=setCompressionLevel:) int compressionLevel;

- (int)compressionLevel;
- (void)setCompressionLevel :(int)newCompressionLevel;

Default Value

9

Remarks

Set this property before starting the server. Possible values range from 0 (lowest compression) to 9 (maximum compression). This property is ignored if compression wasn't accepted.

ExternalCrypto Property (SFTPServer Module)

Provides access to external signing and DC parameters.

Syntax

• Swift
• Objective-C

public var externalCrypto: ExternalCrypto {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=externalCryptoAsyncDocumentID,setter=setExternalCryptoAsyncDocumentID:) NSString* externalCryptoAsyncDocumentID;

- (NSString*)externalCryptoAsyncDocumentID;
- (void)setExternalCryptoAsyncDocumentID :(NSString*)newExternalCryptoAsyncDocumentID;

@property (nonatomic,readwrite,assign,getter=externalCryptoCustomParams,setter=setExternalCryptoCustomParams:) NSString* externalCryptoCustomParams;

- (NSString*)externalCryptoCustomParams;
- (void)setExternalCryptoCustomParams :(NSString*)newExternalCryptoCustomParams;

@property (nonatomic,readwrite,assign,getter=externalCryptoData,setter=setExternalCryptoData:) NSString* externalCryptoData;

- (NSString*)externalCryptoData;
- (void)setExternalCryptoData :(NSString*)newExternalCryptoData;

@property (nonatomic,readwrite,assign,getter=externalCryptoExternalHashCalculation,setter=setExternalCryptoExternalHashCalculation:) BOOL externalCryptoExternalHashCalculation;

- (BOOL)externalCryptoExternalHashCalculation;
- (void)setExternalCryptoExternalHashCalculation :(BOOL)newExternalCryptoExternalHashCalculation;

@property (nonatomic,readwrite,assign,getter=externalCryptoHashAlgorithm,setter=setExternalCryptoHashAlgorithm:) NSString* externalCryptoHashAlgorithm;

- (NSString*)externalCryptoHashAlgorithm;
- (void)setExternalCryptoHashAlgorithm :(NSString*)newExternalCryptoHashAlgorithm;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeyID,setter=setExternalCryptoKeyID:) NSString* externalCryptoKeyID;

- (NSString*)externalCryptoKeyID;
- (void)setExternalCryptoKeyID :(NSString*)newExternalCryptoKeyID;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeySecret,setter=setExternalCryptoKeySecret:) NSString* externalCryptoKeySecret;

- (NSString*)externalCryptoKeySecret;
- (void)setExternalCryptoKeySecret :(NSString*)newExternalCryptoKeySecret;

@property (nonatomic,readwrite,assign,getter=externalCryptoMethod,setter=setExternalCryptoMethod:) int externalCryptoMethod;

- (int)externalCryptoMethod;
- (void)setExternalCryptoMethod :(int)newExternalCryptoMethod;

@property (nonatomic,readwrite,assign,getter=externalCryptoMode,setter=setExternalCryptoMode:) int externalCryptoMode;

- (int)externalCryptoMode;
- (void)setExternalCryptoMode :(int)newExternalCryptoMode;

@property (nonatomic,readwrite,assign,getter=externalCryptoPublicKeyAlgorithm,setter=setExternalCryptoPublicKeyAlgorithm:) NSString* externalCryptoPublicKeyAlgorithm;

- (NSString*)externalCryptoPublicKeyAlgorithm;
- (void)setExternalCryptoPublicKeyAlgorithm :(NSString*)newExternalCryptoPublicKeyAlgorithm;

 

Default Value

False

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).

FIPSMode Property (SFTPServer Module)

Reserved.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

ForceCompression Property (SFTPServer Module)

This property specifies whether server explicitly requires data compression.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=forceCompression,setter=setForceCompression:) BOOL forceCompression;

- (BOOL)forceCompression;
- (void)setForceCompression :(BOOL)newForceCompression;

Default Value

False

Remarks

Set this property before starting the server. If it is set to true, the class will explicitly request data compression. If it is set to False, the class will support compression, although compression will be used only if the remote party doesn't support algorithms without compression.

Host Property (SFTPServer Module)

Specifies server's host name.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=host,setter=setHost:) NSString* host;

- (NSString*)host;
- (void)setHost :(NSString*)newHost;

Default Value

""

Remarks

Use this property to set the host name for this server.

Key Property (SFTPServer Module)

Contains client's public key.

Syntax

• Swift
• Objective-C

public var key: SSHKey {
  get {...}
}

@property (nonatomic,readonly,assign,getter=keyFingerprintSHA1) NSString* keyFingerprintSHA1;

- (NSString*)keyFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=keyFingerprintSHA256) NSString* keyFingerprintSHA256;

- (NSString*)keyFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=keyHandle) long long keyHandle;

- (long long)keyHandle;

 

Default Value

False

Remarks

This property returns the currently pinned client's public key. Call PinClient to propagate the key of a particular client prior to checking this property.

MaxSFTPVersion Property (SFTPServer Module)

Maximum SFTP version supported.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=maxSFTPVersion,setter=setMaxSFTPVersion:) int maxSFTPVersion;

- (int)maxSFTPVersion;
- (void)setMaxSFTPVersion :(int)newMaxSFTPVersion;

Default Value

6

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this server.

MinSFTPVersion Property (SFTPServer Module)

Minimum SFTP version supported.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=minSFTPVersion,setter=setMinSFTPVersion:) int minSFTPVersion;

- (int)minSFTPVersion;
- (void)setMinSFTPVersion :(int)newMinSFTPVersion;

Default Value

0

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this server.

PinnedClient Property (SFTPServer Module)

Populates the pinned client details.

Syntax

• Swift
• Objective-C

public var pinnedClient: SSHClientEntry {
  get {...}
}

@property (nonatomic,readonly,assign,getter=pinnedClientAddress) NSString* pinnedClientAddress;

- (NSString*)pinnedClientAddress;

@property (nonatomic,readonly,assign,getter=pinnedClientClientKeyAlgorithm) NSString* pinnedClientClientKeyAlgorithm;

- (NSString*)pinnedClientClientKeyAlgorithm;

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

- (int)pinnedClientClientKeyBits;

@property (nonatomic,readonly,assign,getter=pinnedClientClientKeyFingerprint) NSString* pinnedClientClientKeyFingerprint;

- (NSString*)pinnedClientClientKeyFingerprint;

@property (nonatomic,readonly,assign,getter=pinnedClientClientSoftwareName) NSString* pinnedClientClientSoftwareName;

- (NSString*)pinnedClientClientSoftwareName;

@property (nonatomic,readonly,assign,getter=pinnedClientCloseReason) NSString* pinnedClientCloseReason;

- (NSString*)pinnedClientCloseReason;

@property (nonatomic,readonly,assign,getter=pinnedClientCompressionAlgorithmInbound) NSString* pinnedClientCompressionAlgorithmInbound;

- (NSString*)pinnedClientCompressionAlgorithmInbound;

@property (nonatomic,readonly,assign,getter=pinnedClientCompressionAlgorithmOutbound) NSString* pinnedClientCompressionAlgorithmOutbound;

- (NSString*)pinnedClientCompressionAlgorithmOutbound;

@property (nonatomic,readonly,assign,getter=pinnedClientEncryptionAlgorithmInbound) NSString* pinnedClientEncryptionAlgorithmInbound;

- (NSString*)pinnedClientEncryptionAlgorithmInbound;

@property (nonatomic,readonly,assign,getter=pinnedClientEncryptionAlgorithmOutbound) NSString* pinnedClientEncryptionAlgorithmOutbound;

- (NSString*)pinnedClientEncryptionAlgorithmOutbound;

@property (nonatomic,readonly,assign,getter=pinnedClientID) long long pinnedClientID;

- (long long)pinnedClientID;

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

- (int)pinnedClientInboundEncryptionKeyBits;

@property (nonatomic,readonly,assign,getter=pinnedClientKexAlgorithm) NSString* pinnedClientKexAlgorithm;

- (NSString*)pinnedClientKexAlgorithm;

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

- (int)pinnedClientKexBits;

@property (nonatomic,readonly,assign,getter=pinnedClientKexLines) NSString* pinnedClientKexLines;

- (NSString*)pinnedClientKexLines;

@property (nonatomic,readonly,assign,getter=pinnedClientMacAlgorithmInbound) NSString* pinnedClientMacAlgorithmInbound;

- (NSString*)pinnedClientMacAlgorithmInbound;

@property (nonatomic,readonly,assign,getter=pinnedClientMacAlgorithmOutbound) NSString* pinnedClientMacAlgorithmOutbound;

- (NSString*)pinnedClientMacAlgorithmOutbound;

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

- (int)pinnedClientOutboundEncryptionKeyBits;

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

- (int)pinnedClientPort;

@property (nonatomic,readonly,assign,getter=pinnedClientPublicKeyAlgorithm) NSString* pinnedClientPublicKeyAlgorithm;

- (NSString*)pinnedClientPublicKeyAlgorithm;

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

- (int)pinnedClientServerKeyBits;

@property (nonatomic,readonly,assign,getter=pinnedClientServerKeyFingerprint) NSString* pinnedClientServerKeyFingerprint;

- (NSString*)pinnedClientServerKeyFingerprint;

@property (nonatomic,readonly,assign,getter=pinnedClientTotalBytesReceived) long long pinnedClientTotalBytesReceived;

- (long long)pinnedClientTotalBytesReceived;

@property (nonatomic,readonly,assign,getter=pinnedClientTotalBytesSent) long long pinnedClientTotalBytesSent;

- (long long)pinnedClientTotalBytesSent;

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

- (int)pinnedClientVersion;

 

Default Value

False

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

Port Property (SFTPServer Module)

Specifies the listening port number.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=port,setter=setPort:) int port;

- (int)port;
- (void)setPort :(int)newPort;

Default Value

22

Remarks

Use this property to specify on which port the class will be listening to client connections.

ReadOnly Property (SFTPServer Module)

Specifies whether files on the server are read-only.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=readOnly,setter=setReadOnly:) BOOL readOnly;

- (BOOL)readOnly;
- (void)setReadOnly :(BOOL)newReadOnly;

Default Value

False

Remarks

Set this property to true to deny all client requests to change files on the server.

ServerKeys Property (SFTPServer Module)

The server's SSH keys.

Syntax

• Swift
• Objective-C

public var serverKeys: Array<SSHKey> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=serverKeyCount,setter=setServerKeyCount:) int serverKeyCount;

- (int)serverKeyCount;
- (void)setServerKeyCount :(int)newServerKeyCount;

- (NSString*)serverKeyAlgorithm:(int)serverKeyIndex;

- (int)serverKeyBits:(int)serverKeyIndex;

- (NSString*)serverKeyFingerprintMD5:(int)serverKeyIndex;

- (NSString*)serverKeyFingerprintSHA1:(int)serverKeyIndex;

- (long long)serverKeyHandle:(int)serverKeyIndex;
- (void)setServerKeyHandle:(int)serverKeyIndex :(long long)newServerKeyHandle;

Default Value

False

Remarks

Use this property to provide a list of SSH private keys for the server endpoint.

An SSH endpoint needs a private key to be able to accept secure connections. Apart from being employed for the handshake, the key is also used as a unique server identifier.

The collection may include more than one endpoint key. A typical usage scenario is to include two or three keys (ECDSA, RSA, and DSS), to cater for clients with different algorithm preferences.

SocketSettings Property (SFTPServer Module)

Manages network connection settings.

Syntax

• Swift
• Objective-C

public var socketSettings: SocketSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=socketIncomingSpeedLimit,setter=setSocketIncomingSpeedLimit:) int socketIncomingSpeedLimit;

- (int)socketIncomingSpeedLimit;
- (void)setSocketIncomingSpeedLimit :(int)newSocketIncomingSpeedLimit;

@property (nonatomic,readwrite,assign,getter=socketLocalAddress,setter=setSocketLocalAddress:) NSString* socketLocalAddress;

- (NSString*)socketLocalAddress;
- (void)setSocketLocalAddress :(NSString*)newSocketLocalAddress;

@property (nonatomic,readwrite,assign,getter=socketLocalPort,setter=setSocketLocalPort:) int socketLocalPort;

- (int)socketLocalPort;
- (void)setSocketLocalPort :(int)newSocketLocalPort;

@property (nonatomic,readwrite,assign,getter=socketOutgoingSpeedLimit,setter=setSocketOutgoingSpeedLimit:) int socketOutgoingSpeedLimit;

- (int)socketOutgoingSpeedLimit;
- (void)setSocketOutgoingSpeedLimit :(int)newSocketOutgoingSpeedLimit;

@property (nonatomic,readwrite,assign,getter=socketTimeout,setter=setSocketTimeout:) int socketTimeout;

- (int)socketTimeout;
- (void)setSocketTimeout :(int)newSocketTimeout;

@property (nonatomic,readwrite,assign,getter=socketUseIPv6,setter=setSocketUseIPv6:) BOOL socketUseIPv6;

- (BOOL)socketUseIPv6;
- (void)setSocketUseIPv6 :(BOOL)newSocketUseIPv6;

 

Default Value

False

Remarks

Use this property to tune up network connection parameters.

SSHSettings Property (SFTPServer Module)

The SSH connection settings.

Syntax

• Swift
• Objective-C

public var sshSettings: SSHSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=SSHSettingsAutoAdjustCiphers,setter=setSSHSettingsAutoAdjustCiphers:) BOOL SSHSettingsAutoAdjustCiphers;

- (BOOL)SSHSettingsAutoAdjustCiphers;
- (void)setSSHSettingsAutoAdjustCiphers :(BOOL)newSSHSettingsAutoAdjustCiphers;

@property (nonatomic,readwrite,assign,getter=SSHSettingsBaseConfiguration,setter=setSSHSettingsBaseConfiguration:) int SSHSettingsBaseConfiguration;

- (int)SSHSettingsBaseConfiguration;
- (void)setSSHSettingsBaseConfiguration :(int)newSSHSettingsBaseConfiguration;

@property (nonatomic,readwrite,assign,getter=SSHSettingsCompressionAlgorithms,setter=setSSHSettingsCompressionAlgorithms:) NSString* SSHSettingsCompressionAlgorithms;

- (NSString*)SSHSettingsCompressionAlgorithms;
- (void)setSSHSettingsCompressionAlgorithms :(NSString*)newSSHSettingsCompressionAlgorithms;

@property (nonatomic,readwrite,assign,getter=SSHSettingsCompressionLevel,setter=setSSHSettingsCompressionLevel:) int SSHSettingsCompressionLevel;

- (int)SSHSettingsCompressionLevel;
- (void)setSSHSettingsCompressionLevel :(int)newSSHSettingsCompressionLevel;

@property (nonatomic,readwrite,assign,getter=SSHSettingsDefaultWindowSize,setter=setSSHSettingsDefaultWindowSize:) int SSHSettingsDefaultWindowSize;

- (int)SSHSettingsDefaultWindowSize;
- (void)setSSHSettingsDefaultWindowSize :(int)newSSHSettingsDefaultWindowSize;

@property (nonatomic,readwrite,assign,getter=SSHSettingsEncryptionAlgorithms,setter=setSSHSettingsEncryptionAlgorithms:) NSString* SSHSettingsEncryptionAlgorithms;

- (NSString*)SSHSettingsEncryptionAlgorithms;
- (void)setSSHSettingsEncryptionAlgorithms :(NSString*)newSSHSettingsEncryptionAlgorithms;

@property (nonatomic,readwrite,assign,getter=SSHSettingsForceCompression,setter=setSSHSettingsForceCompression:) BOOL SSHSettingsForceCompression;

- (BOOL)SSHSettingsForceCompression;
- (void)setSSHSettingsForceCompression :(BOOL)newSSHSettingsForceCompression;

@property (nonatomic,readwrite,assign,getter=SSHSettingsGSSAuthTypes,setter=setSSHSettingsGSSAuthTypes:) NSString* SSHSettingsGSSAuthTypes;

- (NSString*)SSHSettingsGSSAuthTypes;
- (void)setSSHSettingsGSSAuthTypes :(NSString*)newSSHSettingsGSSAuthTypes;

@property (nonatomic,readwrite,assign,getter=SSHSettingsGSSDelegateCreds,setter=setSSHSettingsGSSDelegateCreds:) BOOL SSHSettingsGSSDelegateCreds;

- (BOOL)SSHSettingsGSSDelegateCreds;
- (void)setSSHSettingsGSSDelegateCreds :(BOOL)newSSHSettingsGSSDelegateCreds;

@property (nonatomic,readwrite,assign,getter=SSHSettingsGSSHostname,setter=setSSHSettingsGSSHostname:) NSString* SSHSettingsGSSHostname;

- (NSString*)SSHSettingsGSSHostname;
- (void)setSSHSettingsGSSHostname :(NSString*)newSSHSettingsGSSHostname;

@property (nonatomic,readwrite,assign,getter=SSHSettingsGSSLib,setter=setSSHSettingsGSSLib:) NSString* SSHSettingsGSSLib;

- (NSString*)SSHSettingsGSSLib;
- (void)setSSHSettingsGSSLib :(NSString*)newSSHSettingsGSSLib;

@property (nonatomic,readwrite,assign,getter=SSHSettingsGSSMechanisms,setter=setSSHSettingsGSSMechanisms:) NSString* SSHSettingsGSSMechanisms;

- (NSString*)SSHSettingsGSSMechanisms;
- (void)setSSHSettingsGSSMechanisms :(NSString*)newSSHSettingsGSSMechanisms;

@property (nonatomic,readwrite,assign,getter=SSHSettingsGSSProtocols,setter=setSSHSettingsGSSProtocols:) NSString* SSHSettingsGSSProtocols;

- (NSString*)SSHSettingsGSSProtocols;
- (void)setSSHSettingsGSSProtocols :(NSString*)newSSHSettingsGSSProtocols;

@property (nonatomic,readwrite,assign,getter=SSHSettingsHandshakeTimeout,setter=setSSHSettingsHandshakeTimeout:) int SSHSettingsHandshakeTimeout;

- (int)SSHSettingsHandshakeTimeout;
- (void)setSSHSettingsHandshakeTimeout :(int)newSSHSettingsHandshakeTimeout;

@property (nonatomic,readwrite,assign,getter=SSHSettingsKexAlgorithms,setter=setSSHSettingsKexAlgorithms:) NSString* SSHSettingsKexAlgorithms;

- (NSString*)SSHSettingsKexAlgorithms;
- (void)setSSHSettingsKexAlgorithms :(NSString*)newSSHSettingsKexAlgorithms;

@property (nonatomic,readwrite,assign,getter=SSHSettingsMacAlgorithms,setter=setSSHSettingsMacAlgorithms:) NSString* SSHSettingsMacAlgorithms;

- (NSString*)SSHSettingsMacAlgorithms;
- (void)setSSHSettingsMacAlgorithms :(NSString*)newSSHSettingsMacAlgorithms;

@property (nonatomic,readwrite,assign,getter=SSHSettingsMaxSSHPacketSize,setter=setSSHSettingsMaxSSHPacketSize:) int SSHSettingsMaxSSHPacketSize;

- (int)SSHSettingsMaxSSHPacketSize;
- (void)setSSHSettingsMaxSSHPacketSize :(int)newSSHSettingsMaxSSHPacketSize;

@property (nonatomic,readwrite,assign,getter=SSHSettingsMinWindowSize,setter=setSSHSettingsMinWindowSize:) int SSHSettingsMinWindowSize;

- (int)SSHSettingsMinWindowSize;
- (void)setSSHSettingsMinWindowSize :(int)newSSHSettingsMinWindowSize;

@property (nonatomic,readwrite,assign,getter=SSHSettingsObfuscateHandshake,setter=setSSHSettingsObfuscateHandshake:) BOOL SSHSettingsObfuscateHandshake;

- (BOOL)SSHSettingsObfuscateHandshake;
- (void)setSSHSettingsObfuscateHandshake :(BOOL)newSSHSettingsObfuscateHandshake;

@property (nonatomic,readwrite,assign,getter=SSHSettingsObfuscationPassword,setter=setSSHSettingsObfuscationPassword:) NSString* SSHSettingsObfuscationPassword;

- (NSString*)SSHSettingsObfuscationPassword;
- (void)setSSHSettingsObfuscationPassword :(NSString*)newSSHSettingsObfuscationPassword;

@property (nonatomic,readwrite,assign,getter=SSHSettingsPublicKeyAlgorithms,setter=setSSHSettingsPublicKeyAlgorithms:) NSString* SSHSettingsPublicKeyAlgorithms;

- (NSString*)SSHSettingsPublicKeyAlgorithms;
- (void)setSSHSettingsPublicKeyAlgorithms :(NSString*)newSSHSettingsPublicKeyAlgorithms;

@property (nonatomic,readwrite,assign,getter=SSHSettingsRequestPasswordChange,setter=setSSHSettingsRequestPasswordChange:) BOOL SSHSettingsRequestPasswordChange;

- (BOOL)SSHSettingsRequestPasswordChange;
- (void)setSSHSettingsRequestPasswordChange :(BOOL)newSSHSettingsRequestPasswordChange;

@property (nonatomic,readwrite,assign,getter=SSHSettingsSoftwareName,setter=setSSHSettingsSoftwareName:) NSString* SSHSettingsSoftwareName;

- (NSString*)SSHSettingsSoftwareName;
- (void)setSSHSettingsSoftwareName :(NSString*)newSSHSettingsSoftwareName;

@property (nonatomic,readwrite,assign,getter=SSHSettingsTrustAllKeys,setter=setSSHSettingsTrustAllKeys:) BOOL SSHSettingsTrustAllKeys;

- (BOOL)SSHSettingsTrustAllKeys;
- (void)setSSHSettingsTrustAllKeys :(BOOL)newSSHSettingsTrustAllKeys;

@property (nonatomic,readwrite,assign,getter=SSHSettingsUseAuthAgent,setter=setSSHSettingsUseAuthAgent:) BOOL SSHSettingsUseAuthAgent;

- (BOOL)SSHSettingsUseAuthAgent;
- (void)setSSHSettingsUseAuthAgent :(BOOL)newSSHSettingsUseAuthAgent;

@property (nonatomic,readwrite,assign,getter=SSHSettingsVersions,setter=setSSHSettingsVersions:) int SSHSettingsVersions;

- (int)SSHSettingsVersions;
- (void)setSSHSettingsVersions :(int)newSSHSettingsVersions;

 

Default Value

False

Remarks

Use this property to access and tune-up the SSH layer settings.

Users Property (SFTPServer Module)

A collection of known users.

Syntax

• Swift
• Objective-C

public var users: Array<UserAccount> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=userCount,setter=setUserCount:) int userCount;

- (int)userCount;
- (void)setUserCount :(int)newUserCount;

- (NSData*)userAssociatedData:(int)userIndex;
- (void)setUserAssociatedData:(int)userIndex :(NSData*)newUserAssociatedData;

- (NSString*)userBasePath:(int)userIndex;
- (void)setUserBasePath:(int)userIndex :(NSString*)newUserBasePath;

- (NSData*)userCert:(int)userIndex;
- (void)setUserCert:(int)userIndex :(NSData*)newUserCert;

- (NSString*)userData:(int)userIndex;
- (void)setUserData:(int)userIndex :(NSString*)newUserData;

- (long long)userHandle:(int)userIndex;
- (void)setUserHandle:(int)userIndex :(long long)newUserHandle;

- (NSString*)userHashAlgorithm:(int)userIndex;
- (void)setUserHashAlgorithm:(int)userIndex :(NSString*)newUserHashAlgorithm;

- (int)userIncomingSpeedLimit:(int)userIndex;
- (void)setUserIncomingSpeedLimit:(int)userIndex :(int)newUserIncomingSpeedLimit;

- (int)userOtpAlgorithm:(int)userIndex;
- (void)setUserOtpAlgorithm:(int)userIndex :(int)newUserOtpAlgorithm;

- (int)userOtpValue:(int)userIndex;
- (void)setUserOtpValue:(int)userIndex :(int)newUserOtpValue;

- (int)userOutgoingSpeedLimit:(int)userIndex;
- (void)setUserOutgoingSpeedLimit:(int)userIndex :(int)newUserOutgoingSpeedLimit;

- (NSString*)userPassword:(int)userIndex;
- (void)setUserPassword:(int)userIndex :(NSString*)newUserPassword;

- (int)userPasswordLen:(int)userIndex;
- (void)setUserPasswordLen:(int)userIndex :(int)newUserPasswordLen;

- (NSData*)userSharedSecret:(int)userIndex;
- (void)setUserSharedSecret:(int)userIndex :(NSData*)newUserSharedSecret;

- (NSData*)userSSHKey:(int)userIndex;
- (void)setUserSSHKey:(int)userIndex :(NSData*)newUserSSHKey;

- (NSString*)userUsername:(int)userIndex;
- (void)setUserUsername:(int)userIndex :(NSString*)newUserUsername;

Default Value

False

Remarks

This property provides access to registered user database.

UseUTF8 Property (SFTPServer Module)

Specifies whether UTF8 conversion is to be used when parsing file names.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=useUTF8,setter=setUseUTF8:) BOOL useUTF8;

- (BOOL)useUTF8;
- (void)setUseUTF8 :(BOOL)newUseUTF8;

Default Value

False

Remarks

This property specifies whether UTF8 conversion of filenames is used by the server. It is set automatically according to protocol flow, but user could also set it to the desired value.

Config Method (SFTPServer Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

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.

DoAction Method (SFTPServer Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)actionParams;

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insencitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DropClient Method (SFTPServer Module)

Terminates a client connection.

Syntax

• Swift
• Objective-C

public func dropClient(connectionId: Int32, forced: Bool) throws -> Void

- (void)dropClient:(int)connectionId :(BOOL)forced;

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetClientBuffer Method (SFTPServer Module)

Acquires a piece of operation data.

Syntax

• Swift
• Objective-C

public func getClientBuffer(connectionID: Int64, handle: String) throws -> Data

- (NSData*)getClientBuffer:(long long)connectionID :(NSString*)handle;

Remarks

Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.

A typical place to call this method is inside the WriteFile event handler, when implementing customized file transfers.

GetClientFileEntry Method (SFTPServer Module)

Acquires file entry details from the component.

Syntax

• Swift
• Objective-C

public func getClientFileEntry(connectionID: Int64, handle: String) throws -> Void

- (void)getClientFileEntry:(long long)connectionID :(NSString*)handle;

Remarks

Use this method to acquire the details of a file entry from the server in atomic and thread-safe way. After this method completes, the entry details will be propagated in ClientFileEntry property.

When calling this method, pass the client connection ID in ConnectionID property, and the opened file handle (if needed) in Handle property.

ListClients Method (SFTPServer Module)

Enumerates the connected clients.

Syntax

• Swift
• Objective-C

public func listClients() throws -> String

- (NSString*)listClients;

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (SFTPServer Module)

Takes a snapshot of the connection's properties.

Syntax

• Swift
• Objective-C

public func pinClient(connectionId: Int32) throws -> Void

- (void)pinClient:(int)connectionId;

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient property.

SetClientBuffer Method (SFTPServer Module)

Commits a data buffer to the server component.

Syntax

• Swift
• Objective-C

public func setClientBuffer(connectionID: Int64, handle: String, value: Data) throws -> Void

- (void)setClientBuffer:(long long)connectionID :(NSString*)handle :(NSData*)value;

Remarks

Use this method to commit a data buffer passed via the Value parameter to the server control in a thread-safe way.

One example where you might need to pass your buffer to the server is when customizing upload operations via ReadFile event.

SetClientFileEntry Method (SFTPServer Module)

Commits the file entry details to the component.

Syntax

• Swift
• Objective-C

public func setClientFileEntry(connectionID: Int64, handle: String) throws -> Void

- (void)setClientFileEntry:(long long)connectionID :(NSString*)handle;

Remarks

Use this method to commit the file entry details configured in ClientFileEntry property to the server object in a thread-safe way. Pass the client's connection ID via ConnectionID property, and the file entry's handle via Handle.

Start Method (SFTPServer Module)

Starts SFTP server operation.

Syntax

• Swift
• Objective-C

public func start() throws -> Void

- (void)start;

Remarks

Call this method to start listening to incoming connections.

Stop Method (SFTPServer Module)

Stops SFTP server.

Syntax

• Swift
• Objective-C

public func stop() throws -> Void

- (void)stop;

Remarks

Call this method to close all connections and stop listening to clients.

Accept Event (SFTPServer Module)

This event is fired when new incoming connection is accepted.

Syntax

• Swift
• Objective-C

func onAccept(remoteAddress: String, remotePort: Int32, accept: inout Bool)

- (void)onAccept:(NSString*)remoteAddress :(int)remotePort :(int*)accept;

Remarks

This event is fired by the class before a new incoming connection is accepted. RemoteAddress contains the IP address of the connecting client. Use the Accept parameter to either accept, or reject the connection.

AfterCreateDirectory Event (SFTPServer Module)

This event indicates completion of directory creation request.

Syntax

• Swift
• Objective-C

func onAfterCreateDirectory(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterCreateDirectory:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

This event is fired to report completion of a directory creation request. The ConnectionID parameter specifies in which session the request was received, the Path specifies the directory path, and the OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRemove Event (SFTPServer Module)

This event indicates completion of file removal request.

Syntax

• Swift
• Objective-C

func onAfterRemove(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterRemove:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

This event is fired when a request to delete a file or directory has been processed by the server. The ConnectionID parameter specifies the session in which the request was received. OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRenameFile Event (SFTPServer Module)

This event indicates completion of a file rename operation.

Syntax

• Swift
• Objective-C

func onAfterRenameFile(connectionID: Int64, oldPath: String, newPath: String, operationStatus: inout Int32)

- (void)onAfterRenameFile:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(int*)operationStatus;

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) has been processed. The ConnectionID parameter specifies in which session the request was received, and OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRequestAttributes Event (SFTPServer Module)

This event indicates completion of file attributes request.

Syntax

• Swift
• Objective-C

func onAfterRequestAttributes(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterRequestAttributes:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

This event is fired when a request for get file attributes has been processed by the server. The ConnectionID parameter specifies in which session the request was received. OperationStatus contains the result of the operation.

If needed, you can amend the OperationStatus to return a different operation result:

AfterSetAttributes Event (SFTPServer Module)

This event indicates completion of a set attributes request.

Syntax

• Swift
• Objective-C

func onAfterSetAttributes(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onAfterSetAttributes:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

This event is fired when a request for set file attributes has been processed. The ConnectionID parameter specifies in which session the request was received. The OperationStatus parameter contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AuthAttempt Event (SFTPServer Module)

Reports a user authentication attempt.

Syntax

• Swift
• Objective-C

func onAuthAttempt(connectionID: Int64, username: String, authType: Int32, accept: inout Bool)

- (void)onAuthAttempt:(long long)connectionID :(NSString*)username :(int)authType :(int*)accept;

Remarks

ConnectionID identifies the session, Username specifies client's username, and AuthType specifies the authentication type. Use the Accept parameter to accept or decline the attempt.

Supported authentication types:

AuthFailed Event (SFTPServer Module)

Reports user authentication failure.

Syntax

• Swift
• Objective-C

func onAuthFailed(connectionID: Int64, username: String, authType: Int32)

- (void)onAuthFailed:(long long)connectionID :(NSString*)username :(int)authType;

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

AuthPassword Event (SFTPServer Module)

This event is fired on password authentication attempt from a client.

Syntax

• Swift
• Objective-C

func onAuthPassword(connectionID: Int64, username: String, password: String, accept: inout Bool, forceChangePassword: inout Bool)

- (void)onAuthPassword:(long long)connectionID :(NSString*)username :(NSString*)password :(int*)accept :(int*)forceChangePassword;

Remarks

Parameters Username and Password contain user credentials. If they are correct, set Accept to true. You can request password change by setting ForceChangePassword to true.

AuthPublicKey Event (SFTPServer Module)

This event is fired on public key authentication attempt from a client.

Syntax

• Swift
• Objective-C

func onAuthPublicKey(connectionID: Int64, username: String, accept: inout Bool)

- (void)onAuthPublicKey:(long long)connectionID :(NSString*)username :(int*)accept;

Remarks

Username specifies client's username, and Accept is used to accept or reject authentication.

AuthSucceeded Event (SFTPServer Module)

Reports a successful user authentication.

Syntax

• Swift
• Objective-C

func onAuthSucceeded(connectionID: Int64, username: String, authType: Int32)

- (void)onAuthSucceeded:(long long)connectionID :(NSString*)username :(int)authType;

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

BeforeCreateDirectory Event (SFTPServer Module)

This event is fired when a client requests to create a directory.

Syntax

• Swift
• Objective-C

func onBeforeCreateDirectory(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeCreateDirectory:(long long)connectionID :(NSString*)path :(int*)action;

Remarks

This event is fired when a request to create a directory has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeDownloadFile Event (SFTPServer Module)

This event is fired when a download file request is received.

Syntax

• Swift
• Objective-C

func onBeforeDownloadFile(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeDownloadFile:(long long)connectionID :(NSString*)path :(int*)action;

Remarks

This event is fired when a request to download file is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeFind Event (SFTPServer Module)

This event is fired when a client requests to find files and folders in Path.

Syntax

• Swift
• Objective-C

func onBeforeFind(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeFind:(long long)connectionID :(NSString*)path :(int*)action;

Remarks

This event is fired when a request to find files and folders in Path has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeRemove Event (SFTPServer Module)

This event is fired when a client requests to delete a file or directory.

Syntax

• Swift
• Objective-C

func onBeforeRemove(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeRemove:(long long)connectionID :(NSString*)path :(int*)action;

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeRenameFile Event (SFTPServer Module)

This event is fired when a client requests to rename a file.

Syntax

• Swift
• Objective-C

func onBeforeRenameFile(connectionID: Int64, oldPath: String, newPath: String, action: inout Int32)

- (void)onBeforeRenameFile:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(int*)action;

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeRequestAttributes Event (SFTPServer Module)

This event is fired when a client requests to get file attributes.

Syntax

• Swift
• Objective-C

func onBeforeRequestAttributes(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeRequestAttributes:(long long)connectionID :(NSString*)path :(int*)action;

Remarks

This event is fired when a request to get file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeSetAttributes Event (SFTPServer Module)

This event is fired when a client requests to set file attributes.

Syntax

• Swift
• Objective-C

func onBeforeSetAttributes(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeSetAttributes:(long long)connectionID :(NSString*)path :(int*)action;

Remarks

This event is fired when a request to set file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeUploadFile Event (SFTPServer Module)

This event is fired when an upload file request is received.

Syntax

• Swift
• Objective-C

func onBeforeUploadFile(connectionID: Int64, path: String, action: inout Int32)

- (void)onBeforeUploadFile:(long long)connectionID :(NSString*)path :(int*)action;

Remarks

This event is fired when an upload file request is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location on the server where the file needs to be saved.

Choose Action as one of the following values:

CloseFile Event (SFTPServer Module)

This event instructs the application to close an opened file.

Syntax

• Swift
• Objective-C

func onCloseFile(connectionID: Int64, handle: String, operationStatus: inout Int32)

- (void)onCloseFile:(long long)connectionID :(NSString*)handle :(int*)operationStatus;

Remarks

This event is fired upon receipt of a close-file packet from a client. Servers implementing virtualized transfers must close the previously opened local file referenced by Handle in this event handler. No further operations are allowed with the closed file.

Set OperationStatus to one of the following values to report the result of this operation to the client:

Connect Event (SFTPServer Module)

This event is fired when a remote connection has been established.

Syntax

• Swift
• Objective-C

func onConnect(connectionID: Int64, remoteAddress: String, remotePort: Int32)

- (void)onConnect:(long long)connectionID :(NSString*)remoteAddress :(int)remotePort;

Remarks

ConnectionID contains a session identifier, and RemoteAddress specifies the client's IP address.

CreateDirectory Event (SFTPServer Module)

This event instructs the application to create a directory.

Syntax

• Swift
• Objective-C

func onCreateDirectory(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onCreateDirectory:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

This event is fired when a request to create a directory has been received and needs to be served (virtualized) by the application. The ConnectionID parameter specifies the session that has communicated the request, and Path contains the name of the directory to be created.

Set OperationStatus to one of the below values according to the outcome of the request processing:

Disconnect Event (SFTPServer Module)

This event is fired when a client has disconnected.

Syntax

• Swift
• Objective-C

func onDisconnect(connectionID: Int64)

- (void)onDisconnect:(long long)connectionID;

Remarks

This event reports loss of connection to the client within the session specified by ConnectionID.

Error Event (SFTPServer Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The event is fired in case of exceptional conditions during message processing.

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

ExternalSign Event (SFTPServer Module)

Handles remote or external signing initiated by the server protocol.

Syntax

• Swift
• Objective-C

func onExternalSign(connectionID: Int64, operationId: String, hashAlgorithm: String, pars: String, data: String, signedData: inout String)

- (void)onExternalSign:(long long)connectionID :(NSString*)operationId :(NSString*)hashAlgorithm :(NSString*)pars :(NSString*)data :(NSString**)signedData;

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FindClose Event (SFTPServer Module)

This event signifies the completion of a custom file listing operation.

Syntax

• Swift
• Objective-C

func onFindClose(connectionID: Int64, handle: String, operationStatus: inout Int32)

- (void)onFindClose:(long long)connectionID :(NSString*)handle :(int*)operationStatus;

Remarks

FindClose notifies your code about the completion of a custom file listing request. Use it in conjunction with FindFirst and FindNext to handle file listing requests manually.

See FindFirst topic for the details on implementing customized file listing request processing.

Set OperationStatus to one of the below values according to the outcome of the request processing:

FindFirst Event (SFTPServer Module)

This event signifies the start of the custom file listing retrieval mechanism.

Syntax

• Swift
• Objective-C

func onFindFirst(connectionID: Int64, path: String, operationStatus: inout Int32, handle: inout String)

- (void)onFindFirst:(long long)connectionID :(NSString*)path :(int*)operationStatus :(NSString**)handle;

Remarks

FindFirst, FindNext, and FindClose events represent a mechanism for providing customized file listings to class. They are only fired if Action parameter of the preceding BeforeFind event was set to fraCustom.

The behaviour of these events mimics that of the standard FindFirst/FindNext/FindClose functions found in many operating systems/frameworks. FindFirst fires once to request the first list entry; FindNext then fires continuously in a loop to request all subsequent entries. To indicate that the listing is over, set OperationStatus parameter to ostEOF. Not doing so may lead to an endless loop and session freeze, as the component would continue firing FindNext infinitely waiting for the EOF marker.

The handlers for both FindFirst and FindNext events should be implemented in the following way: if there are more entries in the directory to pass back to the server component,

• set OperationStatus to ostOK,
• fill in ClientFileEntry with the details of the next entry,
• commit the entry to the server using SetClientFileEntry method.

Use the by-ref Handle parameter to assign a handle (a unique identifier) to the file listing procedure inside the FindFirst event handler. This identifier will then be passed to all subsequent FindNext and FindClose calls to let your code chain the events together.

The ConnectionID parameter specifies in which SFTP session the request was received, and Path indicates the requested directory.

The following operation status constants are available, besides the ones referenced above:

FindNext Event (SFTPServer Module)

This event retrieves the next entry of a custom file listing.

Syntax

• Swift
• Objective-C

func onFindNext(connectionID: Int64, handle: String, operationStatus: inout Int32)

- (void)onFindNext:(long long)connectionID :(NSString*)handle :(int*)operationStatus;

Remarks

This event is fired repeatedly after FindFirst to retrieve the directory contents entry-by-entry. Please see the FindFirst topic for more details about implementing a handler of this event.

Remember to set OperationStatus to ostEOF when there are no more entries left to close the listing operation. If there are more entries to pass, set it to ostOK. Other possible values are given in the table below:

Notification Event (SFTPServer Module)

This event notifies the application about an underlying control flow event.

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

OpenFile Event (SFTPServer Module)

This event instructs the application to handle the file open request.

Syntax

• Swift
• Objective-C

func onOpenFile(connectionID: Int64, path: String, modes: Int32, access: Int32, operationStatus: inout Int32, handle: inout String)

- (void)onOpenFile:(long long)connectionID :(NSString*)path :(int)modes :(int)access :(int*)operationStatus :(NSString**)handle;

Remarks

This event is fired when a file open request is received from the client and needs to be handled (virtualized) by the server. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location of the file.

Modes can be a combination of one or several file open mode flags:

Different client applications may provide different selections of mode flags. For example, some clients specify (cfmCreate + cfmTruncate) when overwriting files, whereas others would specify cfmOpenOrCreate. Please make sure your code is prepared to receive different combinations of flags here and handles them gracefully.

The Access parameter provides additional file access modifiers:

The Handle string represents a unique identifier of the opened file, similar to file handles used in Windows or Unix APIs. Handles are unique across all files opened at the same time. Class generates handles automatically, but you can update the auto-generated values with your own in this event handler (just remember to keep them unique).

Set OperationStatus parameter in accordance with the outcome of the operation to one of the values given below:

ReadFile Event (SFTPServer Module)

This event is fired when a file read request is received.

Syntax

• Swift
• Objective-C

func onReadFile(connectionID: Int64, handle: String, offset: Int64, size: Int32, operationStatus: inout Int32)

- (void)onReadFile:(long long)connectionID :(NSString*)handle :(long long)offset :(int)size :(int*)operationStatus;

Remarks

This event is fired when a request to read block from a file is received from the client. The ConnectionID parameter specifies in which session the request was received, and Handle indicates an opened file handle. Offset and Size denote the location and size of the file piece.

Inside the event handler, pass the appropriate file chunk to the component via SetClientBuffer method.

Set OperationStatus to one of the below values according to the outcome of the request processing:

Remove Event (SFTPServer Module)

This event is fired when a client requests to delete a file or directory.

Syntax

• Swift
• Objective-C

func onRemove(connectionID: Int64, path: String, operationStatus: inout Int32)

- (void)onRemove:(long long)connectionID :(NSString*)path :(int*)operationStatus;

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

RenameFile Event (SFTPServer Module)

This event is fired when a client requests to rename a file.

Syntax

• Swift
• Objective-C

func onRenameFile(connectionID: Int64, oldPath: String, newPath: String, operationStatus: inout Int32)

- (void)onRenameFile:(long long)connectionID :(NSString*)oldPath :(NSString*)newPath :(int*)operationStatus;

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

RequestAttributes Event (SFTPServer Module)

This event is fired when a get file attributes request is received.

Syntax

• Swift
• Objective-C

func onRequestAttributes(connectionID: Int64, path: String, handle: String, operationStatus: inout Int32)

- (void)onRequestAttributes:(long long)connectionID :(NSString*)path :(NSString*)handle :(int*)operationStatus;

Remarks

This event is fired when a request to get file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location where the attributes need to be retrieved.

Set OperationStatus to one of the below values according to the outcome of the request processing:

SessionClosed Event (SFTPServer Module)

Reports session closure.

Syntax

• Swift
• Objective-C

func onSessionClosed(connectionID: Int64)

- (void)onSessionClosed:(long long)connectionID;

Remarks

This event is fired when a connection identified by ConnectionID has been gracefully closed.

SessionEstablished Event (SFTPServer Module)

This event is fired when a new session is established.

Syntax

• Swift
• Objective-C

func onSessionEstablished(connectionID: Int64)

- (void)onSessionEstablished:(long long)connectionID;

Remarks

This event is fired when a new connection identified by ConnectionID has been established with a client.

SetAttributes Event (SFTPServer Module)

This event is fired when an set file attributes request is received.

Syntax

• Swift
• Objective-C

func onSetAttributes(connectionID: Int64, path: String, handle: String, operationStatus: inout Int32)

- (void)onSetAttributes:(long long)connectionID :(NSString*)path :(NSString*)handle :(int*)operationStatus;

Remarks

This event is fired when a request to set file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location which the attributes needs to be set.

Set OperationStatus to one of the below values according to the outcome of the request processing:

TranslatePath Event (SFTPServer Module)

This event is fired when a client requests the server to translate a path to its absolute form.

Syntax

• Swift
• Objective-C

func onTranslatePath(connectionID: Int64, path: String, absolutePath: inout String, action: inout Int32)

- (void)onTranslatePath:(long long)connectionID :(NSString*)path :(NSString**)absolutePath :(int*)action;

Remarks

This event is fired when a request to translate a relative path to the corresponding absolute path is received. The ConnectionID parameter specifies the session in which the request was received.

You can let the server do the translation automatically according to the default file system rules, or take care of it yourself. Use the Action parameter to specify who is responsible for the translation. If doing the translation manually, return the translated path via the AbsolutePath parameter. Action can take one of the following values:

WriteFile Event (SFTPServer Module)

This event is fired when a file write request is received.

Syntax

• Swift
• Objective-C

func onWriteFile(connectionID: Int64, handle: String, offset: Int64, operationStatus: inout Int32)

- (void)onWriteFile:(long long)connectionID :(NSString*)handle :(long long)offset :(int*)operationStatus;

Remarks

This event is fired when a request to write a data block to a file is received from the client. The ConnectionID parameter specifies the session the request originates from. The Handle parameter references the opened file where the block should be written to. Offset references the position in the file where the block of data should be written.

Use GetClientBuffer method to obtain the piece of data that should be written to the file.

Set OperationStatus to one of the below values according to the outcome of the request processing:

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

public init()

Creates a new ExternalCrypto object with default field values.

SFTPListEntry Type

A container for filesystem element's attributes.

Remarks

This type contains attributes of a single entry returned by a ListDir command.

The contents of this container may differ for different servers (not all servers support all attributes).

Fields

Constructors

public init()

Creates a new SFTPListEntry object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

public init()

Creates a new SocketSettings object.

SSHClientEntry Type

Contains information about an accepted SSH connection.

Remarks

SSHClientEntry object contains information about one accepted SSH connection.

Fields

Constructors

public init()

Creates an empty object representing a SSH connection entry.

SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

Fields

Constructors

public init()

Creates a new key.

SSHSettings Type

A container for various SSH protocol settings.

Remarks

SSHSettings stores various settings of SSH client or server.

Fields

Constructors

public init()

Creates a new object with default settings.

UserAccount Type

A container for user account information.

Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

Fields

Constructors

public init()

Creates a new UserAccount object.

Config Settings (SFTPServer Module)

SFTPServer Config Settings

Base Config Settings

Trappable Errors (SFTPServer Module)

SFTPServer Errors