SFTPClient Module

Properties   Methods   Events   Config 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.
ConflictResolutionModeDefines the approach that should be used to resolve various conflicts during batch processing.
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.
ResetResets the module settings.
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.
FileNameChangeNeededAsks the application for a new file name.
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.

Config Settings

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

AdjustFileTimesWhether file times should be adjusted after upload/download.
AllAlgorithmsReturns the list of algorithms enabled in the module.
ASCIIModeWhether ASCII transfer mode is used.
AvailableSpaceReturns details of server disk space availability. This protocol extension must be supported by the server for this request to work.
CaseConversionWhether file names and paths should be case-converted.
CaseSensitiveSpecifies if file paths are case-sensitive.
CloseQuietlyControls the client's approach to session closure.
CommandTimeoutSpecifies the command timeout.
CompressionAlgorithmsReturns the list of compression algorithms enabled in the module.
CopyModeDefines what to do with each successfully copied file.
DefaultTransferBlockSpecifies the default transfer block size.
DefOutboundBlockSizeThe default outbound block size.
DisablePacketFragmentationEnables or disables SSH packet fragmentation.
EarlyIdStringEnables the proactive approach to SSH handshake.
EncryptionAlgorithmsReturns the list of encryption algorithms enabled in the module.
ErrorOriginSpecifies whether the error is local or remote.
ErrorSeveritySpecifies whether the error is fatal.
FileHashReturns the hash of the specified file. This protocol extension must be supported by the server for this request to work.
HashAlgorithmThe hash algorithm to use for the protocol operations.
HomeDirReturns a user's home directory. This protocol extension must be supported by the server for this request to work.
IncomingSpeedLimitSpecifies incoming speed limit.
KeepAlivePeriodThe inactivity period after which a keep-alive signal will be sent.
KexAlgorithmsReturns the list of key exchange algorithms enabled in the module.
LocalCharsetCharset used on the client machine.
LocalNewLineConventionA character string for the end of line (EOL) indication on the local machine.
MacAlgorithmsReturns the list of MAC algorithms enabled in the module.
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.
PublicKeyAlgorithmsReturns the list of public key algorithms enabled in the module.
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.
SocketRecvBufferSizeThe inbound socket buffer size.
SocketSendBufferSizeThe outbound socket buffer size.
StatVFSReturns VFS details. This protocol extension must be supported by the server for this request to work.
StdErrDataThe buffer for writing StdErr data.
SuppressAuxTransferOpsTBD.
TempFolderReturns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work.
TempPathPath for storing temporary files.
TreatZeroSizeAsUndefinedWhether zero size returned by STAT should be considered as undefined.
TryPasswordAuthSpecifies whether the module should attempt the password-based authentication if no password is set.
UseStrictKeyExchangeSpecifies how strict key exchange is supported.
UseTruncateFlagOnUploadwhether to use the 'truncate' flag on file upload.
UseUTF8OnV3Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.
ASN1UseGlobalTagCacheControls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPinsSpecifies whether CSP-level PINs should be assigned to CNG keys.
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.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
DNSLocalSuffixThe suffix to assign for TLD names.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicyThe hardware crypto usage policy.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
HttpVersionThe HTTP version to use in any inner HTTP client modules created.
IgnoreExpiredMSCTLSigningCertWhether to tolerate the expired Windows Update signing certificate.
ListDelimiterThe delimiter character for multi-element lists.
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.
OldClientSideRSAFallbackSpecifies whether the SSH client should use a SHA1 fallback.
PKICacheSpecifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePathSpecifies the file system path where cached PKI data is stored.
ProductVersionReturns the version of the SecureBlackbox library.
ServerSSLDHKeyLengthSets the size of the TLS DHE key exchange group.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCachingSpecifies whether reuse of loaded CRL objects is enabled.
UseInternalRandomSwitches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidationEnables legacy AdES validation mode.
UseOCSPResponseObjectCachingSpecifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolverSpecifies whether the client modules should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculationAn internal CryptoAPI access tweak.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrderSpecifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparatorSpecifies the separator used between descriptors in RDN.

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.

ConflictResolutionMode Property (SFTPClient Module)

Defines the approach that should be used to resolve various conflicts during batch processing.

Syntax

public var conflictResolutionMode: SFTPClientConflictResolutionModes {
  get {...}
  set {...}
}

