FTPClient Module

Properties   Methods   Events   Config Settings   Errors  

The FTPClient module provides client-side functionality for FTP and FTPS protocols.

Syntax

SecureBlackbox.Ftpclient

Remarks

FTPClient provides client-side support for the FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations with a remote server over Transport Layer Security (TLS).

Note: TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.

FTPClient is typically used in the following scenario:

• Setting up the connection parameters
• Connecting to the server and signing in
• Performing file transfer operations
• Closing the connection

Setting up the parameters

• Login credentials: these can be tuned up via the Username and Password properties.
• TLS settings: these includes the TLS mode: explicit, implicit, or no TLS. You must get this setting right; otherwise you may not be able to connect. Use TLSSettings property to adjust this setting.
• If your server requires you to authenticate with a certificate, you can provide one via the ClientChain property.
• FTPClient validates the server certificate against the local security settings. If your server uses a custom or non-public PKI, you may need to provide the required trust anchors and CA certificates via the TrustedCertificates and KnownCertificates collections.
• FTP protocol includes its own set of settings, such as PassiveMode, EncryptDataChannel, or AdjustPasvAddress. These may be configured on this stage, or later into the connection.
• In some network environments, you may also need to make adjustments to SocketSettings and Proxy.

Connecting to the server and signing in

Performing file transfer operations

Note that unlike SFTP, FTP only supports one transfer operation at a time. An ongoing operation should be completed or aborted before a new one can be started.

Closing the connection

Useful info

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.

AccountInfo Property (FTPClient Module)

Parameters for the ACCT command.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=accountInfo,setter=setAccountInfo:) NSString* accountInfo;

- (NSString*)accountInfo;
- (void)setAccountInfo :(NSString*)newAccountInfo;

Default Value

""

Remarks

Specifies the parameter for ACCT command. If AccountInfo is set, the client automatically sends ACCT command to the server during authentication.

AdjustPasvAddress Property (FTPClient Module)

Enables or disables automatic adjustment of passive-mode addresses.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=adjustPasvAddress,setter=setAdjustPasvAddress:) BOOL adjustPasvAddress;

- (BOOL)adjustPasvAddress;
- (void)setAdjustPasvAddress :(BOOL)newAdjustPasvAddress;

Default Value

True

Remarks

Occasional NAT'ed servers misbehave by returning local IP addresses in their PASV mode offers, which are not reachable from the outer network. Set this property to true to make the class enforce data connections to the same address as the control connection uses.

Note that sometimes (typically, with multi-faced FTP services aka FTP Clouds) you may need to disable this property to make the transfers work right.

BlockedCertificates Property (FTPClient Module)

The certificates that must be rejected as trust anchors.

Syntax

• Swift
• Objective-C

public var blockedCertificates: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=blockedCertCount,setter=setBlockedCertCount:) int blockedCertCount;

- (int)blockedCertCount;
- (void)setBlockedCertCount :(int)newBlockedCertCount;

- (NSData*)blockedCertBytes:(int)blockedCertIndex;

- (long long)blockedCertHandle:(int)blockedCertIndex;
- (void)setBlockedCertHandle:(int)blockedCertIndex :(long long)newBlockedCertHandle;

Default Value

""

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

ClientChain Property (FTPClient Module)

The TLS client certificate chain.

Syntax

• Swift
• Objective-C

public var clientChain: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=clientCertCount,setter=setClientCertCount:) int clientCertCount;

- (int)clientCertCount;
- (void)setClientCertCount :(int)newClientCertCount;

- (NSData*)clientCertBytes:(int)clientCertIndex;

- (long long)clientCertHandle:(int)clientCertIndex;
- (void)setClientCertHandle:(int)clientCertIndex :(long long)newClientCertHandle;

Default Value

""

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.

Use CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

Connected Property (FTPClient Module)

Indicates whether the module is connected to the server.

Syntax

• Swift
• Objective-C

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

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

- (BOOL)connected;

Default Value

False

Remarks

Use this property to check if the connection to server is active.

This property is read-only.

ControlChannelLog Property (FTPClient Module)

Contains the control channel log of the FTP session.

Syntax

• Swift
• Objective-C

public var controlChannelLog: String {
  get {...}
}

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

- (NSString*)controlChannelLog;

Default Value

""

Remarks

Use this property to access the FTP protocol log (client commands followed by server responses).

This property is read-only.

ControlConnectionInfo Property (FTPClient Module)

Returns the details of the control connection setup.

Syntax

• Swift
• Objective-C

public var controlConnectionInfo: ConnectionInfo {
  get {...}
}

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

- (BOOL)ctlConnInfoAEADCipher;

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

- (int)ctlConnInfoChainValidationDetails;

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

- (int)ctlConnInfoChainValidationResult;

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

- (NSString*)ctlConnInfoCiphersuite;

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

- (BOOL)ctlConnInfoClientAuthenticated;

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

- (BOOL)ctlConnInfoClientAuthRequested;

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

- (BOOL)ctlConnInfoConnectionEstablished;

@property (nonatomic,readonly,assign,getter=ctlConnInfoConnectionID) NSData* ctlConnInfoConnectionID;

