# FTPClient Class

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

## Syntax

```text
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](#username-property-ftpclient-class) and [Password](#password-property-ftpclient-class) 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](#tlssettings-property-ftpclient-class) property to adjust this setting.
- If your server requires you to authenticate with a certificate, you can provide one via the [TLSClientChain](#tlsclientchain-property-ftpclient-class) 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](#trustedcertificates-property-ftpclient-class) and [KnownCertificates](#knowncertificates-property-ftpclient-class) collections.
- FTP protocol includes its own set of settings, such as [PassiveMode](#passivemode-property-ftpclient-class), [EncryptDataChannel](#encryptdatachannel-property-ftpclient-class), or [AdjustPasvAddress](#adjustpasvaddress-property-ftpclient-class). 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](#socketsettings-property-ftpclient-class) and [Proxy](#proxy-property-ftpclient-class).

### Connecting to the server and signing in

 Call [Connect](#connect-method-ftpclient-class) 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](#uploadfile-method-ftpclient-class) or [UploadBytes](#uploadbytes-method-ftpclient-class)), file downloads ([DownloadFile](#downloadfile-method-ftpclient-class), [DownloadBytes](#downloadbytes-method-ftpclient-class)), and directory operations ([ListDir](#listdir-method-ftpclient-class), [MakeDir](#makedir-method-ftpclient-class)).

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](#disconnect-method-ftpclient-class) to close the FTP connection.

### Useful info

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

## Property List

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

|  |  |
| --- | --- |
| [AccountInfo](#accountinfo-property-ftpclient-class) | Parameters for the ACCT command. |
| [AdjustPasvAddress](#adjustpasvaddress-property-ftpclient-class) | Enables or disables automatic adjustment of passive-mode addresses. |
| [BlockedCertificates](#blockedcertificates-property-ftpclient-class) | The certificates that must be rejected as trust anchors. |
| [ConflictResolutionMode](#conflictresolutionmode-property-ftpclient-class) | Defines the approach that should be used to resolve various conflicts during batch processing. |
| [Connected](#connected-property-ftpclient-class) | Indicates whether the class is connected to the server. |
| [ControlChannelLog](#controlchannellog-property-ftpclient-class) | Contains the control channel log of the FTP session. |
| [ControlConnectionInfo](#controlconnectioninfo-property-ftpclient-class) | Returns the details of the control connection setup. |
| [CurrentListEntry](#currentlistentry-property-ftpclient-class) | Contains the details of the file entry reported by ListEntry . |
| [DataConnectionInfo](#dataconnectioninfo-property-ftpclient-class) | Returns the details of the data connection setup. |
| [EncryptDataChannel](#encryptdatachannel-property-ftpclient-class) | Enables or disables data channel encryption. |
| [ExternalCrypto](#externalcrypto-property-ftpclient-class) | Provides access to external signing and DC parameters. |
| [FIPSMode](#fipsmode-property-ftpclient-class) | Reserved. |
| [KnownCertificates](#knowncertificates-property-ftpclient-class) | Additional certificates for chain validation. |
| [KnownCRLs](#knowncrls-property-ftpclient-class) | Additional CRLs for chain validation. |
| [KnownOCSPs](#knownocsps-property-ftpclient-class) | Additional OCSP responses for chain validation. |
| [ModeZ](#modez-property-ftpclient-class) | Switches on data compression. |
| [PassiveMode](#passivemode-property-ftpclient-class) | Enables or disables passive transfer mode. |
| [Password](#password-property-ftpclient-class) | The connecting user's authentication password. |
| [Proxy](#proxy-property-ftpclient-class) | The proxy server settings. |
| [RestartAt](#restartat-property-ftpclient-class) | The offset to restart the file transfer from. |
| [SocketSettings](#socketsettings-property-ftpclient-class) | Manages network connection settings. |
| [TLSClientChain](#tlsclientchain-property-ftpclient-class) | The TLS client certificate chain. |
| [TLSServerChain](#tlsserverchain-property-ftpclient-class) | The TLS server's certificate chain. |
| [TLSSettings](#tlssettings-property-ftpclient-class) | Manages TLS layer settings. |
| [TransferType](#transfertype-property-ftpclient-class) | Sets the file transfer mode. |
| [TrustedCertificates](#trustedcertificates-property-ftpclient-class) | A list of trusted certificates for chain validation. |
| [Username](#username-property-ftpclient-class) | The connecting user's username (login name). |

## Method List

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

|  |  |
| --- | --- |
| [Abort](#abort-method-ftpclient-class) | Aborts the previous FTP service command and any associated transfer of data. |
| [Acct](#acct-method-ftpclient-class) | Sends an Account command. |
| [AppendBytes](#appendbytes-method-ftpclient-class) | Appends a byte array to a server-side file. |
| [AppendFile](#appendfile-method-ftpclient-class) | Uploads a file to the server. |
| [AppendStream](#appendstream-method-ftpclient-class) | Uploads a file to the server. |
| [ChangeDir](#changedir-method-ftpclient-class) | Changes the current directory. |
| [ClearCommandChannel](#clearcommandchannel-method-ftpclient-class) | Sends CCC (Clear Command Channel) command to the server. |
| [Config](#config-method-ftpclient-class) | Sets or retrieves a configuration setting. |
| [Connect](#connect-method-ftpclient-class) | Connects to the FTP server. |
| [DeleteDir](#deletedir-method-ftpclient-class) | Deletes a directory on the server. |
| [DeleteFile](#deletefile-method-ftpclient-class) | Deletes a file on the server. |
| [DirExists](#direxists-method-ftpclient-class) | Checks if a directory exists on the server. |
| [Disconnect](#disconnect-method-ftpclient-class) | Disconnects from the server. |
| [DoAction](#doaction-method-ftpclient-class) | Performs an additional action. |
| [DownloadBytes](#downloadbytes-method-ftpclient-class) | Downloads a file from the server into an array of bytes. |
| [DownloadFile](#downloadfile-method-ftpclient-class) | Downloads a file from the server. |
| [DownloadFiles](#downloadfiles-method-ftpclient-class) | Downloads multiple files from the server. |
| [DownloadStream](#downloadstream-method-ftpclient-class) | Downloads a file from the server into a stream. |
| [FileExists](#fileexists-method-ftpclient-class) | Checks if a file exists on the server. |
| [GetCurrentDir](#getcurrentdir-method-ftpclient-class) | Returns the server-side current directory. |
| [GetFileSize](#getfilesize-method-ftpclient-class) | Returns the size of a remote file. |
| [ListDir](#listdir-method-ftpclient-class) | Lists the contents of a remote directory. |
| [MakeDir](#makedir-method-ftpclient-class) | Creates a new directory on the server. |
| [Noop](#noop-method-ftpclient-class) | Sends a NOOP command to the server. |
| [Rename](#rename-method-ftpclient-class) | Renames a file. |
| [Reset](#reset-method-ftpclient-class) | Resets the class settings. |
| [SendCommand](#sendcommand-method-ftpclient-class) | Sends a custom command to the server. |
| [UploadBytes](#uploadbytes-method-ftpclient-class) | Uploads a byte array to the server. |
| [UploadFile](#uploadfile-method-ftpclient-class) | Uploads a file to the server. |
| [UploadFiles](#uploadfiles-method-ftpclient-class) | Uploads multiple files to the server. |
| [UploadStream](#uploadstream-method-ftpclient-class) | Uploads a file to the server. |

## Event List

*The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [ControlReceive](#controlreceive-event-ftpclient-class) | Fires when data is received via the control channel. |
| [ControlSend](#controlsend-event-ftpclient-class) | Fires when data is about to be set via the control channel. |
| [Error](#error-event-ftpclient-class) | Information about errors during data delivery. |
| [ExternalSign](#externalsign-event-ftpclient-class) | Handles remote or external signing initiated by the SignExternal method or other source. |
| [FileNameChangeNeeded](#filenamechangeneeded-event-ftpclient-class) | Asks the application for a new file name. |
| [FileOperation](#fileoperation-event-ftpclient-class) | Marks the start of a file transfer. |
| [FileOperationResult](#fileoperationresult-event-ftpclient-class) | Reports the result of a file transfer operation. |
| [ListEntry](#listentry-event-ftpclient-class) | Reports a single entry from the requested directory listing. |
| [Notification](#notification-event-ftpclient-class) | This event notifies the application about an underlying control flow event. |
| [Progress](#progress-event-ftpclient-class) | Reports the data transfer progress. |
| [TextDataLine](#textdataline-event-ftpclient-class) | Reports next transferred data line. |
| [TLSCertNeeded](#tlscertneeded-event-ftpclient-class) | Fires when a remote TLS party requests a client certificate. |
| [TLSCertValidate](#tlscertvalidate-event-ftpclient-class) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| [TLSEstablished](#tlsestablished-event-ftpclient-class) | Fires when a TLS handshake with Host successfully completes. |
| [TLSHandshake](#tlshandshake-event-ftpclient-class) | Fires when a new TLS handshake is initiated, before the handshake commences. |
| [TLSPSK](#tlspsk-event-ftpclient-class) | Notifies the application about the PSK key exchange. |
| [TLSShutdown](#tlsshutdown-event-ftpclient-class) | Reports the graceful closure of a TLS connection. |

## Config Settings

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

|  |  |
| --- | --- |
| [AccountInfo](#AccountInfo) | Provides the value to be used with ACCT command. |
| [AuthCmd](#AuthCmd) | Authorization command to be used to request an explicit SSL session. |
| [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. |
| [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. |
| [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. |
| [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. |
| [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. |
| [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. |
| [CaseConversion](#CaseConversion) | Whether file names and paths should be case-converted. |
| [CaseSensitive](#CaseSensitive) | Specifies if file paths are case-sensitive. |
| [CloseQuietly](#CloseQuietly) | Set this to true to avoid sending QUIT command on session closure. |
| [ConcurrentConnections](#ConcurrentConnections) | Number of simultaneous connections for download. |
| [ControlChannelLog](#ControlChannelLog) | Returns the control channel connection log. |
| [CopyMode](#CopyMode) | Tunes up the post-transfer action for batch uploads. |
| [DataPort](#DataPort) | Sets a specific listening port for active mode data connection. |
| [DataPortRangeFilter](#DataPortRangeFilter) | Provides a flexible mechanism to set multiple active mode data port ranges. |
| [DataPortRangeFrom](#DataPortRangeFrom) | Sets the lower boundary for Active mode data port range. |
| [DataPortRangeTo](#DataPortRangeTo) | Sets the upper boundary for Active mode data port range. |
| [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. |
| [ErrorOrigin](#ErrorOrigin) | Specifies whether the error is local or remote. |
| [ErrorSeverity](#ErrorSeverity) | Specifies whether the error is fatal. |
| [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. |
| [EventOrigin](#EventOrigin) | Indicates the channel that has fired the event. |
| [ExtHOSTSupported](#ExtHOSTSupported) | Whether HOST extension is supported. |
| [ExtMDTMSupported](#ExtMDTMSupported) | Whether MDTM extension is supported. |
| [ExtMFMTSupported](#ExtMFMTSupported) | Whether MFMT extension is supported. |
| [ExtMLSTSupported](#ExtMLSTSupported) | Whether MLST extension is supported. |
| [ExtOPTSUTF8Supported](#ExtOPTSUTF8Supported) | Whether OPTS UTF8 extension is supported. |
| [ExtRESTSupported](#ExtRESTSupported) | Whether REST extension is supported. |
| [ExtSIZESupported](#ExtSIZESupported) | Whether SIZE extension is supported. |
| [ExtXCRCSupported](#ExtXCRCSupported) | Whether XCRC extension is supported. |
| [ExtXMD5Supported](#ExtXMD5Supported) | Whether XMD5 extension is supported. |
| [ExtXSHA1Supported](#ExtXSHA1Supported) | TBD. |
| [FTPBufferSize](#FTPBufferSize) | Buffer size in binary mode. |
| [FTPTextBufferSize](#FTPTextBufferSize) | Buffer size in text mode. |
| [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. |
| [ListenTimeout](#ListenTimeout) | Listening socket timeout. |
| [LocalNewLineConvention](#LocalNewLineConvention) | A character string for the end of line (EOL) indication on the local machine. |
| [LocalNewLineConvention](#LocalNewLineConvention) | Defines the local newline convention. |
| [MinSizeForConcurrentDownload](#MinSizeForConcurrentDownload) | Files bigger than this size will be downloaded concurrently. |
| [ModeZ](#ModeZ) | Enables or disables data compression. |
| [Options](#Options) | Various FTP options. |
| [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [TempPath](#TempPath) | Path for storing temporary files. |
| [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the class for the current session. |
| [TLSExtensions](#TLSExtensions) | TBD. |
| [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the class. |
| [TLSLayerKeepAlives](#TLSLayerKeepAlives) | Enables or disables keep alive signals on the TLS layer. |
| [TLSPeerExtensions](#TLSPeerExtensions) | TBD. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the class. |
| [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. |
| [TransferKeepAliveInterval](#TransferKeepAliveInterval) | Keep-alive interval for the data channel transfers. |
| [TransferTimeout](#TransferTimeout) | Timeout for data transfer in active mode. |
| [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. |
| [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. |
| [UseProxySettingsForDataChannel](#UseProxySettingsForDataChannel) | Whether the proxy settings should be applied to data channel. |
| [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. |
| [UseUTF8IfAvailable](#UseUTF8IfAvailable) | Upgrade to UTF8 string encoding if the server supports it. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# AccountInfo Property ([FTPClient](#ftpclient-class) Class)

Parameters for the ACCT command.

## Syntax

```text
public String getAccountInfo();
public void setAccountInfo(String accountInfo);
```

## 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](#ftpclient-class) Class)

Enables or disables automatic adjustment of passive-mode addresses.

## Syntax

```text
public boolean isAdjustPasvAddress();
public void setAdjustPasvAddress(boolean adjustPasvAddress);
```

## 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](#ftpclient-class) Class)

The certificates that must be rejected as trust anchors.

## Syntax

```text
public CertificateList getBlockedCertificates();
```

## Remarks

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

This property is not available at design time.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# ConflictResolutionMode Property ([FTPClient](#ftpclient-class) Class)

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

## Syntax

```text
public int getConflictResolutionMode();
public void setConflictResolutionMode(int conflictResolutionMode);

