FTPClient Class
Properties Methods Events Config Settings Errors
The FTPClient class provides client-side functionality for FTP and FTPS protocols.
Syntax
secureblackbox.Ftpclient
Remarks
FTPClient provides client-side support for the FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations with a remote server over Transport Layer Security (TLS).
Note: TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.
FTPClient is typically used in the following scenario:
- Setting up the connection parameters
- Connecting to the server and signing in
- Performing file transfer operations
- Closing the connection
Setting up the parameters
When working with FTP or FTP-over-TLS service you will often need to tune up several classes of settings:- Login credentials: these can be tuned up via the Username and Password properties.
- TLS settings: these includes the TLS mode: explicit, implicit, or no TLS. You must get this setting right; otherwise you may not be able to connect. Use TLSSettings property to adjust this setting.
- If your server requires you to authenticate with a certificate, you can provide one via the ClientChain property.
- FTPClient validates the server certificate against the local security settings. If your server uses a custom or non-public PKI, you may need to provide the required trust anchors and CA certificates via the TrustedCertificates and KnownCertificates collections.
- FTP protocol includes its own set of settings, such as PassiveMode, EncryptDataChannel, or AdjustPasvAddress. These may be configured on this stage, or later into the connection.
- In some network environments, you may also need to make adjustments to SocketSettings and Proxy.
Connecting to the server and signing in
Call Connect to open the connection to the server. The component will use the provided credentials to sign you in automatically.Performing file transfer operations
FTPClient offers the full set of FTP operations. These include file uploads (UploadFile or UploadBytes), file downloads (DownloadFile, DownloadBytes), and directory operations (ListDir, MakeDir).Note that unlike SFTP, FTP only supports one transfer operation at a time. An ongoing operation should be completed or aborted before a new one can be started.
Closing the connection
Use Disconnect to close the FTP connection.Useful info
During its work FTPClient communicates back via events. Progress event fires periodically during the transfer operation to let you know of the operation progress. ControlSend and ControlReceive report the protocol communication log. FileOperation and FileOperationResult report the start and completion of an individual transfer operation within a multi-file transfer call (such as UploadFiles).Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| AccountInfo | Parameters for the ACCT command. |
| AdjustPasvAddress | Enables or disables automatic adjustment of passive-mode addresses. |
| BlockedCertificates | The certificates that must be rejected as trust anchors. |
| ClientChain | The TLS client certificate chain. |
| Connected | Indicates whether the class is connected to the server. |
| ControlChannelLog | Contains the control channel log of the FTP session. |
| ControlConnectionInfo | Returns the details of the control connection setup. |
| CurrentListEntry | Contains the details of the file entry reported by ListEntry . |
| DataConnectionInfo | Returns the details of the data connection setup. |
| EncryptDataChannel | Enables or disables data channel encryption. |
| ExternalCrypto | Provides access to external signing and DC parameters. |
| FIPSMode | Reserved. |
| KnownCertificates | Additional certificates for chain validation. |
| KnownCRLs | Additional CRLs for chain validation. |
| KnownOCSPs | Additional OCSP responses for chain validation. |
| ModeZ | Switches on data compression. |
| PassiveMode | Enables or disables passive transfer mode. |
| Password | The connecting user's authentication password. |
| Proxy | The proxy server settings. |
| RestartAt | The offset to restart the file transfer from. |
| ServerChain | The TLS server's certificate chain. |
| SocketSettings | Manages network connection settings. |
| TLSSettings | Manages TLS layer settings. |
| TransferType | Sets the file transfer mode. |
| TrustedCertificates | A list of trusted certificates for chain validation. |
| Username | The connecting user's username (login name). |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Abort | Aborts the previous FTP service command and any associated transfer of data. |
| Acct | Sends an Account command. |
| AppendBytes | Appends a byte array to a server-side file. |
| AppendFile | Uploads a file to the server. |
| AppendStream | Uploads a file to the server. |
| ChangeDir | Changes the current directory. |
| ClearCommandChannel | Sends CCC (Clear Command Channel) command to the server. |
| Config | Sets or retrieves a configuration setting. |
| Connect | Connects to the FTP server. |
| DeleteDir | Deletes a directory on the server. |
| DeleteFile | Deletes a file on the server. |
| DirExists | Checks if a directory exists on the server. |
| Disconnect | Disconnects from the server. |
| DoAction | Performs an additional action. |
| DownloadBytes | Downloads a file from the server into an array of bytes. |
| DownloadFile | Downloads a file from the server. |
| DownloadFiles | Downloads multiple files from the server. |
| DownloadStream | Downloads a file from the server into a stream. |
| FileExists | Checks if a file exists on the server. |
| GetCurrentDir | Returns the server-side current directory. |
| GetFileSize | Returns the size of a remote file. |
| ListDir | Lists the contents of a remote directory. |
| MakeDir | Creates a new directory on the server. |
| Noop | Sends a NOOP command to the server. |
| Rename | Renames a file. |
| SendCommand | Sends a custom command to the server. |
| UploadBytes | Uploads a byte array to the server. |
| UploadFile | Uploads a file to the server. |
| UploadFiles | Uploads multiple files to the server. |
| UploadStream | 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 | Fires when data is received via the control channel. |
| ControlSend | Fires when data is about to be set via the control channel. |
| Error | Information about errors during data delivery. |
| ExternalSign | Handles remote or external signing initiated by the SignExternal method or other source. |
| FileOperation | Marks the start of a file transfer. |
| FileOperationResult | Reports the result of a file transfer operation. |
| ListEntry | Reports a single entry from the requested directory listing. |
| Notification | This event notifies the application about an underlying control flow event. |
| Progress | Reports the data transfer progress. |
| TextDataLine | Reports next transferred data line. |
| TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
| TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
| TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
| TLSPSK | Notifies the application about the PSK key exchange. |
| TLSShutdown | 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.
| AuthCmd | Authorization command to be used to request an explicit SSL session. |
| CaseConversion | Whether file names and paths should be case-converted. |
| CaseSensitive | Case-sensitivity of file names and paths. |
| CloseQuietly | Set this to true to avoid sending QUIT command on session closure. |
| ConcurrentConnections | Number of simultaneous connections for download. |
| CopyMode | What to do with the originals of the copied files. |
| ErrorOrigin | Specifies where the error has been originated. |
| ErrorSeverity | Error severity. |
| EventOrigin | Indicates the channel that has fired the event. |
| ExtHOSTSupported | Whether HOST extension is supported. |
| ExtMDTMSupported | Whether MDTM extension is supported. |
| ExtMFMTSupported | Whether MFMT extension is supported. |
| ExtMLSTSupported | Whether MLST extension is supported. |
| ExtOPTSUTF8Supported | Whether OPTS UTF8 extension is supported. |
| ExtRESTSupported | Whether REST extension is supported. |
| ExtSIZESupported | Whether SIZE extension is supported. |
| ExtXCRCSupported | Whether XCRC extension is supported. |
| ExtXMD5Supported | Whether XMD5 extension is supported. |
| FTPBufferSize | Buffer size in binary mode. |
| FTPTextBufferSize | Buffer size in text mode. |
| IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
| ListenTimeout | Listening socket timeout. |
| LocalNewLineConvention | Defines the local newline convention. |
| MinSizeForConcurrentDownload | Files bigger than this size will be downloaded concurrently. |
| Mode | What to do if the destination file already exists. |
| Options | Various FTP options. |
| Recursive | Whether to scan subdirectories. |
| TempPath | Path for storing temporary files. |
| TolerateMinorChainIssues | Whether to tolerate minor chain issues. |
| TransferKeepAliveInterval | Keep-alive interval for the data channel transfers. |
| TransferTimeout | Timeout for data transfer in active mode. |
| UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
| UseProxySettingsForDataChannel | Whether the proxy settings should be applied to data channel. |
| UseSystemCertificates | Enables or disables the use of the system certificates. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
AccountInfo Property (FTPClient Class)
Parameters for the ACCT command.
Syntax
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 Class)
Enables or disables automatic adjustment of passive-mode addresses.
Syntax
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 Class)
The certificates that must be rejected as trust anchors.
Syntax
public CertificateList getBlockedCertificates(); public void setBlockedCertificates(CertificateList blockedCertificates);
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.
ClientChain Property (FTPClient Class)
The TLS client certificate chain.
Syntax
public CertificateList getClientChain(); public void setClientChain(CertificateList clientChain);
Remarks
Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.
Use CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.
This property is not available at design time.
Connected Property (FTPClient Class)
Indicates whether the class is connected to the server.
Syntax
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 Class)
Contains the control channel log of the FTP session.
Syntax
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 Class)
Returns the details of the control connection setup.
Syntax
public ConnectionInfo 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.
CurrentListEntry Property (FTPClient Class)
Contains the details of the file entry reported by ListEntry .
Syntax
public FTPListEntry getCurrentListEntry();
Remarks
A typical use of this property is to check it in ListEntry event handler. This property is updated with new details each time a new entry is processed.
This property is read-only and not available at design time.
DataConnectionInfo Property (FTPClient Class)
Returns the details of the data connection setup.
Syntax
public ConnectionInfo 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.
EncryptDataChannel Property (FTPClient Class)
Enables or disables data channel encryption.
Syntax
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 method is called.
ExternalCrypto Property (FTPClient Class)
Provides access to external signing and DC parameters.
Syntax
public ExternalCrypto getExternalCrypto();
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).
This property is read-only.
FIPSMode Property (FTPClient Class)
Reserved.
Syntax
public boolean isFIPSMode(); public void setFIPSMode(boolean FIPSMode);
Default Value
False
Remarks
This property is reserved for future use.
KnownCertificates Property (FTPClient Class)
Additional certificates for chain validation.
Syntax
public CertificateList getKnownCertificates(); public void setKnownCertificates(CertificateList knownCertificates);
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 component manually.
The purpose of certificates to be added to this collection is roughly equivalent to that of Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
KnownCRLs Property (FTPClient Class)
Additional CRLs for chain validation.
Syntax
public CRLList getKnownCRLs(); public void setKnownCRLs(CRLList knownCRLs);
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.
KnownOCSPs Property (FTPClient Class)
Additional OCSP responses for chain validation.
Syntax
public OCSPResponseList getKnownOCSPs(); public void setKnownOCSPs(OCSPResponseList knownOCSPs);
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.
ModeZ Property (FTPClient Class)
Switches on data compression.
Syntax
public boolean isModeZ(); public void setModeZ(boolean modeZ);
Default Value
True
Remarks
Switches the in-flight data compression on/off.
PassiveMode Property (FTPClient Class)
Enables or disables passive transfer mode.
Syntax
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 Class)
The connecting user's authentication password.
Syntax
public String getPassword(); public void setPassword(String password);
Default Value
""
Remarks
Assign the user's authentication password to this property. Use Username for username/login.
Proxy Property (FTPClient Class)
The proxy server settings.
Syntax
public ProxySettings getProxy();
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
RestartAt Property (FTPClient Class)
The offset to restart the file transfer from.
Syntax
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.
ServerChain Property (FTPClient Class)
The TLS server's certificate chain.
Syntax
public CertificateList getServerChain();
Remarks
Use this property to access the certificate chain sent by the TLS server. This property is ready to read when OnCertificateValidate event is fired by the client component.
This property is read-only and not available at design time.
SocketSettings Property (FTPClient Class)
Manages network connection settings.
Syntax
public SocketSettings getSocketSettings();
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
TLSSettings Property (FTPClient Class)
Manages TLS layer settings.
Syntax
public TLSSettings getTLSSettings();
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
TransferType Property (FTPClient Class)
Sets the file transfer mode.
Syntax
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 Class)
A list of trusted certificates for chain validation.
Syntax
public CertificateList getTrustedCertificates(); public void setTrustedCertificates(CertificateList trustedCertificates);
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 than that of 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.
Username Property (FTPClient Class)
The connecting user's username (login name).
Syntax
public String getUsername(); public void setUsername(String username);
Default Value
""
Remarks
Assign the user's login name to this property. Use Password to provide the password.
Abort Method (Ftpclient Class)
Aborts the previous FTP service command and any associated transfer of data.
Syntax
public void abort();
Remarks
Use this method to abort the previous FTP service command and any associated data transfer.
Acct Method (Ftpclient Class)
Sends an Account command.
Syntax
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 Class)
Appends a byte array to a server-side file.
Syntax
public void appendBytes(byte[] bytes, String remoteFile);
Remarks
Use this method to append Bytes to RemoteFile on the server.
AppendFile Method (Ftpclient Class)
Uploads a file to the server.
Syntax
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 Class)
Uploads a file to the server.
Syntax
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 Class)
Changes the current directory.
Syntax
public void changeDir(String remoteDir);
Remarks
Call this method to change the current server directory to RemoteDir.
ClearCommandChannel Method (Ftpclient Class)
Sends CCC (Clear Command Channel) command to the server.
Syntax
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 Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String configurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Connect Method (Ftpclient Class)
Connects to the FTP server.
Syntax
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 and Password.
DeleteDir Method (Ftpclient Class)
Deletes a directory on the server.
Syntax
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 Class)
Deletes a file on the server.
Syntax
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 Class)
Checks if a directory exists on the server.
Syntax
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 Class)
Disconnects from the server.
Syntax
public void disconnect();
Remarks
Call this method to disconnect from the server.
DoAction Method (Ftpclient Class)
Performs an additional action.
Syntax
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
DownloadBytes Method (Ftpclient Class)
Downloads a file from the server into an array of bytes.
Syntax
public byte[] downloadBytes(String remoteFile);
Remarks
Use this method to download RemoteFile into a byte array.
DownloadFile Method (Ftpclient Class)
Downloads a file from the server.
Syntax
public void downloadFile(String remoteFile, String localFile);
Remarks
Use this method to download RemoteFile into LocalFile.
DownloadFiles Method (Ftpclient Class)
Downloads multiple files from the server.
Syntax
public void downloadFiles(String remotePath, String localDir);
Remarks
Use this method do download a collection of files from the server.
RemotePath can contain a simple mask, a set of masks, or a regular expression. All the files that match the provided rule will be downloaded to LocalDir.
DownloadStream Method (Ftpclient Class)
Downloads a file from the server into a stream.
Syntax
public void downloadStream(String remoteFile, java.io.OutputStream localStream);
Remarks
Use this method to download RemoteFile into a stream object.
FileExists Method (Ftpclient Class)
Checks if a file exists on the server.
Syntax
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 command first, then call this method.
GetCurrentDir Method (Ftpclient Class)
Returns the server-side current directory.
Syntax
public String getCurrentDir();
Remarks
Use this method to find out the current directory on the server.
GetFileSize Method (Ftpclient Class)
Returns the size of a remote file.
Syntax
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 command first, then call this method.
ListDir Method (Ftpclient Class)
Lists the contents of a remote directory.
Syntax
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 for each entry in the list, propagating its details in CurrentListEntry.
This method uses some heuristics internally by choosing the most appropriate listing method among MLSD, NLST, and LIST.
MakeDir Method (Ftpclient Class)
Creates a new directory on the server.
Syntax
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 Class)
Sends a NOOP command to the server.
Syntax
public void noop();
Remarks
Call this method to send a NOOP (No Operation) command to the server.
Rename Method (Ftpclient Class)
Renames a file.
Syntax
public void rename(String sourceFile, String destFile);
Remarks
Use this method to rename a server-side SourceFile to DestFile.
SendCommand Method (Ftpclient Class)
Sends a custom command to the server.
Syntax
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 Class)
Uploads a byte array to the server.
Syntax
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 Class)
Uploads a file to the server.
Syntax
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 Class)
Uploads multiple files to the server.
Syntax
public void uploadFiles(String localPath, String remoteDir);
Remarks
This method uploads all the files that match the LocalPath criteria to RemoteDir directory on the server. LocalPath accepts a simple mask, a set of masks, or a regular expression.
For each file being uploaded a pair of FileOperation and FileOperationResult events are invoked.
UploadStream Method (Ftpclient Class)
Uploads a file to the server.
Syntax
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 Class)
Fires when data is received via the control channel.
Syntax
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 Class)
Fires when data is about to be set via the control channel.
Syntax
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 Class)
Information about errors during data delivery.
Syntax
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 section.
ExternalSign Event (Ftpclient Class)
Handles remote or external signing initiated by the SignExternal method or other source.
Syntax
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; }
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
FileOperation Event (Ftpclient Class)
Marks the start of a file transfer.
Syntax
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; public boolean cancel; }
Remarks
The class fires this event from DownloadFiles and UploadFiles to notify the application that the transfer of the next file in the list is about to start.
Use the Skip parameter to skip this particular file, or Cancel to cancel the whole multi-file operation.
Operations:
| cffoDownloadFile | 0 | Download file |
| cffoUploadFile | 1 | Upload file |
| cffoDeleteFile | 2 | Delete file |
| cffoMakeDir | 3 | Make directory |
FileOperationResult Event (Ftpclient Class)
Reports the result of a file transfer operation.
Syntax
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; }
Remarks
The class fires this event from DownloadFiles and UploadFiles to notify the application of the completion of a file operation.
ErrorCode and Comment provide the details of the operation. Use the Cancel parameter to terminate the whole multi-file operation if needed.
Operations:
| cffoDownloadFile | 0 | Download file |
| cffoUploadFile | 1 | Upload file |
| cffoDeleteFile | 2 | Delete file |
| cffoMakeDir | 3 | Make directory |
ListEntry Event (Ftpclient Class)
Reports a single entry from the requested directory listing.
Syntax
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 property.
Notification Event (Ftpclient Class)
This event notifies the application about an underlying control flow event.
Syntax
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 component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
Progress Event (Ftpclient Class)
Reports the data transfer progress.
Syntax
public class DefaultFtpclientEventListener implements FtpclientEventListener { ... public void progress(FtpclientProgressEvent e) {} ... } public class FtpclientProgressEvent { public long total; public long current; public boolean cancel; }
Remarks
This event fires periodically during a file transfer operation to report its progress.
Use the Cancel parameter to terminate the transfer if needed.
TextDataLine Event (Ftpclient Class)
Reports next transferred data line.
Syntax
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 Class)
Fires when a remote TLS party requests a client certificate.
Syntax
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 (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.
TLSCertValidate Event (Ftpclient Class)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
public class DefaultFtpclientEventListener implements FtpclientEventListener { ... public void TLSCertValidate(FtpclientTLSCertValidateEvent e) {} ... } public class FtpclientTLSCertValidateEvent { public String serverHost; public String serverIP; public boolean accept; }
Remarks
This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components 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 component, and can be adjusted if needed.
TLSEstablished Event (Ftpclient Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
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; }
Remarks
The class uses this event to notify the application about successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (Ftpclient Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
public class DefaultFtpclientEventListener implements FtpclientEventListener { ... public void TLSHandshake(FtpclientTLSHandshakeEvent e) {} ... } public class FtpclientTLSHandshakeEvent { public String host; public boolean abort; }
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.
TLSPSK Event (Ftpclient Class)
Notifies the application about the PSK key exchange.
Syntax
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 to provide the pre-shared key to the component.
TLSShutdown Event (Ftpclient Class)
Reports the graceful closure of a TLS connection.
Syntax
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
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
|
Bytes byte[] |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CA boolean |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CAKeyID byte[] |
A unique identifier (fingerprint) of the CA certificate's private key. Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CRLDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Fingerprint byte[] |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
FriendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyBits int |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyFingerprint byte[] |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyUsage int |
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyValid boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
OCSPNoCheck boolean |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Origin int |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PolicyIDs String |
Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyBytes byte[] |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExists boolean |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PrivateKeyExtractable boolean |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBytes byte[] |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
QualifiedStatements int |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SelfSigned boolean |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SerialNumber byte[] |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectKeyID byte[] |
Contains a unique identifier (fingerprint) of the certificate's private key. Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public Certificate( bytes, startIndex, count, 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.
public Certificate( certBytes, certStartIndex, certCount, keyBytes, keyStartIndex, keyCount, password);
Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the 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.
public Certificate( bytes, startIndex, 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.
public Certificate( path, 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.
public Certificate( certPath, keyPath, 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.
public Certificate( path);
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.
public Certificate( stream);
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public Certificate( stream, password);
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.
public Certificate( certStream, keyStream, 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.
public Certificate();
Creates a new object with default field values.
ConnectionInfo Type
Contains information about a network connection.
Remarks
Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.
Fields
|
AEADCipher boolean |
Indicates whether the encryption algorithm used is an AEAD cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationDetails int |
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result. Returns a bit mask of the following options:
|
||||||||||||||||||||||||||||||||||||||||||||||||
|
ChainValidationResult int |
The outcome of a certificate chain validation routine. Available options:
Use the ValidationLog property to access the detailed validation log. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Ciphersuite String |
The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ClientAuthenticated boolean |
Specifies whether client authentication was performed during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ClientAuthRequested boolean |
Specifies whether client authentication was requested during this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ConnectionEstablished boolean |
Indicates whether the connection has been established fully. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ConnectionID byte[] |
The unique identifier assigned to this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
DigestAlgorithm String |
The digest algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
EncryptionAlgorithm String |
The symmetric encryption algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Exportable boolean |
Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyExchangeAlgorithm String |
The key exchange algorithm used in a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyExchangeKeyBits int |
The length of the key exchange key of a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
NamedECCurve String |
The elliptic curve used in this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PFSCipher boolean |
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PreSharedIdentityHint String |
A hint professed by the server to help the client select the PSK identity to use. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyBits int |
The length of the public key. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ResumedSession boolean |
Indicates whether a TLS-enabled connection was spawned from another TLS connection |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SecureConnection boolean |
Indicates whether TLS or SSL is enabled for this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ServerAuthenticated boolean |
Indicates whether server authentication was performed during a TLS-enabled connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SignatureAlgorithm String |
The signature algorithm used in a TLS handshake. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SymmetricBlockSize int |
The block size of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
SymmetricKeyBits int |
The key length of the symmetric algorithm used. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
TotalBytesReceived long |
The total number of bytes received over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
TotalBytesSent long |
The total number of bytes sent over this connection. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
ValidationLog String |
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. |
||||||||||||||||||||||||||||||||||||||||||||||||
|
Version String |
Indicates the version of SSL/TLS protocol negotiated during this connection. |
Constructors
public ConnectionInfo();
Creates a new ConnectionInfo object.
CRL Type
Represents a Certificate Revocation List.
Remarks
CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.
Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.
Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.
Fields
|
Bytes byte[] |
Returns raw CRL data in DER format. |
|
CAKeyID byte[] |
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. |
|
EntryCount int |
Returns the number of certificate status entries in the CRL. |
|
Issuer String |
The common name of the CRL issuer (CA), typically a company name. |
|
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
|
Location String |
The URL that the CRL was downloaded from. |
|
NextUpdate String |
The planned time and date of the next version of this CRL to be published. |
|
SigAlgorithm String |
The public key algorithm that was used by the CA to sign this CRL. |
|
TBS byte[] |
The to-be-signed part of the CRL (the CRL without the signature part). |
|
ThisUpdate String |
The date and time at which this version of the CRL was published. |
Constructors
public CRL( bytes, startIndex, 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.
public CRL( location);
Creates a CRL object by downloading it from a remote location.
public CRL( stream);
Creates a CRL object from data contained in a stream.
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.
Fields
|
AsyncDocumentID String |
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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
CustomParams String |
Custom parameters to be passed to the signing service (uninterpreted). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Data String |
Additional data to be included in the async state and mirrored back by the requestor |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
ExternalHashCalculation boolean |
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
HashAlgorithm String |
Specifies the request's signature hash algorithm.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeyID String |
The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
KeySecret String |
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the KeyID topic. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Method int |
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Mode int |
Specifies the external cryptography mode. Available options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
PublicKeyAlgorithm String |
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
|
Constructors
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.
Fields
|
EntryFormat int |
The file listing format:
|
||||||||||||||
|
FileDate String |
File last modification date. |
||||||||||||||
|
FileType int |
The type of the entry:
|
||||||||||||||
|
Name String |
The file or directory name. |
||||||||||||||
|
Path String |
The full path to the file or directory. |
||||||||||||||
|
RawData String |
The unparsed entry as returned by the server. |
||||||||||||||
|
Size long |
File size in bytes. |
Constructors
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 (CRL).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
|
Bytes byte[] |
Buffer containing raw OCSP response data. |
|
EntryCount int |
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. |
|
Issuer String |
Indicates the issuer of this response (a CA or its authorized representative). |
|
IssuerRDN String |
Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
|
Location String |
Location of the OCSP responder. |
|
ProducedAt String |
Specifies the time when the response was produced, in UTC. |
Constructors
public OCSPResponse( bytes, startIndex, 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.
public OCSPResponse( location);
Downloads an OCSP response from a remote location.
public OCSPResponse( stream);
Initializes the response with the data from a stream.
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.
Fields
|
Address String |
The IP address of the proxy server. |
||||||||||
|
Authentication int |
The authentication type used by the proxy server.
|
||||||||||
|
Password String |
The password to authenticate to the proxy server. |
||||||||||
|
Port int |
The port on the proxy server to connect to. |
||||||||||
|
ProxyType int |
The type of the proxy server. The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
|
||||||||||
|
RequestHeaders String |
Contains HTTP request headers for WebTunnel and HTTP proxy. |
||||||||||
|
ResponseBody String |
Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
||||||||||
|
ResponseHeaders String |
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
||||||||||
|
UseIPv6 boolean |
Specifies whether IPv6 should be used when connecting through the proxy. |
||||||||||
|
UseProxy boolean |
Enables or disables proxy-driven connection. |
||||||||||
|
Username String |
Specifies the username credential for proxy authentication. |
Constructors
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.
Fields
|
DNSMode int |
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
|
||||||||
|
DNSPort int |
Specifies the port number to be used for sending queries to the DNS server. |
||||||||
|
DNSQueryTimeout int |
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout. |
||||||||
|
DNSServers String |
The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
||||||||
|
DNSTotalTimeout int |
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout. |
||||||||
|
IncomingSpeedLimit int |
The maximum number of bytes to read from the socket, per second. |
||||||||
|
LocalAddress String |
The local network interface to bind the socket to. |
||||||||
|
LocalPort int |
The local port number to bind the socket to. |
||||||||
|
OutgoingSpeedLimit int |
The maximum number of bytes to write to the socket, per second. |
||||||||
|
Timeout int |
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 |
Enables or disables IP protocol version 6. |
Constructors
public SocketSettings();
Creates a new SocketSettings object.
TLSSettings Type
A container for TLS connection settings.
Remarks
TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
|
AutoValidateCertificates boolean |
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
|||||||||||||||||||||||||||||||||
|
BaseConfiguration int |
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
|
|||||||||||||||||||||||||||||||||
|
Ciphersuites String |
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
|
|||||||||||||||||||||||||||||||||
|
ECCurves String |
Defines the elliptic curves to enable. |
|||||||||||||||||||||||||||||||||
|
Extensions String |
Provides access to TLS extensions. |
|||||||||||||||||||||||||||||||||
|
ForceResumeIfDestinationChanges boolean |
Whether to force TLS session resumption when the destination address changes. |
|||||||||||||||||||||||||||||||||
|
PreSharedIdentity String |
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
|||||||||||||||||||||||||||||||||
|
PreSharedKey String |
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
|||||||||||||||||||||||||||||||||
|
PreSharedKeyCiphersuite String |
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
|||||||||||||||||||||||||||||||||
|
RenegotiationAttackPreventionMode int |
Selects renegotiation attack prevention mechanism. The following options are available:
|
|||||||||||||||||||||||||||||||||
|
RevocationCheck int |
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.
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. |
|||||||||||||||||||||||||||||||||
|
SSLOptions int |
Various SSL (TLS) protocol options, set of
|
|||||||||||||||||||||||||||||||||
|
TLSMode int |
Specifies the TLS mode to use.
|
|||||||||||||||||||||||||||||||||
|
UseExtendedMasterSecret boolean |
Enables Extended Master Secret Extension, as defined in RFC 7627. |
|||||||||||||||||||||||||||||||||
|
UseSessionResumption boolean |
Enables or disables TLS session resumption capability. |
|||||||||||||||||||||||||||||||||
|
Versions int |
Th SSL/TLS versions to enable by default.
|
Constructors
public TLSSettings();
Creates a new TLSSettings object.
Config Settings (Ftpclient 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 method.FTPClient Config Settings | ||||||||||||||||||||||||||||||
| AuthCmd: Authorization command to be used to request an explicit SSL session.Use this property to specify the authorization command that will be used to request an explicit SSL session. The following choices are possible: 0 - Auto, 1 - TLS, 2 - SSL, 3 - TLSP, 4 - TLSC. Different servers support different commands, so in most cases it is a good idea to set this property to 0. | ||||||||||||||||||||||||||||||
| CaseConversion: Whether file names and paths should be case-converted.Defines whether file names are converted (on the destination system) to: lowercase (1), uppercase (2). | ||||||||||||||||||||||||||||||
| CaseSensitive: Case-sensitivity of file names and paths.Whether file paths and names are case-sensitive. | ||||||||||||||||||||||||||||||
| CloseQuietly: Set this to true to avoid sending QUIT command on session closure.Set this property to true to tell the component not to send the QUIT command when closing the connection. | ||||||||||||||||||||||||||||||
| ConcurrentConnections: Number of simultaneous connections for download.The maximum number of concurrent connections that may be opened for download. This feature is not available if the server does not support file size requests. | ||||||||||||||||||||||||||||||
| CopyMode: What to do with the originals of the copied files.Defines what to do with the originals of the files which have been copied. You can choose to just leave them, delete each original right after it has been copied, or delete files only when all of them have been transferred. | ||||||||||||||||||||||||||||||
| ErrorOrigin: Specifies where the error has been originated.Specifies where the error has been originated, on the server or client side. | ||||||||||||||||||||||||||||||
| ErrorSeverity: Error severity.Specifies whether a warning or an error encountered. | ||||||||||||||||||||||||||||||
| EventOrigin: Indicates the channel that has fired the event.Check this read-only property in event handlers to identify whether the event originates from the FTP protocol's control or data channel. While some events are channel-independent (FileOperation, ListEntry), and some other are explicitly bound to the control channel (ControlSend, ControlReceive), some events may be thrown from either. Two examples of such events are CertificateValidate and RemoteSign. The property can be set to one of the following values: feoUnknown (0), feoControl (1), feoData (2). | ||||||||||||||||||||||||||||||
| ExtHOSTSupported: Whether HOST extension is supported.Use this read-only property to check whether the FTP server supports HOST command. | ||||||||||||||||||||||||||||||
| ExtMDTMSupported: Whether MDTM extension is supported.Use this read-only property to check whether the FTP server supports MDTM command. The MDTM command is used to determine file modification date. | ||||||||||||||||||||||||||||||
| ExtMFMTSupported: Whether MFMT extension is supported.Use this read-only property to check whether the FTP server supports MFMT (Modify Fact: Modification Time) command. | ||||||||||||||||||||||||||||||
| ExtMLSTSupported: Whether MLST extension is supported.Use this read-only property to check whether the FTP server supports MLST command. This command lists the directory contents on the server, although it is different from the LIST command. In particular, MLST reply has a strictly defined format. | ||||||||||||||||||||||||||||||
| ExtOPTSUTF8Supported: Whether OPTS UTF8 extension is supported.Use this read-only property to check whether the FTP server supports OPTS UTF8 ON command. This command switches the server to UTF8. | ||||||||||||||||||||||||||||||
| ExtRESTSupported: Whether REST extension is supported.Use this read-only property to check whether the FTP server supports REST (RESTART) command. | ||||||||||||||||||||||||||||||
| ExtSIZESupported: Whether SIZE extension is supported.Use this read-only property to check whether the FTP server supports SIZE command. This command returns file size. | ||||||||||||||||||||||||||||||
| ExtXCRCSupported: Whether XCRC extension is supported.Use this read-only property to check whether the FTP server supports XCRC command. It calculates a CRC checksum of the file to check its integrity during transfer. | ||||||||||||||||||||||||||||||
| ExtXMD5Supported: Whether XMD5 extension is supported.Use this read-only property to check whether the FTP server supports XMD5 command. It calculates an MD5 checksum of a file to check its integrity during transfer. | ||||||||||||||||||||||||||||||
| FTPBufferSize: Buffer size in binary mode.The size of the memory buffer used for data transfer in binary mode. Changing the buffer size may increase (or, on the contrary, decrease) the speed of file download/upload. | ||||||||||||||||||||||||||||||
| FTPTextBufferSize: Buffer size in text mode.The size of the memory buffer used for data transfer in text mode. Changing the buffer size may increase (or, on the contrary, decrease) the speed of file download/upload. | ||||||||||||||||||||||||||||||
| IgnoreSystemTrust:
Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect
the trust to CA certificates as configured in the operating system.
In Windows this effectively defines whether the component should trust the
certificates residing in the Trusted Root Certification Authorities store.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted. |
||||||||||||||||||||||||||||||
| ListenTimeout: Listening socket timeout.The maximum time during which the listening socket will be opened in the active mode. If there is no connection request from the server during this time, the transfer operation will be canceled. | ||||||||||||||||||||||||||||||
| LocalNewLineConvention: Defines the local newline convention.Contains character string for the end of string indication used on the local machine. During file upload all the LocalNewLineConvention line endings are converted to newline endings used on the server. Correspondingly, for all downloaded files line endings are replaced with LocalNewLineConventionline endings. Line ending conventions are only used in text transfer mode. | ||||||||||||||||||||||||||||||
| MinSizeForConcurrentDownload: Files bigger than this size will be downloaded concurrently.The minimum size of the file for which the concurrent download is used. The value of ConcurrentConnections property is ignored for smaller files. | ||||||||||||||||||||||||||||||
| Mode: What to do if the destination file already exists.Specifies what to do if the destination file already exists. You can choose to: overwrite, append, resume, overwrite only if the destination file's size is different, save with a new name, or rename the existing destination file. | ||||||||||||||||||||||||||||||
| Options: Various FTP options.Various options of FTP connection. | ||||||||||||||||||||||||||||||
| Recursive: Whether to scan subdirectories.Whether the subdirectories should also be scanned for matching files. | ||||||||||||||||||||||||||||||
| TempPath: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. | ||||||||||||||||||||||||||||||
TolerateMinorChainIssues:
Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:
|
||||||||||||||||||||||||||||||
| TransferKeepAliveInterval: Keep-alive interval for the data channel transfers.FTPClient may be configured to send occasional NOOP commands on the control channel to circumvent control channel closures by firewalls due to inactivity. This setting sets the period, in milliseconds, after which another NOOP request is sent. The default value of this property is 0, which stands for no NOOP requests. | ||||||||||||||||||||||||||||||
| TransferTimeout: Timeout for data transfer in active mode.In active mode, specifies a time period that a client should wait for incoming data connection (when file or directory listing is to be transferred). If no data connection is accepted during this period, the data connection will be cancelled. | ||||||||||||||||||||||||||||||
| UseMicrosoftCTL: Enables or disables automatic use of Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. | ||||||||||||||||||||||||||||||
| UseProxySettingsForDataChannel: Whether the proxy settings should be applied to data channel.Whether the proxy settings should be applied to data channel. | ||||||||||||||||||||||||||||||
| UseSystemCertificates: Enables or disables the use of the system certificates.Use this property to tell chain validation module automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. | ||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||
| StaticIPAddress[domain]: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character. | ||||||||||||||||||||||||||||||
| StaticIPAddresses: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (Ftpclient Class)
FTPClient Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) | |
| 18874368 Unsupported file operation (SB_ERROR_FTP_UNSUPPORTED_FILEOPERATION) |