Docs

SecureBlackbox 2022 macOS Edition

Version 22.0 [Build 8174]

SFTPClient Module

Properties   Methods   Events   Configuration Settings   Errors  

The SFTPClient module provides client-side functionality for SFTP (Secure File Transfer Protocol).

Syntax

SecureBlackbox.Sftpclient

Remarks

SFTP is a file transfer subsystem that runs on top of secure shell (SSH) connection. This means that SFTP uses the whole strength of security provided by the SSH protocol, at the same time providing strong file transfer capabilities.

Please do keep in mind that there exist two protocols that offer similar secure file transfer features. SFTP works on top of SSH and normally uses port 22. FTPS works on top of TLS (or SSL) and normally uses ports 21 and 990. The protocols are very different, so please make sure you are after the right component. This component works with SFTP. Use the FTPClient component to connect to FTPS servers.

Below are the typical steps that let you integrate SFTPClient to your project:

  • Set up your Username and Password. SSH uses mandatory client-side authentication, so in most cases you need to provide your username, your password, or, sometimes, your private key. Use Key property to provide your key, if needed.
  • Be ready to handle server authentication, which is also mandatory in SSH. SSH operates a concept of a trusted keys file, where keys of known servers are stored. You can assign a path to your own trusted keys file to the TrustedKeysFile property. When a client receives a server key, it reports it to your code via its KnownKeyReceived or UnknownKeyReceived event, depending on whether the key was found in the trusted list. If you leave TrustedKeysFile empty, SFTPClient will only be able to fire the UnknownKeyReceived event, since there will be no known keys to report.
  • If needed, customize Proxy parameters and SSHSettings.
  • Consider interacting more with SFTPClient by subscribing to AuthAttempt, AuthFailed, and AuthSucceeded events to be notified about the client authentication progress.
  • When you are ready to connect, call Connect, passing the details of the server as parameters. During the initial handshake, the following events will fire: UnknownKeyReceived (or KnownKeyReceived), and then one or more AuthAttempt, AuthFailed and AuthSucceeded.
  • Upon completion of the Connect method, the component is ready for file operations. Use DownloadFile, UploadFile, ListDir, DeleteFile and other file transfer methods to work with the server file system.
  • When you are done with your work, call Disconnect to close the connection.

Some SFTP servers, primarily older ones, may expose various transfer issues. If you come across a weird issue that you believe should not be happening (such as repeated connection closures in the middle of the transfer), please try adjusting the following properties:

These adjustments will put SFTPClient in very conservative transfer setup. While this setup may be quite sluggish with modern servers, it should make SFTPClient interoperable with most older servers.

Property List


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

AuthAttemptsSpecifies the number of SSH authentication attempts.
AutoAdjustTransferBlockSpecifies whether to adjust the send and receive buffer sizes automatically.
ConnectedIndicates if the client is connected to the SFTP server.
ConnectionInfoContains the secure connection info.
CurrentListEntryContains the current entry returned by ListDir .
DownloadBlockSizeThe download block size in bytes.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
ForceCompressionEnforces compression for the SSH layer.
KeyContains the client's SSH key.
MaxSFTPVersionHigher SFTP version to support.
MinSFTPVersionLower SFTP version to support.
PasswordSpecifies user's authentication password.
PipelineLengthThe number of parallelized transfer requests.
ProxyThe proxy server settings.
ServerKeyReturns the server's public key.
SocketSettingsManages network connection settings.
SSHSettingsThe SSH connection settings.
TrustedKeysFileA file containing the keys of authorized servers.
UploadBlockSizeThe upload block size in bytes.
UsernameThe client's username to authenticate to the server.
UseUTF8Enables UTF8 for all string content.
VersionThe SFTP version negotiated.

Method List


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

AbsolutePathRequests the absolute path for a relative path.
ChangeDirChanges current working directory on the server.
ConfigSets or retrieves a configuration setting.
ConnectConnects to an SFTP server.
CreateLinkCreates a symbolic or hard link to a remote file.
DeleteDirRemoves directory from the SFTP server.
DeleteFileDeletes a file from the SFTP server.
DeleteFilesDeletes a group of files from the SFTP server.
DirExistsChecks if a directory exists on the SFTP server.
DisconnectDisconnects from the SFTP server.
DoActionPerforms an additional action.
DownloadBytesDownloads a file from the server into an array of bytes.
DownloadFileDownloads a file from the SFTP server.
DownloadFilesDownloads multiple files from the SFTP server.
ExecuteSSHCommandSends an SSH command to the server in the middle of SFTP session.
ExtensionCmdSends an extension command to the server.
FileExistsChecks whether a file exists on the server.
GetCurrentDirReturns the current directory on the SFTP server.
GetFileSizeChecks the size of a remote file.
ListDirLists the content of the current remote directory.
MakeDirCreates a new directory on the server.
RenameFileRenames a file.
RequestAttributesRequests attributes of the remote file.
SetAttributesSets the attributes upon a remote file.
UploadBytesUploads a byte array to the server.
UploadFileUploads a file to the server.
UploadFilesUploads multiple files to the server.

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.

AuthAttemptFires when an authentication attempt is performed.
AuthFailedFires if an authentication attempt fails.
AuthSucceededReports a successful authentication.
BannerReports the receipt of the Welcome message from the server.
DisconnectReports SFTP connection closure.
ErrorInformation about errors during SFTP connection.
ExternalSignHandles remote or external signing initiated by the SignExternal method or other source.
FileOperationSignifies the start of a file transfer operation.
FileOperationResultSignifies the completion of a file transfer operation.
KnownKeyReceivedSignals that the server has introduced itself with a known key.
ListEntryReports a directory listing entry to the application.
NotificationThis event notifies the application about an underlying control flow event.
PasswordChangeRequestSignals that the server requests a password change.
PrivateKeyNeededAsks the application for the client's private key.
ProgressFires periodically during the data transfer.
UnknownKeyReceivedSignals that the server has introduced itself with an unknown key.

Configuration Settings


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