- (NSData*)ctlConnInfoConnectionID;

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

- (NSString*)ctlConnInfoDigestAlgorithm;

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

- (NSString*)ctlConnInfoEncryptionAlgorithm;

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

- (BOOL)ctlConnInfoExportable;

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

- (NSString*)ctlConnInfoKeyExchangeAlgorithm;

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

- (int)ctlConnInfoKeyExchangeKeyBits;

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

- (NSString*)ctlConnInfoNamedECCurve;

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

- (BOOL)ctlConnInfoPFSCipher;

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

- (NSString*)ctlConnInfoPreSharedIdentityHint;

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

- (int)ctlConnInfoPublicKeyBits;

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

- (BOOL)ctlConnInfoResumedSession;

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

- (BOOL)ctlConnInfoSecureConnection;

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

- (BOOL)ctlConnInfoServerAuthenticated;

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

- (NSString*)ctlConnInfoSignatureAlgorithm;

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

- (int)ctlConnInfoSymmetricBlockSize;

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

- (int)ctlConnInfoSymmetricKeyBits;

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

- (long long)ctlConnInfoTotalBytesReceived;

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

- (long long)ctlConnInfoTotalBytesSent;

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

- (NSString*)ctlConnInfoValidationLog;

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

- (NSString*)ctlConnInfoVersion;

 

Default Value

""

Remarks

Use this property to learn about the control connection setup, such as protocol details and amounts of data transferred each way.

CurrentListEntry Property (FTPClient Module)

Contains the details of the file entry reported by ListEntry .

Syntax

• Swift
• Objective-C

public var currentListEntry: FTPListEntry {
  get {...}
}

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

- (int)currListEntryEntryFormat;

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

- (NSString*)currListEntryFileDate;

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

- (int)currListEntryFileType;

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

- (long long)currListEntryHandle;

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

- (NSString*)currListEntryName;

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

- (NSString*)currListEntryPath;

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

- (NSString*)currListEntryRawData;

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

- (long long)currListEntrySize;

 

Default Value

""

Remarks

A typical use of this property is to check it in ListEntry event handler. This property is updated with new details each time a new entry is processed.

DataConnectionInfo Property (FTPClient Module)

Returns the details of the data connection setup.

Syntax

• Swift
• Objective-C

public var dataConnectionInfo: ConnectionInfo {
  get {...}
}

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

- (BOOL)dataConnInfoAEADCipher;

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

- (int)dataConnInfoChainValidationDetails;

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

- (int)dataConnInfoChainValidationResult;

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

- (NSString*)dataConnInfoCiphersuite;

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

- (BOOL)dataConnInfoClientAuthenticated;

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

- (BOOL)dataConnInfoClientAuthRequested;

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

- (BOOL)dataConnInfoConnectionEstablished;

@property (nonatomic,readonly,assign,getter=dataConnInfoConnectionID) NSData* dataConnInfoConnectionID;

- (NSData*)dataConnInfoConnectionID;

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

- (NSString*)dataConnInfoDigestAlgorithm;

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

- (NSString*)dataConnInfoEncryptionAlgorithm;

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

- (BOOL)dataConnInfoExportable;

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

- (NSString*)dataConnInfoKeyExchangeAlgorithm;

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

- (int)dataConnInfoKeyExchangeKeyBits;

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

- (NSString*)dataConnInfoNamedECCurve;

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

- (BOOL)dataConnInfoPFSCipher;

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

- (NSString*)dataConnInfoPreSharedIdentityHint;

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

- (int)dataConnInfoPublicKeyBits;

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

- (BOOL)dataConnInfoResumedSession;

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

- (BOOL)dataConnInfoSecureConnection;

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

- (BOOL)dataConnInfoServerAuthenticated;

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

- (NSString*)dataConnInfoSignatureAlgorithm;

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

- (int)dataConnInfoSymmetricBlockSize;

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

- (int)dataConnInfoSymmetricKeyBits;

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

- (long long)dataConnInfoTotalBytesReceived;

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

- (long long)dataConnInfoTotalBytesSent;

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

- (NSString*)dataConnInfoValidationLog;

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

- (NSString*)dataConnInfoVersion;

 

Default Value

""

Remarks

Use this property to learn about the data connection setup, such as protocol details and amounts of data transferred each way.

EncryptDataChannel Property (FTPClient Module)

Enables or disables data channel encryption.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=encryptDataChannel,setter=setEncryptDataChannel:) BOOL encryptDataChannel;

- (BOOL)encryptDataChannel;
- (void)setEncryptDataChannel :(BOOL)newEncryptDataChannel;

Default Value

True

Remarks

Use this property to enable or disable data channel encryption. This property should be configured before Connect method is called.

