FTPClient Module

Properties Methods Events Configuration Settings Errors

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

Syntax

SecureBlackbox.Ftpclient

Remarks

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

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

FTPClient is typically used in the following scenario:

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

Setting up the parameters

When working with FTP or FTP-over-TLS service you will often need to tune up several classes of settings:

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

Connecting to the server and signing in

Call Connect to open the connection to the server. The component will use the provided credentials to sign you in automatically.

Performing file transfer operations

FTPClient offers the full set of FTP operations. These include file uploads (UploadFile or UploadBytes), file downloads (DownloadFile, DownloadBytes), and directory operations (ListDir, MakeDir).

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

Closing the connection

Use Disconnect to close the FTP connection.

Useful info

During its work FTPClient communicates back via events. Progress event fires periodically during the transfer operation to let you know of the operation progress. ControlSend and ControlReceive report the protocol communication log. FileOperation and FileOperationResult report the start and completion of an individual transfer operation within a multi-file transfer call (such as UploadFiles).

Property List

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


AccountInfo	Parameters for the ACCT command.
AdjustPasvAddress	Enables or disables automatic adjustment of passive-mode addresses.
BlockedCertificates	The certificates that must be rejected as trust anchors.
ClientChain	The TLS client certificate chain.
Connected	Indicates whether the module is connected to the server.
ControlChannelLog	TBD.
ControlConnectionInfo	Returns the details of the control connection setup.
CurrentListEntry	Contains the details of the file entry reported by ListEntry .
DataConnectionInfo	Returns the details of the data connection setup.
EncryptDataChannel	Enables or disables data channel encryption.
ExternalCrypto	Provides access to external signing and DC parameters.
FIPSMode	Reserved.
KnownCertificates	Additional certificates for chain validation.
KnownCRLs	Additional CRLs for chain validation.
KnownOCSPs	Additional OCSP responses for chain validation.
ModeZ	Switches on data compression.
PassiveMode	Enables or disables passive transfer mode.
Password	The connecting user's authentication password.
Proxy	The proxy server settings.
RestartAt	The offset to restart the file transfer from.
ServerChain	The TLS server's certificate chain.
SocketSettings	Manages network connection settings.
TLSSettings	Manages TLS layer settings.
TransferType	Sets the file transfer mode.
TrustedCertificates	A list of trusted certificates for chain validation.
Username	The connecting user's username (login name).

Method List

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


Abort	Aborts the previous FTP service command and any associated transfer of data.
Acct	Sends an Account command.
AppendBytes	Appends a byte array to a server-side file.
AppendFile	Uploads a file to the server.
ChangeDir	Changes the current directory.
ClearCommandChannel	Sends CCC (Clear Command Channel) command to the server.
Config	Sets or retrieves a configuration setting.
Connect	Connects to the FTP server.
DeleteDir	Deletes a directory on the server.
DeleteFile	Deletes a file on the server.
DirExists	Checks if a directory exists on the server.
Disconnect	Disconnects from the server.
DoAction	Performs an additional action.
DownloadBytes	Downloads a file from the server into an array of bytes.
DownloadFile	Downloads a file from the server.
DownloadFiles	Downloads multiple files from the server.
FileExists	Checks if a file exists on the server.
GetCurrentDir	Returns the server-side current directory.
GetFileSize	Returns the size of a remote file.
ListDir	Lists the contents of a remote directory.
MakeDir	Creates a new directory on the server.
Noop	Sends a NOOP command to the server.
Rename	Renames a file.
SendCommand	Sends a custom command to the server.
UploadBytes	Uploads a byte array to the server.
UploadFile	Uploads a file to the server.
UploadFiles	Uploads 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.


CertificateValidate	Fires when the server's TLS certificate has to be validated.
ControlReceive	Fires when data is received via the control channel.
ControlSend	Fires when data is about to be set via the control channel.
Error	Information about errors during data delivery.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
FileOperation	Marks the start of a file transfer.
FileOperationResult	Reports the result of a file transfer operation.
ListEntry	Reports a single entry from the requested directory listing.
Notification	This event notifies the application about an underlying control flow event.
Progress	Reports the data transfer progress.
TextDataLine	Reports next transferred data line.
TLSEstablished	TBD.
TLSHandshake	TBD.
TLSPSK	TBD.
TLSShutdown	TBD.

Configuration Settings

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