AdjustFileTimesWhether file times should be adjusted after upload/download.
ASCIIModeWhether ASCII transfer mode is used.
CaseConversionWhether case conversion must be applied to file names as they are downloaded.
CaseSensitiveSpecifies if file paths are case-sensitive.
CopyModeDefines what to do with each successfully copied file.
DefOutboundBlockSizeThe default outbound block size.
DisablePacketFragmentationEnables or disables SSH packet fragmentation.
ErrorOriginSpecifies whether the error is local or remote.
ErrorSeveritySpecifies whether the error is fatal.
IncomingSpeedLimitSpecifies incoming speed limit.
KeepAlivePeriodThe inactivity period after which a keep-alive signal will be sent.
LocalCharsetCharset used on the client machine.
LocalNewLineConventionA character string for the end of line (EOL) indication on the local machine.
ModeThe file open mode to use.
NewLineConventionA character string for the end of line (EOL) indication on the server.
OutgoingSpeedLimitSpecifies incoming speed limit.
PreserveExistingFileTimesWhether original file times should be restored upon transfer.
RecursiveWhether subdirectories should also be scanned for matching files.
RedirectStdErrWhether to redirect output to StdErr.
RemoteCharsetCharset used on the server.
SFTPBufferSizeThe size of internal buffer used for data transfer.
SFTPServerExecutableLocationsLocation of the SFTP server executable.
StdErrDataThe buffer for writing StdErr data.
TempPathLocation where the temporary files are stored.
TreatZeroSizeAsUndefinedWhether zero size returned by STAT should be considered as undefined.
UseTruncateFlagOnUploadwhether to use the 'truncate' flag on file upload.
UseUTF8OnV3Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the module (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
TagAllows to store any custom data.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

AuthAttempts Property (SFTPClient Module)

Specifies the number of SSH authentication attempts.

Syntax

public var authAttempts: Int32 {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=authAttempts,setter=setAuthAttempts:) int authAttempts;

- (int)authAttempts;
- (void)setAuthAttempts :(int)newAuthAttempts;

Default Value

1

Remarks

Use this property to specify the number of authentication attempts to try. The AuthFailed event is fired for every failed attempt.

AutoAdjustTransferBlock Property (SFTPClient Module)

Specifies whether to adjust the send and receive buffer sizes automatically.

Syntax

public var autoAdjustTransferBlock: Bool {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=autoAdjustTransferBlock,setter=setAutoAdjustTransferBlock:) BOOL autoAdjustTransferBlock;

- (BOOL)autoAdjustTransferBlock;
- (void)setAutoAdjustTransferBlock :(BOOL)newAutoAdjustTransferBlock;

Default Value

True

Remarks

Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds.

Use DownloadBlockSize, UploadBlockSize, and PipelineLength properties to adjust the transfer settings manually.

Connected Property (SFTPClient Module)

Indicates if the client is connected to the SFTP server.

Syntax

public var connected: Bool {

get {...} }

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

- (BOOL)connected;

Default Value

False

Remarks

Use this read-only property to check whether the client is connected to the server.

This property is read-only.

ConnectionInfo Property (SFTPClient Module)

Contains the secure connection info.

Syntax

public var connectionInfo: SSHInfo {

get {...} }

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

- (NSString*)connInfoClientKeyAlgorithm;

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

- (int)connInfoClientKeyBits;

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

- (NSString*)connInfoClientKeyFingerprint;

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

- (NSString*)connInfoCloseReason;

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

- (NSString*)connInfoCompressionAlgorithmInbound;

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

- (NSString*)connInfoCompressionAlgorithmOutbound;

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

- (NSString*)connInfoEncryptionAlgorithmInbound;

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

- (NSString*)connInfoEncryptionAlgorithmOutbound;

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

- (int)connInfoInboundEncryptionKeyBits;

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

- (NSString*)connInfoKexAlgorithm;

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

- (int)connInfoKexBits;

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

- (NSString*)connInfoKexLines;

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

- (NSString*)connInfoMacAlgorithmInbound;

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

- (NSString*)connInfoMacAlgorithmOutbound;

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

- (int)connInfoOutboundEncryptionKeyBits;

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

- (NSString*)connInfoPublicKeyAlgorithm;

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

- (int)connInfoServerKeyBits;

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

- (NSString*)connInfoServerKeyFingerprint;

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

- (NSString*)connInfoServerSoftwareName;

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

- (long long)connInfoTotalBytesReceived;

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

- (long long)connInfoTotalBytesSent;

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

- (int)connInfoVersion;

 

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

CurrentListEntry Property (SFTPClient Module)

Contains the current entry returned by ListDir .

Syntax

public var currentListEntry: SFTPListEntry {

get {...} }

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

- (NSString*)currListEntryATime;

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

- (NSString*)currListEntryCTime;

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

- (BOOL)currListEntryDirectory;

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

- (int)currListEntryFileType;

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

- (BOOL)currListEntryGroupExecute;

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

- (BOOL)currListEntryGroupRead;

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

- (BOOL)currListEntryGroupWrite;

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

- (long long)currListEntryHandle;

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

- (NSString*)currListEntryLongName;

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

- (NSString*)currListEntryMTime;

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

- (NSString*)currListEntryName;

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

- (BOOL)currListEntryOtherExecute;

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

- (BOOL)currListEntryOtherRead;

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

- (BOOL)currListEntryOtherWrite;

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

- (NSString*)currListEntryOwner;

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

- (NSString*)currListEntryPath;

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

- (long long)currListEntrySize;

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

- (BOOL)currListEntryUserExecute;

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

- (BOOL)currListEntryUserRead;

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

- (BOOL)currListEntryUserWrite;

 

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

DownloadBlockSize Property (SFTPClient Module)

The download block size in bytes.

Syntax

public var downloadBlockSize: Int32 {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=downloadBlockSize,setter=setDownloadBlockSize:) int downloadBlockSize;

- (int)downloadBlockSize;
- (void)setDownloadBlockSize :(int)newDownloadBlockSize;

Default Value

65536

Remarks

Use this property to manually control the size of download blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

ExternalCrypto Property (SFTPClient Module)

Provides access to external signing and DC parameters.

Syntax

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

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

FIPSMode Property (SFTPClient Module)

Reserved.

Syntax

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

Enforces compression for the SSH layer.

Syntax

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 opening a connection to enforce compression of the SSH packets.

Key Property (SFTPClient Module)

Contains the client's SSH key.

Syntax

public var key: SSHKey {

get {...}
set {...} }

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

- (NSString*)keyFingerprintSHA1;

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

- (NSString*)keyFingerprintSHA256;

@property (nonatomic,readwrite,assign,getter=keyHandle,setter=setKeyHandle:) long long keyHandle;

- (long long)keyHandle;
- (void)setKeyHandle :(long long)newKeyHandle;

 

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

MaxSFTPVersion Property (SFTPClient Module)

Higher SFTP version to support.

Syntax

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

MinSFTPVersion Property (SFTPClient Module)

Lower SFTP version to support.

Syntax

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 to be supported by this client.

Password Property (SFTPClient Module)

Specifies user's authentication password.

Syntax

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

Use this property to provide an authentication password. This property is only applicable for password-based and keyboard-interactive authentication types.

PipelineLength Property (SFTPClient Module)

The number of parallelized transfer requests.

Syntax

public var pipelineLength: Int32 {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=pipelineLength,setter=setPipelineLength:) int pipelineLength;

- (int)pipelineLength;
- (void)setPipelineLength :(int)newPipelineLength;

Default Value

32

Remarks

This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.

Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Proxy Property (SFTPClient Module)

The proxy server settings.

Syntax

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

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

ServerKey Property (SFTPClient Module)

Returns the server's public key.

Syntax

public var serverKey: SSHKey {

get {...} }

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

- (NSString*)serverKeyAlgorithm;

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

- (int)serverKeyBits;

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

- (NSString*)serverKeyComment;

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

- (NSString*)serverKeyCurve;

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

- (NSData*)serverKeyDSSG;

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

- (NSData*)serverKeyDSSP;

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

- (NSData*)serverKeyDSSQ;

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

- (NSData*)serverKeyDSSX;

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

- (NSData*)serverKeyDSSY;

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

- (NSData*)serverKeyECCD;

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

- (NSData*)serverKeyECCQX;

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

- (NSData*)serverKeyECCQY;

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

- (NSData*)serverKeyEdPrivate;

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

- (NSData*)serverKeyEdPublic;

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

- (NSString*)serverKeyFingerprintMD5;

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

- (NSString*)serverKeyFingerprintSHA1;

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

- (NSString*)serverKeyFingerprintSHA256;

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

- (long long)serverKeyHandle;

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

- (BOOL)serverKeyIsExtractable;

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

- (BOOL)serverKeyIsPrivate;

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

- (BOOL)serverKeyIsPublic;

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

- (int)serverKeyKDFRounds;

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

- (NSData*)serverKeyKDFSalt;

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

- (int)serverKeyKeyFormat;

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

- (NSString*)serverKeyKeyProtectionAlgorithm;

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

- (NSData*)serverKeyRSAExponent;

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

- (NSData*)serverKeyRSAIQMP;

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

- (NSData*)serverKeyRSAModulus;

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

- (NSData*)serverKeyRSAP;

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

- (NSData*)serverKeyRSAPrivateExponent;

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

- (NSData*)serverKeyRSAQ;

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

- (NSString*)serverKeySubject;

 

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

SocketSettings Property (SFTPClient Module)

Manages network connection settings.

Syntax

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

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

SSHSettings Property (SFTPClient Module)

The SSH connection settings.

Syntax

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

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

TrustedKeysFile Property (SFTPClient Module)

A file containing the keys of authorized servers.

Syntax

public var trustedKeysFile: String {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=trustedKeysFile,setter=setTrustedKeysFile:) NSString* trustedKeysFile;

- (NSString*)trustedKeysFile;
- (void)setTrustedKeysFile :(NSString*)newTrustedKeysFile;

Default Value

""

Remarks

Use this property to provide a path to the 'authorized_keys' file to be used by the client.

UploadBlockSize Property (SFTPClient Module)

The upload block size in bytes.

Syntax

public var uploadBlockSize: Int32 {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=uploadBlockSize,setter=setUploadBlockSize:) int uploadBlockSize;

- (int)uploadBlockSize;
- (void)setUploadBlockSize :(int)newUploadBlockSize;

Default Value

32256

Remarks

Use this property to manually control the size of upload blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Username Property (SFTPClient Module)

The client's username to authenticate to the server.

Syntax

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

Use this property to provide an authentication username (login). This property is only applicable for password-based and keyboard-interactive authentication types.

UseUTF8 Property (SFTPClient Module)

Enables UTF8 for all string content.

Syntax

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

If UseUTF8 is true, the class expects all downloaded filenames to be encoded in UTF-8. Set UseUTF8 to false if you connect to a server that does not support UTF8 (e.g., OpenSSH). In this case the file names will be interpreted in the default character set.

Version Property (SFTPClient Module)

The SFTP version negotiated.

Syntax

public var version: Int32 {

get {...} }

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

- (int)version;

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

AbsolutePath Method (SFTPClient Module)

Requests the absolute path for a relative path.

Syntax

public func absolutePath(remotePath: String) throws -> String
- (NSString*)absolutePath:(NSString*)remotePath;

Remarks

Use this method to ask the SFTP server to convert a relative path to an absolute.

ChangeDir Method (SFTPClient Module)

Changes current working directory on the server.

Syntax

public func changeDir(remoteDir: String) throws -> Void
- (void)changeDir:(NSString*)remoteDir;

Remarks

Changes current working directory on the server to RemoteDir.

Config Method (SFTPClient Module)

Sets or retrieves a configuration setting.

Syntax

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

Remarks

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

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

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

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

Connect Method (SFTPClient Module)

Connects to an SFTP server.

Syntax

public func connect(address: String, port: Int32) throws -> Void
- (void)connect:(NSString*)address :(int)port;

Remarks

Use this method to connect to the SFTP server identified via its Address and Port.

CreateLink Method (SFTPClient Module)

Creates a symbolic or hard link to a remote file.

Syntax

Remarks

Use this method to create a symbolic or hard link on the server. Provide the name of the new link object via the LinkPath parameter, and the destinating file or directory path via the TargetPath parameter. HardLink specifies whether the new link should be hard (true) or symbolic (false).

DeleteDir Method (SFTPClient Module)

Removes directory from the SFTP server.

Syntax

public func deleteDir(remoteDir: String) throws -> Void
- (void)deleteDir:(NSString*)remoteDir;

Remarks

Use RemoteDir to provide a path to the directory to be deleted.

DeleteFile Method (SFTPClient Module)

Deletes a file from the SFTP server.

Syntax

public func deleteFile(remoteFile: String) throws -> Void
- (void)deleteFile:(NSString*)remoteFile;

Remarks

Use the RemoteFile parameter to specify the name of the file to delete.

DeleteFiles Method (SFTPClient Module)

Deletes a group of files from the SFTP server.

Syntax

public func deleteFiles(remotePath: String, mask: String, caseSensitive: Bool, recursive: Bool) throws -> Void
- (void)deleteFiles:(NSString*)remotePath :(NSString*)mask :(BOOL)caseSensitive :(BOOL)recursive;

Remarks

Use this method to delete a group of files from the SFTP server. Specify the files to be deleted via RemotePath and Mask parameters. Use CaseSensitive and Recursive parameters to tune up the operation.

This method is a more efficient way to delete a group of files than deleting them one by one.

DirExists Method (SFTPClient Module)

Checks if a directory exists on the SFTP server.

Syntax

public func dirExists(remoteDir: String) throws -> Bool
- (BOOL)dirExists:(NSString*)remoteDir;

Remarks

RemoteDir specifies the name of the remote directory to check for existence.

Disconnect Method (SFTPClient Module)

Disconnects from the SFTP server.

Syntax

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

Remarks

Call this method to disconnect from the SFTP server.

DoAction Method (SFTPClient Module)

Performs an additional action.

Syntax

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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DownloadBytes Method (SFTPClient Module)

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

Syntax

public func downloadBytes(remoteFile: String) throws -> Data
- (NSData*)downloadBytes:(NSString*)remoteFile;

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (SFTPClient Module)

Downloads a file from the SFTP server.

Syntax

public func downloadFile(remoteFile: String, localFile: String) throws -> Void
- (void)downloadFile:(NSString*)remoteFile :(NSString*)localFile;

Remarks

Use this method to download RemoteFile into the location specified by LocalFile.

DownloadFiles Method (SFTPClient Module)

Downloads multiple files from the SFTP server.

Syntax

public func downloadFiles(remotePath: String, localDir: String) throws -> Void
- (void)downloadFiles:(NSString*)remotePath :(NSString*)localDir;

Remarks

RemotePath contains a file mask or regular expression by which the files are selected for download.

LocalDir specifies the local folder where the files should be saved.

ExecuteSSHCommand Method (SFTPClient Module)

Sends an SSH command to the server in the middle of SFTP session.

Syntax

public func executeSSHCommand(command: String) throws -> Data
- (NSData*)executeSSHCommand:(NSString*)command;

Remarks

Use this command to send an SSH command to the server in the middle of an SFTP session. The command is executed in a secondary channel, so the SFTP connection is not affected.

This method is suitable for simple commands that do not require interaction with the user. The call returns the command output.

ExtensionCmd Method (SFTPClient Module)

Sends an extension command to the server.

Syntax

public func extensionCmd(extn: String, dataBuffer: Data) throws -> Data
- (NSData*)extensionCmd:(NSString*)extn :(NSData*)dataBuffer;

Remarks

Use this method to send an extension command to the SFTP server. Provide the extension type via the Extn parameter, and the request body via the DataBuffer parameter.

Upon completion of the command, the method returns the response as received from the server.

FileExists Method (SFTPClient Module)

Checks whether a file exists on the server.

Syntax

public func fileExists(remoteFile: String) throws -> Bool
- (BOOL)fileExists:(NSString*)remoteFile;

Remarks

Use this method to check if a RemoteFile exists on the server.

GetCurrentDir Method (SFTPClient Module)

Returns the current directory on the SFTP server.

Syntax

public func getCurrentDir() throws -> String
- (NSString*)getCurrentDir;

Remarks

Use this method to retrieve the current directory as stored by the class. This is a virtualized current directory, as SFTP protocol does not maintain a concept of the current directory.

GetFileSize Method (SFTPClient Module)

Checks the size of a remote file.

Syntax

public func getFileSize(remoteFile: String) throws -> Int64
- (long long)getFileSize:(NSString*)remoteFile;

Remarks

Returns the size of the RemoteFile.

ListDir Method (SFTPClient Module)

Lists the content of the current remote directory.

Syntax

public func listDir(includeFiles: Bool, includeDirectories: Bool) throws -> String
- (NSString*)listDir:(BOOL)includeFiles :(BOOL)includeDirectories;

Remarks

IncludeFiles specifies whether file names and symlinks should be included in the results. IncludeDirectories specifies whether directory names should be included in the result.

Upon receiving the listing, the component will report each entry in it via ListEntry event.

MakeDir Method (SFTPClient Module)

Creates a new directory on the server.

Syntax

public func makeDir(remoteDir: String) throws -> Void
- (void)makeDir:(NSString*)remoteDir;

Remarks

RemoteDir specifies the name of the new directory.

RenameFile Method (SFTPClient Module)

Renames a file.

Syntax

public func renameFile(sourceFile: String, destFile: String) throws -> Void
- (void)renameFile:(NSString*)sourceFile :(NSString*)destFile;

Remarks

Use this method to rename a remote file. Provide the old and the new name via SourceFile and DestFile parameters.

RequestAttributes Method (SFTPClient Module)

Requests attributes of the remote file.

Syntax

public func requestAttributes(remotePath: String, followSymLinks: Bool) throws -> String
- (NSString*)requestAttributes:(NSString*)remotePath :(BOOL)followSymLinks;

Remarks

Use this method to request attributes of a remote file. Pass the name of the file via the RemotePath parameter, and use FollowSymLinks to specify whether symbolic links should be resolved.

SetAttributes Method (SFTPClient Module)

Sets the attributes upon a remote file.

Syntax

public func setAttributes(remotePath: String, attributes: String) throws -> Void
- (void)setAttributes:(NSString*)remotePath :(NSString*)attributes;

Remarks

Use this method to set the attributes of a remote file.

UploadBytes Method (SFTPClient Module)

Uploads a byte array to the server.

Syntax

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

Uploads a file to the server.

Syntax

public func uploadFile(localFile: String, remoteFile: String) throws -> Void
- (void)uploadFile:(NSString*)localFile :(NSString*)remoteFile;

Remarks

Use this method to upload LocalFile to the RemoteFile location on the server.

UploadFiles Method (SFTPClient Module)

Uploads multiple files to the server.

Syntax

public func uploadFiles(localPath: String, remoteDir: String) throws -> Void
- (void)uploadFiles:(NSString*)localPath :(NSString*)remoteDir;

Remarks

Use this property to upload a batch of files to the server.

LocalPath specifies a wildcard or regular expression by which the local files are picked for uploading. RemoteDir specifies the location on the server where these files should be saved.

AuthAttempt Event (SFTPClient Module)

Fires when an authentication attempt is performed.

Syntax

func onAuthAttempt(authType: Int32)
- (void)onAuthAttempt:(int)authType;

Remarks

This event signals the start of an authentication attempt. The AuthType parameter specifies the authentication type. This event may be fired more than once if the client tries different authentication methods one after another.

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

AuthFailed Event (SFTPClient Module)

Fires if an authentication attempt fails.

Syntax

func onAuthFailed(authType: Int32)
- (void)onAuthFailed:(int)authType;

Remarks

This event fires if an authentication attempt fails (for example, if a bad password had been provided). AuthType parameter indicates the authentication type.

AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the AuthAttempts property.

This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method.

Supported authentication types:

atRhosts0x01RHOSTS file authentication. Rarely used today.

atPublicKey0x02Public key (sometimes called private key) authentication

atPassword0x04Password-based authentication

atHostbased0x08Hostbased authentication

atKeyboard0x10Keyboard-interactive authentication. This is often used in place of generic password authentication.

atGssWithMic0x20GSS authentication

atGssKeyex0x40GSS authentication with key exchange

atPublicKeyAgent0x80Public key agent authentication

AuthSucceeded Event (SFTPClient Module)

Reports a successful authentication.

Syntax

func onAuthSucceeded()
- (void)onAuthSucceeded;

Remarks

This event marks the completion of the authentication procedure, and signifies transition to the SSH connection subprotocol.

Banner Event (SFTPClient Module)

Reports the receipt of the Welcome message from the server.

Syntax

func onBanner(text: Data, language: Data)
- (void)onBanner:(NSData*)text :(NSData*)language;

Remarks

The class fires this event when it receives a welcome message from the server. Use the Text parameter to access the encoded message.

Disconnect Event (SFTPClient Module)

Reports SFTP connection closure.

Syntax

func onDisconnect(closeReason: Int32)
- (void)onDisconnect:(int)closeReason;

Remarks

The class fires this event to report connection closure. No more SFTP activity could be done after the disconnect.

Error Event (SFTPClient Module)

Information about errors during SFTP connection.

Syntax

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

Remarks

The event is fired in case of exceptional conditions during data transfer.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of error codes please refer to SFTP.

ExternalSign Event (SFTPClient Module)

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

Syntax

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 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(); };