ExternalCrypto Property (FTPClient 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

""

Remarks

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

FIPSMode Property (FTPClient 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.

KnownCertificates Property (FTPClient Module)

Additional certificates for chain validation.

Syntax

• Swift
• Objective-C

public var knownCertificates: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount;

- (int)knownCertCount;
- (void)setKnownCertCount :(int)newKnownCertCount;

- (NSData*)knownCertBytes:(int)knownCertIndex;

- (long long)knownCertHandle:(int)knownCertIndex;
- (void)setKnownCertHandle:(int)knownCertIndex :(long long)newKnownCertHandle;

Default Value

""

Remarks

Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.

The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.

KnownCRLs Property (FTPClient Module)

Additional CRLs for chain validation.

Syntax

• Swift
• Objective-C

public var knownCRLs: Array<CRL> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=knownCRLCount,setter=setKnownCRLCount:) int knownCRLCount;

- (int)knownCRLCount;
- (void)setKnownCRLCount :(int)newKnownCRLCount;

- (NSData*)knownCRLBytes:(int)knownCRLIndex;

- (long long)knownCRLHandle:(int)knownCRLIndex;
- (void)setKnownCRLHandle:(int)knownCRLIndex :(long long)newKnownCRLHandle;

Default Value

""

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

KnownOCSPs Property (FTPClient Module)

Additional OCSP responses for chain validation.

Syntax

• Swift
• Objective-C

public var knownOCSPs: Array<OCSPResponse> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=knownOCSPCount,setter=setKnownOCSPCount:) int knownOCSPCount;

- (int)knownOCSPCount;
- (void)setKnownOCSPCount :(int)newKnownOCSPCount;

- (NSData*)knownOCSPBytes:(int)knownOCSPIndex;

- (long long)knownOCSPHandle:(int)knownOCSPIndex;
- (void)setKnownOCSPHandle:(int)knownOCSPIndex :(long long)newKnownOCSPHandle;

Default Value

""

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

ModeZ Property (FTPClient Module)

Switches on data compression.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=modeZ,setter=setModeZ:) BOOL modeZ;

- (BOOL)modeZ;
- (void)setModeZ :(BOOL)newModeZ;

Default Value

True

Remarks

Switches the in-flight data compression on/off.

PassiveMode Property (FTPClient Module)

Enables or disables passive transfer mode.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=passiveMode,setter=setPassiveMode:) BOOL passiveMode;

- (BOOL)passiveMode;
- (void)setPassiveMode :(BOOL)newPassiveMode;

Default Value

True

Remarks

The transfer mode (active or passive) regulates which party is responsible for opening a listening port for data connections. Where passive mode is used, the FTP server is responsible for listening for data connections. In active mode, the listening port is opened by the client.

In today's Internet of firewalls it is a de-facto standard to use the passive mode for FTP transfers.

Password Property (FTPClient Module)

The connecting user's authentication password.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

Assign the user's authentication password to this property. Use Username for username/login.

Proxy Property (FTPClient Module)

The proxy server settings.

Syntax

• Swift
• Objective-C

public var proxy: ProxySettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAddress,setter=setProxyAddress:) NSString* proxyAddress;

- (NSString*)proxyAddress;
- (void)setProxyAddress :(NSString*)newProxyAddress;

@property (nonatomic,readwrite,assign,getter=proxyAuthentication,setter=setProxyAuthentication:) int proxyAuthentication;

- (int)proxyAuthentication;
- (void)setProxyAuthentication :(int)newProxyAuthentication;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyProxyType,setter=setProxyProxyType:) int proxyProxyType;

- (int)proxyProxyType;
- (void)setProxyProxyType :(int)newProxyProxyType;

@property (nonatomic,readwrite,assign,getter=proxyRequestHeaders,setter=setProxyRequestHeaders:) NSString* proxyRequestHeaders;

- (NSString*)proxyRequestHeaders;
- (void)setProxyRequestHeaders :(NSString*)newProxyRequestHeaders;

@property (nonatomic,readwrite,assign,getter=proxyResponseBody,setter=setProxyResponseBody:) NSString* proxyResponseBody;

- (NSString*)proxyResponseBody;
- (void)setProxyResponseBody :(NSString*)newProxyResponseBody;

@property (nonatomic,readwrite,assign,getter=proxyResponseHeaders,setter=setProxyResponseHeaders:) NSString* proxyResponseHeaders;

- (NSString*)proxyResponseHeaders;
- (void)setProxyResponseHeaders :(NSString*)newProxyResponseHeaders;

@property (nonatomic,readwrite,assign,getter=proxyUseIPv6,setter=setProxyUseIPv6:) BOOL proxyUseIPv6;

- (BOOL)proxyUseIPv6;
- (void)setProxyUseIPv6 :(BOOL)newProxyUseIPv6;

@property (nonatomic,readwrite,assign,getter=proxyUseProxy,setter=setProxyUseProxy:) BOOL proxyUseProxy;

- (BOOL)proxyUseProxy;
- (void)setProxyUseProxy :(BOOL)newProxyUseProxy;

@property (nonatomic,readwrite,assign,getter=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername;

- (NSString*)proxyUsername;
- (void)setProxyUsername :(NSString*)newProxyUsername;

 

Default Value

""

Remarks

Use this property to tune up the proxy server settings.

RestartAt Property (FTPClient Module)

The offset to restart the file transfer from.

Syntax

• Swift
• Objective-C

public var restartAt: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=restartAt,setter=setRestartAt:) long long restartAt;