public enum SFTPClientConflictResolutionModes: Int32 {
  case cftmOverwrite = 0
  case cftmSkip = 1
  case cftmAppendToEnd = 2
  case cftmResume = 3
  case cftmOverwriteIfDiffSize = 4
  case cftmSaveWithNewName = 5
  case cftmRenameExistingTarget = 6
}


@property (nonatomic,readwrite,assign,getter=conflictResolutionMode,setter=setConflictResolutionMode:) int conflictResolutionMode;

- (int)conflictResolutionMode;
- (void)setConflictResolutionMode :(int)newConflictResolutionMode;

Default Value

0

Remarks

Use this property to specify the approach to use when landing in conflicting transfer situations.

cftmOverwrite0
cftmSkip1
cftmAppendToEnd2The signature is corrupted

cftmResume3
cftmOverwriteIfDiffSize4
cftmSaveWithNewName5
cftmRenameExistingTarget5

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: SSHConnectionInfo {
  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=connInfoRemoteAddress) NSString* connInfoRemoteAddress;

- (NSString*)connInfoRemoteAddress;

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

- (int)connInfoRemotePort;

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

- (NSString*)connInfoServerKeyAlgorithm;

@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

This property contains various information about the secure connection.

This property is read-only.

CurrentListEntry Property (SFTPClient Module)

Contains the current entry returned by ListDir .

Syntax

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


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

- (NSString*)currListEntryAccessTime;

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

- (NSString*)currListEntryCreationTime;

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

- (int)currListEntryEntryFormat;

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

- (int)currListEntryFileType;

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

- (long long)currListEntryHandle;

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

- (NSString*)currListEntryModificationTime;

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

- (NSString*)currListEntryName;

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

- (NSString*)currListEntryPath;

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

- (NSString*)currListEntryPrincipal;

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

- (long long)currListEntrySize;

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

- (int)currListEntryUnixPerms;

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

- (NSString*)currListEntryUnparsedName;

Default Value

0

Remarks

Use this property to access the current list entry as returned by ListDir call. Entries are passed back to the application one by one, with ListEntry thrown for each entry.

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 tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

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 provide the client's SSH key for authentication. Note that you may start with providing the public part of the key, and only complete it with the private part in response to PrivateKeyNeeded event.

Alternative, you may load the private key straightaway.

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=proxyUsername,setter=setProxyUsername:) NSString* proxyUsername;

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

Default Value

0

Remarks

Use this property to tune up the proxy server settings.

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 check the details of the server public key.

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 tune up network connection parameters.

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=SSHSettingsForwardAuthAgent,setter=setSSHSettingsForwardAuthAgent:) BOOL SSHSettingsForwardAuthAgent;

- (BOOL)SSHSettingsForwardAuthAgent;
- (void)setSSHSettingsForwardAuthAgent :(BOOL)newSSHSettingsForwardAuthAgent;

@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 access and tune-up the SSH layer settings.

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, errorHandling: Int32) throws -> Void

- (void)deleteFiles:(NSString*)remotePath :(NSString*)mask :(BOOL)caseSensitive :(BOOL)recursive :(int)errorHandling;

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.

The ErrorHandling parameter specifies the error handling tactics.

ehStopOnFailure0Stop on the first failure and throw an exception

ehIgnoreErrors1Ignore individual processing errors, just proceed to the next item on the list

ehTryAllItems2Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process

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 (case insensitive) of the action is provided in the ActionID parameter.

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

Common ActionIDs:

ActionParametersReturned valueDescription
ResetTrustedListCachenonenoneClears the cached list of trusted lists.
ResetCertificateCachenonenoneClears the cached certificates.
ResetCRLCachenonenoneClears the cached CRLs.
ResetOCSPResponseCachenonenoneClears the cached OCSP responses.

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, recursive: Bool, errorHandling: Int32) throws -> Void

- (void)downloadFiles:(NSString*)remotePath :(NSString*)localDir :(BOOL)recursive :(int)errorHandling;

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. The Recursive parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual RemotePath, but not its subdirectories, will be downloaded.

The ErrorHandling parameter specifies the error handling tactics.

ehStopOnFailure0Stop on the first failure and throw an exception

ehIgnoreErrors1Ignore individual processing errors, just proceed to the next item on the list

ehTryAllItems2Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process

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.