FileOperation Event (SFTPClient Module)

Signifies the start of a file transfer operation.

Syntax

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

This event is fired each time the class starts an upload or download operation within a multi-file call. Operation defines the operation about to start, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

If needed, set Skip to true to ignore the current file, or Cancel to abort the whole batch.

Supported operations:

csfoDownloadFile0Download file

csfoUploadFile1Upload file

csfoDeleteFile2Delete file

csfoMakeDir3Make directory

FileOperationResult Event (SFTPClient Module)

Signifies the completion of a file transfer operation.

Syntax

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

This event is fired each time the class completes a file transfer within a multi-file call. Operation defines the operation performed on the file, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

ErrorCode and Comment return the code and textual description of the error, if it was encountered.

Set Cancel to True to cancel the multi-file operation.

Supported operations:

csfoDownloadFile0Download file

csfoUploadFile1Upload file

csfoDeleteFile2Delete file

csfoMakeDir3Make directory

KnownKeyReceived Event (SFTPClient Module)

Signals that the server has introduced itself with a known key.

Syntax

func onKnownKeyReceived(algorithm: String, bits: Int32, fingerprintSHA256: String)
- (void)onKnownKeyReceived:(NSString*)algorithm :(int)bits :(NSString*)fingerprintSHA256;

Remarks