- (long long)restartAt;
- (void)setRestartAt :(long long)newRestartAt;

Default Value

-1

Remarks

If non-zero, tells the component to restart the file transfer operation at the specified position, rather than transfer the file in full.

ServerChain Property (FTPClient Module)

The TLS server's certificate chain.

Syntax

• Swift
• Objective-C

public var serverChain: Array<Certificate> {
  get {...}
}

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

- (int)serverCertCount;

- (NSData*)serverCertBytes:(int)serverCertIndex;

- (NSData*)serverCertCAKeyID:(int)serverCertIndex;

- (NSData*)serverCertFingerprint:(int)serverCertIndex;

- (long long)serverCertHandle:(int)serverCertIndex;

- (NSString*)serverCertIssuer:(int)serverCertIndex;

- (NSString*)serverCertIssuerRDN:(int)serverCertIndex;

- (NSString*)serverCertKeyAlgorithm:(int)serverCertIndex;

- (int)serverCertKeyBits:(int)serverCertIndex;

- (NSData*)serverCertKeyFingerprint:(int)serverCertIndex;

- (int)serverCertKeyUsage:(int)serverCertIndex;

- (NSData*)serverCertPublicKeyBytes:(int)serverCertIndex;

- (BOOL)serverCertSelfSigned:(int)serverCertIndex;

- (NSData*)serverCertSerialNumber:(int)serverCertIndex;

- (NSString*)serverCertSigAlgorithm:(int)serverCertIndex;

- (NSString*)serverCertSubject:(int)serverCertIndex;

- (NSData*)serverCertSubjectKeyID:(int)serverCertIndex;

- (NSString*)serverCertSubjectRDN:(int)serverCertIndex;

- (NSString*)serverCertValidFrom:(int)serverCertIndex;

- (NSString*)serverCertValidTo:(int)serverCertIndex;

Default Value

""

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when OnCertificateValidate event is fired by the client component.

SocketSettings Property (FTPClient Module)

Manages network connection settings.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=socketDNSMode,setter=setSocketDNSMode:) int socketDNSMode;

- (int)socketDNSMode;
- (void)setSocketDNSMode :(int)newSocketDNSMode;

@property (nonatomic,readwrite,assign,getter=socketDNSPort,setter=setSocketDNSPort:) int socketDNSPort;

- (int)socketDNSPort;
- (void)setSocketDNSPort :(int)newSocketDNSPort;

@property (nonatomic,readwrite,assign,getter=socketDNSQueryTimeout,setter=setSocketDNSQueryTimeout:) int socketDNSQueryTimeout;

- (int)socketDNSQueryTimeout;
- (void)setSocketDNSQueryTimeout :(int)newSocketDNSQueryTimeout;

@property (nonatomic,readwrite,assign,getter=socketDNSServers,setter=setSocketDNSServers:) NSString* socketDNSServers;

- (NSString*)socketDNSServers;
- (void)setSocketDNSServers :(NSString*)newSocketDNSServers;

@property (nonatomic,readwrite,assign,getter=socketDNSTotalTimeout,setter=setSocketDNSTotalTimeout:) int socketDNSTotalTimeout;

- (int)socketDNSTotalTimeout;
- (void)setSocketDNSTotalTimeout :(int)newSocketDNSTotalTimeout;

@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

""

Remarks

Use this property to tune up network connection parameters.

TLSSettings Property (FTPClient Module)

Manages TLS layer settings.

Syntax

• Swift
• Objective-C

public var tlsSettings: TLSSettings {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=TLSAutoValidateCertificates,setter=setTLSAutoValidateCertificates:) BOOL TLSAutoValidateCertificates;

- (BOOL)TLSAutoValidateCertificates;
- (void)setTLSAutoValidateCertificates :(BOOL)newTLSAutoValidateCertificates;

@property (nonatomic,readwrite,assign,getter=TLSBaseConfiguration,setter=setTLSBaseConfiguration:) int TLSBaseConfiguration;

- (int)TLSBaseConfiguration;
- (void)setTLSBaseConfiguration :(int)newTLSBaseConfiguration;

@property (nonatomic,readwrite,assign,getter=TLSCiphersuites,setter=setTLSCiphersuites:) NSString* TLSCiphersuites;

- (NSString*)TLSCiphersuites;
- (void)setTLSCiphersuites :(NSString*)newTLSCiphersuites;

@property (nonatomic,readwrite,assign,getter=TLSECCurves,setter=setTLSECCurves:) NSString* TLSECCurves;

- (NSString*)TLSECCurves;
- (void)setTLSECCurves :(NSString*)newTLSECCurves;

@property (nonatomic,readwrite,assign,getter=TLSExtensions,setter=setTLSExtensions:) NSString* TLSExtensions;

- (NSString*)TLSExtensions;
- (void)setTLSExtensions :(NSString*)newTLSExtensions;

@property (nonatomic,readwrite,assign,getter=TLSForceResumeIfDestinationChanges,setter=setTLSForceResumeIfDestinationChanges:) BOOL TLSForceResumeIfDestinationChanges;