Enumerated values:
  public final static int cftmOverwrite = 0;
  public final static int cftmSkip = 1;
  public final static int cftmAppendToEnd = 2;
  public final static int cftmResume = 3;
  public final static int cftmOverwriteIfDiffSize = 4;
  public final static int cftmSaveWithNewName = 5;
  public final static int cftmRenameExistingTarget = 6;
```

## Default Value

0

## Remarks

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

|  |  |  |
| --- | --- | --- |
| cftmOverwrite | 0 |  |
| cftmSkip | 1 |  |
| cftmAppendToEnd | 2 | The signature is corrupted |
| cftmResume | 3 |  |
| cftmOverwriteIfDiffSize | 4 |  |
| cftmSaveWithNewName | 5 |  |
| cftmRenameExistingTarget | 5 |  |

# Connected Property ([FTPClient](#ftpclient-class) Class)

Indicates whether the class is connected to the server.

## Syntax

```text
public boolean isConnected();
```

## Default Value

False

## Remarks

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

This property is read-only and not available at design time.

# ControlChannelLog Property ([FTPClient](#ftpclient-class) Class)

Contains the control channel log of the FTP session.

## Syntax

```text
public String getControlChannelLog();
```

## Default Value

""

## Remarks

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

This property is read-only.

# ControlConnectionInfo Property ([FTPClient](#ftpclient-class) Class)

Returns the details of the control connection setup.

## Syntax

```text
public TLSConnectionInfo getControlConnectionInfo();
```

## Remarks

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

This property is read-only.

 Please refer to the [TLSConnectionInfo](#tlsconnectioninfo-type) type for a complete list of fields.

# CurrentListEntry Property ([FTPClient](#ftpclient-class) Class)

Contains the details of the file entry reported by ListEntry .

## Syntax

```text
public FTPListEntry getCurrentListEntry();
```

## Remarks

A typical use of this property is to check it in [ListEntry](#listentry-event-ftpclient-class) event handler. This property is updated with new details each time a new entry is processed.

This property is read-only and not available at design time.

 Please refer to the [FTPListEntry](#ftplistentry-type) type for a complete list of fields.

# DataConnectionInfo Property ([FTPClient](#ftpclient-class) Class)

Returns the details of the data connection setup.

## Syntax

```text
public TLSConnectionInfo getDataConnectionInfo();
```

## Remarks

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

This property is read-only.

 Please refer to the [TLSConnectionInfo](#tlsconnectioninfo-type) type for a complete list of fields.

# EncryptDataChannel Property ([FTPClient](#ftpclient-class) Class)

Enables or disables data channel encryption.

## Syntax

```text
public boolean isEncryptDataChannel();
public void setEncryptDataChannel(boolean encryptDataChannel);
```

## Default Value

True

## Remarks

Use this property to enable or disable data channel encryption. This property should be configured before [Connect](#connect-method-ftpclient-class) method is called.

# ExternalCrypto Property ([FTPClient](#ftpclient-class) Class)

Provides access to external signing and DC parameters.

## Syntax

```text
public ExternalCrypto getExternalCrypto();
```

## Remarks

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

This property is read-only.

 Please refer to the [ExternalCrypto](#externalcrypto-type) type for a complete list of fields.

# FIPSMode Property ([FTPClient](#ftpclient-class) Class)

Reserved.

## Syntax

```text
public boolean isFIPSMode();
public void setFIPSMode(boolean FIPSMode);
```

## Default Value

False

## Remarks

This property is reserved for future use.

# KnownCertificates Property ([FTPClient](#ftpclient-class) Class)

Additional certificates for chain validation.

## Syntax

```text
public CertificateList getKnownCertificates();
```

## Remarks

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

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

Do not add trust anchors or root certificates to this collection: add them to [TrustedCertificates](#trustedcertificates-property-ftpclient-class) instead.

This property is not available at design time.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# KnownCRLs Property ([FTPClient](#ftpclient-class) Class)

Additional CRLs for chain validation.

## Syntax

```text
public CRLList getKnownCRLs();
```

## Remarks

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

This property is not available at design time.

 Please refer to the [CRL](#crl-type) type for a complete list of fields.

# KnownOCSPs Property ([FTPClient](#ftpclient-class) Class)

Additional OCSP responses for chain validation.

## Syntax

```text
public OCSPResponseList getKnownOCSPs();
```

## Remarks

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

This property is not available at design time.

 Please refer to the [OCSPResponse](#ocspresponse-type) type for a complete list of fields.

# ModeZ Property ([FTPClient](#ftpclient-class) Class)

Switches on data compression.

## Syntax

```text
public boolean isModeZ();
public void setModeZ(boolean modeZ);
```

## Default Value

True

## Remarks

Switches the in-flight data compression on/off.

# PassiveMode Property ([FTPClient](#ftpclient-class) Class)

Enables or disables passive transfer mode.

## Syntax

```text
public boolean isPassiveMode();
public void setPassiveMode(boolean passiveMode);
```

## 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](#ftpclient-class) Class)

The connecting user's authentication password.

## Syntax

```text
public String getPassword();
public void setPassword(String password);
```

## Default Value

""

## Remarks

Assign the user's authentication password to this property. Use [Username](#username-property-ftpclient-class) for username/login.

# Proxy Property ([FTPClient](#ftpclient-class) Class)

The proxy server settings.

## Syntax

```text
public ProxySettings getProxy();
```

## Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

 Please refer to the [ProxySettings](#proxysettings-type) type for a complete list of fields.

# RestartAt Property ([FTPClient](#ftpclient-class) Class)

The offset to restart the file transfer from.

## Syntax

```text
public long getRestartAt();
public void setRestartAt(long restartAt);
```

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

# SocketSettings Property ([FTPClient](#ftpclient-class) Class)

Manages network connection settings.

## Syntax

```text
public SocketSettings getSocketSettings();
```

## Remarks

Use this property to tune up network connection parameters.

This property is read-only.

 Please refer to the [SocketSettings](#socketsettings-type) type for a complete list of fields.

# TLSClientChain Property ([FTPClient](#ftpclient-class) Class)

The TLS client certificate chain.

## Syntax

```text
public CertificateList getTLSClientChain();
```

## Remarks

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

Use the [CertificateStorage](CertificateStorage.md#CertificateStorage) or [CertificateManager](CertificateManager.md#CertificateManager) components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# TLSServerChain Property ([FTPClient](#ftpclient-class) Class)

The TLS server's certificate chain.

## Syntax

```text
public CertificateList getTLSServerChain();
```

## Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the [TLSCertValidate](#tlscertvalidate-event-ftpclient-class) event is fired by the client component.

This property is read-only and not available at design time.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# TLSSettings Property ([FTPClient](#ftpclient-class) Class)

Manages TLS layer settings.

## Syntax

```text
public TLSSettings getTLSSettings();
```

## Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

 Please refer to the [TLSSettings](#tlssettings-type) type for a complete list of fields.

# TransferType Property ([FTPClient](#ftpclient-class) Class)

Sets the file transfer mode.

## Syntax

```text
public int getTransferType();
public void setTransferType(int transferType);