The class fires this event to tell the application that the server has introduced itself with a known key from TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

Use ServerKey to access more key details.

ListEntry Event (SFTPClient Module)

Reports a directory listing entry to the application.

Syntax

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

Remarks

The class fires this event to report a directory listing entry to the application. FileName contains the entry name.

Use CurrentListEntry to access the details of the entry.

Notification Event (SFTPClient Module)

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

Syntax

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.

PasswordChangeRequest Event (SFTPClient Module)

Signals that the server requests a password change.

Syntax

func onPasswordChangeRequest(prompt: String, newPassword: inout String, cancel: inout Bool)
- (void)onPasswordChangeRequest:(NSString*)prompt :(NSString**)newPassword :(int*)cancel;

Remarks

The class fires this event to pass the password change request from the server to the application. This event is fired during the SSH handshake.

PrivateKeyNeeded Event (SFTPClient Module)

Asks the application for the client's private key.

Syntax

func onPrivateKeyNeeded(skip: inout Bool)
- (void)onPrivateKeyNeeded:(int*)skip;

Remarks

The class fires this event if the public key provided in Key was accepted by the server, but no private key is available for it.

Use this event handler to attach the private key to your Key. The component will pick the key up and continue the authentication.

Progress Event (SFTPClient Module)

Fires periodically during the data transfer.