- (BOOL)TLSForceResumeIfDestinationChanges;
- (void)setTLSForceResumeIfDestinationChanges :(BOOL)newTLSForceResumeIfDestinationChanges;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedIdentity,setter=setTLSPreSharedIdentity:) NSString* TLSPreSharedIdentity;

- (NSString*)TLSPreSharedIdentity;
- (void)setTLSPreSharedIdentity :(NSString*)newTLSPreSharedIdentity;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKey,setter=setTLSPreSharedKey:) NSString* TLSPreSharedKey;

- (NSString*)TLSPreSharedKey;
- (void)setTLSPreSharedKey :(NSString*)newTLSPreSharedKey;

@property (nonatomic,readwrite,assign,getter=TLSPreSharedKeyCiphersuite,setter=setTLSPreSharedKeyCiphersuite:) NSString* TLSPreSharedKeyCiphersuite;

- (NSString*)TLSPreSharedKeyCiphersuite;
- (void)setTLSPreSharedKeyCiphersuite :(NSString*)newTLSPreSharedKeyCiphersuite;

@property (nonatomic,readwrite,assign,getter=TLSRenegotiationAttackPreventionMode,setter=setTLSRenegotiationAttackPreventionMode:) int TLSRenegotiationAttackPreventionMode;

- (int)TLSRenegotiationAttackPreventionMode;
- (void)setTLSRenegotiationAttackPreventionMode :(int)newTLSRenegotiationAttackPreventionMode;

@property (nonatomic,readwrite,assign,getter=TLSRevocationCheck,setter=setTLSRevocationCheck:) int TLSRevocationCheck;

- (int)TLSRevocationCheck;
- (void)setTLSRevocationCheck :(int)newTLSRevocationCheck;

@property (nonatomic,readwrite,assign,getter=TLSSSLOptions,setter=setTLSSSLOptions:) int TLSSSLOptions;

- (int)TLSSSLOptions;
- (void)setTLSSSLOptions :(int)newTLSSSLOptions;

@property (nonatomic,readwrite,assign,getter=TLSTLSMode,setter=setTLSTLSMode:) int TLSTLSMode;

- (int)TLSTLSMode;
- (void)setTLSTLSMode :(int)newTLSTLSMode;

@property (nonatomic,readwrite,assign,getter=TLSUseExtendedMasterSecret,setter=setTLSUseExtendedMasterSecret:) BOOL TLSUseExtendedMasterSecret;

- (BOOL)TLSUseExtendedMasterSecret;
- (void)setTLSUseExtendedMasterSecret :(BOOL)newTLSUseExtendedMasterSecret;

@property (nonatomic,readwrite,assign,getter=TLSUseSessionResumption,setter=setTLSUseSessionResumption:) BOOL TLSUseSessionResumption;

- (BOOL)TLSUseSessionResumption;
- (void)setTLSUseSessionResumption :(BOOL)newTLSUseSessionResumption;

@property (nonatomic,readwrite,assign,getter=TLSVersions,setter=setTLSVersions:) int TLSVersions;

- (int)TLSVersions;
- (void)setTLSVersions :(int)newTLSVersions;

 

Default Value

""

Remarks

Use this property to tune up the TLS layer parameters.

TransferType Property (FTPClient Module)

Sets the file transfer mode.

Syntax

• Swift
• Objective-C

public var transferType: FtpclientTransferTypes {
  get {...}
  set {...}
}

public enum FtpclientTransferTypes: Int32 {
  case cttText = 0
  case cttBinary = 1
}

@property (nonatomic,readwrite,assign,getter=transferType,setter=setTransferType:) int transferType;

- (int)transferType;
- (void)setTransferType :(int)newTransferType;

Default Value

1

Remarks

Use this property to switch between binary and text transfer modes.

TrustedCertificates Property (FTPClient Module)

A list of trusted certificates for chain validation.

Syntax

• Swift
• Objective-C

public var trustedCertificates: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=trustedCertCount,setter=setTrustedCertCount:) int trustedCertCount;

- (int)trustedCertCount;
- (void)setTrustedCertCount :(int)newTrustedCertCount;

- (NSData*)trustedCertBytes:(int)trustedCertIndex;

- (long long)trustedCertHandle:(int)trustedCertIndex;
- (void)setTrustedCertHandle:(int)trustedCertIndex :(long long)newTrustedCertHandle;

Default Value

""

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

Username Property (FTPClient Module)

The connecting user's username (login name).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=username,setter=setUsername:) NSString* username;

- (NSString*)username;
- (void)setUsername :(NSString*)newUsername;

Default Value

""

Remarks

Assign the user's login name to this property. Use Password to provide the password.

Abort Method (FTPClient Module)

Aborts the previous FTP service command and any associated transfer of data.

Syntax

• Swift
• Objective-C

public func abort() throws -> Void

- (void)abort;

Remarks

Use this method to abort the previous FTP service command and any associated data transfer.

Acct Method (FTPClient Module)

Sends an Account command.

Syntax

• Swift
• Objective-C