The method returns the list of attributes as a line of semicolon-separated entries: Size=78220;Owner=user@system;Group=none@system;Permissions=432;ATime=2020-04-28 08:21:00.295;MTime=2020-04-28 08:21:00.302;CTime=2020-04-28 08:21:00.295;AttribBits=24;LinkCount=1.

Reset Method (SFTPClient Module)

Resets the component settings.

Syntax

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

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, recursive: Bool, errorHandling: Int32) throws -> Void

- (void)uploadFiles:(NSString*)localPath :(NSString*)remoteDir :(BOOL)recursive :(int)errorHandling;

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. The Recursive parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual LocalPath, but not its subdirectories, will be uploaded.

The ErrorHandling parameter specifies one of the pre-defined error handling tactics:

ehStopOnFailure0Stop on the first failure and throw an exception

ehIgnoreErrors1Ignore individual processing errors, just proceed to the next item on the list

ehTryAllItems2Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process

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 class via the SignedData parameter.

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

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

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

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

FileNameChangeNeeded Event (SFTPClient Module)

Asks the application for a new file name.

Syntax

func onFileNameChangeNeeded(fileName: inout String, force: inout Bool)

- (void)onFileNameChangeNeeded:(NSString**)fileName :(int*)force;

Remarks

The component uses this event to ask the application for a new file name in the case of a name conflict. Adjust the FileName as required to avoid the conflict, or set Force to true to go ahead with the current name (possibly overwriting an existing file).

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:

cffoDownloadFile0Download file

cffoUploadFile1Upload file

cffoDeleteFile2Delete file

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

cffoDownloadFile0Download file

cffoUploadFile1Upload file

cffoDeleteFile2Delete file

cffoMakeDir3Make 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 class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

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

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.