Syntax

func onProgress(total: Int64, current: Int64, cancel: inout Bool)
- (void)onProgress:(long long)total :(long long)current :(int*)cancel;

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

UnknownKeyReceived Event (SFTPClient Module)

Signals that the server has introduced itself with an unknown key.

Syntax

func onUnknownKeyReceived(algorithm: String, bits: Int32, fingerprintSHA256: String, action: inout Int32)
- (void)onUnknownKeyReceived:(NSString*)algorithm :(int)bits :(NSString*)fingerprintSHA256 :(int*)action;

Remarks

The class fires this event to tell the application that the server has introduced itself with a key not present in TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

In this event handler, you need to make a decision whether to proceed with the connection. Use Action to tell the class what it should do with the key:

catAcceptOnce1Accept the key for the current session only.
catAcceptPermanently2Accept the key for the current session and store the key to the trusted keys list.
catReject3Reject the key and close the connection.

Note that accepting an unknown and unchecked key may be risky.

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

asyncDocumentID
String

Specifies the document ID for SignAsyncEnd() call

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

customParams
String

Custom parameters to be passed to the signing service (uninterpreted).

data
String

Additional data to be included in the async state and mirrored back by the requestor

externalHashCalculation
Bool

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

hashAlgorithm
String

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

keyID
String

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