public func acct(acctInfo: String) throws -> Void

- (void)acct:(NSString*)acctInfo;

Remarks

Some servers require the ACCT command to be sent after signing in to grant access to specific server resources.

Reply codes sometimes allow to differentiate the handling of ACCT command:

• when account information is required for login, the response to a successful PASSword command is reply code 332;
• if account information is NOT required for login, the reply to a successful PASSword command is 230;
• if account information is needed for a command issued later in the dialogue, the server should return a 332 or 532 reply depending on whether it stores (pending receipt of the ACCounT command) or discards the command, respectively.

AppendBytes Method (FTPClient Module)

Appends a byte array to a server-side file.

Syntax

• Swift
• Objective-C

public func appendBytes(bytes: Data, remoteFile: String) throws -> Void

- (void)appendBytes:(NSData*)bytes :(NSString*)remoteFile;

Remarks

Use this method to append Bytes to RemoteFile on the server.

AppendFile Method (FTPClient Module)

Uploads a file to the server.

Syntax

• Swift
• Objective-C

public func appendFile(localFile: String, remoteFile: String) throws -> Void

- (void)appendFile:(NSString*)localFile :(NSString*)remoteFile;

Remarks

Use this method to upload LocalFile or its part to RemoteFile on the server.

ChangeDir Method (FTPClient Module)

Changes the current directory.

Syntax

• Swift
• Objective-C

public func changeDir(remoteDir: String) throws -> Void

- (void)changeDir:(NSString*)remoteDir;

Remarks

Call this method to change the current server directory to RemoteDir.

ClearCommandChannel Method (FTPClient Module)

Sends CCC (Clear Command Channel) command to the server.

Syntax

• Swift
• Objective-C

public func clearCommandChannel(gracefulSSLClosure: Bool) throws -> Void

- (void)clearCommandChannel:(BOOL)gracefulSSLClosure;

Remarks

Use this method to send a CCC command. CCC clears command channel encryption state, turning off TLS encryption.

Some servers expect this command to allow for the control channel to be properly handled by NATs.