The following fields are available:
  • AsyncDocumentID
  • CustomParams
  • Data
  • ExternalHashCalculation
  • HashAlgorithm
  • KeyID
  • KeySecret
  • Method
  • Mode
  • PublicKeyAlgorithm

    • Fields

    asyncDocumentID
    String
    Default Value: ""

    Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

    Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component 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 the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

    customParams
    String
    Default Value: ""

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

    data
    String
    Default Value: ""

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

    externalHashCalculation
    Bool
    Default Value: False

    Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

    If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

    hashAlgorithm
    String
    Default Value: "SHA256"

    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
    Default Value: ""

    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 an extra protection layer for the protocol and diminishes the risk of the 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
    Default Value: ""

    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
    Default Value: 0

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

    Available options:

    asmdPKCS10
    asmdPKCS71

    mode
    ExternalCryptoModes
    Default Value: 0

    Specifies the external cryptography mode.

    Available options:

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

    publicKeyAlgorithm
    String
    Default Value: ""

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

    FTPListEntry Type

    Represents a basic container for the remote file details.

    Remarks

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

    The following fields are available:
  • AccessTime
  • CreationTime
  • EntryFormat
  • FileType
  • Handle
  • ModificationTime
  • Name
  • Path
  • Principal
  • Size
  • UnixPerms
  • UnparsedName

    • Fields

    accessTime
    String
    Default Value: ""

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

    creationTime
    String
    Default Value: ""

    Contains this file's creation time, in UTC.

    entryFormat
    FTPFileFormats
    Default Value: 0

    The file listing format:

    cfefUnknown0
    cfefUnix1
    cfefWindows2
    cfefMLSD3

    fileType
    FTPFileTypes
    Default Value: 0

    The type of the entry:

    fetUnknown0
    fetDirectory1
    fetFile2
    fetSymlink3
    fetSpecial4
    fetCurrentDirectory5
    fetParentDirectory6
    fetSocket7
    fetCharDevice8
    fetBlockDevice9
    fetFIFO10

    handle
    Int64
    Default Value: 0

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

    modificationTime
    String
    Default Value: ""

    File last modification date/time.

    name
    String
    Default Value: ""

    The file or directory name.

    path
    String
    Default Value: ""

    The full path to the file or directory.

    principal
    String
    Default Value: ""

    Specifies the owner of the file/directory.

    Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings.

    size
    Int64
    Default Value: 0

    File size in bytes.

    unixPerms
    Int32
    Default Value: 511

    The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)).

    unparsedName
    String
    Default Value: ""

    The unparsed entry as returned by the server. Sometimes this is also known as "long name".

    Constructors

    public init()

    Creates a new FTPListEntry object.

    ProxySettings Type

    A container for proxy server settings.

    Remarks

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

    The following fields are available:
  • Address
  • Authentication
  • Password
  • Port
  • ProxyType
  • RequestHeaders
  • ResponseBody
  • ResponseHeaders
  • UseIPv6
  • Username

    • Fields

    address
    String
    Default Value: ""

    The IP address of the proxy server.

    authentication
    ProxyAuthTypes
    Default Value: 0

    The authentication type used by the proxy server.

    patNoAuthentication0
    patBasic1
    patDigest2
    patNTLM3

    password
    String
    Default Value: ""

    The password to authenticate to the proxy server.

    port
    Int32
    Default Value: 0

    The port on the proxy server to connect to.

    proxyType
    ProxyTypes
    Default Value: 0

    The type of the proxy server.

    cptNone0
    cptSocks41
    cptSocks52
    cptWebTunnel3
    cptHTTP4

    requestHeaders
    String
    Default Value: ""

    Contains HTTP request headers for WebTunnel and HTTP proxy.

    responseBody
    String
    Default Value: ""

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

    responseHeaders
    String
    Default Value: ""

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

    useIPv6
    Bool
    Default Value: False

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

    username
    String
    Default Value: ""

    Specifies the username credential for proxy authentication.

    Constructors

    public init()

    Creates a new ProxySettings object.

    SocketSettings Type

    A container for the socket settings.

    Remarks

    This type is a container for socket-layer parameters.

    The following fields are available:
  • DNSMode
  • DNSPort
  • DNSQueryTimeout
  • DNSServers
  • DNSTotalTimeout
  • IncomingSpeedLimit
  • LocalAddress
  • LocalPort
  • OutgoingSpeedLimit
  • Timeout
  • UseIPv6

    • Fields

    dnsMode
    DNSResolveModes
    Default Value: 0

    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
    Default Value: 0

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

    dnsQueryTimeout
    Int32
    Default Value: 0

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

    dnsServers
    String
    Default Value: ""

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

    dnsTotalTimeout
    Int32
    Default Value: 0

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

    incomingSpeedLimit
    Int32
    Default Value: 0

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

    localAddress
    String
    Default Value: ""

    The local network interface to bind the socket to.

    localPort
    Int32
    Default Value: 0

    The local port number to bind the socket to.

    outgoingSpeedLimit
    Int32
    Default Value: 0

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

    timeout
    Int32
    Default Value: 60000

    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
    Default Value: False

    Enables or disables IP protocol version 6.

    Constructors

    public init()

    Creates a new SocketSettings object.

    SSHConnectionInfo Type

    Contains information about SSH connection.

    Remarks

    SSHConnectionInfo object contains information about one SSH connection.

    The following fields are available:
  • ClientKeyAlgorithm
  • ClientKeyBits
  • ClientKeyFingerprint
  • CloseReason
  • CompressionAlgorithmInbound
  • CompressionAlgorithmOutbound
  • EncryptionAlgorithmInbound
  • EncryptionAlgorithmOutbound
  • InboundEncryptionKeyBits
  • KexAlgorithm
  • KexBits
  • KexLines
  • MacAlgorithmInbound
  • MacAlgorithmOutbound
  • OutboundEncryptionKeyBits
  • PublicKeyAlgorithm
  • RemoteAddress
  • RemotePort
  • ServerKeyAlgorithm
  • ServerKeyBits
  • ServerKeyFingerprint
  • ServerSoftwareName
  • TotalBytesReceived
  • TotalBytesSent
  • Version

    • Fields

    clientKeyAlgorithm
    String (read-only)
    Default Value: ""

    Specifies the client's key algorithm.

    clientKeyBits
    Int32 (read-only)
    Default Value: 0

    Specifies the length of the client's key.

    clientKeyFingerprint
    String (read-only)
    Default Value: ""

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

    closeReason
    String (read-only)
    Default Value: ""

    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 (read-only)
    Default Value: ""

    Compression algorithm for the incoming traffic.

    compressionAlgorithmOutbound
    String (read-only)
    Default Value: ""

    Compression algorithm for the outgoing traffic.

    encryptionAlgorithmInbound
    String (read-only)
    Default Value: ""

    Encryption algorithm for the incoming traffic.

    encryptionAlgorithmOutbound
    String (read-only)
    Default Value: ""

    Encryption algorithm for the outgoing traffic.

    inboundEncryptionKeyBits
    Int32 (read-only)
    Default Value: 0

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

    kexAlgorithm
    String (read-only)
    Default Value: ""

    The key exchange algorithm used during the SSH handshake.

    kexBits
    Int32 (read-only)
    Default Value: 0

    The number of bits used by the key exchange algorithm.

    kexLines
    String (read-only)
    Default Value: ""

    The contents of the received KexInit packet.

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

    macAlgorithmInbound
    String (read-only)
    Default Value: ""

    MAC algorithm used for the incoming connection.

    macAlgorithmOutbound
    String (read-only)
    Default Value: ""

    MAC algorithm used for outbound connection.

    outboundEncryptionKeyBits
    Int32 (read-only)
    Default Value: 0

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

    publicKeyAlgorithm
    String (read-only)
    Default Value: ""

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

    remoteAddress
    String (read-only)
    Default Value: ""

    The client's IP address.

    remotePort
    Int32 (read-only)
    Default Value: 0

    The remote port of the client connection.

    serverKeyAlgorithm
    String (read-only)
    Default Value: ""

    Specifies the server's key algorithm.

    serverKeyBits
    Int32 (read-only)
    Default Value: 0

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

    serverKeyFingerprint
    String (read-only)
    Default Value: ""

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

    serverSoftwareName
    String (read-only)
    Default Value: ""

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

    totalBytesReceived
    Int64 (read-only)
    Default Value: 0

    Returns the total number of bytes received over this connection.

    totalBytesSent
    Int64 (read-only)
    Default Value: 0

    Returns the total number of bytes sent over this connection.

    version
    Int32 (read-only)
    Default Value: 2

    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.

    The following fields are available:
  • Algorithm
  • Bits
  • Comment
  • Curve
  • DSSG
  • DSSP
  • DSSQ
  • DSSX
  • DSSY
  • ECCD
  • ECCQX
  • ECCQY
  • EdPrivate
  • EdPublic
  • FingerprintMD5
  • FingerprintSHA1
  • FingerprintSHA256
  • Handle
  • IsExtractable
  • IsPrivate
  • IsPublic
  • KDFRounds
  • KDFSalt
  • KeyFormat
  • KeyProtectionAlgorithm
  • RSAExponent
  • RSAIQMP
  • RSAModulus
  • RSAP
  • RSAPrivateExponent
  • RSAQ
  • Subject

    • Fields

    algorithm
    String (read-only)
    Default Value: ""

    Specifies the key algorithm.

    The following algorithms are currently supported:

    • RSA
    • DSS
    • ECDSA
    • EDDSA

    bits
    Int32 (read-only)
    Default Value: 0

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

    comment
    String
    Default Value: ""

    The comment for the public key.

    curve
    String (read-only)
    Default Value: ""

    Specifies the elliptical curve when EC cryptography is used.

    The following curves are currently supported:

    • NISTP256
    • NISTP384
    • NISTP521
    • NISTK163
    • NISTP192
    • NISTP224
    • NISTK233
    • NISTB233
    • NISTK283
    • NISTK409
    • NISTB409
    • NISTK571
    • CURVE25519 (EdDSA curve)
    • CURVE448 (EdDSA curve)

    dssg
    Data (read-only)
    Default Value: ""

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

    dssp
    Data (read-only)
    Default Value: ""

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

    dssq
    Data (read-only)
    Default Value: ""

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

    dssx
    Data (read-only)
    Default Value: ""

    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 (read-only)
    Default Value: ""

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

    eccd
    Data (read-only)
    Default Value: ""

    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 (read-only)
    Default Value: ""

    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 (read-only)
    Default Value: ""

    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 (read-only)
    Default Value: ""

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

    edPublic
    Data (read-only)
    Default Value: ""

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

    fingerprintMD5
    String (read-only)
    Default Value: ""

    Contains the MD5 fingerprint (hash) of the key.

    fingerprintSHA1
    String (read-only)
    Default Value: ""

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

    fingerprintSHA256
    String (read-only)
    Default Value: ""

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

    handle
    Int64
    Default Value: 0

    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 (read-only)
    Default Value: False

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

    isPrivate
    Bool (read-only)
    Default Value: False

    Whether this key is a private key or not.

    isPublic
    Bool (read-only)
    Default Value: False

    Whether this key is a public key or not.

    kdfRounds
    Int32 (read-only)
    Default Value: 0

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

    kdfSalt
    Data (read-only)
    Default Value: ""

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

    keyFormat
    SSHKeyFormats (read-only)
    Default Value: 0

    Specifies the format in which the key is stored.

    ckfOpenSSH0
    ckfOpenSSH21
    ckfIETF2
    ckfPuTTY3
    ckfX5094
    ckfBinary5
    ckfSSH16
    ckfPGP7
    ckfPKCS88
    ckfPuTTY39

    keyProtectionAlgorithm
    String (read-only)
    Default Value: ""

    Specifies the key protection algorithm.

    rsaExponent
    Data (read-only)
    Default Value: ""

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

    rsaiqmp
    Data (read-only)
    Default Value: ""

    Returns the iqmp parameter of the RSA key.

    rsaModulus
    Data (read-only)
    Default Value: ""

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

    rsap
    Data (read-only)
    Default Value: ""

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

    rsaPrivateExponent
    Data (read-only)
    Default Value: ""

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

    rsaq
    Data (read-only)
    Default Value: ""

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

    subject
    String
    Default Value: ""

    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.

    The following fields are available:
  • AutoAdjustCiphers
  • BaseConfiguration
  • CompressionAlgorithms
  • CompressionLevel
  • DefaultWindowSize
  • EncryptionAlgorithms
  • ForceCompression
  • ForwardAuthAgent
  • GSSAuthTypes
  • GSSDelegateCreds
  • GSSHostname
  • GSSLib
  • GSSMechanisms
  • GSSProtocols
  • HandshakeTimeout
  • KexAlgorithms
  • MacAlgorithms
  • MaxSSHPacketSize
  • MinWindowSize
  • ObfuscateHandshake
  • ObfuscationPassword
  • PublicKeyAlgorithms
  • RequestPasswordChange
  • SoftwareName
  • TrustAllKeys
  • UseAuthAgent
  • Versions

    • Fields

    autoAdjustCiphers
    Bool
    Default Value: True

    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
    Default Value: 0

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

    compressionAlgorithms
    String
    Default Value: ""

    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
    Default Value: 6

    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
    Default Value: 2048000

    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
    Default Value: ""

    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
    Default Value: False

    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.

    forwardAuthAgent
    Bool
    Default Value: False

    Enables or disables auth agent forwarding. This allows the class to connect to the second and subsequent servers in the chain with the key agent available on the client computer.

    gssAuthTypes
    String
    Default Value: ""

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

    gssDelegateCreds
    Bool
    Default Value: False

    Switches credential delegation on or off.

    gssHostname
    String
    Default Value: ""

    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
    Default Value: ""

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

    gssMechanisms
    String
    Default Value: ""

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

    gssProtocols
    String
    Default Value: ""

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

    handshakeTimeout
    Int32
    Default Value: 45

    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
    Default Value: ""

    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
    • diffie-hellman-group14-sha256
    • diffie-hellman-group15-sha512
    • diffie-hellman-group16-sha512
    • diffie-hellman-group17-sha512
    • diffie-hellman-group18-sha512

    macAlgorithms
    String
    Default Value: ""

    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
    Default Value: 262144

    Specifies the maximum length of one SSH packet in bytes.

    minWindowSize
    Int32
    Default Value: 2048

    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
    Default Value: False

    Enables or disables handshake obfuscation.

    obfuscationPassword
    String
    Default Value: ""

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

    publicKeyAlgorithms
    String
    Default Value: ""

    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
    • rsa-sha2-256
    • rsa-sha2-512

    requestPasswordChange
    Bool
    Default Value: False

    Whether to request a password change when connecting.

    softwareName
    String
    Default Value: "SecureBlackbox"

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

    trustAllKeys
    Bool
    Default Value: False

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

    useAuthAgent
    Bool
    Default Value: False

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

    versions
    Int32
    Default Value: 1

    Specifies enabled SSH protocol versions (1 or 2).

    Constructors

    public init()

    Creates a new object with default settings.

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

    AllAlgorithms:   Returns the list of algorithms enabled in the component.

    Use this configuration setting to obtain the list of algorithms currently enabled in the component in the kexinit format.

    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.

    AvailableSpace:   Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work.

    This config property returns the details of the server disk space. The information is provided in the form of semicolon-separated entries: BytesOnDevice, UnusedBytesOnDevice, BytesAvailableToUser, UnusedBytesAvailableToUser, BytesPerAllocationUnit. You can use this property without parameters, or provide a specific mounting point in brackets: AvailableSpace(./path).

    CaseConversion:   Whether file names and paths should be case-converted.

    Defines whether file names are converted (on the destination system) to: lowercase (1), uppercase (2).

    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.

    CloseQuietly:   Controls the client's approach to session closure.

    The quiet closure entails the client shutting down the connection immediately without expecting graceful notifications from the other side. When closing non-quietly, the client will close the connection gradually, starting from the SSH session before proceeding to shutdown-based socket closure. Both options have their pros and cons; choose carefully the option that you want to use going forward.

    CommandTimeout:   Specifies the command timeout.

    Specifies the command timeout (the maximum time to expect the result from the SSH command), in milliseconds.

    CompressionAlgorithms:   Returns the list of compression algorithms enabled in the component.

    Use this configuration setting to get the list of compression algorithms currently enabled in the component, as a respective kexinit block line.

    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.

    DefaultTransferBlock:   Specifies the default transfer block size.

    This setting provides means to adjust the size of the SFTP transfer block (i.e. the size of the content of the write and read packets). It can be used to influence the transfer speed.

    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.

    EarlyIdString:   Enables the proactive approach to SSH handshake.

    The rule of thumb in the majority of SSH environments is for the server to initiate the handshake with its identification string (and for the client to respond). By setting this property to true you can tell the client to initiate the handshake by sending out the identification string proactively without waiting for the server to send one in. This setting may help in situations where your SSH or SFTP connection fails unexpectedly due to a timeout or network error.

    EncryptionAlgorithms:   Returns the list of encryption algorithms enabled in the component.

    Use this configuration setting to get the list of symmetric encryption algorithms currently enabled in the component, as a respective kexinit block line.

    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.

    FileHash:   Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work.

    Use this property to request the hash of a remote file. Pass the file name in brackets: FileHash(./path/file.ext). You can adjust the hash algorithm using the HashAlgorithm configuration setting.

    HashAlgorithm:   The hash algorithm to use for the protocol operations.

    Specifies the hash algorithm to use for file protocol operations, such as FileHash.

    HomeDir:   Returns a user's home directory. This protocol extension must be supported by the server for this request to work.

    Use this property to request a specific user's home directory on the server. Provide the username in brackets: HomeDir(user2).

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

    KexAlgorithms:   Returns the list of key exchange algorithms enabled in the component.

    Use this configuration setting to get the list of key exchange algorithms currently enabled in the component, as a respective kexinit block line.

    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.

    MacAlgorithms:   Returns the list of MAC algorithms enabled in the component.

    Use this configuration setting to get the list of MAC algorithms currently enabled in the component, as a respective kexinit block line.

    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.

    PublicKeyAlgorithms:   Returns the list of public key algorithms enabled in the component.

    Use this configuration setting to get the list of public key algorithms currently enabled in the component, as a respective kexinit block line.

    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.

    SocketRecvBufferSize:   The inbound socket buffer size.

    Use this property to adjust the size of the inbound socket buffer.

    SocketSendBufferSize:   The outbound socket buffer size.

    Use this property to adjust the size of the outbound socket buffer.

    StatVFS:   Returns VFS details. This protocol extension must be supported by the server for this request to work.

    This config property returns the VFS details of the server file system. The information is provided in the form of semicolon-separated entries. You can use this property without parameters, or provide a specific mounting point in brackets: StatVFS(./).

    StdErrData:   The buffer for writing StdErr data.

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

    SuppressAuxTransferOps:   TBD.

    TBD

    TempFolder:   Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work.

    Use this property to request a path to the temporary directory maintained by the server.

    TempPath:   Path for storing temporary files.

    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.

    TryPasswordAuth:   Specifies whether the component should attempt the password-based authentication if no password is set.

    If the Password property is not set, the component disables the password-based authentication. Set this property to true to make it try the empty password instead.

    UseStrictKeyExchange:   Specifies how strict key exchange is supported.

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

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

    0Disabled. Strict key exchange is not supported in the class.
    1 (default)Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue.
    2Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack.
    3Required. If the remote host does not support strict key exchange the connection will fail.

    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 Config Settings

    ASN1UseGlobalTagCache:   Controls whether ASN.1 module should use a global object cache.

    This is a performance setting. It is unlikely that you will ever need to adjust it.

    AssignSystemSmartCardPins:   Specifies whether CSP-level PINs should be assigned to CNG keys.

    This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

    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
    globalGlobal caching

    Cookies:   Gets or sets local cookies for the class.

    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.

    DNSLocalSuffix:   The suffix to assign for TLD names.

    Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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

    HardwareCryptoUsePolicy:   The hardware crypto usage policy.

    This global setting controls the hardware cryptography usage policy: auto, enable, or disable.

    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.

    HttpVersion:   The HTTP version to use in any inner HTTP client components created.

    Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

    IgnoreExpiredMSCTLSigningCert:   Whether to tolerate the expired Windows Update signing certificate.

    It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

    ListDelimiter:   The delimiter character for multi-element lists.

    Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

    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.

    OldClientSideRSAFallback:   Specifies whether the SSH client should use a SHA1 fallback.

    Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

    PKICache:   Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

    The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

    Supported Values:

    certificateEnables caching of certificates.
    crlEnables caching of Certificate Revocation Lists (CRLs).
    ocspEnables caching of OCSP (Online Certificate Status Protocol) responses.

    Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

    PKICachePath:   Specifies the file system path where cached PKI data is stored.

    The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

    The default value is an empty string - no cached PKI data is stored on disk.

    Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

    ProductVersion:   Returns the version of the SecureBlackbox library.

    This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

    ServerSSLDHKeyLength:   Sets the size of the TLS DHE key exchange group.

    Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

    StaticDNS:   Specifies whether static DNS rules should be used.

    Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

    Supported values are:

    noneNo static DNS rules (default)
    localLocal static DNS rules
    globalGlobal static DNS rules

    StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

    Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

    StaticIPAddresses:   Gets or sets all the static DNS rules.

    Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

    Tag:   Allows to store any custom data.

    Use this config property to store any custom data.

    TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

    Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

    TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

    Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

    TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

    Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

    UseCRLObjectCaching:   Specifies whether reuse of loaded CRL objects is enabled.

    This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

    UseInternalRandom:   Switches between SecureBlackbox-own and platform PRNGs.

    Allows to switch between internal/native PRNG implementation and the one provided by the platform.

    UseLegacyAdESValidation:   Enables legacy AdES validation mode.

    Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

    UseOCSPResponseObjectCaching:   Specifies whether reuse of loaded OCSP response objects is enabled.

    This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

    UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

    Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

    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.

    UseSystemNativeSizeCalculation:   An internal CryptoAPI access tweak.

    This is an internal setting. Please do not use it unless instructed by the support team.

    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.

    XMLRDNDescriptorName[OID]:   Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

    This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

    The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

    Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

    Where:

    OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

    PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

    Alias1, Alias2, ...: Optional alternative names recognized during parsing.

    Usage Examples:

    Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

    Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

    XMLRDNDescriptorPriority[OID]:   Specifies the priority of descriptor names associated with a specific OID.

    This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

    XMLRDNDescriptorReverseOrder:   Specifies whether to reverse the order of descriptors in RDN.

    Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

    XMLRDNDescriptorSeparator:   Specifies the separator used between descriptors in RDN.

    Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

    Trappable Errors (SFTPClient Module)

    SFTPClient Errors

    1048577   Invalid parameter (SB_ERROR_INVALID_PARAMETER)
    1048578   Invalid configuration (SB_ERROR_INVALID_SETUP)
    1048579   Invalid state (SB_ERROR_INVALID_STATE)
    1048580   Invalid value (SB_ERROR_INVALID_VALUE)
    1048581   Private key not found (SB_ERROR_NO_PRIVATE_KEY)
    1048582   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
    1048583   The file was not found (SB_ERROR_NO_SUCH_FILE)
    1048584   Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE)
    1048585   General error (SB_ERROR_GENERAL_ERROR)
    31457281   Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILE_OPERATION)
    31457282   Invalid authentication type (SB_ERROR_SFTP_INVALID_AUTH_TYPE)