keySecret
String

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the topic.

method
AsyncSignMethods

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

mode
ExternalCryptoModes

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

publicKeyAlgorithm
String

Provide public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

public init()

Creates a new ExternalCrypto object with default field values.

ProxySettings Type

A container for proxy server settings.

Remarks

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

Fields

address
String

The IP address of the proxy server.

authentication
ProxyAuthTypes

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

password
String

The password to authenticate to the proxy server.

port
Int32

The port on the proxy server to connect to.

proxyType
ProxyTypes

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

requestHeaders
String

Contains HTTP request headers for WebTunnel and HTTP proxy.

responseBody
String

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

responseHeaders
String

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

useIPv6
Bool

Specifies whether IPv6 should be used when connecting through the proxy.

useProxy
Bool

Enables or disables proxy-driven connection.

username
String

Specifies the username credential for proxy authentication.

Constructors

public init()

Creates a new ProxySettings object.

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

aTime
String

Contains the last access time for this file, in UTC.

cTime
String

Contains this file's creation time, in UTC.

directory
Bool

Specifies whether this entry is a directory.

fileType
SFTPFileTypes

Specifies the type of this entry, one of the following:

cftFile0
cftDirectory1
cftSymblink2
cftSpecial3
cftUnknown4
cftSocket5
cftCharDevice6
cftBlockDevice7
cftFIFO8

groupExecute
Bool

Controls file execution permission for the group users.

groupRead
Bool

Controls file read permission for the group users.

groupWrite
Bool

Controls file write permission for the group users.

handle
Int64

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

longName
String

Contains the long name of the file (human-readable, ftp-like).

mTime
String

Specifies the last modification time, in UTC.

name
String

Specifies the file name.

otherExecute
Bool

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

otherRead
Bool

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

otherWrite
Bool

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

owner
String

Specifies the owner of the file/directory.

path
String

Contains the full path to the file.

size
Int64

The size of the file in bytes.

userExecute
Bool

Controls file execution permission for the file owner.

userRead
Bool

Controls file read permission for the file owner.

userWrite
Bool

Controls file write permission for the file owner.

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

dnsMode
DNSResolveModes

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

dnsPort
Int32

Specifies the port number to be used for sending queries to the DNS server.

dnsQueryTimeout
Int32

The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.

dnsServers
String

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

dnsTotalTimeout
Int32

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.

incomingSpeedLimit
Int32

The maximum number of bytes to read from the socket, per second.

localAddress
String

The local network interface to bind the socket to.

localPort
Int32

The local port number to bind the socket to.

outgoingSpeedLimit
Int32

The maximum number of bytes to write to the socket, per second.

timeout
Int32

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

useIPv6
Bool

Enables or disables IP protocol version 6.

Constructors

public init()

Creates a new SocketSettings object.

SSHInfo Type

Contains information about SSH connection.

Remarks

SSHInfo object contains information about one SSH connection.

Fields

clientKeyAlgorithm
String

Specifies the client's key algorithm.

clientKeyBits
Int32

Specifies the length of the client's key.

clientKeyFingerprint
String

The fingerprint (hash value) of the client's public key.

closeReason
String

Contains the line sent by the server just before closing the connection. It might contain the error description if the connection was not closed gracefully.

compressionAlgorithmInbound
String

Compression algorithm for the incoming traffic.

compressionAlgorithmOutbound
String

Compression algorithm for the outgoing traffic.

encryptionAlgorithmInbound
String

Encryption algorithm for the incoming traffic.

encryptionAlgorithmOutbound
String

Encryption algorithm for the outgoing traffic.

inboundEncryptionKeyBits
Int32

Specifies the length of the key used to encrypt the incoming traffic.

kexAlgorithm
String

The key exchange algorithm used during the SSH handshake.

kexBits
Int32

The number of bits used by the key exchange algorithm.

kexLines
String

The contents of the received KexInit packet.

KexInit packet contains the list of algorithms supported by the remote party.

macAlgorithmInbound
String

MAC algorithm used for the incoming connection.

macAlgorithmOutbound
String

MAC algorithm used for outbound connection.

outboundEncryptionKeyBits
Int32

Specifies the length of the key used to encrypt the outgoing traffic.

publicKeyAlgorithm
String

Specifies the public key algorithm which was used during the SSH handshake.

serverKeyBits
Int32

Specifies the number of bits in the server's key.

serverKeyFingerprint
String

The fingerprint (hash value) of the server's public key.

serverSoftwareName
String

Returns the name of the SSH software running on the server side.

totalBytesReceived
Int64

Returns the total number of bytes received over this connection.

totalBytesSent
Int64

Returns the total number of bytes sent over this connection.

version
Int32

Specifies SSH protocol version.

Constructors

public init()