Config Method (FTPClient 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.

Connect Method (FTPClient Module)

Connects to the FTP server.

Syntax

• Swift
• Objective-C

public func connect(address: String, port: Int32) throws -> Void

- (void)connect:(NSString*)address :(int)port;

Remarks

Call this method to connect to the FTP server residing at Address:Port.

The component will connect to the server using the connection settings provided. If the connection is successful, it will also authenticate using the provided Username and Password.

DeleteDir Method (FTPClient Module)

Deletes a directory on the server.

Syntax

• Swift
• Objective-C

public func deleteDir(remoteDir: String) throws -> Void

- (void)deleteDir:(NSString*)remoteDir;

Remarks

This method sends an RMD command to the server to request deletion of a remote directory.

DeleteFile Method (FTPClient Module)

Deletes a file on the server.

Syntax

• Swift
• Objective-C

public func deleteFile(remoteFile: String) throws -> Void

- (void)deleteFile:(NSString*)remoteFile;

Remarks

This method sends a DELE command to the server to request deletion of a remote file.

DirExists Method (FTPClient Module)

Checks if a directory exists on the server.

Syntax

• Swift
• Objective-C

public func dirExists(remoteDir: String) throws -> Bool

- (BOOL)dirExists:(NSString*)remoteDir;

Remarks

Use this method to check if the RemoteDir exists on the server.

The test is performed by attempting to change the current directory to RemoteDir, and checking the response code returned by the server.

Note that this method will return false if the directory does exist but is not accessible for the client (e.g. due to a permission issue).

Disconnect Method (FTPClient Module)

Disconnects from the server.

Syntax

• Swift
• Objective-C

public func disconnect() throws -> Void

- (void)disconnect;

Remarks

Call this method to disconnect from the server.

DoAction Method (FTPClient 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 insensitive) 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;....

DownloadBytes Method (FTPClient Module)

Downloads a file from the server into an array of bytes.

Syntax

• Swift
• Objective-C

public func downloadBytes(remoteFile: String) throws -> Data

- (NSData*)downloadBytes:(NSString*)remoteFile;

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (FTPClient Module)

Downloads a file from the server.

Syntax

• Swift
• Objective-C

public func downloadFile(remoteFile: String, localFile: String) throws -> Void

- (void)downloadFile:(NSString*)remoteFile :(NSString*)localFile;

Remarks

Use this method to download RemoteFile into LocalFile.

DownloadFiles Method (FTPClient Module)

Downloads multiple files from the server.

Syntax

• Swift
• Objective-C

public func downloadFiles(remotePath: String, localDir: String) throws -> Void

- (void)downloadFiles:(NSString*)remotePath :(NSString*)localDir;

Remarks

Use this method do download a collection of files from the server.

RemotePath can contain a simple mask, a set of masks, or a regular expression. All the files that match the provided rule will be downloaded to LocalDir.

FileExists Method (FTPClient Module)

Checks if a file exists on the server.

Syntax

• Swift
• Objective-C

public func fileExists(remoteFile: String) throws -> Bool

- (BOOL)fileExists:(NSString*)remoteFile;

Remarks

Use this method to check if RemoteFile exists in the current remote directory. This method attempts to detect file existence using SIZE and MLST commands first, and falls back to LIST command if they are not available.

Please note that this command only looks for the file in the current directory. To check for existence of a file in a different directory, change to it with ChangeDir command first, then call this method.

GetCurrentDir Method (FTPClient Module)

Returns the server-side current directory.

Syntax

• Swift
• Objective-C

public func getCurrentDir() throws -> String

- (NSString*)getCurrentDir;

Remarks

Use this method to find out the current directory on the server.

GetFileSize Method (FTPClient Module)

Returns the size of a remote file.

Syntax

• Swift
• Objective-C

public func getFileSize(remoteFile: String) throws -> Int64

- (long long)getFileSize:(NSString*)remoteFile;

Remarks

Use this method to retrieve the size of a remote file. This method attempts to use SIZE and MLST commands if available, and resorts to LIST command otherwise.

Please note that this command only looks for the file in the current directory. To check for existence of a file in a different directory, change to it with ChangeDir command first, then call this method.

ListDir Method (FTPClient Module)

Lists the contents of a remote directory.

Syntax

• Swift
• Objective-C

public func listDir(includeFiles: Bool, includeDirectories: Bool) throws -> String

- (NSString*)listDir:(BOOL)includeFiles :(BOOL)includeDirectories;

Remarks

Use the IncludeFiles and IncludeDirectories parameters to tune up the output. The output of IncludeFiles also includes symbolic links.

This method returns a human-readable string containing the requested list. It also fires ListEntry for each entry in the list, propagating its details in CurrentListEntry.

This method uses some heuristics internally by choosing the most appropriate listing method among MLSD, NLST, and LIST.

MakeDir Method (FTPClient Module)

Creates a new directory on the server.

Syntax

• Swift
• Objective-C

public func makeDir(remoteDir: String) throws -> Void

- (void)makeDir:(NSString*)remoteDir;

Remarks

This method creates a directory. The path provided via RemoteDir can either be absolute or relative.

Depending on the server, the directory structure up to the innermost element might need to exist.

Noop Method (FTPClient Module)

Sends a NOOP command to the server.

Syntax

• Swift
• Objective-C

public func noop() throws -> Void

- (void)noop;

Remarks

Call this method to send a NOOP (No Operation) command to the server.

Rename Method (FTPClient Module)

Renames a file.

Syntax

• Swift
• Objective-C

public func rename(sourceFile: String, destFile: String) throws -> Void

- (void)rename:(NSString*)sourceFile :(NSString*)destFile;

Remarks

Use this method to rename a server-side SourceFile to DestFile.

SendCommand Method (FTPClient Module)

Sends a custom command to the server.

Syntax

• Swift
• Objective-C

public func sendCommand(command: String) throws -> Int32

- (int)sendCommand:(NSString*)command;

Remarks

This method sends an arbitrary command to the server and returns the status code received. Use it to send custom or non-standard commands, or tune up the session flow as required by the server.

UploadBytes Method (FTPClient Module)

Uploads a byte array to the server.

Syntax

• Swift
• Objective-C

public func uploadBytes(bytes: Data, remoteFile: String) throws -> Void

- (void)uploadBytes:(NSData*)bytes :(NSString*)remoteFile;

Remarks

Use this method to upload Bytes or its part to RemoteFile on the server.

UploadFile Method (FTPClient Module)

Uploads a file to the server.

Syntax

• Swift
• Objective-C

public func uploadFile(localFile: String, remoteFile: String) throws -> Void

- (void)uploadFile:(NSString*)localFile :(NSString*)remoteFile;

Remarks

Use this method to upload LocalFile or its part to RemoteFile on the server.

UploadFiles Method (FTPClient Module)

Uploads multiple files to the server.

Syntax

• Swift
• Objective-C

public func uploadFiles(localPath: String, remoteDir: String) throws -> Void

- (void)uploadFiles:(NSString*)localPath :(NSString*)remoteDir;

Remarks

This method uploads all the files that match the LocalPath criteria to RemoteDir directory on the server. LocalPath accepts a simple mask, a set of masks, or a regular expression.

For each file being uploaded a pair of FileOperation and FileOperationResult events are invoked.

ControlReceive Event (FTPClient Module)

Fires when data is received via the control channel.

Syntax

• Swift
• Objective-C

func onControlReceive(textLine: String)

- (void)onControlReceive:(NSString*)textLine;

Remarks

TextLine contains the data that was received, which would typically contain a reply to a command (e.g. 200 Command OK).

ControlSend Event (FTPClient Module)

Fires when data is about to be set via the control channel.

Syntax

• Swift
• Objective-C

func onControlSend(textLine: String)

- (void)onControlSend:(NSString*)textLine;

Remarks

TextLine contains the data to be sent, which would typically contain a command issued by the client (e.g. CWD dir).

Error Event (FTPClient 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 FTP section.

ExternalSign Event (FTPClient Module)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

• Swift
• Objective-C

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

- (void)onExternalSign:(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 class via the SignedData parameter.

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

The class uses base16 (hex) encoding for the 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 the .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(); };

FileOperation Event (FTPClient Module)

Marks the start of a file transfer.

Syntax

• Swift
• Objective-C

func onFileOperation(operation: Int32, remotePath: String, localPath: String, skip: inout Bool, cancel: inout Bool)

- (void)onFileOperation:(int)operation :(NSString*)remotePath :(NSString*)localPath :(int*)skip :(int*)cancel;

Remarks

The class fires this event from DownloadFiles and UploadFiles to notify the application that the transfer of the next file in the list is about to start.

Use the Skip parameter to skip this particular file, or Cancel to cancel the whole multi-file operation.

Operations:

FileOperationResult Event (FTPClient Module)

Reports the result of a file transfer operation.

Syntax

• Swift
• Objective-C

func onFileOperationResult(operation: Int32, remotePath: String, localPath: String, errorCode: Int32, comment: String, cancel: inout Bool)

- (void)onFileOperationResult:(int)operation :(NSString*)remotePath :(NSString*)localPath :(int)errorCode :(NSString*)comment :(int*)cancel;

Remarks

The class fires this event from DownloadFiles and UploadFiles to notify the application of the completion of a file operation.

ErrorCode and Comment provide the details of the operation. Use the Cancel parameter to terminate the whole multi-file operation if needed.

Operations:

ListEntry Event (FTPClient Module)

Reports a single entry from the requested directory listing.

Syntax

• Swift
• Objective-C

func onListEntry(filename: String)

- (void)onListEntry:(NSString*)filename;

Remarks

FileName contains the filename of the reported entry. Read the details of the entry from CurrentListEntry property.

Notification Event (FTPClient 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 class. 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 the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

Progress Event (FTPClient Module)

Reports the data transfer progress.

Syntax

• Swift
• Objective-C

func onProgress(total: Int64, current: Int64, cancel: inout Bool)

- (void)onProgress:(long long)total :(long long)current :(int*)cancel;

Remarks

This event fires periodically during a file transfer operation to report its progress.

Use the Cancel parameter to terminate the transfer if needed.

TextDataLine Event (FTPClient Module)

Reports next transferred data line.

Syntax

• Swift
• Objective-C

func onTextDataLine(textLine: String)

- (void)onTextDataLine:(NSString*)textLine;

Remarks

The class fires this event in series when transferring a file in ASCII mode to report each line being transferred.

TLSCertNeeded Event (FTPClient Module)

Fires when a remote TLS party requests a client certificate.

Syntax

• Swift
• Objective-C

func onTLSCertNeeded(host: String, caNames: String)

- (void)onTLSCertNeeded:(NSString*)host :(NSString*)CANames;

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (FTPClient Module)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

• Swift
• Objective-C

func onTLSCertValidate(serverHost: String, serverIP: String, accept: inout Bool)

- (void)onTLSCertValidate:(NSString*)serverHost :(NSString*)serverIP :(int*)accept;

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

TLSEstablished Event (FTPClient Module)

Fires when a TLS handshake with Host successfully completes.

Syntax

• Swift
• Objective-C

func onTLSEstablished(host: String, version: String, ciphersuite: String, connectionId: Data, abort: inout Bool)

- (void)onTLSEstablished:(NSString*)host :(NSString*)version :(NSString*)ciphersuite :(NSData*)connectionId :(int*)abort;

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (FTPClient Module)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

• Swift
• Objective-C

func onTLSHandshake(host: String, abort: inout Bool)

- (void)onTLSHandshake:(NSString*)host :(int*)abort;

Remarks

The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (FTPClient Module)

Notifies the application about the PSK key exchange.

Syntax

• Swift
• Objective-C

func onTLSPSK(host: String, hint: String)

- (void)onTLSPSK:(NSString*)host :(NSString*)hint;

Remarks

The class fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (FTPClient Module)

Reports the graceful closure of a TLS connection.

Syntax

• Swift
• Objective-C

func onTLSShutdown(host: String)

- (void)onTLSShutdown:(NSString*)host;

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

public init(stream: )

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public init()

Creates a new object with default field values.

ConnectionInfo Type

Contains information about a network connection.

Remarks

Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.

Fields

Constructors

public init()

Creates a new ConnectionInfo object.

CRL Type

Represents a Certificate Revocation List.

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

Fields

Constructors

public init()

Creates an empty CRL object.

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.

FTPListEntry Type

Represents a basic container for the remote file details.

Remarks

The class represents the details of a file entry returned by the FTP server.

Fields

Constructors

public init()

Creates a new FTPListEntry object.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

An OCSP response is a snapshot of the certificate status at a given time.

Fields

Constructors

public init()

Creates an empty OCSP response object.

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

Constructors

public init()

Creates a new ProxySettings 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.

TLSSettings Type

A container for TLS connection settings.

Remarks

The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.

Fields

Constructors

public init()

Creates a new TLSSettings object.

Config Settings (FTPClient Module)

FTPClient Config Settings

Base Config Settings

Trappable Errors (FTPClient Module)

FTPClient Errors