Enumerated values:
  public final static int cttText = 0;
  public final static int cttBinary = 1;
```

## Default Value

1

## Remarks

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

|  |  |
| --- | --- |
| cttText | 0 |
| cttBinary | 1 |

# TrustedCertificates Property ([FTPClient](#ftpclient-class) Class)

A list of trusted certificates for chain validation.

## Syntax

```text
public CertificateList getTrustedCertificates();
```

## Remarks

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

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

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

This property is not available at design time.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# Username Property ([FTPClient](#ftpclient-class) Class)

The connecting user's username (login name).

## Syntax

```text
public String getUsername();
public void setUsername(String username);
```

## Default Value

""

## Remarks

Assign the user's login name to this property. Use [Password](#password-property-ftpclient-class) to provide the password.

# Abort Method ([FTPClient](#ftpclient-class) Class)

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

## Syntax

```text
public void abort();
```

## Remarks

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

# Acct Method ([FTPClient](#ftpclient-class) Class)

Sends an Account command.

## Syntax

```text
public void acct(String 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](#ftpclient-class) Class)

Appends a byte array to a server-side file.

## Syntax

```text
public void appendBytes(byte[] bytes, String remoteFile);
```

## Remarks

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

# AppendFile Method ([FTPClient](#ftpclient-class) Class)

Uploads a file to the server.

## Syntax

```text
public void appendFile(String localFile, String remoteFile);
```

## Remarks

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

# AppendStream Method ([FTPClient](#ftpclient-class) Class)

Uploads a file to the server.

## Syntax

```text
public void appendStream(java.io.InputStream localStream, String remoteFile);
```

## Remarks

Use this method to upload data contained in *LocalStream* to *RemoteFile* on the server.

# ChangeDir Method ([FTPClient](#ftpclient-class) Class)

Changes the current directory.

## Syntax

```text
public void changeDir(String remoteDir);
```

## Remarks

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

# ClearCommandChannel Method ([FTPClient](#ftpclient-class) Class)

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

## Syntax

```text
public void clearCommandChannel(boolean 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](#ftpclient-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
public String config(String configurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-ftpclient-class) 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](#config-settings-ftpclient-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Connect Method ([FTPClient](#ftpclient-class) Class)

Connects to the FTP server.

## Syntax

```text
public void connect(String 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](#username-property-ftpclient-class) and [Password](#password-property-ftpclient-class).

# DeleteDir Method ([FTPClient](#ftpclient-class) Class)

Deletes a directory on the server.

## Syntax

```text
public void deleteDir(String remoteDir);
```

## Remarks

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

# DeleteFile Method ([FTPClient](#ftpclient-class) Class)

Deletes a file on the server.

## Syntax

```text
public void deleteFile(String remoteFile);
```

## Remarks

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

# DirExists Method ([FTPClient](#ftpclient-class) Class)

Checks if a directory exists on the server.

## Syntax

```text
public boolean dirExists(String 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](#ftpclient-class) Class)

Disconnects from the server.

## Syntax

```text
public void disconnect();
```

## Remarks

Call this method to disconnect from the server.

# DoAction Method ([FTPClient](#ftpclient-class) Class)

Performs an additional action.

## Syntax

```text
public String doAction(String actionID, String actionParams);
```

## Remarks

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

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

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

Common ActionIDs:

|  |  |  |  |
| --- | --- | --- | --- |
| Action | Parameters | Returned value | Description |
| ResetTrustedListCache | none | none | Clears the cached list of trusted lists. |
| ResetCertificateCache | none | none | Clears the cached certificates. |
| ResetCRLCache | none | none | Clears the cached CRLs. |
| ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. |

# DownloadBytes Method ([FTPClient](#ftpclient-class) Class)

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

## Syntax

```text
public byte[] downloadBytes(String remoteFile);
```

## Remarks

Use this method to download *RemoteFile* into a byte array.

# DownloadFile Method ([FTPClient](#ftpclient-class) Class)

Downloads a file from the server.

## Syntax

```text
public void downloadFile(String remoteFile, String localFile);
```

## Remarks

Use this method to download *RemoteFile* into *LocalFile*.

# DownloadFiles Method ([FTPClient](#ftpclient-class) Class)

Downloads multiple files from the server.

## Syntax

```text
public void downloadFiles(String remotePath, String localDir, boolean recursive, int errorHandling);
```

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

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

|  |  |  |
| --- | --- | --- |
| ehStopOnFailure | 0 | Stop on the first failure and throw an exception |
| ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list |
| ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process |

# DownloadStream Method ([FTPClient](#ftpclient-class) Class)

Downloads a file from the server into a stream.

## Syntax

```text
public void downloadStream(String remoteFile, java.io.OutputStream localStream);
```

## Remarks

Use this method to download *RemoteFile* into a stream object.

# FileExists Method ([FTPClient](#ftpclient-class) Class)

Checks if a file exists on the server.

## Syntax

```text
public boolean fileExists(String 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](#changedir-method-ftpclient-class) command first, then call this method.

# GetCurrentDir Method ([FTPClient](#ftpclient-class) Class)

Returns the server-side current directory.

## Syntax

```text
public String getCurrentDir();
```

## Remarks

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

# GetFileSize Method ([FTPClient](#ftpclient-class) Class)

Returns the size of a remote file.

## Syntax

```text
public long getFileSize(String remoteFile);
```

## Remarks

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

Please note that this command only looks for the file in the current directory. To check for existence of a file in a different directory, change to it with [ChangeDir](#changedir-method-ftpclient-class) command first, then call this method.

# ListDir Method ([FTPClient](#ftpclient-class) Class)

Lists the contents of a remote directory.

## Syntax

```text
public String listDir(boolean includeFiles, boolean 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](#listentry-event-ftpclient-class) for each entry in the list, propagating its details in [CurrentListEntry](#currentlistentry-property-ftpclient-class).

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

# MakeDir Method ([FTPClient](#ftpclient-class) Class)

Creates a new directory on the server.

## Syntax

```text
public void makeDir(String 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](#ftpclient-class) Class)

Sends a NOOP command to the server.

## Syntax

```text
public void noop();
```

## Remarks

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

# Rename Method ([FTPClient](#ftpclient-class) Class)

Renames a file.

## Syntax

```text
public void rename(String sourceFile, String destFile);
```

## Remarks

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

# Reset Method ([FTPClient](#ftpclient-class) Class)

Resets the class settings.

## Syntax

```text
public void reset();
```

## Remarks

Reset is a generic method available in every class.

# SendCommand Method ([FTPClient](#ftpclient-class) Class)

Sends a custom command to the server.

## Syntax

```text
public int sendCommand(String 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](#ftpclient-class) Class)

Uploads a byte array to the server.

## Syntax

```text
public void uploadBytes(byte[] bytes, String remoteFile);
```

## Remarks

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

# UploadFile Method ([FTPClient](#ftpclient-class) Class)

Uploads a file to the server.

## Syntax

```text
public void uploadFile(String localFile, String remoteFile);
```

## Remarks

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

# UploadFiles Method ([FTPClient](#ftpclient-class) Class)

Uploads multiple files to the server.

## Syntax

```text
public void uploadFiles(String localPath, String remoteDir, boolean recursive, int errorHandling);
```

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

The *ErrorHandling* parameter specifies the error handling tactics:

|  |  |  |
| --- | --- | --- |
| ehStopOnFailure | 0 | Stop on the first failure and throw an exception |
| ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list |
| ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process |

For each file being uploaded a pair of [FileOperation](#fileoperation-event-ftpclient-class) and [FileOperationResult](#fileoperationresult-event-ftpclient-class) events are invoked.

# UploadStream Method ([FTPClient](#ftpclient-class) Class)

Uploads a file to the server.

## Syntax

```text
public void uploadStream(java.io.InputStream localStream, String remoteFile);
```

## Remarks

Use this method to upload data contained in *LocalStream* to *RemoteFile* on the server.

# ControlReceive Event ([FTPClient](#ftpclient-class) Class)

Fires when data is received via the control channel.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void controlReceive(FTPClientControlReceiveEvent e) {}
  ...
}

public class FTPClientControlReceiveEvent {
  public String 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](#ftpclient-class) Class)

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

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void controlSend(FTPClientControlSendEvent e) {}
  ...
}

public class FTPClientControlSendEvent {
  public String 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](#ftpclient-class) Class)

Information about errors during data delivery.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void error(FTPClientErrorEvent e) {}
  ...
}

public class FTPClientErrorEvent {
  public int errorCode;
  public String 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](#trappable-errors-ftpclient-class) section.

# ExternalSign Event ([FTPClient](#ftpclient-class) Class)

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

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void externalSign(FTPClientExternalSignEvent e) {}
  ...
}

public class FTPClientExternalSignEvent {
  public String operationId;
  public String hashAlgorithm;
  public String pars;
  public String data;
  public String signedData; //read-write
}
```

## Remarks

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

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

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

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

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

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:

```text
signer.OnExternalSign += (s, e) =>
{
       var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
       var key = (RSACryptoServiceProvider)cert.PrivateKey;

       var dataToSign = e.Data.FromBase16String();
       var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
       e.SignedData = signedData.ToBase16String();
};
```

# FileNameChangeNeeded Event ([FTPClient](#ftpclient-class) Class)

Asks the application for a new file name.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void fileNameChangeNeeded(FTPClientFileNameChangeNeededEvent e) {}
  ...
}

public class FTPClientFileNameChangeNeededEvent {
  public String fileName; //read-write
  public boolean force; //read-write
}
```

## Remarks

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

# FileOperation Event ([FTPClient](#ftpclient-class) Class)

Marks the start of a file transfer.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void fileOperation(FTPClientFileOperationEvent e) {}
  ...
}

public class FTPClientFileOperationEvent {
  public int operation;
  public String remotePath;
  public String localPath;
  public boolean skip; //read-write
  public boolean cancel; //read-write
}
```

## Remarks

The class fires this event from [DownloadFiles](#downloadfiles-method-ftpclient-class) and [UploadFiles](#uploadfiles-method-ftpclient-class) 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](#ftpclient-class) Class)

Reports the result of a file transfer operation.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void fileOperationResult(FTPClientFileOperationResultEvent e) {}
  ...
}

public class FTPClientFileOperationResultEvent {
  public int operation;
  public String remotePath;
  public String localPath;
  public int errorCode;
  public String comment;
  public boolean cancel; //read-write
}
```

## Remarks

The class fires this event from [DownloadFiles](#downloadfiles-method-ftpclient-class) and [UploadFiles](#uploadfiles-method-ftpclient-class) 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](#ftpclient-class) Class)

Reports a single entry from the requested directory listing.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void listEntry(FTPClientListEntryEvent e) {}
  ...
}

public class FTPClientListEntryEvent {
  public String fileName;
}
```

## Remarks

*FileName* contains the filename of the reported entry. Read the details of the entry from [CurrentListEntry](#currentlistentry-property-ftpclient-class) property.

# Notification Event ([FTPClient](#ftpclient-class) Class)

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

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void notification(FTPClientNotificationEvent e) {}
  ...
}

public class FTPClientNotificationEvent {
  public String eventID;
  public String eventParam;
}
```

## Remarks

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

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

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

|  |  |
| --- | --- |
| TLSExtensions.CertificateStatus | TBD |
| TLSExtensions.PreSharedIdentityHint | TBD |

# Progress Event ([FTPClient](#ftpclient-class) Class)

Reports the data transfer progress.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void progress(FTPClientProgressEvent e) {}
  ...
}

public class FTPClientProgressEvent {
  public long total;
  public long current;
  public boolean cancel; //read-write
}
```

## 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](#ftpclient-class) Class)

Reports next transferred data line.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void textDataLine(FTPClientTextDataLineEvent e) {}
  ...
}

public class FTPClientTextDataLineEvent {
  public String textLine;
}
```

## Remarks

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

# TLSCertNeeded Event ([FTPClient](#ftpclient-class) Class)

Fires when a remote TLS party requests a client certificate.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void TLSCertNeeded(FTPClientTLSCertNeededEvent e) {}
  ...
}

public class FTPClientTLSCertNeededEvent {
  public String host;
  public String CANames;
}
```

## Remarks

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

Use the [TLSClientChain](#tlsclientchain-property-ftpclient-class) property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the [TLSHandshake](#tlshandshake-event-ftpclient-class) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-ftpclient-class) event.

# TLSCertValidate Event ([FTPClient](#ftpclient-class) Class)

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

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void TLSCertValidate(FTPClientTLSCertValidateEvent e) {}
  ...
}

public class FTPClientTLSCertValidateEvent {
  public String serverHost;
  public String serverIP;
  public boolean accept; //read-write
}
```

## Remarks

This event is fired during a TLS handshake. Use the [TLSServerChain](#tlsserverchain-property-ftpclient-class) property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

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

# TLSEstablished Event ([FTPClient](#ftpclient-class) Class)

Fires when a TLS handshake with Host successfully completes.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void TLSEstablished(FTPClientTLSEstablishedEvent e) {}
  ...
}

public class FTPClientTLSEstablishedEvent {
  public String host;
  public String version;
  public String ciphersuite;
  public byte[] connectionId;
  public boolean abort; //read-write
}
```

## Remarks

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

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

# TLSHandshake Event ([FTPClient](#ftpclient-class) Class)

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

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void TLSHandshake(FTPClientTLSHandshakeEvent e) {}
  ...
}

public class FTPClientTLSHandshakeEvent {
  public String host;
  public boolean abort; //read-write
}
```

## Remarks

The class uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [TLSEstablished](#tlsestablished-event-ftpclient-class) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-ftpclient-class) event will also be fired.

# TLSPSK Event ([FTPClient](#ftpclient-class) Class)

Notifies the application about the PSK key exchange.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void TLSPSK(FTPClientTLSPSKEvent e) {}
  ...
}

public class FTPClientTLSPSKEvent {
  public String host;
  public String hint;
}
```

## Remarks

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

# TLSShutdown Event ([FTPClient](#ftpclient-class) Class)

Reports the graceful closure of a TLS connection.

## Syntax

```text
public class DefaultFTPClientEventListener implements FTPClientEventListener {
  ...
  public void TLSShutdown(FTPClientTLSShutdownEvent e) {}
  ...
}

public class FTPClientTLSShutdownEvent {
  public String host;
}
```

## Remarks

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

# Certificate Type

Encapsulates an individual X.509 certificate.

## Remarks

This type keeps and provides access to X.509 certificate details.

The following fields are available:

- [Bytes](#Certificate_f_Bytes)

- [CA](#Certificate_f_CA)

- [CAKeyID](#Certificate_f_CAKeyID)

- [CertType](#Certificate_f_CertType)

- [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints)

- [Curve](#Certificate_f_Curve)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FriendlyName](#Certificate_f_FriendlyName)

- [HashAlgorithm](#Certificate_f_HashAlgorithm)

- [Issuer](#Certificate_f_Issuer)

- [IssuerRDN](#Certificate_f_IssuerRDN)

- [KeyAlgorithm](#Certificate_f_KeyAlgorithm)

- [KeyBits](#Certificate_f_KeyBits)

- [KeyFingerprint](#Certificate_f_KeyFingerprint)

- [KeyUsage](#Certificate_f_KeyUsage)

- [KeyValid](#Certificate_f_KeyValid)

- [OCSPLocations](#Certificate_f_OCSPLocations)

- [OCSPNoCheck](#Certificate_f_OCSPNoCheck)

- [Origin](#Certificate_f_Origin)

- [PolicyIDs](#Certificate_f_PolicyIDs)

- [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes)

- [PrivateKeyExists](#Certificate_f_PrivateKeyExists)

- [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable)

- [PublicKeyBytes](#Certificate_f_PublicKeyBytes)

- [Qualified](#Certificate_f_Qualified)

- [QualifiedStatements](#Certificate_f_QualifiedStatements)

- [Qualifiers](#Certificate_f_Qualifiers)

- [SelfSigned](#Certificate_f_SelfSigned)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SigAlgorithm](#Certificate_f_SigAlgorithm)

- [Source](#Certificate_f_Source)

- [Subject](#Certificate_f_Subject)

- [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName)

- [SubjectKeyID](#Certificate_f_SubjectKeyID)

- [SubjectRDN](#Certificate_f_SubjectRDN)

- [Valid](#Certificate_f_Valid)

- [ValidFrom](#Certificate_f_ValidFrom)

- [ValidTo](#Certificate_f_ValidTo)

## Fields

 **Bytes** *byte[] (read-only)*
*Default Value: ""*

Returns the raw certificate data in DER format.

 **CA** *boolean*
*Default Value: False*

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.

 **CAKeyID** *byte[] (read-only)*
*Default Value: ""*

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

 **CertType** *int (read-only)*
*Default Value: 0*

Returns the type of the entity contained in the [Certificate](#certificate-type) object.

A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the [CertificateManager](CertificateManager.md#CertificateManager) class to load or create new certificate and certificate requests objects.

 **CRLDistributionPoints** *String*
*Default Value: ""*

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

 **Curve** *String*
*Default Value: ""*

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

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

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

 **FriendlyName** *String (read-only)*
*Default Value: ""*

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

 **HashAlgorithm** *String*
*Default Value: ""*

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [SigAlgorithm](#Certificate_f_SigAlgorithm) to find out the hash algorithm that is part of the certificate signature.

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

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN).

 **IssuerRDN** *String*
*Default Value: ""*

A list of *Property=Value* pairs that uniquely identify the certificate issuer.

Example: */C=US/O=Nationwide CA/CN=Web Certification Authority*

 **KeyAlgorithm** *String*
*Default Value: "0"*

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 |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

Use the [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains.

 **KeyBits** *int (read-only)*
*Default Value: 0*

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer.

 **KeyFingerprint** *String (read-only)*
*Default Value: ""*

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

 **KeyUsage** *int*
*Default Value: 0*

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 |

Set this field before generating the certificate to propagate the key usage flags to the new certificate.

 **KeyValid** *boolean (read-only)*
*Default Value: False*

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

 **OCSPLocations** *String*
*Default Value: ""*

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this field before calling the certificate manager's [Generate](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

 **OCSPNoCheck** *boolean*
*Default Value: False*

Accessor to the value of the certificate's ocsp-no-check extension.

 **Origin** *int (read-only)*
*Default Value: 0*

Returns the location that the certificate was taken or loaded from.

 **PolicyIDs** *String*
*Default Value: ""*

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.

Set this field when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

 **PrivateKeyBytes** *byte[] (read-only)*
*Default Value: ""*

Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

 **PrivateKeyExists** *boolean (read-only)*
*Default Value: False*

Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption.

This field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

 **PrivateKeyExtractable** *boolean (read-only)*
*Default Value: False*

Indicates whether the private key is extractable (exportable).

 **PublicKeyBytes** *byte[] (read-only)*
*Default Value: ""*

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

 **Qualified** *boolean (read-only)*
*Default Value: False*

Indicates whether the certificate is qualified.

This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified.

 **QualifiedStatements** *int*
*Default Value: 0*

Returns a simplified qualified status of the certificate.

 **Qualifiers** *String (read-only)*
*Default Value: ""*

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*.

 **SelfSigned** *boolean (read-only)*
*Default Value: False*

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

 **SerialNumber** *byte[]*
*Default Value: ""*

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

 **SigAlgorithm** *String (read-only)*
*Default Value: ""*

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

A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*.

 **Source** *int (read-only)*
*Default Value: 0*

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

 **Subject** *String (read-only)*
*Default Value: ""*

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [SubjectRDN](#Certificate_f_SubjectRDN).

 **SubjectAlternativeName** *String*
*Default Value: ""*

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main [SubjectRDN](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

 **SubjectKeyID** *byte[]*
*Default Value: ""*

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

 **SubjectRDN** *String*
*Default Value: ""*

A list of *Property=Value* pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*.

 **Valid** *boolean (read-only)*
*Default Value: False*

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

 **ValidFrom** *String*
*Default Value: ""*

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

 **ValidTo** *String*
*Default Value: ""*

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

## Constructors

```text
public Certificate(byte[] bytes, int startIndex, int count, String password);
```

 Loads the X.509 certificate from a memory buffer. * Bytes * is a buffer containing the raw certificate data. * StartIndex * and * Count * specify the starting position and number of bytes to be read from the buffer, respectively. * Password * is a password encrypting the certificate.

```text
public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, String password);
```

 Loads the X.509 certificate from a memory buffer.

 * CertBytes * is a buffer containing the raw certificate data. * CertStartIndex * and * CertCount * specify the starting position and number of bytes to be read from the buffer, respectively.

 * KeyBytes * is a buffer containing the private key data. * KeyStartIndex * and * KeyCount * specify the starting position and number of bytes to be read from the buffer, respectively.

 * Password * is a password encrypting the certificate.

```text
public Certificate(byte[] bytes, int startIndex, int count);
```

 Loads the X.509 certificate from a memory buffer. * Bytes * is a buffer containing the raw certificate data. * StartIndex * and * Count * specify the starting position and number of bytes to be read from the buffer, respectively.

```text
public Certificate(String path, String password);
```

 Loads the X.509 certificate from a file. * Path * specifies the full path to the file containing the certificate data. * Password * is a password encrypting the certificate.

```text
public Certificate(String certPath, String keyPath, String password);
```

 Loads the X.509 certificate from a file. * CertPath * specifies the full path to the file containing the certificate data. * KeyPath * specifies the full path to the file containing the private key. * Password * is a password encrypting the certificate.

```text
public Certificate(String path);
```

 Loads the X.509 certificate from a file. * Path * specifies the full path to the file containing the certificate data.

```text
public Certificate(java.io.InputStream stream);
```

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

```text
public Certificate(java.io.InputStream stream, String password);
```

 Loads the X.509 certificate from a stream. * Stream * is a stream containing the certificate data. * Password * is a password encrypting the certificate.

```text
public Certificate(java.io.InputStream certStream, java.io.InputStream keyStream, String password);
```

 Loads the X.509 certificate from a stream. * CertStream * is a stream containing the certificate data. * KeyStream * is a stream containing the private key. * Password * is a password encrypting the certificate.

```text
public Certificate();
```

 Creates a new object with default field values.

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

The following fields are available:

- [Bytes](#CRL_f_Bytes)

- [CAKeyID](#CRL_f_CAKeyID)

- [EntryCount](#CRL_f_EntryCount)

- [Issuer](#CRL_f_Issuer)

- [IssuerRDN](#CRL_f_IssuerRDN)

- [Location](#CRL_f_Location)

- [NextUpdate](#CRL_f_NextUpdate)

- [SigAlgorithm](#CRL_f_SigAlgorithm)

- [Source](#CRL_f_Source)

- [TBS](#CRL_f_TBS)

- [ThisUpdate](#CRL_f_ThisUpdate)

## Fields

 **Bytes** *byte[] (read-only)*
*Default Value: ""*

Returns the raw CRL data in DER format.

 **CAKeyID** *byte[]*
*Default Value: ""*

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

 **EntryCount** *int (read-only)*
*Default Value: 0*

Returns the number of certificate status entries in the CRL.

 **Issuer** *String (read-only)*
*Default Value: ""*

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

 **IssuerRDN** *String (read-only)*
*Default Value: ""*

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

 **Location** *String (read-only)*
*Default Value: ""*

The URL that the CRL was downloaded from.

 **NextUpdate** *String*
*Default Value: ""*

The planned time and date of the next version of this CRL to be published.

 **SigAlgorithm** *String*
*Default Value: "0"*

The public key algorithm that was used by the CA to sign this CRL.

 **Source** *int (read-only)*
*Default Value: 0*

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

 **TBS** *byte[] (read-only)*
*Default Value: ""*

The to-be-signed part of the CRL (the CRL without the signature part).

 **ThisUpdate** *String*
*Default Value: ""*

The date and time at which this version of the CRL was published.

## Constructors

```text
public CRL(byte[] bytes, int startIndex, int count);
```

 Creates a CRL object from a memory buffer. * Bytes * is a buffer containing raw (DER) CRL data, * StartIndex * and * Count * specify the starting position and the length of the CRL data in the buffer, respectively.

```text
public CRL(String location);
```

 Creates a CRL object by downloading it from a remote location.

```text
public CRL(java.io.InputStream stream);
```

 Creates a CRL object from data contained in a stream.

```text
public CRL();
```

 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.

The following fields are available:

- [AsyncDocumentID](#ExternalCrypto_f_AsyncDocumentID)

- [CustomParams](#ExternalCrypto_f_CustomParams)

- [Data](#ExternalCrypto_f_Data)

- [ExternalHashCalculation](#ExternalCrypto_f_ExternalHashCalculation)

- [HashAlgorithm](#ExternalCrypto_f_HashAlgorithm)

- [KeyID](#ExternalCrypto_f_KeyID)

- [KeySecret](#ExternalCrypto_f_KeySecret)

- [Method](#ExternalCrypto_f_Method)

- [Mode](#ExternalCrypto_f_Mode)

- [PublicKeyAlgorithm](#ExternalCrypto_f_PublicKeyAlgorithm)

## Fields

 **AsyncDocumentID** *String*
*Default Value: ""*

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

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

 **CustomParams** *String*
*Default Value: ""*

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

 **Data** *String*
*Default Value: ""*

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

 **ExternalHashCalculation** *boolean*
*Default Value: False*

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

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

 **HashAlgorithm** *String*
*Default Value: "SHA256"*

Specifies the request's signature hash algorithm.

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

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

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [KeySecret](#ExternalCrypto_f_KeySecret) 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:

```text
  signer.ExternalCrypto.KeyID = "MainSigningKey";
  signer.ExternalCrypto.KeySecret = "abcdef0123456789";
```

 **KeySecret** *String*
*Default Value: ""*

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

Read more about configuring authentication in the [KeyID](#ExternalCrypto_f_KeyID) topic.

 **Method** *int*
*Default Value: 0*

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

Available options:

|  |  |
| --- | --- |
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |

 **Mode** *int*
*Default Value: 0*

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 the OnExternalSign event (2) |
| ecmDCAuth | DCAuth signing (3) |
| ecmDCAuthJSON | DCAuth signing in JSON format (4) |

 **PublicKeyAlgorithm** *String*
*Default Value: ""*

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

|  |  |  |
| --- | --- | --- |
| SB_CERT_ALGORITHM_ID_RSA_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 |  |
| SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 |  |
| SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 |  |
| SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 |  |
| SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 |  |
| SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 |  |
| SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 |  |
| SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 |  |

## Constructors

```text
public ExternalCrypto();
```

 Creates a new ExternalCrypto object with default field values.

# FTPListEntry Type

Represents a basic container for the remote file details.

## Remarks

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

The following fields are available:

- [AccessTime](#FTPListEntry_f_AccessTime)

- [CreationTime](#FTPListEntry_f_CreationTime)

- [EntryFormat](#FTPListEntry_f_EntryFormat)

- [FileType](#FTPListEntry_f_FileType)

- [ModificationTime](#FTPListEntry_f_ModificationTime)

- [Name](#FTPListEntry_f_Name)

- [Path](#FTPListEntry_f_Path)

- [Principal](#FTPListEntry_f_Principal)

- [Size](#FTPListEntry_f_Size)

- [UnixPerms](#FTPListEntry_f_UnixPerms)

- [UnparsedName](#FTPListEntry_f_UnparsedName)

## Fields

 **AccessTime** *String*
*Default Value: ""*

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

 **CreationTime** *String*
*Default Value: ""*

Contains this file's creation time, in UTC.

 **EntryFormat** *int*
*Default Value: 0*

The file listing format:

|  |  |
| --- | --- |
| cfefUnknown | 0 |
| cfefUnix | 1 |
| cfefWindows | 2 |
| cfefMLSD | 3 |

 **FileType** *int*
*Default Value: 0*

The type of the entry:

|  |  |
| --- | --- |
| fetUnknown | 0 |
| fetDirectory | 1 |
| fetFile | 2 |
| fetSymlink | 3 |
| fetSpecial | 4 |
| fetCurrentDirectory | 5 |
| fetParentDirectory | 6 |
| fetSocket | 7 |
| fetCharDevice | 8 |
| fetBlockDevice | 9 |
| fetFIFO | 10 |

 **ModificationTime** *String*
*Default Value: ""*

File last modification date/time.

 **Name** *String*
*Default Value: ""*

The file or directory name.

 **Path** *String*
*Default Value: ""*

The full path to the file or directory.

 **Principal** *String*
*Default Value: ""*

Specifies the owner of the file/directory.

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

 **Size** *long*
*Default Value: 0*

File size in bytes.

 **UnixPerms** *int*
*Default Value: 511*

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

 **UnparsedName** *String*
*Default Value: ""*

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

## Constructors

```text
public FTPListEntry();
```

 Creates a new FTPListEntry object.

# OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

## Remarks

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

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

The following fields are available:

- [Bytes](#OCSPResponse_f_Bytes)

- [EntryCount](#OCSPResponse_f_EntryCount)

- [Issuer](#OCSPResponse_f_Issuer)

- [IssuerRDN](#OCSPResponse_f_IssuerRDN)

- [Location](#OCSPResponse_f_Location)

- [ProducedAt](#OCSPResponse_f_ProducedAt)

- [SigAlgorithm](#OCSPResponse_f_SigAlgorithm)

- [Source](#OCSPResponse_f_Source)

## Fields

 **Bytes** *byte[] (read-only)*
*Default Value: ""*

A buffer containing the raw OCSP response data.

 **EntryCount** *int (read-only)*
*Default Value: 0*

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

 **Issuer** *String (read-only)*
*Default Value: ""*

Indicates the issuer of this response (a CA or its authorized representative).

 **IssuerRDN** *String (read-only)*
*Default Value: ""*

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

 **Location** *String (read-only)*
*Default Value: ""*

The location of the OCSP responder.

 **ProducedAt** *String*
*Default Value: ""*

Specifies the time when the response was produced, in UTC.

 **SigAlgorithm** *String*
*Default Value: "0"*

The public key algorithm that was used by the CA to sign this OCSP response.

 **Source** *int (read-only)*
*Default Value: 0*

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

## Constructors

```text
public OCSPResponse(byte[] bytes, int startIndex, int count);
```

 Initializes the response from a memory buffer. * Bytes * is a buffer containing raw OCSP response data, * StartIndex * and * Count * specify the starting position and the number of bytes to be read from this buffer.

```text
public OCSPResponse(String location);
```

 Downloads an OCSP response from a remote location.

```text
public OCSPResponse(java.io.InputStream stream);
```

 Initializes the response with the data from a stream.

```text
public OCSPResponse();
```

 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.

The following fields are available:

- [Address](#ProxySettings_f_Address)

- [Authentication](#ProxySettings_f_Authentication)

- [Password](#ProxySettings_f_Password)

- [Port](#ProxySettings_f_Port)

- [ProxyType](#ProxySettings_f_ProxyType)

- [RequestHeaders](#ProxySettings_f_RequestHeaders)

- [ResponseBody](#ProxySettings_f_ResponseBody)

- [ResponseHeaders](#ProxySettings_f_ResponseHeaders)

- [UseIPv6](#ProxySettings_f_UseIPv6)

- [Username](#ProxySettings_f_Username)

## Fields

 **Address** *String*
*Default Value: ""*

The IP address of the proxy server.

 **Authentication** *int*
*Default Value: 0*

The authentication type used by the proxy server.

|  |  |
| --- | --- |
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |

 **Password** *String*
*Default Value: ""*

The password to authenticate to the proxy server.

 **Port** *int*
*Default Value: 0*

The port on the proxy server to connect to.

 **ProxyType** *int*
*Default Value: 0*

The type of the proxy server.

|  |  |
| --- | --- |
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |

 **RequestHeaders** *String*
*Default Value: ""*

Contains HTTP request headers for WebTunnel and HTTP proxy.

 **ResponseBody** *String*
*Default Value: ""*

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

 **ResponseHeaders** *String*
*Default Value: ""*

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

 **UseIPv6** *boolean*
*Default Value: False*

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

 **Username** *String*
*Default Value: ""*

Specifies the username credential for proxy authentication.

## Constructors

```text
public ProxySettings();
```

 Creates a new ProxySettings object.

# SocketSettings Type

A container for the socket settings.

## Remarks

This type is a container for socket-layer parameters.

The following fields are available:

- [DNSMode](#SocketSettings_f_DNSMode)

- [DNSPort](#SocketSettings_f_DNSPort)

- [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout)

- [DNSServers](#SocketSettings_f_DNSServers)

- [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout)

- [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit)

- [LocalAddress](#SocketSettings_f_LocalAddress)

- [LocalPort](#SocketSettings_f_LocalPort)

- [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit)

- [Timeout](#SocketSettings_f_Timeout)

- [UseIPv6](#SocketSettings_f_UseIPv6)

## Fields

 **DNSMode** *int*
*Default Value: 0*

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

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

 **DNSQueryTimeout** *int*
*Default Value: 0*

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

 **DNSServers** *String*
*Default Value: ""*

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

 **DNSTotalTimeout** *int*
*Default Value: 0*

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

 **IncomingSpeedLimit** *int*
*Default Value: 0*

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

 **LocalAddress** *String*
*Default Value: ""*

The local network interface to bind the socket to.

 **LocalPort** *int*
*Default Value: 0*

The local port number to bind the socket to.

 **OutgoingSpeedLimit** *int*
*Default Value: 0*

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

 **Timeout** *int*
*Default Value: 60000*

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

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

 **UseIPv6** *boolean*
*Default Value: False*

Enables or disables IP protocol version 6.

## Constructors

```text
public SocketSettings();
```

 Creates a new SocketSettings object.

# TLSConnectionInfo 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.

The following fields are available:

- [AEADCipher](#TLSConnectionInfo_f_AEADCipher)

- [ChainValidationDetails](#TLSConnectionInfo_f_ChainValidationDetails)

- [ChainValidationResult](#TLSConnectionInfo_f_ChainValidationResult)

- [Ciphersuite](#TLSConnectionInfo_f_Ciphersuite)

- [ClientAuthenticated](#TLSConnectionInfo_f_ClientAuthenticated)

- [ClientAuthRequested](#TLSConnectionInfo_f_ClientAuthRequested)

- [ConnectionEstablished](#TLSConnectionInfo_f_ConnectionEstablished)

- [ConnectionID](#TLSConnectionInfo_f_ConnectionID)

- [DigestAlgorithm](#TLSConnectionInfo_f_DigestAlgorithm)

- [EncryptionAlgorithm](#TLSConnectionInfo_f_EncryptionAlgorithm)

- [Exportable](#TLSConnectionInfo_f_Exportable)

- [Group](#TLSConnectionInfo_f_Group)

- [ID](#TLSConnectionInfo_f_ID)

- [KeyExchangeAlgorithm](#TLSConnectionInfo_f_KeyExchangeAlgorithm)

- [KeyExchangeKeyBits](#TLSConnectionInfo_f_KeyExchangeKeyBits)

- [PFSCipher](#TLSConnectionInfo_f_PFSCipher)

- [PreSharedIdentity](#TLSConnectionInfo_f_PreSharedIdentity)

- [PreSharedIdentityHint](#TLSConnectionInfo_f_PreSharedIdentityHint)

- [PublicKeyBits](#TLSConnectionInfo_f_PublicKeyBits)

- [RemoteAddress](#TLSConnectionInfo_f_RemoteAddress)

- [RemotePort](#TLSConnectionInfo_f_RemotePort)

- [ResumedSession](#TLSConnectionInfo_f_ResumedSession)

- [SecureConnection](#TLSConnectionInfo_f_SecureConnection)

- [ServerAuthenticated](#TLSConnectionInfo_f_ServerAuthenticated)

- [SignatureAlgorithm](#TLSConnectionInfo_f_SignatureAlgorithm)

- [SymmetricBlockSize](#TLSConnectionInfo_f_SymmetricBlockSize)

- [SymmetricKeyBits](#TLSConnectionInfo_f_SymmetricKeyBits)

- [TotalBytesReceived](#TLSConnectionInfo_f_TotalBytesReceived)

- [TotalBytesSent](#TLSConnectionInfo_f_TotalBytesSent)

- [ValidationLog](#TLSConnectionInfo_f_ValidationLog)

- [Version](#TLSConnectionInfo_f_Version)

## Fields

 **AEADCipher** *boolean (read-only)*
*Default Value: False*

Indicates whether the encryption algorithm used is an AEAD cipher.

 **ChainValidationDetails** *int (read-only)*
*Default Value: 0*

The details of a certificate chain validation outcome. They may often suggest the 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** *int (read-only)*
*Default Value: 0*

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

The cipher suite employed by this connection.

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

 **ClientAuthenticated** *boolean (read-only)*
*Default Value: False*

Specifies whether client authentication was performed during this connection.

 **ClientAuthRequested** *boolean (read-only)*
*Default Value: False*

Specifies whether client authentication was requested during this connection.

 **ConnectionEstablished** *boolean (read-only)*
*Default Value: False*

Indicates whether the connection has been established fully.

 **ConnectionID** *byte[] (read-only)*
*Default Value: ""*

The unique identifier assigned to this connection.

 **DigestAlgorithm** *String (read-only)*
*Default Value: ""*

The digest algorithm used in a TLS-enabled connection.

 **EncryptionAlgorithm** *String (read-only)*
*Default Value: ""*

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

 **Exportable** *boolean (read-only)*
*Default Value: False*

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

 **Group** *String (read-only)*
*Default Value: ""*

The elliptic curve used in this connection.

This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions.

 **ID** *long (read-only)*
*Default Value: -1*

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

 **KeyExchangeAlgorithm** *String (read-only)*
*Default Value: ""*

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

 **KeyExchangeKeyBits** *int (read-only)*
*Default Value: 0*

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

 **PFSCipher** *boolean (read-only)*
*Default Value: False*

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

 **PreSharedIdentity** *String*
*Default Value: ""*

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

 **PreSharedIdentityHint** *String (read-only)*
*Default Value: ""*

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

 **PublicKeyBits** *int (read-only)*
*Default Value: 0*

The length of the public key.

 **RemoteAddress** *String (read-only)*
*Default Value: ""*

The client's IP address.

 **RemotePort** *int (read-only)*
*Default Value: 0*

The remote port of the client connection.

 **ResumedSession** *boolean (read-only)*
*Default Value: False*

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

 **SecureConnection** *boolean (read-only)*
*Default Value: False*

Indicates whether TLS or SSL is enabled for this connection.

 **ServerAuthenticated** *boolean (read-only)*
*Default Value: False*

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

 **SignatureAlgorithm** *String (read-only)*
*Default Value: ""*

The signature algorithm used in a TLS handshake.

 **SymmetricBlockSize** *int (read-only)*
*Default Value: 0*

The block size of the symmetric algorithm used.

 **SymmetricKeyBits** *int (read-only)*
*Default Value: 0*

The key length of the symmetric algorithm used.

 **TotalBytesReceived** *long (read-only)*
*Default Value: 0*

The total number of bytes received over this connection.

 **TotalBytesSent** *long (read-only)*
*Default Value: 0*

The total number of bytes sent over this connection.

 **ValidationLog** *String (read-only)*
*Default Value: ""*

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

 **Version** *String (read-only)*
*Default Value: ""*

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

## Constructors

```text
public TLSConnectionInfo();
```

 Creates a new TLSConnectionInfo object.

# TLSSettings Type

A container for TLS connection settings.

## Remarks

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

The following fields are available:

- [AutoValidateCertificates](#TLSSettings_f_AutoValidateCertificates)

- [BaseConfiguration](#TLSSettings_f_BaseConfiguration)

- [Ciphersuites](#TLSSettings_f_Ciphersuites)

- [ClientAuth](#TLSSettings_f_ClientAuth)

- [Extensions](#TLSSettings_f_Extensions)

- [ForceResumeIfDestinationChanges](#TLSSettings_f_ForceResumeIfDestinationChanges)

- [Groups](#TLSSettings_f_Groups)

- [PreSharedIdentity](#TLSSettings_f_PreSharedIdentity)

- [PreSharedKey](#TLSSettings_f_PreSharedKey)

- [PreSharedKeyCiphersuite](#TLSSettings_f_PreSharedKeyCiphersuite)

- [RenegotiationAttackPreventionMode](#TLSSettings_f_RenegotiationAttackPreventionMode)

- [RevocationCheck](#TLSSettings_f_RevocationCheck)

- [SSLOptions](#TLSSettings_f_SSLOptions)

- [TLSMode](#TLSSettings_f_TLSMode)

- [UseExtendedMasterSecret](#TLSSettings_f_UseExtendedMasterSecret)

- [UseSessionResumption](#TLSSettings_f_UseSessionResumption)

- [Versions](#TLSSettings_f_Versions)

## Fields

 **AutoValidateCertificates** *boolean*
*Default Value: True*

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

 **BaseConfiguration** *int*
*Default Value: 0*

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

|  |  |  |
| --- | --- | --- |
| stpcDefault | 0 |  |
| stpcCompatible | 1 |  |
| stpcComprehensiveInsecure | 2 |  |
| stpcHighlySecure | 3 |  |

 **Ciphersuites** *String*
*Default Value: ""*

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, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [BaseConfiguration](#TLSSettings_f_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

 **ClientAuth** *int*
*Default Value: 0*

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

|  |  |  |
| --- | --- | --- |
| ccatNoAuth | 0 |  |
| ccatRequestCert | 1 |  |
| ccatRequireCert | 2 |  |

 **Extensions** *String*
*Default Value: ""*

Provides access to TLS extensions.

 **ForceResumeIfDestinationChanges** *boolean*
*Default Value: False*

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

 **Groups** *String*
*Default Value: ""*

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder:

```text
  // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled
  client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048";

  // Only enable the hybrid X25519/ML-KEM768 group
  client.TLSSettings.Groups = "-all;+x25519mlkem768";
```

The list of groups supported by the component is provided below. All the names are case-insensitive:

**Elliptic curve-based groups:**

- SECT163K1
- SECT163R1
- SECT163R2
- SECT193R1
- SECT193R2
- SECT233K1
- SECT233R1
- SECT239K1
- SECT283K1
- SECT283R1
- SECT409K1
- SECT409R1
- SECT571K1
- SECT571R1
- SECP160K1
- SECP160R1
- SECP160R2
- SECP192K1
- SECP192R1
- SECP224K1
- SECP224R1
- SECP256K1
- SECP256R1
- SECP384R1
- SECP521R1
- BRAINPOOLP256R1
- BRAINPOOLP384R1
- BRAINPOOLP512R1
- X25519
- X448

**Finite field-based groups:**

- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192

**Post-Quantum and Hybrid groups:**

- MLKEM512
- MLKEM768
- MLKEM1024
- SECP256R1MLKEM768
- X25519MLKEM768
- SECP384R1MLKEM1024

Note: this property was called *ECCurves* in SecureBlackbox 2024 and older.

 **PreSharedIdentity** *String*
*Default Value: ""*

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

 **PreSharedKey** *String*
*Default Value: ""*

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

 **PreSharedKeyCiphersuite** *String*
*Default Value: ""*

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

 **RenegotiationAttackPreventionMode** *int*
*Default Value: 2*

Selects the 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** *int*
*Default Value: 1*

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 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

This setting controls the way the revocation checks are performed for every certificate in the chain. 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 the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

 **SSLOptions** *int*
*Default Value: 16*

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 the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the 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 the handshake message as large batches rather than individually |

 **TLSMode** *int*
*Default Value: 0*

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. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |

 **UseExtendedMasterSecret** *boolean*
*Default Value: True*

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

 **UseSessionResumption** *boolean*
*Default Value: False*

Enables or disables the TLS session resumption capability.

 **Versions** *int*
*Default Value: 48*

The 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

```text
public TLSSettings();
```

 Creates a new TLSSettings object.

# Config Settings ([FTPClient](#ftpclient-class) Class)

 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](#config-method-ftpclient-class) method.

### FTPClient Config Settings

**AccountInfo**: Provides the value to be used with ACCT command.Specifies an additional authentication value to be passed to the server with the ACCT command.

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

**CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.

The default value is 0, which disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.

The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

The default value is 0, which disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.

**CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

**CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.

**CaseConversion**: Whether file names and paths should be case-converted.Defines whether file names are converted (on the destination system) to: lowercase (1), uppercase (2).

**CaseSensitive**: Specifies if file paths are case-sensitive.Set this property to True if all file names, paths and file masks should be case-sensitive.

**CloseQuietly**: 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.

**ControlChannelLog**: Returns the control channel connection log.Use this setting to retrieve the control channel connection log, similar to the logs produced by typical FTP clients and servers. Any sensitive data, such as passwords, will be hidden.

**CopyMode**: Tunes up the post-transfer action for batch uploads.Use this setting to adjust the post-transfer action for files that are uploaded or downloaded as part of a batch.

The following values are supported:

- 0 (the default setting) - no post-transfer action.
- 1 - delete each file immediately after it has been transferred to the destination system.
- 2 - delete all the original files after all the files have been transferred to the destination system.

 The difference between modes 1 and 2 is about error management. In the latter case, any (and all) files will only be deleted if the entire batch has been transferred successfully. Any transfer error that happens in the middle cancels the deletion.

In the former case, each file is deleted right after it has been transferred, independently of the outcome of transfer of other items in the batch.

Note that this setting only applies to batch (multi-file_ transfers. It has no effect on single-file transfers.

**DataPort**: Sets a specific listening port for active mode data connection.Use this property to provide a specific listening port to be used for data transfer.

**DataPortRangeFilter**: Provides a flexible mechanism to set multiple active mode data port ranges.Use this property to provide multiple data port ranges to be used for active mode transfers. This configuration setting accepts a comma-separated list of ranges or individual port numbers. Make sure that all the port ranges are mutually exclusive and none of any two ranges intersect. Example: 1500,1505-1512,1520,1521-1531.

**DataPortRangeFrom**: Sets the lower boundary for Active mode data port range.This setting specifies the lower boundary for the listening port range to be used for data transfers in active mode.

**DataPortRangeTo**: Sets the upper boundary for Active mode data port range.This setting specifies the upper boundary for the listening port range to be used for data transfers in active mode.

**DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during TLS certificate revocation checks.

The default value is **dcrlpPreferDelta** (0).

Supported values:

- **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
- **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.

**ErrorOrigin**: Specifies whether the error is local or remote.Use this property to check where the error took place.

**ErrorSeverity**: Specifies whether the error is fatal.Use this property to check whether the error is fatal or not.

**EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.Enable this property to delegate the chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

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

**ExtXSHA1Supported**: TBD.TBD

**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 class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

If [IgnoreSystemTrust](#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 the [TrustedCertificates](#trustedcertificates-property-ftpclient-class) 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**: A character string for the end of line (EOL) indication on the local machine.This property contains a character string for the end of line (EOL) indication on the local machine. 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 LocalNewLineConvention line endings. Line ending conventions are only used in text transfer mode.

**LocalNewLineConvention**: A character string for the end of line (EOL) indication on the local machine.This property contains a character string for the end of line (EOL) indication on the local machine. 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 LocalNewLineConvention line 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.

**ModeZ**: Enables or disables data compression.Use this setting to enable to disable Mode Z (data compression).

**Options**: Various FTP options.Various options of FTP connection.

**RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled.

Supported values are case-insensitive:

|  |  |
| --- | --- |
| Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. |
| Default | Applies the component default freshness settings. For this component, Default is equivalent to Disabled. |
| Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. |
| Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. |
| N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. |
| crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap> | Sets the CRL and OCSP response freshness values explicitly. |

Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

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

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

**TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply.

**TLSCiphersuites**: Returns the list of ciphersuites activated in the component for the current session.Check this property to enumerate the list of TLS ciphersuites enabled in the component. A good place to do that is OnTLSHandshake event handler.

**TLSExtensions**: TBD.TBD

**TLSGroups**: Returns the list of TLS key exchange groups enabled in the component.Check this property to enumerate the list of TLS key exchange groups enabled in the component.

**TLSLayerKeepAlives**: Enables or disables keep alive signals on the TLS layer.Normally FTP environments choose FTP-level keep-alive commands (NOOP). However, in some cases (firewalls, buggy servers) it may be necessary to implement keep-alives at lower level. Use this setting to enable TLS-layer keep-alive packets.

**TLSPeerExtensions**: TBD.TBD

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

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

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

**TLSVersions**: Returns the list of TLS versions enabled in the component.Check this property to obtain the list of TLS versions enabled in the component, as an integer bitmask.

**TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated

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

**UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.

**UseMicrosoftCTL**: Enables or disables the automatic use of the 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 the chain validation module to 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.

**UseUTF8IfAvailable**: Upgrade to UTF8 string encoding if the server supports it.This setting, which is set to true by default, tells the client to activate UTF8 encoding for international strings if the server indicates its support via the UTF8 feature.

### Base Config Settings

**ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it.

**AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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

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

**CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.

Supported values are:

|  |  |  |
| --- | --- | --- |
| off |  | No caching (default) |
| local |  | Local caching |
| global |  | Global caching |

**Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

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

**DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*.

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

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

**EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

**EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

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

**HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy.

Supported Values:

|  |  |
| --- | --- |
| auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). |
| enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. |
| disable | Do not use hardware cryptography. |

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

**HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

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

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

**LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

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

**OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

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

Supported Values:

|  |  |
| --- | --- |
| certificate | Enables caching of certificates. |
| crl | Enables caching of Certificate Revocation Lists (CRLs). |
| ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |

Example (default value):

```text
PKICache=certificate,crl,ocsp
```

 In this example, the component caches certificates, CRLs, and OCSP responses.

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

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

Example:

```text
PKICachePath=C:\Temp\cache
```

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

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

**ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

**StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*.

Supported values are:

|  |  |  |
| --- | --- | --- |
| none |  | No static DNS rules (default) |
| local |  | Local static DNS rules |
| global |  | Global static DNS rules |

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

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

**Tag**: Allows to store any custom data.Use this config property to store any custom data.

**TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

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

**TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

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

**UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform.

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

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

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

**UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores.

**UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team.

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

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

**UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

**XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

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

Syntax:

```text
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
```

Where:

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

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

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

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

```text
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
```

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:

```text
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
```

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

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

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

# Trappable Errors ([FTPClient](#ftpclient-class) Class)

### FTPClient Errors

|  |  |
| --- | --- |
| 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) |
| 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) |
| 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) |
| 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) |
| 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) |
| 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) |
| 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) |
| 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) |
| 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |
| 18874369 | Unsupported file operation ([SB_ERROR_FTP_UNSUPPORTED_FILE_OPERATION](constants.md#const_SBERRORFTPUNSUPPORTEDFILEOPERATION)) |