Creates an empty object representing a SSH connection info.

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

algorithm
String

Specifies the key algorithm.

bits
Int32

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

comment
String

The comment for the public key.

curve
String

Specifies the elliptical curve when EC cryptography is used.

dssg
Data

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

dssp
Data

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

dssq
Data

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

dssx
Data

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

dssy
Data

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

eccd
Data

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

eccqx
Data

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

eccqy
Data

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

edPrivate
Data

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

edPublic
Data

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

fingerprintMD5
String

Contains the MD5 fingerprint (hash) of the key.

fingerprintSHA1
String

Contains the SHA-1 fingerprint (hash) of the key.

fingerprintSHA256
String

Contains the SHA-256 fingerprint (hash) of the key.

handle
Int64

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

isExtractable
Bool

Whether the key is extractable (e.g., from a security token), or not.

isPrivate
Bool

Whether this key is a private key or not.

isPublic
Bool

Whether this key is a public key or not.

kdfRounds
Int32

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

kdfSalt
Data

The salt value used by the Key Derivation Function (KDF) to generate this key.

keyFormat
SSHKeyFormats

Specifies the format in which the key is stored.

ckfOpenSSH0
ckfOpenSSH21
ckfIETF2
ckfPuTTY3
ckfX5094
ckfBinary5
ckfSSH16
ckfPGP7
ckfPKCS88

keyProtectionAlgorithm
String

Specifies the key protection algorithm.

rsaExponent
Data

Returns the e parameter (public exponent) of the RSA key.

rsaiqmp
Data

Returns the iqmp parameter of the RSA key.

rsaModulus
Data

Returns the m parameter (public modulus) of the RSA key.

rsap
Data

Returns the p parameter (first factor of the common modulus n) of the RSA key.

rsaPrivateExponent
Data

Returns the d parameter (private exponent) of the RSA key.

rsaq
Data

Returns the q parameter (second factor of the common modulus n) of the RSA key.

subject
String

Specifies the public key owner (subject). This property is used only for IETF-keys.

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

autoAdjustCiphers
Bool

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

baseConfiguration
SecureTransportPredefinedConfigurations

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

compressionAlgorithms
String

A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all compression algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below:

  • none
  • zlib
  • zlib@openssh.com

compressionLevel
Int32

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.

defaultWindowSize
Int32

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

encryptionAlgorithms
String

A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all encryption algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below:

  • 3des-cbc
  • blowfish-cbc
  • twofish256-cbc
  • twofish192-cbc
  • twofish128-cbc
  • aes256-cbc
  • aes192-cbc
  • aes128-cbc
  • serpent256-cbc
  • serpent192-cbc
  • serpent128-cbc
  • arcfour
  • idea-cbc
  • cast128-cbc
  • none
  • des-cbc
  • aes128-ctr
  • aes192-ctr
  • aes256-ctr
  • 3des-ctr
  • blowfish-ctr
  • twofish128-ctr
  • twofish192-ctr
  • twofish256-ctr
  • serpent128-ctr
  • serpent192-ctr
  • serpent256-ctr
  • idea-ctr
  • cast128-ctr
  • arcfour128
  • arcfour256
  • aes128-gcm
  • aes256-gcm
  • aes128-gcm@openssh.com
  • aes256-gcm@openssh.com
  • chacha20-poly1305
  • chacha20-poly1305@openssh.com

forceCompression
Bool

Whether the SSH client should explicitly request compression.

If ForceCompression is False, compression will be used only if the server doesn't support algorithms without compression.

gssAuthTypes
String

A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.

gssDelegateCreds
Bool

Switches credential delegation on or off.

gssHostname
String

The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com).

gssLib
String

A path to the GSS-API library (DLL or SO).

gssMechanisms
String

A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.

gssProtocols
String

A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.

handshakeTimeout
Int32

Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.

kexAlgorithms
String

A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all key exchange algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below:

  • diffie-hellman-group-exchange-sha1
  • diffie-hellman-group1-sha1
  • diffie-hellman-group14-sha1
  • diffie-hellman-group-exchange-sha256
  • rsa1024-sha1
  • rsa2048-sha256
  • ecdh-sha2-nistp256
  • ecdh-sha2-nistp384
  • ecdh-sha2-nistp521
  • ecdh-sha2-nistk163
  • ecdh-sha2-nistp192
  • ecdh-sha2-nistp224
  • ecdh-sha2-nistk233
  • ecdh-sha2-nistb233
  • ecdh-sha2-nistk283
  • ecdh-sha2-nistk409
  • ecdh-sha2-nistb409
  • ecdh-sha2-nistt571
  • ecdh-sha2-curve25519
  • curve25519-sha256@libssh.org
  • curve448-sha512@libssh.org

macAlgorithms
String

A list of MAC (for message authentication code) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all MAC algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below:

  • hmac-sha1
  • hmac-sha1-96
  • hmac-md5
  • hmac-md5-96
  • none
  • hmac-ripemd160
  • hmac-ripemd
  • hmac-ripemd160@openssh.com
  • hmac-sha256@ssh.com
  • hmac-sha256-96@ssh.com
  • umac-32@openssh.com
  • umac-64@openssh.com
  • umac-96@openssh.com
  • umac-128@openssh.com
  • hmac-sha2-256
  • hmac-sha2-512
  • aes128-gcm
  • aes256-gcm
  • chacha20-poly1305@openssh.com
  • hmac-sha2-256-etm@openssh.com
  • hmac-sha2-512-etm@openssh.com

maxSSHPacketSize
Int32

Specifies the maximum length of one SSH packet in bytes.

minWindowSize
Int32

Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data.

obfuscateHandshake
Bool

Enables or disables handshake obfuscation.

obfuscationPassword
String

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

publicKeyAlgorithms
String