AuthCmd	Authorization command to be used to request an explicit SSL session.
CaseConversion	Whether file names and paths should be case-converted.
CaseSensitive	Case-sensitivity of file names and paths.
CloseQuietly	Set this to true to avoid sending QUIT command on session closure.
ConcurrentConnections	Number of simultaneous connections for download.
CopyMode	What to do with the originals of the copied files.
ErrorOrigin	Specifies where the error has been originated.
ErrorSeverity	Error severity.
EventOrigin	Indicates the channel that has fired the event.
ExtHOSTSupported	Whether HOST extension is supported.
ExtMDTMSupported	Whether MDTM extension is supported.
ExtMFMTSupported	Whether MFMT extension is supported.
ExtMLSTSupported	Whether MLST extension is supported.
ExtOPTSUTF8Supported	Whether OPTS UTF8 extension is supported.
ExtRESTSupported	Whether REST extension is supported.
ExtSIZESupported	Whether SIZE extension is supported.
ExtXCRCSupported	Whether XCRC extension is supported.
ExtXMD5Supported	Whether XMD5 extension is supported.
FTPBufferSize	Buffer size in binary mode.
FTPTextBufferSize	Buffer size in text mode.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
ListenTimeout	Listening socket timeout.
LocalNewLineConvention	Defines the local newline convention.
MinSizeForConcurrentDownload	Files bigger than this size will be downloaded concurrently.
Mode	What to do if the destination file already exists.
Options	Various FTP options.
Recursive	Whether to scan subdirectories.
TempPath	Path for storing temporary files.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
TransferKeepAliveInterval	Keep-alive interval for the data channel transfers.
TransferTimeout	Timeout for data transfer in active mode.
UseMicrosoftCTL	Enables or disables automatic use of Microsoft online certificate trust list.
UseProxySettingsForDataChannel	Whether the proxy settings should be applied to data channel.
UseSystemCertificates	Enables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the module (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
Tag	Allows to store any custom data.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

AccountInfo Property (FTPClient Module)

Parameters for the ACCT command.

public var accountInfo: String {

  get {...}

  set {...}
}


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

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

Default Value

Remarks

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

AdjustPasvAddress Property (FTPClient Module)

Enables or disables automatic adjustment of passive-mode addresses.

Syntax

Swift
Objective-C

public var adjustPasvAddress: Bool {

  get {...}

  set {...}
}


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

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

Default Value

True

Remarks

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

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

BlockedCertificates Property (FTPClient Module)

The certificates that must be rejected as trust anchors.

Syntax

Swift
Objective-C

public var blockedCertificates: Array<Certificate> {

  get {...}
}


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

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

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

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

Default Value

Remarks

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

ClientChain Property (FTPClient Module)

The TLS client certificate chain.

Syntax

Swift
Objective-C

public var clientChain: Array<Certificate> {

  get {...}
}


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

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

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

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

Default Value

Remarks

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

Connected Property (FTPClient Module)

Indicates whether the module is connected to the server.

Syntax

Swift
Objective-C

public var connected: Bool {

  get {...}
}


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

- (BOOL)connected;

Default Value

False

Remarks

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

This property is read-only.

ControlChannelLog Property (FTPClient Module)

TBD.

Syntax

Swift
Objective-C

public var controlChannelLog: String {

  get {...}
}


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

- (NSString*)controlChannelLog;

Default Value

Remarks

TBD

This property is read-only.

ControlConnectionInfo Property (FTPClient Module)

Returns the details of the control connection setup.

Syntax

Swift
Objective-C

public var controlConnectionInfo: ConnectionInfo {

  get {...}
}


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

- (BOOL)ctlConnInfoAEADCipher;

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

- (int)ctlConnInfoChainValidationDetails;

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

- (int)ctlConnInfoChainValidationResult;

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

- (NSString*)ctlConnInfoCiphersuite;

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

- (BOOL)ctlConnInfoClientAuthenticated;

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

- (BOOL)ctlConnInfoClientAuthRequested;

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

- (BOOL)ctlConnInfoConnectionEstablished;

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

- (NSData*)ctlConnInfoConnectionID;

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

- (NSString*)ctlConnInfoDigestAlgorithm;

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

- (NSString*)ctlConnInfoEncryptionAlgorithm;

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

- (BOOL)ctlConnInfoExportable;

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

- (NSString*)ctlConnInfoKeyExchangeAlgorithm;

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

- (int)ctlConnInfoKeyExchangeKeyBits;

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

- (NSString*)ctlConnInfoNamedECCurve;

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

- (BOOL)ctlConnInfoPFSCipher;

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

- (NSString*)ctlConnInfoPreSharedIdentityHint;

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

- (int)ctlConnInfoPublicKeyBits;

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

- (BOOL)ctlConnInfoResumedSession;

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

- (BOOL)ctlConnInfoSecureConnection;

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

- (BOOL)ctlConnInfoServerAuthenticated;

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

- (NSString*)ctlConnInfoSignatureAlgorithm;

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

- (int)ctlConnInfoSymmetricBlockSize;

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

- (int)ctlConnInfoSymmetricKeyBits;

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

- (long long)ctlConnInfoTotalBytesReceived;

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

- (long long)ctlConnInfoTotalBytesSent;

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

- (NSString*)ctlConnInfoValidationLog;

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

- (NSString*)ctlConnInfoVersion;

Default Value

Remarks

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

CurrentListEntry Property (FTPClient Module)

Contains the details of the file entry reported by ListEntry .

Syntax

Swift
Objective-C

public var currentListEntry: FTPListEntry {

  get {...}
}


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

- (int)currListEntryEntryFormat;

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

- (NSString*)currListEntryFileDate;

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

- (int)currListEntryFileType;

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

- (long long)currListEntryHandle;

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

- (NSString*)currListEntryName;

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

- (NSString*)currListEntryPath;

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

- (NSString*)currListEntryRawData;

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

- (long long)currListEntrySize;

Default Value

Remarks

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

DataConnectionInfo Property (FTPClient Module)

Returns the details of the data connection setup.

Syntax

Swift
Objective-C

public var dataConnectionInfo: ConnectionInfo {

  get {...}
}


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

- (BOOL)dataConnInfoAEADCipher;

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

- (int)dataConnInfoChainValidationDetails;

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

- (int)dataConnInfoChainValidationResult;

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

- (NSString*)dataConnInfoCiphersuite;

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

- (BOOL)dataConnInfoClientAuthenticated;

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

- (BOOL)dataConnInfoClientAuthRequested;

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

- (BOOL)dataConnInfoConnectionEstablished;

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

- (NSData*)dataConnInfoConnectionID;

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

- (NSString*)dataConnInfoDigestAlgorithm;

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

- (NSString*)dataConnInfoEncryptionAlgorithm;

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

- (BOOL)dataConnInfoExportable;

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

- (NSString*)dataConnInfoKeyExchangeAlgorithm;

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

- (int)dataConnInfoKeyExchangeKeyBits;

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

- (NSString*)dataConnInfoNamedECCurve;

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

- (BOOL)dataConnInfoPFSCipher;

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

- (NSString*)dataConnInfoPreSharedIdentityHint;

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

- (int)dataConnInfoPublicKeyBits;

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

- (BOOL)dataConnInfoResumedSession;

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

- (BOOL)dataConnInfoSecureConnection;

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

- (BOOL)dataConnInfoServerAuthenticated;

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

- (NSString*)dataConnInfoSignatureAlgorithm;

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

- (int)dataConnInfoSymmetricBlockSize;

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

- (int)dataConnInfoSymmetricKeyBits;

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

- (long long)dataConnInfoTotalBytesReceived;

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

- (long long)dataConnInfoTotalBytesSent;

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

- (NSString*)dataConnInfoValidationLog;

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

- (NSString*)dataConnInfoVersion;

Default Value

Remarks

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

EncryptDataChannel Property (FTPClient Module)

Enables or disables data channel encryption.

Syntax

Swift
Objective-C

public var encryptDataChannel: Bool {

  get {...}

  set {...}
}


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

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

Default Value

True

Remarks

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

ExternalCrypto Property (FTPClient Module)

Provides access to external signing and DC parameters.

Syntax

Swift
Objective-C

public var externalCrypto: ExternalCrypto {

  get {...}
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default Value

Remarks

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

FIPSMode Property (FTPClient Module)

Reserved.

Syntax

Swift
Objective-C

public var fipsMode: Bool {

  get {...}

  set {...}
}


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

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

Default Value

False

Remarks

This property is reserved for future use.

KnownCertificates Property (FTPClient Module)

Additional certificates for chain validation.

Syntax

Swift
Objective-C

public var knownCertificates: Array<Certificate> {

  get {...}
}


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

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

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

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

Default Value

Remarks

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

KnownCRLs Property (FTPClient Module)

Additional CRLs for chain validation.

Syntax

Swift
Objective-C

public var knownCRLs: Array<CRL> {

  get {...}
}


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

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

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

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

Default Value

Remarks

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

KnownOCSPs Property (FTPClient Module)

Additional OCSP responses for chain validation.

Syntax

Swift
Objective-C

public var knownOCSPs: Array<OCSPResponse> {

  get {...}
}


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

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

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

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

Default Value

Remarks

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

ModeZ Property (FTPClient Module)

Switches on data compression.

Syntax

Swift
Objective-C

public var modeZ: Bool {

  get {...}

  set {...}
}


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

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

Default Value

True

Remarks

Switches the in-flight data compression on/off.

PassiveMode Property (FTPClient Module)

Enables or disables passive transfer mode.

Syntax

Swift
Objective-C

public var passiveMode: Bool {

  get {...}

  set {...}
}


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

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

Default Value

True

Remarks

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

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

Password Property (FTPClient Module)

The connecting user's authentication password.

Syntax

Swift
Objective-C

public var password: String {

  get {...}

  set {...}
}


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

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

Default Value

Remarks

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

Proxy Property (FTPClient Module)

The proxy server settings.

Syntax

Swift
Objective-C

public var proxy: ProxySettings {

  get {...}
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default Value

Remarks

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

RestartAt Property (FTPClient Module)

The offset to restart the file transfer from.

Syntax

Swift
Objective-C

public var restartAt: Int64 {

  get {...}

  set {...}
}


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

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

Default Value

-1

Remarks

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

ServerChain Property (FTPClient Module)

The TLS server's certificate chain.

Syntax

Swift
Objective-C

public var serverChain: Array<Certificate> {

  get {...}
}


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

- (int)serverCertCount;

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

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

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

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

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

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

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

- (int)serverCertKeyBits:(int)serverCertIndex;

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

- (int)serverCertKeyUsage:(int)serverCertIndex;

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

- (BOOL)serverCertSelfSigned:(int)serverCertIndex;

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

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

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

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

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

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

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

Default Value

Remarks

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

SocketSettings Property (FTPClient Module)

Manages network connection settings.

Syntax

Swift
Objective-C

public var socketSettings: SocketSettings {

  get {...}
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default Value

Remarks

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

TLSSettings Property (FTPClient Module)

Manages TLS layer settings.

Syntax

Swift
Objective-C

public var tlsSettings: TLSSettings {

  get {...}
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Default Value

Remarks

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

TransferType Property (FTPClient Module)

Sets the file transfer mode.

Syntax

Swift
Objective-C

public var transferType: FtpclientTransferTypes {

  get {...}

  set {...}
}

public enum FtpclientTransferTypes: Int32 {
  case cttText = 0

  case cttBinary = 1

}


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

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

Default Value

Remarks

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


cttText	`0`
cttBinary	`1`

TrustedCertificates Property (FTPClient Module)

A list of trusted certificates for chain validation.

Syntax

Swift
Objective-C

public var trustedCertificates: Array<Certificate> {

  get {...}
}


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

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

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

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

Default Value

Remarks

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

Username Property (FTPClient Module)

The connecting user's username (login name).

Syntax

Swift
Objective-C

public var username: String {

  get {...}

  set {...}
}


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

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

Default Value

Remarks

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

Abort Method (FTPClient Module)

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

Syntax

Swift
Objective-C

public func abort() throws -> Void

- (void)abort;

Remarks

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

Acct Method (FTPClient Module)

Sends an Account command.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

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

AppendBytes Method (FTPClient Module)

Appends a byte array to a server-side file.

Syntax

Swift
Objective-C

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

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

Remarks

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

AppendFile Method (FTPClient Module)

Uploads a file to the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

ChangeDir Method (FTPClient Module)

Changes the current directory.

Syntax

Swift
Objective-C

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

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

Remarks

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

ClearCommandChannel Method (FTPClient Module)

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

Syntax

Swift
Objective-C

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

- (void)clearCommandChannel:(BOOL)gracefulSSLClosure;

Remarks

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

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

Config Method (FTPClient Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

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

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

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

Connect Method (FTPClient Module)

Connects to the FTP server.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

DeleteDir Method (FTPClient Module)

Deletes a directory on the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

DeleteFile Method (FTPClient Module)

Deletes a file on the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

DirExists Method (FTPClient Module)

Checks if a directory exists on the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

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

Disconnect Method (FTPClient Module)

Disconnects from the server.

Syntax

Swift
Objective-C

public func disconnect() throws -> Void

- (void)disconnect;

Remarks

Call this method to disconnect from the server.

DoAction Method (FTPClient Module)

Performs an additional action.

Syntax

Swift
Objective-C

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

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

Remarks

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

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DownloadBytes Method (FTPClient Module)

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

Syntax

Swift
Objective-C

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

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

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (FTPClient Module)

Downloads a file from the server.

Syntax

Swift
Objective-C

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

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

Remarks

Use this method to download RemoteFile into LocalFile.

DownloadFiles Method (FTPClient Module)

Downloads multiple files from the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

FileExists Method (FTPClient Module)

Checks if a file exists on the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

GetCurrentDir Method (FTPClient Module)

Returns the server-side current directory.

Syntax

Swift
Objective-C

public func getCurrentDir() throws -> String

- (NSString*)getCurrentDir;

Remarks

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

GetFileSize Method (FTPClient Module)

Returns the size of a remote file.

Syntax

Swift
Objective-C

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

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

Remarks

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

ListDir Method (FTPClient Module)

Lists the contents of a remote directory.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

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

MakeDir Method (FTPClient Module)

Creates a new directory on the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

Noop Method (FTPClient Module)

Sends a NOOP command to the server.

Syntax

Swift
Objective-C

public func noop() throws -> Void

- (void)noop;

Remarks

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

Rename Method (FTPClient Module)

Renames a file.

Syntax

Swift
Objective-C

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

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

Remarks

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

SendCommand Method (FTPClient Module)

Sends a custom command to the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

UploadBytes Method (FTPClient Module)

Uploads a byte array to the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

UploadFile Method (FTPClient Module)

Uploads a file to the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

UploadFiles Method (FTPClient Module)

Uploads multiple files to the server.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

CertificateValidate Event (FTPClient Module)

Fires when the server's TLS certificate has to be validated.

Syntax

Swift
Objective-C

func onCertificateValidate(address: String, accept: inout Bool)

- (void)onCertificateValidate:(NSString*)address :(int*)accept;

Remarks

The class fires this event upon receiving the server's certificate during TLS handshake. The subscriber to this event has to validate the certificate and return its status back to the class using the Accept parameter.

The Address parameter indicates the address of the server the connection is being established to.

This event is fired independently of the AutoValidateCertificates setting. If this setting is false, the event handler (and your code) is responsible for validating the certificate chain and returning the result back to the component through the Accept parameter. Note that setting AutoValidateCertificates to false and not performing any validation inside the handler of this event creates a serious security vulnerability, which can lead to grave consequences.

The exact validation method to use depends on your circumstances, and may range from comparing the certificate to its legit and trusted copy (sometimes called certificate pinning), to fully-fledged chain validation. CertificateValidator component is one of the options to build your chain validation on.

If AutoValidateCertificates is true, the chain has already been validated internally by the component by the time this event fires, and the value of Accept reflects the outcome of that check. You can perform your own, additional validation even when using AutoValidateCertificates mode, and adjust Accept if needed.

ControlReceive Event (FTPClient Module)

Fires when data is received via the control channel.

Syntax

Swift
Objective-C

func onControlReceive(textLine: String)

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

Remarks

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

ControlSend Event (FTPClient Module)

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

Syntax

Swift
Objective-C

func onControlSend(textLine: String)

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

Remarks

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

Error Event (FTPClient Module)

Information about errors during data delivery.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

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

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the FTP section.

ExternalSign Event (FTPClient Module)

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

Syntax

Swift
Objective-C

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

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

Remarks

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

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

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

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

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

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

FileOperation Event (FTPClient Module)

Marks the start of a file transfer.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

Operations:


cffoDownloadFile	`0`	Download file
cffoUploadFile	`1`	Upload file
cffoDeleteFile	`2`	Delete file
cffoMakeDir	`3`	Make directory

FileOperationResult Event (FTPClient Module)

Reports the result of a file transfer operation.

Syntax

Swift
Objective-C

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

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

Remarks

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

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

Operations:


cffoDownloadFile	`0`	Download file
cffoUploadFile	`1`	Upload file
cffoDeleteFile	`2`	Delete file
cffoMakeDir	`3`	Make directory

ListEntry Event (FTPClient Module)

Reports a single entry from the requested directory listing.

Syntax

Swift
Objective-C

func onListEntry(filename: String)

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

Remarks

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

Notification Event (FTPClient Module)

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

Syntax

Swift
Objective-C

func onNotification(eventID: String, eventParam: String)

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

Remarks

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

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

Progress Event (FTPClient Module)

Reports the data transfer progress.

Syntax

Swift
Objective-C

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

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

Remarks

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

Use the Cancel parameter to terminate the transfer if needed.

TextDataLine Event (FTPClient Module)

Reports next transferred data line.

Syntax

Swift
Objective-C

func onTextDataLine(textLine: String)

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

Remarks

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

TLSEstablished Event (FTPClient Module)

TBD.

Syntax

Swift
Objective-C

func onTLSEstablished()

- (void)onTLSEstablished;

Remarks

TBD

TLSHandshake Event (FTPClient Module)

TBD.

Syntax

Swift
Objective-C

func onTLSHandshake()

- (void)onTLSHandshake;

Remarks

TBD

TLSPSK Event (FTPClient Module)

TBD.

Syntax

Swift
Objective-C

func onTLSPSK(hint: String)

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

Remarks

TBD

TLSShutdown Event (FTPClient Module)

TBD.

Syntax

Swift
Objective-C

func onTLSShutdown()

- (void)onTLSShutdown;

Remarks

TBD

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

bytes
Data

Returns raw certificate data in DER format.

ca
Bool

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

caKeyID
Data

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

crlDistributionPoints
String

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

curve
String

Specifies the elliptic curve of the EC public key.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

fingerprint
Data

Contains the fingerprint (a hash imprint) of this certificate.

friendlyName
String

Contains an associated alias (friendly name) of the certificate.

handle
Int64

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

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

hashAlgorithm
String

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

issuer
String

The common name of the certificate issuer (CA), typically a company name.

issuerRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

keyAlgorithm
String

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

keyBits
Int32

Returns the length of the public key.

keyFingerprint
Data

Returns a fingerprint of the public key contained in the certificate.

keyUsage
Int32

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

keyValid
Bool

Returns True if the certificate's key is cryptographically valid, and False otherwise.

ocspLocations
String

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

ocspNoCheck
Bool

TBD.

origin
Int32

Returns the origin of this certificate.

policyIDs
String

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

privateKeyBytes
Data

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

privateKeyExists
Bool

Indicates whether the certificate has an associated private key.

privateKeyExtractable
Bool

Indicates whether the private key is extractable

publicKeyBytes
Data

Contains the certificate's public key in DER format.

qualifiedStatements
QualifiedStatementsTypes

TBD

selfSigned
Bool

Indicates whether the certificate is self-signed (root) or signed by an external CA.

serialNumber
Data

Returns the certificate's serial number.

sigAlgorithm
String

Indicates the algorithm that was used by the CA to sign this certificate.

subject
String

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

subjectAlternativeName
String

TBD.

subjectKeyID
Data

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

subjectRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

validFrom
String

The time point at which the certificate becomes valid, in UTC.

validTo
String

The time point at which the certificate expires, in UTC.

Constructors

public init(stream: InputStream?)

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

public init()

Creates a new object with default field values.

ConnectionInfo Type

Contains information about a network connection.

Remarks

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

Fields

aeadCipher
Bool

Indicates whether the encryption algorithm used is an AEAD cipher.

chainValidationDetails
Int32

The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.

Returns a bit mask of the following options:


cvrBadData	`0x0001`	One or more certificates in the validation path are malformed
cvrRevoked	`0x0002`	One or more certificates are revoked
cvrNotYetValid	`0x0004`	One or more certificates are not yet valid
cvrExpired	`0x0008`	One or more certificates are expired
cvrInvalidSignature	`0x0010`	A certificate contains a non-valid digital signature
cvrUnknownCA	`0x0020`	A CA certificate for one or more certificates has not been found (chain incomplete)
cvrCAUnauthorized	`0x0040`	One of the CA certificates are not authorized to act as CA
cvrCRLNotVerified	`0x0080`	One or more CRLs could not be verified
cvrOCSPNotVerified	`0x0100`	One or more OCSP responses could not be verified
cvrIdentityMismatch	`0x0200`	The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate
cvrNoKeyUsage	`0x0400`	A mandatory key usage is not enabled in one of the chain certificates
cvrBlocked	`0x0800`	One or more certificates are blocked
cvrFailure	`0x1000`	General validation failure
cvrChainLoop	`0x2000`	Chain loop: one of the CA certificates recursively signs itself
cvrWeakAlgorithm	`0x4000`	A weak algorithm is used in one of certificates or revocation elements
cvrUserEnforced	`0x8000`	The chain was considered invalid following intervention from a user code

chainValidationResult
ChainValidities

The outcome of a certificate chain validation routine.

Available options:


cvtValid	`0`	The chain is valid
cvtValidButUntrusted	`1`	The chain is valid, but the root certificate is not trusted
cvtInvalid	`2`	The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)
cvtCantBeEstablished	`3`	The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

ciphersuite
String

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

clientAuthenticated
Bool

Specifies whether client authentication was performed during this connection.

clientAuthRequested
Bool

Specifies whether client authentication was requested during this connection.

connectionEstablished
Bool

Indicates whether the connection has been established fully.

connectionID
Data

The unique identifier assigned to this connection.

digestAlgorithm
String

The digest algorithm used in a TLS-enabled connection.

encryptionAlgorithm
String

The symmetric encryption algorithm used in a TLS-enabled connection.

exportable
Bool

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

keyExchangeAlgorithm
String

The key exchange algorithm used in a TLS-enabled connection.

keyExchangeKeyBits
Int32

The length of the key exchange key of a TLS-enabled connection.

namedECCurve
String

The elliptic curve used in this connection.

pfsCipher
Bool

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

preSharedIdentityHint
String

A hint professed by the server to help the client select the PSK identity to use.

publicKeyBits
Int32

The length of the public key.

resumedSession
Bool

Indicates whether a TLS-enabled connection was spawned from another TLS connection

secureConnection
Bool

Indicates whether TLS or SSL is enabled for this connection.

serverAuthenticated
Bool

Indicates whether server authentication was performed during a TLS-enabled connection.

signatureAlgorithm
String

The signature algorithm used in a TLS handshake.

symmetricBlockSize
Int32

The block size of the symmetric algorithm used.

symmetricKeyBits
Int32

The key length of the symmetric algorithm used.

totalBytesReceived
Int64

The total number of bytes received over this connection.

totalBytesSent
Int64

The total number of bytes sent over this connection.

validationLog
String

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

version
String

Indicates the version of SSL/TLS protocol negotiated during this connection.

Constructors

public init()

Creates a new ConnectionInfo object.

CRL Type

Represents a Certificate Revocation List.

Remarks

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

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

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

Fields


bytes Data	Returns raw CRL data in DER format.
caKeyID Data	A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
entryCount Int32	Returns the number of certificate status entries in the CRL.
handle Int64	Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. `pdfSigner.setSigningCertHandle(certMgr.getCertHandle());`
issuer String	The common name of the CRL issuer (CA), typically a company name.
issuerRDN String	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
location String	The URL that the CRL was downloaded from.
nextUpdate String	The planned time and date of the next version of this CRL to be published.
sigAlgorithm String	The public key algorithm that was used by the CA to sign this CRL.
tbs Data	The to-be-signed part of the CRL (the CRL without the signature part).
thisUpdate String	The date and time at which this version of the CRL was published.

Constructors

public init()

Creates an empty CRL object.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

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

Fields

asyncDocumentID
String

Specifies the document ID for SignAsyncEnd() call

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

customParams
String

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

data
String

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

externalHashCalculation
Bool

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

hashAlgorithm
String

Specifies the request's signature hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

keyID
String

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

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

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

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

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

keySecret
String

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

Read more about configuring authentication in the topic.

method
AsyncSignMethods

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

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

mode
ExternalCryptoModes

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

publicKeyAlgorithm
String

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


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-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.

Fields

entryFormat
FTPFileFormats

The file listing format:


cfefUnknown	`0`
cfefUnix	`1`
cfefWindows	`2`
cfefMLSD	`3`

fileDate
String

File last modification date.

fileType
FTPFileTypes

The type of the entry:


cfetUnknown	`0`
cfetDirectory	`1`
cfetFile	`2`
cfetSymlink	`3`
cfetSpecial	`4`
cfetCurrentDirectory	`5`
cfetParentDirectory	`6`

handle
Int64

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

name
String

The file or directory name.

path
String

The full path to the file or directory.

rawData
String

The unparsed entry as returned by the server.

size
Int64

File size in bytes.

Constructors

public init()

Creates a new FTPListEntry object.

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

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

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

Fields


bytes Data	Buffer containing raw OCSP response data.
entryCount Int32	The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
handle Int64	Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. `pdfSigner.setSigningCertHandle(certMgr.getCertHandle());`
issuer String	Indicates the issuer of this response (a CA or its authorized representative).
issuerRDN String	Indicates the RDN of the issuer of this response (a CA or its authorized representative).
location String	Location of the OCSP responder.
producedAt String	Specifies the time when the response was produced, in UTC.

Constructors

public init()

Creates an empty OCSP response object.

ProxySettings Type

A container for proxy server settings.

Remarks

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

Fields

address
String

The IP address of the proxy server.

authentication
ProxyAuthTypes

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

password
String

The password to authenticate to the proxy server.

port
Int32

The port on the proxy server to connect to.

proxyType
ProxyTypes

The type of the proxy server.

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


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

requestHeaders
String

Contains HTTP request headers for WebTunnel and HTTP proxy.

responseBody
String

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

responseHeaders
String

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

useIPv6
Bool

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

useProxy
Bool

Enables or disables proxy-driven connection.

username
String

Specifies the username credential for proxy authentication.

Constructors

public init()

Creates a new ProxySettings object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

dnsMode
DNSResolveModes

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


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

dnsPort
Int32

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

dnsQueryTimeout
Int32

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

dnsServers
String

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

dnsTotalTimeout
Int32

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

incomingSpeedLimit
Int32

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

localAddress
String

The local network interface to bind the socket to.

localPort
Int32

The local port number to bind the socket to.

outgoingSpeedLimit
Int32

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

timeout
Int32

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

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

useIPv6
Bool

Enables or disables IP protocol version 6.

Constructors

public init()

Creates a new SocketSettings object.

TLSSettings Type

A container for TLS connection settings.

Remarks

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

Fields

autoValidateCertificates
Bool

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

baseConfiguration
SecureTransportPredefinedConfigurations

Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.


stpcDefault	`0`
stpcCompatible	`1`
stpcComprehensiveInsecure	`2`
stpcHighlySecure	`3`

ciphersuites
String

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

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

NULL_NULL_NULL
RSA_NULL_MD5
RSA_NULL_SHA
RSA_RC4_MD5
RSA_RC4_SHA
RSA_RC2_MD5
RSA_IDEA_MD5
RSA_IDEA_SHA
RSA_DES_MD5
RSA_DES_SHA
RSA_3DES_MD5
RSA_3DES_SHA
RSA_AES128_SHA
RSA_AES256_SHA
DH_DSS_DES_SHA
DH_DSS_3DES_SHA
DH_DSS_AES128_SHA
DH_DSS_AES256_SHA
DH_RSA_DES_SHA
DH_RSA_3DES_SHA
DH_RSA_AES128_SHA
DH_RSA_AES256_SHA
DHE_DSS_DES_SHA
DHE_DSS_3DES_SHA
DHE_DSS_AES128_SHA
DHE_DSS_AES256_SHA
DHE_RSA_DES_SHA
DHE_RSA_3DES_SHA
DHE_RSA_AES128_SHA
DHE_RSA_AES256_SHA
DH_ANON_RC4_MD5
DH_ANON_DES_SHA
DH_ANON_3DES_SHA
DH_ANON_AES128_SHA
DH_ANON_AES256_SHA
RSA_RC2_MD5_EXPORT
RSA_RC4_MD5_EXPORT
RSA_DES_SHA_EXPORT
DH_DSS_DES_SHA_EXPORT
DH_RSA_DES_SHA_EXPORT
DHE_DSS_DES_SHA_EXPORT
DHE_RSA_DES_SHA_EXPORT
DH_ANON_RC4_MD5_EXPORT
DH_ANON_DES_SHA_EXPORT
RSA_CAMELLIA128_SHA
DH_DSS_CAMELLIA128_SHA
DH_RSA_CAMELLIA128_SHA
DHE_DSS_CAMELLIA128_SHA
DHE_RSA_CAMELLIA128_SHA
DH_ANON_CAMELLIA128_SHA
RSA_CAMELLIA256_SHA
DH_DSS_CAMELLIA256_SHA
DH_RSA_CAMELLIA256_SHA
DHE_DSS_CAMELLIA256_SHA
DHE_RSA_CAMELLIA256_SHA
DH_ANON_CAMELLIA256_SHA
PSK_RC4_SHA
PSK_3DES_SHA
PSK_AES128_SHA
PSK_AES256_SHA
DHE_PSK_RC4_SHA
DHE_PSK_3DES_SHA
DHE_PSK_AES128_SHA
DHE_PSK_AES256_SHA
RSA_PSK_RC4_SHA
RSA_PSK_3DES_SHA
RSA_PSK_AES128_SHA
RSA_PSK_AES256_SHA
RSA_SEED_SHA
DH_DSS_SEED_SHA
DH_RSA_SEED_SHA
DHE_DSS_SEED_SHA
DHE_RSA_SEED_SHA
DH_ANON_SEED_SHA
SRP_SHA_3DES_SHA
SRP_SHA_RSA_3DES_SHA
SRP_SHA_DSS_3DES_SHA
SRP_SHA_AES128_SHA
SRP_SHA_RSA_AES128_SHA
SRP_SHA_DSS_AES128_SHA
SRP_SHA_AES256_SHA
SRP_SHA_RSA_AES256_SHA
SRP_SHA_DSS_AES256_SHA
ECDH_ECDSA_NULL_SHA
ECDH_ECDSA_RC4_SHA
ECDH_ECDSA_3DES_SHA
ECDH_ECDSA_AES128_SHA
ECDH_ECDSA_AES256_SHA
ECDHE_ECDSA_NULL_SHA
ECDHE_ECDSA_RC4_SHA
ECDHE_ECDSA_3DES_SHA
ECDHE_ECDSA_AES128_SHA
ECDHE_ECDSA_AES256_SHA
ECDH_RSA_NULL_SHA
ECDH_RSA_RC4_SHA
ECDH_RSA_3DES_SHA
ECDH_RSA_AES128_SHA
ECDH_RSA_AES256_SHA
ECDHE_RSA_NULL_SHA
ECDHE_RSA_RC4_SHA
ECDHE_RSA_3DES_SHA
ECDHE_RSA_AES128_SHA
ECDHE_RSA_AES256_SHA
ECDH_ANON_NULL_SHA
ECDH_ANON_RC4_SHA
ECDH_ANON_3DES_SHA
ECDH_ANON_AES128_SHA
ECDH_ANON_AES256_SHA
RSA_NULL_SHA256
RSA_AES128_SHA256
RSA_AES256_SHA256
DH_DSS_AES128_SHA256
DH_RSA_AES128_SHA256
DHE_DSS_AES128_SHA256
DHE_RSA_AES128_SHA256
DH_DSS_AES256_SHA256
DH_RSA_AES256_SHA256
DHE_DSS_AES256_SHA256
DHE_RSA_AES256_SHA256
DH_ANON_AES128_SHA256
DH_ANON_AES256_SHA256
RSA_AES128_GCM_SHA256
RSA_AES256_GCM_SHA384
DHE_RSA_AES128_GCM_SHA256
DHE_RSA_AES256_GCM_SHA384
DH_RSA_AES128_GCM_SHA256
DH_RSA_AES256_GCM_SHA384
DHE_DSS_AES128_GCM_SHA256
DHE_DSS_AES256_GCM_SHA384
DH_DSS_AES128_GCM_SHA256
DH_DSS_AES256_GCM_SHA384
DH_ANON_AES128_GCM_SHA256
DH_ANON_AES256_GCM_SHA384
ECDHE_ECDSA_AES128_SHA256
ECDHE_ECDSA_AES256_SHA384
ECDH_ECDSA_AES128_SHA256
ECDH_ECDSA_AES256_SHA384
ECDHE_RSA_AES128_SHA256
ECDHE_RSA_AES256_SHA384
ECDH_RSA_AES128_SHA256
ECDH_RSA_AES256_SHA384
ECDHE_ECDSA_AES128_GCM_SHA256
ECDHE_ECDSA_AES256_GCM_SHA384
ECDH_ECDSA_AES128_GCM_SHA256
ECDH_ECDSA_AES256_GCM_SHA384
ECDHE_RSA_AES128_GCM_SHA256
ECDHE_RSA_AES256_GCM_SHA384
ECDH_RSA_AES128_GCM_SHA256
ECDH_RSA_AES256_GCM_SHA384
PSK_AES128_GCM_SHA256
PSK_AES256_GCM_SHA384
DHE_PSK_AES128_GCM_SHA256
DHE_PSK_AES256_GCM_SHA384
RSA_PSK_AES128_GCM_SHA256
RSA_PSK_AES256_GCM_SHA384
PSK_AES128_SHA256
PSK_AES256_SHA384
PSK_NULL_SHA256
PSK_NULL_SHA384
DHE_PSK_AES128_SHA256
DHE_PSK_AES256_SHA384
DHE_PSK_NULL_SHA256
DHE_PSK_NULL_SHA384
RSA_PSK_AES128_SHA256
RSA_PSK_AES256_SHA384
RSA_PSK_NULL_SHA256
RSA_PSK_NULL_SHA384
RSA_CAMELLIA128_SHA256
DH_DSS_CAMELLIA128_SHA256
DH_RSA_CAMELLIA128_SHA256
DHE_DSS_CAMELLIA128_SHA256
DHE_RSA_CAMELLIA128_SHA256
DH_ANON_CAMELLIA128_SHA256
RSA_CAMELLIA256_SHA256
DH_DSS_CAMELLIA256_SHA256
DH_RSA_CAMELLIA256_SHA256
DHE_DSS_CAMELLIA256_SHA256
DHE_RSA_CAMELLIA256_SHA256
DH_ANON_CAMELLIA256_SHA256
ECDHE_ECDSA_CAMELLIA128_SHA256
ECDHE_ECDSA_CAMELLIA256_SHA384
ECDH_ECDSA_CAMELLIA128_SHA256
ECDH_ECDSA_CAMELLIA256_SHA384
ECDHE_RSA_CAMELLIA128_SHA256
ECDHE_RSA_CAMELLIA256_SHA384
ECDH_RSA_CAMELLIA128_SHA256
ECDH_RSA_CAMELLIA256_SHA384
RSA_CAMELLIA128_GCM_SHA256
RSA_CAMELLIA256_GCM_SHA384
DHE_RSA_CAMELLIA128_GCM_SHA256
DHE_RSA_CAMELLIA256_GCM_SHA384
DH_RSA_CAMELLIA128_GCM_SHA256
DH_RSA_CAMELLIA256_GCM_SHA384
DHE_DSS_CAMELLIA128_GCM_SHA256
DHE_DSS_CAMELLIA256_GCM_SHA384
DH_DSS_CAMELLIA128_GCM_SHA256
DH_DSS_CAMELLIA256_GCM_SHA384
DH_anon_CAMELLIA128_GCM_SHA256
DH_anon_CAMELLIA256_GCM_SHA384
ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
ECDH_ECDSA_CAMELLIA128_GCM_SHA256
ECDH_ECDSA_CAMELLIA256_GCM_SHA384
ECDHE_RSA_CAMELLIA128_GCM_SHA256
ECDHE_RSA_CAMELLIA256_GCM_SHA384
ECDH_RSA_CAMELLIA128_GCM_SHA256
ECDH_RSA_CAMELLIA256_GCM_SHA384
PSK_CAMELLIA128_GCM_SHA256
PSK_CAMELLIA256_GCM_SHA384
DHE_PSK_CAMELLIA128_GCM_SHA256
DHE_PSK_CAMELLIA256_GCM_SHA384
RSA_PSK_CAMELLIA128_GCM_SHA256
RSA_PSK_CAMELLIA256_GCM_SHA384
PSK_CAMELLIA128_SHA256
PSK_CAMELLIA256_SHA384
DHE_PSK_CAMELLIA128_SHA256
DHE_PSK_CAMELLIA256_SHA384
RSA_PSK_CAMELLIA128_SHA256
RSA_PSK_CAMELLIA256_SHA384
ECDHE_PSK_CAMELLIA128_SHA256
ECDHE_PSK_CAMELLIA256_SHA384
ECDHE_PSK_RC4_SHA
ECDHE_PSK_3DES_SHA
ECDHE_PSK_AES128_SHA
ECDHE_PSK_AES256_SHA
ECDHE_PSK_AES128_SHA256
ECDHE_PSK_AES256_SHA384
ECDHE_PSK_NULL_SHA
ECDHE_PSK_NULL_SHA256
ECDHE_PSK_NULL_SHA384
ECDHE_RSA_CHACHA20_POLY1305_SHA256
ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
DHE_RSA_CHACHA20_POLY1305_SHA256
PSK_CHACHA20_POLY1305_SHA256
ECDHE_PSK_CHACHA20_POLY1305_SHA256
DHE_PSK_CHACHA20_POLY1305_SHA256
RSA_PSK_CHACHA20_POLY1305_SHA256
AES128_GCM_SHA256
AES256_GCM_SHA384
CHACHA20_POLY1305_SHA256
AES128_CCM_SHA256
AES128_CCM8_SHA256

ecCurves
String

Defines the elliptic curves to enable.

extensions
String

Provides access to TLS extensions.

forceResumeIfDestinationChanges
Bool

Whether to force TLS session resumption when the destination address changes.

preSharedIdentity
String

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

preSharedKey
String

Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

preSharedKeyCiphersuite
String

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

renegotiationAttackPreventionMode
RenegotiationAttackPreventionModes

Selects renegotiation attack prevention mechanism.

The following options are available:


crapmCompatible	`0`	TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict	`1`	Renegotiation attack prevention is enabled and enforced.
crapmAuto	`2`	Automatically choose whether to enable or disable renegotiation attack prevention.

revocationCheck
RevocationCheckKinds

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.


crcNone (`0`)	No revocation checking
crcAuto (`1`)	Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL (`2`)	Check all provided CRL endpoints for all chain certificates.
crcAllOCSP (`3`)	Check all provided OCSP endpoints for all chain certificates.
crcAllCRLAndOCSP (`4`)	Check all CRL and OCSP endpoints for all chain certificates.
crcAnyCRL (`5`)	At least one CRL check for every certificate in the chain must succeed.
crcAnyOCSP (`6`)	At least one OCSP check for every certificate in the chain must succeed.
crcAnyCRLOrOCSP (`7`)	At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL (`8`)	At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

sslOptions
Int32

Various SSL (TLS) protocol options, set of


cssloExpectShutdownMessage	`0x001`	Wait for the close-notify message when shutting down the connection
cssloOpenSSLDTLSWorkaround	`0x002`	(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions
cssloDisableKexLengthAlignment	`0x004`	Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.
cssloForceUseOfClientCertHashAlg	`0x008`	Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it.
cssloAutoAddServerNameExtension	`0x010`	Automatically add server name extension when known
cssloAcceptTrustedSRPPrimesOnly	`0x020`	Accept trusted SRP primes only
cssloDisableSignatureAlgorithmsExtension	`0x040`	Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it.
cssloIntolerateHigherProtocolVersions	`0x080`	(server option) Do not allow fallback from TLS versions higher than currently enabled
cssloStickToPrefCertHashAlg	`0x100`	Stick to preferred certificate hash algorithms
cssloNoImplicitTLS12Fallback	`0x200`	Disable implicit TLS 1.3 to 1.2 fallbacks
cssloUseHandshakeBatches	`0x400`	Send handshake message as large batches rather than individually

tlsMode
SSLModes

Specifies the TLS mode to use.


smDefault	`0`
smNoTLS	`1`	Do not use TLS
smExplicitTLS	`2`	Connect to the server without any encryption and then request an SSL session.
smImplicitTLS	`3`	Connect to the specified port, and establish the SSL session at once.

useExtendedMasterSecret
Bool

Enables Extended Master Secret Extension, as defined in RFC 7627.

useSessionResumption
Bool

Enables or disables TLS session resumption capability.

versions
Int32

Th SSL/TLS versions to enable by default.


csbSSL2	`0x01`	SSL 2
csbSSL3	`0x02`	SSL 3
csbTLS1	`0x04`	TLS 1.0
csbTLS11	`0x08`	TLS 1.1
csbTLS12	`0x10`	TLS 1.2
csbTLS13	`0x20`	TLS 1.3

Constructors

public init()

Creates a new TLSSettings object.

Configuration Settings (FTPClient 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.

FTPClient Configuration Settings

AuthCmd: Authorization command to be used to request an explicit SSL session.

Use this property to specify the authorization command that will be used to request an explicit SSL session. The following choices are possible: 0 - Auto, 1 - TLS, 2 - SSL, 3 - TLSP, 4 - TLSC. Different servers support different commands, so in most cases it is a good idea to set this property to 0.

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: Case-sensitivity of file names and paths.

Whether file paths and names are case-sensitive.

CloseQuietly: Set this to true to avoid sending QUIT command on session closure.

Set this property to true to tell the component not to send the QUIT command when closing the connection.

ConcurrentConnections: Number of simultaneous connections for download.

The maximum number of concurrent connections that may be opened for download. This feature is not available if the server does not support file size requests.

CopyMode: What to do with the originals of the copied files.

Defines what to do with the originals of the files which have been copied. You can choose to just leave them, delete each original right after it has been copied, or delete files only when all of them have been transferred.

ErrorOrigin: Specifies where the error has been originated.

Specifies where the error has been originated, on the server or client side.

ErrorSeverity: Error severity.

Specifies whether a warning or an error encountered.

EventOrigin: Indicates the channel that has fired the event.

Check this read-only property in event handlers to identify whether the event originates from the FTP protocol's control or data channel. While some events are channel-independent (FileOperation, ListEntry), and some other are explicitly bound to the control channel (ControlSend, ControlReceive), some events may be thrown from either. Two examples of such events are CertificateValidate and RemoteSign. The property can be set to one of the following values: feoUnknown (0), feoControl (1), feoData (2).

ExtHOSTSupported: Whether HOST extension is supported.

Use this read-only property to check whether the FTP server supports HOST command.

ExtMDTMSupported: Whether MDTM extension is supported.

Use this read-only property to check whether the FTP server supports MDTM command. The MDTM command is used to determine file modification date.

ExtMFMTSupported: Whether MFMT extension is supported.

Use this read-only property to check whether the FTP server supports MFMT (Modify Fact: Modification Time) command.

ExtMLSTSupported: Whether MLST extension is supported.

Use this read-only property to check whether the FTP server supports MLST command. This command lists the directory contents on the server, although it is different from the LIST command. In particular, MLST reply has a strictly defined format.

ExtOPTSUTF8Supported: Whether OPTS UTF8 extension is supported.

Use this read-only property to check whether the FTP server supports OPTS UTF8 ON command. This command switches the server to UTF8.

ExtRESTSupported: Whether REST extension is supported.

Use this read-only property to check whether the FTP server supports REST (RESTART) command.

ExtSIZESupported: Whether SIZE extension is supported.

Use this read-only property to check whether the FTP server supports SIZE command. This command returns file size.

ExtXCRCSupported: Whether XCRC extension is supported.

Use this read-only property to check whether the FTP server supports XCRC command. It calculates a CRC checksum of the file to check its integrity during transfer.

ExtXMD5Supported: Whether XMD5 extension is supported.

Use this read-only property to check whether the FTP server supports XMD5 command. It calculates an MD5 checksum of a file to check its integrity during transfer.

FTPBufferSize: Buffer size in binary mode.

The size of the memory buffer used for data transfer in binary mode. Changing the buffer size may increase (or, on the contrary, decrease) the speed of file download/upload.

FTPTextBufferSize: Buffer size in text mode.

The size of the memory buffer used for data transfer in text mode. Changing the buffer size may increase (or, on the contrary, decrease) the speed of file download/upload.

IgnoreSystemTrust: Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted.

ListenTimeout: Listening socket timeout.

The maximum time during which the listening socket will be opened in the active mode. If there is no connection request from the server during this time, the transfer operation will be canceled.

LocalNewLineConvention: Defines the local newline convention.

Contains character string for the end of string indication used on the local machine. During file upload all the LocalNewLineConvention line endings are converted to newline endings used on the server. Correspondingly, for all downloaded files line endings are replaced with LocalNewLineConventionline endings. Line ending conventions are only used in text transfer mode.

MinSizeForConcurrentDownload: Files bigger than this size will be downloaded concurrently.

The minimum size of the file for which the concurrent download is used. The value of ConcurrentConnections property is ignored for smaller files.

Mode: What to do if the destination file already exists.

Specifies what to do if the destination file already exists. You can choose to: overwrite, append, resume, overwrite only if the destination file's size is different, save with a new name, or rename the existing destination file.

Options: Various FTP options.

Various options of FTP connection.

Recursive: Whether to scan subdirectories.

Whether the subdirectories should also be scanned for matching files.

TempPath: Path for storing temporary files.

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

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

TBD

TransferKeepAliveInterval: Keep-alive interval for the data channel transfers.

FTPClient may be configured to send occasional NOOP commands on the control channel to circumvent control channel closures by firewalls due to inactivity. This setting sets the period, in milliseconds, after which another NOOP request is sent. The default value of this property is 0, which stands for no NOOP requests.

TransferTimeout: Timeout for data transfer in active mode.

In active mode, specifies a time period that a client should wait for incoming data connection (when file or directory listing is to be transferred). If no data connection is accepted during this period, the data connection will be cancelled.

UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseProxySettingsForDataChannel: Whether the proxy settings should be applied to data channel.

Whether the proxy settings should be applied to data channel.

UseSystemCertificates: Enables or disables the use of the system certificates.

Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

Base Configuration Settings

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

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

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

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

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

Supported values are:


off		No caching (default)
local		Local caching (supported for HTTPClient, RESTClient and SOAPClient only)
global		Global caching

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

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

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

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

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

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

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

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

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

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

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

LogDestination: Specifies the debug log destination.

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

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (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:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All 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-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include 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:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush 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:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More 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:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

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

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

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

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

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

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

Tag: Allows to store any custom data.

Use this config property to store any custom data.

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

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

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

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

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

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

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

Trappable Errors (FTPClient Module)

FTPClient Errors

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

SecureBlackbox 2022 macOS Edition - Version 22.0 [Build 8174]


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