A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all public key algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below:

  • ssh-dss
  • ssh-rsa
  • x509v3-sign-rsa
  • x509v3-sign-dss
  • spki-sign-rsa,
  • spki-sign-dss
  • pgp-sign-rsa
  • pgp-sign-dss
  • ecdsa-sha2-nistp256
  • ecdsa-sha2-nistp384
  • ecdsa-sha2-nistp521
  • ecdsa-sha2-nistk163
  • ecdsa-sha2-nistp192
  • ecdsa-sha2-nistp224
  • ecdsa-sha2-nistk233
  • ecdsa-sha2-nistb233
  • ecdsa-sha2-nistk283
  • ecdsa-sha2-nistk409
  • ecdsa-sha2-nistb409
  • ecdsa-sha2-nistt571,
  • ecdsa-sha2-curve25519
  • x509v3-ssh-rsa
  • x509v3-ssh-dss
  • x509v3-rsa2048-sha256
  • x509v3-ecdsa-sha2-nistp256
  • x509v3-ecdsa-sha2-nistp384
  • x509v3-ecdsa-sha2-nistp521
  • x509v3-ecdsa-sha2-nistk163
  • x509v3-ecdsa-sha2-nistp192
  • x509v3-ecdsa-sha2-nistp224
  • x509v3-ecdsa-sha2-nistk233
  • x509v3-ecdsa-sha2-nistb233
  • x509v3-ecdsa-sha2-nistk283
  • x509v3-ecdsa-sha2-nistk409
  • x509v3-ecdsa-sha2-nistb409
  • x509v3-ecdsa-sha2-nistt571
  • x509v3-ecdsa-sha2-curve25519
  • ssh-ed25519
  • ssh-ed448

requestPasswordChange
Bool

Whether to request a password change when connecting.

softwareName
String

The name to be used by the component to identify itself.

trustAllKeys
Bool

Enables or disables explicit trust to all server keys. Use with care.

useAuthAgent
Bool

Enables or disables the use of external key agent, such as Putty key agent.

versions
Int32

Specifies enabled SSH protocol versions (1 or 2).

Constructors

public init()

Creates a new object with default settings.

Configuration Settings (SFTPClient Module)

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

SFTPClient Configuration Settings

AdjustFileTimes:   Whether file times should be adjusted after upload/download.

If this property value is True, file times (creation, access and last modification times) will be adjusted after upload/download operation.

ASCIIMode:   Whether ASCII transfer mode is used.

When this property is True, ASCII (text) transfer mode is used, otherwise the transfer is performed in binary mode.

CaseConversion:   Whether case conversion must be applied to file names as they are downloaded.

You can choose to: convert file names to upper case, convert file names to lower case, or to keep them as they are.

CaseSensitive:   Specifies if file paths are case-sensitive.

Set this property to True if all file names, paths and file masks should be case-sensitive.

CopyMode:   Defines what to do with each successfully copied file.

You could choose to: simply copy the file, delete each file's origin right after that file has been copied, or delete all original files only after all files have been copied.

DefOutboundBlockSize:   The default outbound block size.

Use this property to configure the outbound data block size.

DisablePacketFragmentation:   Enables or disables SSH packet fragmentation.

Use this property to enable or disable SSH packet fragmentation. This is one of the settings that is worth a look if encountering unexplained transfer issues.

ErrorOrigin:   Specifies whether the error is local or remote.

Use this property to check where the error took place.

ErrorSeverity:   Specifies whether the error is fatal.

Use this property to check whether the error is fatal or not.

IncomingSpeedLimit:   Specifies incoming speed limit.

Use this property to limit the maximum number of bytes per second that client may receive. The value of 0 (zero) means "no limitation".

KeepAlivePeriod:   The inactivity period after which a keep-alive signal will be sent.

Use this property to specify tunnel inactivity period (in milliseconds) after which a keep-alive signal will be sent. The default value is 0 (no keep-alive signals).

LocalCharset:   Charset used on the client machine.

This property specifies the charset used on the local client computer.

LocalNewLineConvention:   A character string for the end of line (EOL) indication on the local machine.

This property contains a character string for the end of line (EOL) indication on the local machine.

Mode:   The file open mode to use.

This property allows to provide a custom file upload mode.

NewLineConvention:   A character string for the end of line (EOL) indication on the server.

This property contains a character string for the end of line (EOL) indication used by the server. Usually its value is one of: 0x0d, 0x0d0x0a, 0x0a0x0d, or 0x0a, but it can differ for some servers.

OutgoingSpeedLimit:   Specifies incoming speed limit.

Use this property to limit the maximum number of bytes per second that client may send. The value of 0 (zero) means "no limitation".

PreserveExistingFileTimes:   Whether original file times should be restored upon transfer.

If the destination file exists and PreserveExistingFileTimes option is enabled, the class will remember the file's times before transfer, and restore them after the file has been transferred. The default value is False.

Recursive:   Whether subdirectories should also be scanned for matching files.

Set this property to True to indicate that subdirectories should also be scanned for matching files

RedirectStdErr:   Whether to redirect output to StdErr.

If this property is True, all output will be redirected to StdErr.

RemoteCharset:   Charset used on the server.

This property specifies the charset used on the server.

SFTPBufferSize:   The size of internal buffer used for data transfer.

Use this property to control the size of the internal buffers used for data transfer.

SFTPServerExecutableLocations:   Location of the SFTP server executable.

Specifies the location of the SFTP server executable.

StdErrData:   The buffer for writing StdErr data.

This property represents a buffer where StdErr data is written by the class.

TempPath:   Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TreatZeroSizeAsUndefined:   Whether zero size returned by STAT should be considered as undefined.

This property specifies if the size of zero returned by the STAT command for a particular file should be considered as undefined. It makes sense to set this property to True, because some operating systems (e.g. Unix-based) return zero size for the files of certain type. For instance, most of the files contained in the /proc directory are reported as 0-sized, while actually not being empty.

UseTruncateFlagOnUpload:   whether to use the 'truncate' flag on file upload.

If this property is True, the existing files are opened truncated on upload, otherwise new files are created. The default value is True.

UseUTF8OnV3:   Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.

If this property is True, UTF-8 encoding will be applied to file names for SFTP protocol versions 3 and lower.

Base Configuration Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SFTPClient Module)

SFTPClient Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
31457281   Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILEOPERATION)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 macOS Edition - Version 22.0 [Build 8174]