FTPClient Class
Properties Methods Events Config Settings Errors
The FTPClient class provides client-side functionality for FTP and FTPS protocols.
Syntax
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 TLSClientChain 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. |
ConflictResolutionMode | Defines the approach that should be used to resolve various conflicts during batch processing. |
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. |
SocketSettings | Manages network connection settings. |
TLSClientChain | The TLS client certificate chain. |
TLSServerChain | The TLS server's certificate chain. |
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. |
Reset | Resets the class settings. |
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. |
FileNameChangeNeeded | Asks the application for a new file name. |
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.
AccountInfo | Provides the value to be used with ACCT command. |
AuthCmd | Authorization command to be used to request an explicit SSL session. |
CaseConversion | Whether file names and paths should be case-converted. |
CaseSensitive | Specifies if file paths are case-sensitive. |
CloseQuietly | Set this to true to avoid sending QUIT command on session closure. |
ConcurrentConnections | Number of simultaneous connections for download. |
ControlChannelLog | Returns the control channel connection log. |
CopyMode | Defines what to do with each successfully copied file. |
ErrorOrigin | Specifies whether the error is local or remote. |
ErrorSeverity | Specifies whether the error is fatal. |
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. |
ExtXSHA1Supported | TBD. |
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 | A character string for the end of line (EOL) indication on the local machine. |
LocalNewLineConvention | Defines the local newline convention. |
MinSizeForConcurrentDownload | Files bigger than this size will be downloaded concurrently. |
ModeZ | Enables or disables data compression. |
Options | Various FTP options. |
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. |
TempPath | Path for storing temporary files. |
TLSExtensions | TBD. |
TLSLayerKeepAlives | Enables or disables keep alive signals on the TLS layer. |
TLSPeerExtensions | TBD. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
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 the automatic use of the 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. |
UseUTF8IfAvailable | Upgrade to UTF8 string encoding if the server supports it. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
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. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
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. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
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. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
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. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
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
ANSI (Cross Platform) char* GetAccountInfo();
int SetAccountInfo(const char* lpszAccountInfo); Unicode (Windows) LPWSTR GetAccountInfo();
INT SetAccountInfo(LPCWSTR lpszAccountInfo);
char* secureblackbox_ftpclient_getaccountinfo(void* lpObj);
int secureblackbox_ftpclient_setaccountinfo(void* lpObj, const char* lpszAccountInfo);
QString GetAccountInfo();
int SetAccountInfo(QString qsAccountInfo);
Default Value
""
Remarks
Specifies the parameter for ACCT command. If AccountInfo is set, the client automatically sends ACCT command to the server during authentication.
Data Type
String
AdjustPasvAddress Property (FTPClient Class)
Enables or disables automatic adjustment of passive-mode addresses.
Syntax
ANSI (Cross Platform) int GetAdjustPasvAddress();
int SetAdjustPasvAddress(int bAdjustPasvAddress); Unicode (Windows) BOOL GetAdjustPasvAddress();
INT SetAdjustPasvAddress(BOOL bAdjustPasvAddress);
int secureblackbox_ftpclient_getadjustpasvaddress(void* lpObj);
int secureblackbox_ftpclient_setadjustpasvaddress(void* lpObj, int bAdjustPasvAddress);
bool GetAdjustPasvAddress();
int SetAdjustPasvAddress(bool bAdjustPasvAddress);
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.
Data Type
Boolean
BlockedCertificates Property (FTPClient Class)
The certificates that must be rejected as trust anchors.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates(); int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_ftpclient_getblockedcertcount(void* lpObj);
int secureblackbox_ftpclient_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int secureblackbox_ftpclient_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
int64 secureblackbox_ftpclient_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_ftpclient_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); QByteArray GetBlockedCertBytes(int iBlockedCertIndex); qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
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.
Data Type
ConflictResolutionMode Property (FTPClient Class)
Defines the approach that should be used to resolve various conflicts during batch processing.
Syntax
ANSI (Cross Platform) int GetConflictResolutionMode();
int SetConflictResolutionMode(int iConflictResolutionMode); Unicode (Windows) INT GetConflictResolutionMode();
INT SetConflictResolutionMode(INT iConflictResolutionMode);
Possible Values
CFTM_OVERWRITE(0),
CFTM_SKIP(1),
CFTM_APPEND_TO_END(2),
CFTM_RESUME(3),
CFTM_OVERWRITE_IF_DIFF_SIZE(4),
CFTM_SAVE_WITH_NEW_NAME(5),
CFTM_RENAME_EXISTING_TARGET(6)
int secureblackbox_ftpclient_getconflictresolutionmode(void* lpObj);
int secureblackbox_ftpclient_setconflictresolutionmode(void* lpObj, int iConflictResolutionMode);
int GetConflictResolutionMode();
int SetConflictResolutionMode(int iConflictResolutionMode);
Default Value
0
Remarks
Use this property to specify the approach to use when landing in conflicting transfer situations.
cftmOverwrite | 0 | |
cftmSkip | 1 | |
cftmAppendToEnd | 2 | The signature is corrupted |
cftmResume | 3 | |
cftmOverwriteIfDiffSize | 4 | |
cftmSaveWithNewName | 5 | |
cftmRenameExistingTarget | 5 |
Data Type
Integer
Connected Property (FTPClient Class)
Indicates whether the class is connected to the server.
Syntax
ANSI (Cross Platform) int GetConnected(); Unicode (Windows) BOOL GetConnected();
int secureblackbox_ftpclient_getconnected(void* lpObj);
bool GetConnected();
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.
Data Type
Boolean
ControlChannelLog Property (FTPClient Class)
Contains the control channel log of the FTP session.
Syntax
ANSI (Cross Platform) char* GetControlChannelLog(); Unicode (Windows) LPWSTR GetControlChannelLog();
char* secureblackbox_ftpclient_getcontrolchannellog(void* lpObj);
QString GetControlChannelLog();
Default Value
""
Remarks
Use this property to access the FTP protocol log (client commands followed by server responses).
This property is read-only.
Data Type
String
ControlConnectionInfo Property (FTPClient Class)
Returns the details of the control connection setup.
Syntax
SecureBlackboxTLSConnectionInfo* GetControlConnectionInfo();
int secureblackbox_ftpclient_getctlconninfoaeadcipher(void* lpObj);
int secureblackbox_ftpclient_getctlconninfochainvalidationdetails(void* lpObj);
int secureblackbox_ftpclient_getctlconninfochainvalidationresult(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfociphersuite(void* lpObj);
int secureblackbox_ftpclient_getctlconninfoclientauthenticated(void* lpObj);
int secureblackbox_ftpclient_getctlconninfoclientauthrequested(void* lpObj);
int secureblackbox_ftpclient_getctlconninfoconnectionestablished(void* lpObj);
int secureblackbox_ftpclient_getctlconninfoconnectionid(void* lpObj, char** lpCtlConnInfoConnectionID, int* lenCtlConnInfoConnectionID);
char* secureblackbox_ftpclient_getctlconninfodigestalgorithm(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfoencryptionalgorithm(void* lpObj);
int secureblackbox_ftpclient_getctlconninfoexportable(void* lpObj);
int64 secureblackbox_ftpclient_getctlconninfoid(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfokeyexchangealgorithm(void* lpObj);
int secureblackbox_ftpclient_getctlconninfokeyexchangekeybits(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfonamedeccurve(void* lpObj);
int secureblackbox_ftpclient_getctlconninfopfscipher(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfopresharedidentity(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfopresharedidentityhint(void* lpObj);
int secureblackbox_ftpclient_getctlconninfopublickeybits(void* lpObj);
char* secureblackbox_ftpclient_getctlconninforemoteaddress(void* lpObj);
int secureblackbox_ftpclient_getctlconninforemoteport(void* lpObj);
int secureblackbox_ftpclient_getctlconninforesumedsession(void* lpObj);
int secureblackbox_ftpclient_getctlconninfosecureconnection(void* lpObj);
int secureblackbox_ftpclient_getctlconninfoserverauthenticated(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfosignaturealgorithm(void* lpObj);
int secureblackbox_ftpclient_getctlconninfosymmetricblocksize(void* lpObj);
int secureblackbox_ftpclient_getctlconninfosymmetrickeybits(void* lpObj);
int64 secureblackbox_ftpclient_getctlconninfototalbytesreceived(void* lpObj);
int64 secureblackbox_ftpclient_getctlconninfototalbytessent(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfovalidationlog(void* lpObj);
char* secureblackbox_ftpclient_getctlconninfoversion(void* lpObj);
bool GetCtlConnInfoAEADCipher(); int GetCtlConnInfoChainValidationDetails(); int GetCtlConnInfoChainValidationResult(); QString GetCtlConnInfoCiphersuite(); bool GetCtlConnInfoClientAuthenticated(); bool GetCtlConnInfoClientAuthRequested(); bool GetCtlConnInfoConnectionEstablished(); QByteArray GetCtlConnInfoConnectionID(); QString GetCtlConnInfoDigestAlgorithm(); QString GetCtlConnInfoEncryptionAlgorithm(); bool GetCtlConnInfoExportable(); qint64 GetCtlConnInfoID(); QString GetCtlConnInfoKeyExchangeAlgorithm(); int GetCtlConnInfoKeyExchangeKeyBits(); QString GetCtlConnInfoNamedECCurve(); bool GetCtlConnInfoPFSCipher(); QString GetCtlConnInfoPreSharedIdentity(); QString GetCtlConnInfoPreSharedIdentityHint(); int GetCtlConnInfoPublicKeyBits(); QString GetCtlConnInfoRemoteAddress(); int GetCtlConnInfoRemotePort(); bool GetCtlConnInfoResumedSession(); bool GetCtlConnInfoSecureConnection(); bool GetCtlConnInfoServerAuthenticated(); QString GetCtlConnInfoSignatureAlgorithm(); int GetCtlConnInfoSymmetricBlockSize(); int GetCtlConnInfoSymmetricKeyBits(); qint64 GetCtlConnInfoTotalBytesReceived(); qint64 GetCtlConnInfoTotalBytesSent(); QString GetCtlConnInfoValidationLog(); QString GetCtlConnInfoVersion();
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.
Data Type
SecureBlackboxTLSConnectionInfo
CurrentListEntry Property (FTPClient Class)
Contains the details of the file entry reported by ListEntry .
Syntax
SecureBlackboxFTPListEntry* GetCurrentListEntry();
char* secureblackbox_ftpclient_getcurrlistentryaccesstime(void* lpObj);
char* secureblackbox_ftpclient_getcurrlistentrycreationtime(void* lpObj);
int secureblackbox_ftpclient_getcurrlistentryentryformat(void* lpObj);
int secureblackbox_ftpclient_getcurrlistentryfiletype(void* lpObj);
int64 secureblackbox_ftpclient_getcurrlistentryhandle(void* lpObj);
char* secureblackbox_ftpclient_getcurrlistentrymodificationtime(void* lpObj);
char* secureblackbox_ftpclient_getcurrlistentryname(void* lpObj);
char* secureblackbox_ftpclient_getcurrlistentrypath(void* lpObj);
char* secureblackbox_ftpclient_getcurrlistentryprincipal(void* lpObj);
int64 secureblackbox_ftpclient_getcurrlistentrysize(void* lpObj);
int secureblackbox_ftpclient_getcurrlistentryunixperms(void* lpObj);
char* secureblackbox_ftpclient_getcurrlistentryunparsedname(void* lpObj);
QString GetCurrListEntryAccessTime(); QString GetCurrListEntryCreationTime(); int GetCurrListEntryEntryFormat(); int GetCurrListEntryFileType(); qint64 GetCurrListEntryHandle(); QString GetCurrListEntryModificationTime(); QString GetCurrListEntryName(); QString GetCurrListEntryPath(); QString GetCurrListEntryPrincipal(); qint64 GetCurrListEntrySize(); int GetCurrListEntryUnixPerms(); QString GetCurrListEntryUnparsedName();
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.
Data Type
DataConnectionInfo Property (FTPClient Class)
Returns the details of the data connection setup.
Syntax
SecureBlackboxTLSConnectionInfo* GetDataConnectionInfo();
int secureblackbox_ftpclient_getdataconninfoaeadcipher(void* lpObj);
int secureblackbox_ftpclient_getdataconninfochainvalidationdetails(void* lpObj);
int secureblackbox_ftpclient_getdataconninfochainvalidationresult(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfociphersuite(void* lpObj);
int secureblackbox_ftpclient_getdataconninfoclientauthenticated(void* lpObj);
int secureblackbox_ftpclient_getdataconninfoclientauthrequested(void* lpObj);
int secureblackbox_ftpclient_getdataconninfoconnectionestablished(void* lpObj);
int secureblackbox_ftpclient_getdataconninfoconnectionid(void* lpObj, char** lpDataConnInfoConnectionID, int* lenDataConnInfoConnectionID);
char* secureblackbox_ftpclient_getdataconninfodigestalgorithm(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfoencryptionalgorithm(void* lpObj);
int secureblackbox_ftpclient_getdataconninfoexportable(void* lpObj);
int64 secureblackbox_ftpclient_getdataconninfoid(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfokeyexchangealgorithm(void* lpObj);
int secureblackbox_ftpclient_getdataconninfokeyexchangekeybits(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfonamedeccurve(void* lpObj);
int secureblackbox_ftpclient_getdataconninfopfscipher(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfopresharedidentity(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfopresharedidentityhint(void* lpObj);
int secureblackbox_ftpclient_getdataconninfopublickeybits(void* lpObj);
char* secureblackbox_ftpclient_getdataconninforemoteaddress(void* lpObj);
int secureblackbox_ftpclient_getdataconninforemoteport(void* lpObj);
int secureblackbox_ftpclient_getdataconninforesumedsession(void* lpObj);
int secureblackbox_ftpclient_getdataconninfosecureconnection(void* lpObj);
int secureblackbox_ftpclient_getdataconninfoserverauthenticated(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfosignaturealgorithm(void* lpObj);
int secureblackbox_ftpclient_getdataconninfosymmetricblocksize(void* lpObj);
int secureblackbox_ftpclient_getdataconninfosymmetrickeybits(void* lpObj);
int64 secureblackbox_ftpclient_getdataconninfototalbytesreceived(void* lpObj);
int64 secureblackbox_ftpclient_getdataconninfototalbytessent(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfovalidationlog(void* lpObj);
char* secureblackbox_ftpclient_getdataconninfoversion(void* lpObj);
bool GetDataConnInfoAEADCipher(); int GetDataConnInfoChainValidationDetails(); int GetDataConnInfoChainValidationResult(); QString GetDataConnInfoCiphersuite(); bool GetDataConnInfoClientAuthenticated(); bool GetDataConnInfoClientAuthRequested(); bool GetDataConnInfoConnectionEstablished(); QByteArray GetDataConnInfoConnectionID(); QString GetDataConnInfoDigestAlgorithm(); QString GetDataConnInfoEncryptionAlgorithm(); bool GetDataConnInfoExportable(); qint64 GetDataConnInfoID(); QString GetDataConnInfoKeyExchangeAlgorithm(); int GetDataConnInfoKeyExchangeKeyBits(); QString GetDataConnInfoNamedECCurve(); bool GetDataConnInfoPFSCipher(); QString GetDataConnInfoPreSharedIdentity(); QString GetDataConnInfoPreSharedIdentityHint(); int GetDataConnInfoPublicKeyBits(); QString GetDataConnInfoRemoteAddress(); int GetDataConnInfoRemotePort(); bool GetDataConnInfoResumedSession(); bool GetDataConnInfoSecureConnection(); bool GetDataConnInfoServerAuthenticated(); QString GetDataConnInfoSignatureAlgorithm(); int GetDataConnInfoSymmetricBlockSize(); int GetDataConnInfoSymmetricKeyBits(); qint64 GetDataConnInfoTotalBytesReceived(); qint64 GetDataConnInfoTotalBytesSent(); QString GetDataConnInfoValidationLog(); QString GetDataConnInfoVersion();
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.
Data Type
SecureBlackboxTLSConnectionInfo
EncryptDataChannel Property (FTPClient Class)
Enables or disables data channel encryption.
Syntax
ANSI (Cross Platform) int GetEncryptDataChannel();
int SetEncryptDataChannel(int bEncryptDataChannel); Unicode (Windows) BOOL GetEncryptDataChannel();
INT SetEncryptDataChannel(BOOL bEncryptDataChannel);
int secureblackbox_ftpclient_getencryptdatachannel(void* lpObj);
int secureblackbox_ftpclient_setencryptdatachannel(void* lpObj, int bEncryptDataChannel);
bool GetEncryptDataChannel();
int SetEncryptDataChannel(bool bEncryptDataChannel);
Default Value
TRUE
Remarks
Use this property to enable or disable data channel encryption. This property should be configured before Connect method is called.
Data Type
Boolean
ExternalCrypto Property (FTPClient Class)
Provides access to external signing and DC parameters.
Syntax
SecureBlackboxExternalCrypto* GetExternalCrypto();
char* secureblackbox_ftpclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_ftpclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_ftpclient_getexternalcryptodata(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_ftpclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_ftpclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_ftpclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_ftpclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_ftpclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_ftpclient_getexternalcryptomode(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_ftpclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_ftpclient_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).
This property is read-only.
Data Type
FIPSMode Property (FTPClient Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_ftpclient_getfipsmode(void* lpObj);
int secureblackbox_ftpclient_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
FALSE
Remarks
This property is reserved for future use.
Data Type
Boolean
KnownCertificates Property (FTPClient Class)
Additional certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_ftpclient_getknowncertcount(void* lpObj);
int secureblackbox_ftpclient_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_ftpclient_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_ftpclient_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_ftpclient_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the class manually.
The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
Data Type
KnownCRLs Property (FTPClient Class)
Additional CRLs for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs(); int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
int secureblackbox_ftpclient_getknowncrlcount(void* lpObj);
int secureblackbox_ftpclient_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int secureblackbox_ftpclient_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
int64 secureblackbox_ftpclient_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_ftpclient_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); QByteArray GetKnownCRLBytes(int iKnownCRLIndex); qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
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.
Data Type
KnownOCSPs Property (FTPClient Class)
Additional OCSP responses for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs(); int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);
int secureblackbox_ftpclient_getknownocspcount(void* lpObj);
int secureblackbox_ftpclient_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int secureblackbox_ftpclient_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
int64 secureblackbox_ftpclient_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_ftpclient_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex); qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
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.
Data Type
ModeZ Property (FTPClient Class)
Switches on data compression.
Syntax
ANSI (Cross Platform) int GetModeZ();
int SetModeZ(int bModeZ); Unicode (Windows) BOOL GetModeZ();
INT SetModeZ(BOOL bModeZ);
int secureblackbox_ftpclient_getmodez(void* lpObj);
int secureblackbox_ftpclient_setmodez(void* lpObj, int bModeZ);
bool GetModeZ();
int SetModeZ(bool bModeZ);
Default Value
TRUE
Remarks
Switches the in-flight data compression on/off.
Data Type
Boolean
PassiveMode Property (FTPClient Class)
Enables or disables passive transfer mode.
Syntax
ANSI (Cross Platform) int GetPassiveMode();
int SetPassiveMode(int bPassiveMode); Unicode (Windows) BOOL GetPassiveMode();
INT SetPassiveMode(BOOL bPassiveMode);
int secureblackbox_ftpclient_getpassivemode(void* lpObj);
int secureblackbox_ftpclient_setpassivemode(void* lpObj, int bPassiveMode);
bool GetPassiveMode();
int SetPassiveMode(bool bPassiveMode);
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.
Data Type
Boolean
Password Property (FTPClient Class)
The connecting user's authentication password.
Syntax
ANSI (Cross Platform) char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* secureblackbox_ftpclient_getpassword(void* lpObj);
int secureblackbox_ftpclient_setpassword(void* lpObj, const char* lpszPassword);
QString GetPassword();
int SetPassword(QString qsPassword);
Default Value
""
Remarks
Assign the user's authentication password to this property. Use Username for username/login.
Data Type
String
Proxy Property (FTPClient Class)
The proxy server settings.
Syntax
SecureBlackboxProxySettings* GetProxy();
char* secureblackbox_ftpclient_getproxyaddress(void* lpObj);
int secureblackbox_ftpclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_ftpclient_getproxyauthentication(void* lpObj);
int secureblackbox_ftpclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_ftpclient_getproxypassword(void* lpObj);
int secureblackbox_ftpclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_ftpclient_getproxyport(void* lpObj);
int secureblackbox_ftpclient_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_ftpclient_getproxyproxytype(void* lpObj);
int secureblackbox_ftpclient_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_ftpclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_ftpclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_ftpclient_getproxyresponsebody(void* lpObj);
int secureblackbox_ftpclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_ftpclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_ftpclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_ftpclient_getproxyuseipv6(void* lpObj);
int secureblackbox_ftpclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_ftpclient_getproxyusername(void* lpObj);
int secureblackbox_ftpclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress); int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders); QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody); QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders); bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6); QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
Data Type
RestartAt Property (FTPClient Class)
The offset to restart the file transfer from.
Syntax
ANSI (Cross Platform) int64 GetRestartAt();
int SetRestartAt(int64 lRestartAt); Unicode (Windows) LONG64 GetRestartAt();
INT SetRestartAt(LONG64 lRestartAt);
int64 secureblackbox_ftpclient_getrestartat(void* lpObj);
int secureblackbox_ftpclient_setrestartat(void* lpObj, int64 lRestartAt);
qint64 GetRestartAt();
int SetRestartAt(qint64 lRestartAt);
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.
Data Type
Long64
SocketSettings Property (FTPClient Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_ftpclient_getsocketdnsmode(void* lpObj);
int secureblackbox_ftpclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_ftpclient_getsocketdnsport(void* lpObj);
int secureblackbox_ftpclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_ftpclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_ftpclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_ftpclient_getsocketdnsservers(void* lpObj);
int secureblackbox_ftpclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_ftpclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_ftpclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_ftpclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_ftpclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_ftpclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_ftpclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_ftpclient_getsocketlocalport(void* lpObj);
int secureblackbox_ftpclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_ftpclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_ftpclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_ftpclient_getsockettimeout(void* lpObj);
int secureblackbox_ftpclient_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_ftpclient_getsocketuseipv6(void* lpObj);
int secureblackbox_ftpclient_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers); int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Data Type
TLSClientChain Property (FTPClient Class)
The TLS client certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain(); int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_ftpclient_gettlsclientcertcount(void* lpObj);
int secureblackbox_ftpclient_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int secureblackbox_ftpclient_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
int64 secureblackbox_ftpclient_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_ftpclient_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount); QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex); qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);
Remarks
Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.
Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.
This property is not available at design time.
Data Type
TLSServerChain Property (FTPClient Class)
The TLS server's certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int secureblackbox_ftpclient_gettlsservercertcount(void* lpObj);
int secureblackbox_ftpclient_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
char* secureblackbox_ftpclient_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);
int64 secureblackbox_ftpclient_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
char* secureblackbox_ftpclient_gettlsservercertissuer(void* lpObj, int tlsservercertindex);
char* secureblackbox_ftpclient_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_ftpclient_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);
int secureblackbox_ftpclient_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);
int secureblackbox_ftpclient_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);
int secureblackbox_ftpclient_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);
int secureblackbox_ftpclient_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);
char* secureblackbox_ftpclient_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);
char* secureblackbox_ftpclient_gettlsservercertsubject(void* lpObj, int tlsservercertindex);
char* secureblackbox_ftpclient_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_ftpclient_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);
char* secureblackbox_ftpclient_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);
int GetTLSServerCertCount(); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); QString GetTLSServerCertFingerprint(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex); QString GetTLSServerCertIssuer(int iTLSServerCertIndex); QString GetTLSServerCertIssuerRDN(int iTLSServerCertIndex); QString GetTLSServerCertKeyAlgorithm(int iTLSServerCertIndex); int GetTLSServerCertKeyBits(int iTLSServerCertIndex); int GetTLSServerCertKeyUsage(int iTLSServerCertIndex); bool GetTLSServerCertSelfSigned(int iTLSServerCertIndex); QByteArray GetTLSServerCertSerialNumber(int iTLSServerCertIndex); QString GetTLSServerCertSigAlgorithm(int iTLSServerCertIndex); QString GetTLSServerCertSubject(int iTLSServerCertIndex); QString GetTLSServerCertSubjectRDN(int iTLSServerCertIndex); QString GetTLSServerCertValidFrom(int iTLSServerCertIndex); QString GetTLSServerCertValidTo(int iTLSServerCertIndex);
Remarks
Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.
This property is read-only and not available at design time.
Data Type
TLSSettings Property (FTPClient Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_ftpclient_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_ftpclient_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_ftpclient_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_ftpclient_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_ftpclient_gettlsciphersuites(void* lpObj);
int secureblackbox_ftpclient_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_ftpclient_gettlsclientauth(void* lpObj);
int secureblackbox_ftpclient_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_ftpclient_gettlseccurves(void* lpObj);
int secureblackbox_ftpclient_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_ftpclient_gettlsextensions(void* lpObj);
int secureblackbox_ftpclient_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_ftpclient_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_ftpclient_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_ftpclient_gettlspresharedidentity(void* lpObj);
int secureblackbox_ftpclient_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_ftpclient_gettlspresharedkey(void* lpObj);
int secureblackbox_ftpclient_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_ftpclient_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_ftpclient_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_ftpclient_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_ftpclient_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_ftpclient_gettlsrevocationcheck(void* lpObj);
int secureblackbox_ftpclient_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_ftpclient_gettlsssloptions(void* lpObj);
int secureblackbox_ftpclient_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_ftpclient_gettlstlsmode(void* lpObj);
int secureblackbox_ftpclient_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_ftpclient_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_ftpclient_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_ftpclient_gettlsusesessionresumption(void* lpObj);
int secureblackbox_ftpclient_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_ftpclient_gettlsversions(void* lpObj);
int secureblackbox_ftpclient_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Data Type
TransferType Property (FTPClient Class)
Sets the file transfer mode.
Syntax
ANSI (Cross Platform) int GetTransferType();
int SetTransferType(int iTransferType); Unicode (Windows) INT GetTransferType();
INT SetTransferType(INT iTransferType);
Possible Values
CTT_TEXT(0),
CTT_BINARY(1)
int secureblackbox_ftpclient_gettransfertype(void* lpObj);
int secureblackbox_ftpclient_settransfertype(void* lpObj, int iTransferType);
int GetTransferType();
int SetTransferType(int iTransferType);
Default Value
1
Remarks
Use this property to switch between binary and text transfer modes.
cttText | 0 |
cttBinary | 1 |
Data Type
Integer
TrustedCertificates Property (FTPClient Class)
A list of trusted certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates(); int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_ftpclient_gettrustedcertcount(void* lpObj);
int secureblackbox_ftpclient_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int secureblackbox_ftpclient_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
int64 secureblackbox_ftpclient_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_ftpclient_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); QByteArray GetTrustedCertBytes(int iTrustedCertIndex); qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
Remarks
Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.
Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.
This property is not available at design time.
Data Type
Username Property (FTPClient Class)
The connecting user's username (login name).
Syntax
ANSI (Cross Platform) char* GetUsername();
int SetUsername(const char* lpszUsername); Unicode (Windows) LPWSTR GetUsername();
INT SetUsername(LPCWSTR lpszUsername);
char* secureblackbox_ftpclient_getusername(void* lpObj);
int secureblackbox_ftpclient_setusername(void* lpObj, const char* lpszUsername);
QString GetUsername();
int SetUsername(QString qsUsername);
Default Value
""
Remarks
Assign the user's login name to this property. Use Password to provide the password.
Data Type
String
Abort Method (FTPClient Class)
Aborts the previous FTP service command and any associated transfer of data.
Syntax
ANSI (Cross Platform) int Abort(); Unicode (Windows) INT Abort();
int secureblackbox_ftpclient_abort(void* lpObj);
int Abort();
Remarks
Use this method to abort the previous FTP service command and any associated data transfer.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Acct Method (FTPClient Class)
Sends an Account command.
Syntax
ANSI (Cross Platform) int Acct(const char* lpszAcctInfo); Unicode (Windows) INT Acct(LPCWSTR lpszAcctInfo);
int secureblackbox_ftpclient_acct(void* lpObj, const char* lpszAcctInfo);
int Acct(const QString& qsAcctInfo);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AppendBytes Method (FTPClient Class)
Appends a byte array to a server-side file.
Syntax
ANSI (Cross Platform) int AppendBytes(const char* lpBytes, int lenBytes, const char* lpszRemoteFile); Unicode (Windows) INT AppendBytes(LPCSTR lpBytes, INT lenBytes, LPCWSTR lpszRemoteFile);
int secureblackbox_ftpclient_appendbytes(void* lpObj, const char* lpBytes, int lenBytes, const char* lpszRemoteFile);
int AppendBytes(QByteArray qbaBytes, const QString& qsRemoteFile);
Remarks
Use this method to append Bytes to RemoteFile on the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AppendFile Method (FTPClient Class)
Uploads a file to the server.
Syntax
ANSI (Cross Platform) int AppendFile(const char* lpszLocalFile, const char* lpszRemoteFile); Unicode (Windows) INT AppendFile(LPCWSTR lpszLocalFile, LPCWSTR lpszRemoteFile);
int secureblackbox_ftpclient_appendfile(void* lpObj, const char* lpszLocalFile, const char* lpszRemoteFile);
int AppendFile(const QString& qsLocalFile, const QString& qsRemoteFile);
Remarks
Use this method to upload LocalFile or its part to RemoteFile on the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
AppendStream Method (FTPClient Class)
Uploads a file to the server.
Syntax
ANSI (Cross Platform) int AppendStream(SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile); Unicode (Windows) INT AppendStream(SecureBlackboxStream* sLocalStream, LPCWSTR lpszRemoteFile);
int secureblackbox_ftpclient_appendstream(void* lpObj, SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile);
int AppendStream(SecureBlackboxStream* sLocalStream, const QString& qsRemoteFile);
Remarks
Use this method to upload data contained in LocalStream to RemoteFile on the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ChangeDir Method (FTPClient Class)
Changes the current directory.
Syntax
ANSI (Cross Platform) int ChangeDir(const char* lpszRemoteDir); Unicode (Windows) INT ChangeDir(LPCWSTR lpszRemoteDir);
int secureblackbox_ftpclient_changedir(void* lpObj, const char* lpszRemoteDir);
int ChangeDir(const QString& qsRemoteDir);
Remarks
Call this method to change the current server directory to RemoteDir.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ClearCommandChannel Method (FTPClient Class)
Sends CCC (Clear Command Channel) command to the server.
Syntax
ANSI (Cross Platform) int ClearCommandChannel(int bGracefulSSLClosure); Unicode (Windows) INT ClearCommandChannel(BOOL bGracefulSSLClosure);
int secureblackbox_ftpclient_clearcommandchannel(void* lpObj, int bGracefulSSLClosure);
int ClearCommandChannel(bool bGracefulSSLClosure);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (FTPClient Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_ftpclient_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Connect Method (FTPClient Class)
Connects to the FTP server.
Syntax
ANSI (Cross Platform) int Connect(const char* lpszAddress, int iPort); Unicode (Windows) INT Connect(LPCWSTR lpszAddress, INT iPort);
int secureblackbox_ftpclient_connect(void* lpObj, const char* lpszAddress, int iPort);
int Connect(const QString& qsAddress, int iPort);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DeleteDir Method (FTPClient Class)
Deletes a directory on the server.
Syntax
ANSI (Cross Platform) int DeleteDir(const char* lpszRemoteDir); Unicode (Windows) INT DeleteDir(LPCWSTR lpszRemoteDir);
int secureblackbox_ftpclient_deletedir(void* lpObj, const char* lpszRemoteDir);
int DeleteDir(const QString& qsRemoteDir);
Remarks
This method sends an RMD command to the server to request deletion of a remote directory.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DeleteFile Method (FTPClient Class)
Deletes a file on the server.
Syntax
ANSI (Cross Platform) int DeleteFile(const char* lpszRemoteFile); Unicode (Windows) INT DeleteFile(LPCWSTR lpszRemoteFile);
int secureblackbox_ftpclient_deletefile(void* lpObj, const char* lpszRemoteFile);
int DeleteFile(const QString& qsRemoteFile);
Remarks
This method sends a DELE command to the server to request deletion of a remote file.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DirExists Method (FTPClient Class)
Checks if a directory exists on the server.
Syntax
ANSI (Cross Platform) bool DirExists(const char* lpszRemoteDir); Unicode (Windows) INT DirExists(LPCWSTR lpszRemoteDir);
bool secureblackbox_ftpclient_direxists(void* lpObj, const char* lpszRemoteDir);
bool DirExists(const QString& qsRemoteDir);
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).
Error Handling (C++)
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Disconnect Method (FTPClient Class)
Disconnects from the server.
Syntax
ANSI (Cross Platform) int Disconnect(); Unicode (Windows) INT Disconnect();
int secureblackbox_ftpclient_disconnect(void* lpObj);
int Disconnect();
Remarks
Call this method to disconnect from the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoAction Method (FTPClient Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_ftpclient_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DownloadBytes Method (FTPClient Class)
Downloads a file from the server into an array of bytes.
Syntax
ANSI (Cross Platform) char* DownloadBytes(const char* lpszRemoteFile, int *lpSize = NULL); Unicode (Windows) LPSTR DownloadBytes(LPCWSTR lpszRemoteFile, LPINT lpSize = NULL);
char* secureblackbox_ftpclient_downloadbytes(void* lpObj, const char* lpszRemoteFile, int *lpSize);
QByteArray DownloadBytes(const QString& qsRemoteFile);
Remarks
Use this method to download RemoteFile into a byte array.
Error Handling (C++)
This method returns a Byte Array value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DownloadFile Method (FTPClient Class)
Downloads a file from the server.
Syntax
ANSI (Cross Platform) int DownloadFile(const char* lpszRemoteFile, const char* lpszLocalFile); Unicode (Windows) INT DownloadFile(LPCWSTR lpszRemoteFile, LPCWSTR lpszLocalFile);
int secureblackbox_ftpclient_downloadfile(void* lpObj, const char* lpszRemoteFile, const char* lpszLocalFile);
int DownloadFile(const QString& qsRemoteFile, const QString& qsLocalFile);
Remarks
Use this method to download RemoteFile into LocalFile.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DownloadFiles Method (FTPClient Class)
Downloads multiple files from the server.
Syntax
ANSI (Cross Platform) int DownloadFiles(const char* lpszRemotePath, const char* lpszLocalDir, int bRecursive, int iErrorHandling); Unicode (Windows) INT DownloadFiles(LPCWSTR lpszRemotePath, LPCWSTR lpszLocalDir, BOOL bRecursive, INT iErrorHandling);
int secureblackbox_ftpclient_downloadfiles(void* lpObj, const char* lpszRemotePath, const char* lpszLocalDir, int bRecursive, int iErrorHandling);
int DownloadFiles(const QString& qsRemotePath, const QString& qsLocalDir, bool bRecursive, int iErrorHandling);
Remarks
Use this method do download a collection of files from the server.
RemotePath can contain a simple mask, a set of masks, or a regular expression. All the files that match the provided rule will be downloaded to LocalDir. The Recursive parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual RemotePath, but not its subdirectories, will be downloaded.
The ErrorHandling parameter specifies one of the pre-defined error handling tactics:
ehStopOnFailure | 0 | Stop on the first failure and throw an exception |
ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list |
ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DownloadStream Method (FTPClient Class)
Downloads a file from the server into a stream.
Syntax
ANSI (Cross Platform) int DownloadStream(const char* lpszRemoteFile, SecureBlackboxStream* sLocalStream); Unicode (Windows) INT DownloadStream(LPCWSTR lpszRemoteFile, SecureBlackboxStream* sLocalStream);
int secureblackbox_ftpclient_downloadstream(void* lpObj, const char* lpszRemoteFile, SecureBlackboxStream* sLocalStream);
int DownloadStream(const QString& qsRemoteFile, SecureBlackboxStream* sLocalStream);
Remarks
Use this method to download RemoteFile into a stream object.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
FileExists Method (FTPClient Class)
Checks if a file exists on the server.
Syntax
ANSI (Cross Platform) bool FileExists(const char* lpszRemoteFile); Unicode (Windows) INT FileExists(LPCWSTR lpszRemoteFile);
bool secureblackbox_ftpclient_fileexists(void* lpObj, const char* lpszRemoteFile);
bool FileExists(const QString& qsRemoteFile);
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.
Error Handling (C++)
This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetCurrentDir Method (FTPClient Class)
Returns the server-side current directory.
Syntax
ANSI (Cross Platform) char* GetCurrentDir(); Unicode (Windows) LPWSTR GetCurrentDir();
char* secureblackbox_ftpclient_getcurrentdir(void* lpObj);
QString GetCurrentDir();
Remarks
Use this method to find out the current directory on the server.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetFileSize Method (FTPClient Class)
Returns the size of a remote file.
Syntax
ANSI (Cross Platform) int64 GetFileSize(const char* lpszRemoteFile); Unicode (Windows) LONG64 GetFileSize(LPCWSTR lpszRemoteFile);
int64 secureblackbox_ftpclient_getfilesize(void* lpObj, const char* lpszRemoteFile);
qint64 GetFileSize(const QString& qsRemoteFile);
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.
Error Handling (C++)
This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ListDir Method (FTPClient Class)
Lists the contents of a remote directory.
Syntax
ANSI (Cross Platform) char* ListDir(int bIncludeFiles, int bIncludeDirectories); Unicode (Windows) LPWSTR ListDir(BOOL bIncludeFiles, BOOL bIncludeDirectories);
char* secureblackbox_ftpclient_listdir(void* lpObj, int bIncludeFiles, int bIncludeDirectories);
QString ListDir(bool bIncludeFiles, bool bIncludeDirectories);
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.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
MakeDir Method (FTPClient Class)
Creates a new directory on the server.
Syntax
ANSI (Cross Platform) int MakeDir(const char* lpszRemoteDir); Unicode (Windows) INT MakeDir(LPCWSTR lpszRemoteDir);
int secureblackbox_ftpclient_makedir(void* lpObj, const char* lpszRemoteDir);
int MakeDir(const QString& qsRemoteDir);
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Noop Method (FTPClient Class)
Sends a NOOP command to the server.
Syntax
ANSI (Cross Platform) int Noop(); Unicode (Windows) INT Noop();
int secureblackbox_ftpclient_noop(void* lpObj);
int Noop();
Remarks
Call this method to send a NOOP (No Operation) command to the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Rename Method (FTPClient Class)
Renames a file.
Syntax
ANSI (Cross Platform) int Rename(const char* lpszSourceFile, const char* lpszDestFile); Unicode (Windows) INT Rename(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile);
int secureblackbox_ftpclient_rename(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile);
int Rename(const QString& qsSourceFile, const QString& qsDestFile);
Remarks
Use this method to rename a server-side SourceFile to DestFile.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (FTPClient Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_ftpclient_reset(void* lpObj);
int Reset();
Remarks
Reset is a generic method available in every class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendCommand Method (FTPClient Class)
Sends a custom command to the server.
Syntax
ANSI (Cross Platform) int SendCommand(const char* lpszCommand); Unicode (Windows) INT SendCommand(LPCWSTR lpszCommand);
int secureblackbox_ftpclient_sendcommand(void* lpObj, const char* lpszCommand);
int SendCommand(const QString& qsCommand);
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.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
UploadBytes Method (FTPClient Class)
Uploads a byte array to the server.
Syntax
ANSI (Cross Platform) int UploadBytes(const char* lpBytes, int lenBytes, const char* lpszRemoteFile); Unicode (Windows) INT UploadBytes(LPCSTR lpBytes, INT lenBytes, LPCWSTR lpszRemoteFile);
int secureblackbox_ftpclient_uploadbytes(void* lpObj, const char* lpBytes, int lenBytes, const char* lpszRemoteFile);
int UploadBytes(QByteArray qbaBytes, const QString& qsRemoteFile);
Remarks
Use this method to upload Bytes or its part to RemoteFile on the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
UploadFile Method (FTPClient Class)
Uploads a file to the server.
Syntax
ANSI (Cross Platform) int UploadFile(const char* lpszLocalFile, const char* lpszRemoteFile); Unicode (Windows) INT UploadFile(LPCWSTR lpszLocalFile, LPCWSTR lpszRemoteFile);
int secureblackbox_ftpclient_uploadfile(void* lpObj, const char* lpszLocalFile, const char* lpszRemoteFile);
int UploadFile(const QString& qsLocalFile, const QString& qsRemoteFile);
Remarks
Use this method to upload LocalFile or its part to RemoteFile on the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
UploadFiles Method (FTPClient Class)
Uploads multiple files to the server.
Syntax
ANSI (Cross Platform) int UploadFiles(const char* lpszLocalPath, const char* lpszRemoteDir, int bRecursive, int iErrorHandling); Unicode (Windows) INT UploadFiles(LPCWSTR lpszLocalPath, LPCWSTR lpszRemoteDir, BOOL bRecursive, INT iErrorHandling);
int secureblackbox_ftpclient_uploadfiles(void* lpObj, const char* lpszLocalPath, const char* lpszRemoteDir, int bRecursive, int iErrorHandling);
int UploadFiles(const QString& qsLocalPath, const QString& qsRemoteDir, bool bRecursive, int iErrorHandling);
Remarks
This method uploads all the files that match the LocalPath criteria to RemoteDir directory on the server. LocalPath accepts a simple mask, a set of masks, or a regular expression. The Recursive parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual LocalPath, but not its subdirectories, will be uploaded.
The ErrorHandling parameter specifies the error handling tactics:
ehStopOnFailure | 0 | Stop on the first failure and throw an exception |
ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list |
ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process |
For each file being uploaded a pair of FileOperation and FileOperationResult events are invoked.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
UploadStream Method (FTPClient Class)
Uploads a file to the server.
Syntax
ANSI (Cross Platform) int UploadStream(SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile); Unicode (Windows) INT UploadStream(SecureBlackboxStream* sLocalStream, LPCWSTR lpszRemoteFile);
int secureblackbox_ftpclient_uploadstream(void* lpObj, SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile);
int UploadStream(SecureBlackboxStream* sLocalStream, const QString& qsRemoteFile);
Remarks
Use this method to upload data contained in LocalStream to RemoteFile on the server.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ControlReceive Event (FTPClient Class)
Fires when data is received via the control channel.
Syntax
ANSI (Cross Platform) virtual int FireControlReceive(FTPClientControlReceiveEventParams *e);
typedef struct {
const char *TextLine; int reserved; } FTPClientControlReceiveEventParams;
Unicode (Windows) virtual INT FireControlReceive(FTPClientControlReceiveEventParams *e);
typedef struct {
LPCWSTR TextLine; INT reserved; } FTPClientControlReceiveEventParams;
#define EID_FTPCLIENT_CONTROLRECEIVE 1 virtual INT SECUREBLACKBOX_CALL FireControlReceive(LPSTR &lpszTextLine);
class FTPClientControlReceiveEventParams { public: const QString &TextLine(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ControlReceive(FTPClientControlReceiveEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireControlReceive(FTPClientControlReceiveEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireControlSend(FTPClientControlSendEventParams *e);
typedef struct {
const char *TextLine; int reserved; } FTPClientControlSendEventParams;
Unicode (Windows) virtual INT FireControlSend(FTPClientControlSendEventParams *e);
typedef struct {
LPCWSTR TextLine; INT reserved; } FTPClientControlSendEventParams;
#define EID_FTPCLIENT_CONTROLSEND 2 virtual INT SECUREBLACKBOX_CALL FireControlSend(LPSTR &lpszTextLine);
class FTPClientControlSendEventParams { public: const QString &TextLine(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ControlSend(FTPClientControlSendEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireControlSend(FTPClientControlSendEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireError(FTPClientErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } FTPClientErrorEventParams;
Unicode (Windows) virtual INT FireError(FTPClientErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } FTPClientErrorEventParams;
#define EID_FTPCLIENT_ERROR 3 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class FTPClientErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(FTPClientErrorEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireError(FTPClientErrorEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireExternalSign(FTPClientExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } FTPClientExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(FTPClientExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } FTPClientExternalSignEventParams;
#define EID_FTPCLIENT_EXTERNALSIGN 4 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class FTPClientExternalSignEventParams { public: const QString &OperationId(); const QString &HashAlgorithm(); const QString &Pars(); const QString &Data(); const QString &SignedData(); void SetSignedData(const QString &qsSignedData); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ExternalSign(FTPClientExternalSignEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireExternalSign(FTPClientExternalSignEventParams *e) {...}
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
FileNameChangeNeeded Event (FTPClient Class)
Asks the application for a new file name.
Syntax
ANSI (Cross Platform) virtual int FireFileNameChangeNeeded(FTPClientFileNameChangeNeededEventParams *e);
typedef struct {
char *FileName;
int Force; int reserved; } FTPClientFileNameChangeNeededEventParams;
Unicode (Windows) virtual INT FireFileNameChangeNeeded(FTPClientFileNameChangeNeededEventParams *e);
typedef struct {
LPWSTR FileName;
BOOL Force; INT reserved; } FTPClientFileNameChangeNeededEventParams;
#define EID_FTPCLIENT_FILENAMECHANGENEEDED 5 virtual INT SECUREBLACKBOX_CALL FireFileNameChangeNeeded(LPSTR &lpszFileName, BOOL &bForce);
class FTPClientFileNameChangeNeededEventParams { public: const QString &FileName(); void SetFileName(const QString &qsFileName); bool Force(); void SetForce(bool bForce); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FileNameChangeNeeded(FTPClientFileNameChangeNeededEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireFileNameChangeNeeded(FTPClientFileNameChangeNeededEventParams *e) {...}
Remarks
The component uses this event to ask the application for a new file name in the case of a name conflict. Adjust the FileName as required to avoid the conflict, or set Force to true to go ahead with the current name (possibly overwriting an existing file).
FileOperation Event (FTPClient Class)
Marks the start of a file transfer.
Syntax
ANSI (Cross Platform) virtual int FireFileOperation(FTPClientFileOperationEventParams *e);
typedef struct {
int Operation;
const char *RemotePath;
const char *LocalPath;
int Skip;
int Cancel; int reserved; } FTPClientFileOperationEventParams;
Unicode (Windows) virtual INT FireFileOperation(FTPClientFileOperationEventParams *e);
typedef struct {
INT Operation;
LPCWSTR RemotePath;
LPCWSTR LocalPath;
BOOL Skip;
BOOL Cancel; INT reserved; } FTPClientFileOperationEventParams;
#define EID_FTPCLIENT_FILEOPERATION 6 virtual INT SECUREBLACKBOX_CALL FireFileOperation(INT &iOperation, LPSTR &lpszRemotePath, LPSTR &lpszLocalPath, BOOL &bSkip, BOOL &bCancel);
class FTPClientFileOperationEventParams { public: int Operation(); const QString &RemotePath(); const QString &LocalPath(); bool Skip(); void SetSkip(bool bSkip); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FileOperation(FTPClientFileOperationEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireFileOperation(FTPClientFileOperationEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireFileOperationResult(FTPClientFileOperationResultEventParams *e);
typedef struct {
int Operation;
const char *RemotePath;
const char *LocalPath;
int ErrorCode;
const char *Comment;
int Cancel; int reserved; } FTPClientFileOperationResultEventParams;
Unicode (Windows) virtual INT FireFileOperationResult(FTPClientFileOperationResultEventParams *e);
typedef struct {
INT Operation;
LPCWSTR RemotePath;
LPCWSTR LocalPath;
INT ErrorCode;
LPCWSTR Comment;
BOOL Cancel; INT reserved; } FTPClientFileOperationResultEventParams;
#define EID_FTPCLIENT_FILEOPERATIONRESULT 7 virtual INT SECUREBLACKBOX_CALL FireFileOperationResult(INT &iOperation, LPSTR &lpszRemotePath, LPSTR &lpszLocalPath, INT &iErrorCode, LPSTR &lpszComment, BOOL &bCancel);
class FTPClientFileOperationResultEventParams { public: int Operation(); const QString &RemotePath(); const QString &LocalPath(); int ErrorCode(); const QString &Comment(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FileOperationResult(FTPClientFileOperationResultEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireFileOperationResult(FTPClientFileOperationResultEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireListEntry(FTPClientListEntryEventParams *e);
typedef struct {
const char *FileName; int reserved; } FTPClientListEntryEventParams;
Unicode (Windows) virtual INT FireListEntry(FTPClientListEntryEventParams *e);
typedef struct {
LPCWSTR FileName; INT reserved; } FTPClientListEntryEventParams;
#define EID_FTPCLIENT_LISTENTRY 8 virtual INT SECUREBLACKBOX_CALL FireListEntry(LPSTR &lpszFileName);
class FTPClientListEntryEventParams { public: const QString &FileName(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ListEntry(FTPClientListEntryEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireListEntry(FTPClientListEntryEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireNotification(FTPClientNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } FTPClientNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(FTPClientNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } FTPClientNotificationEventParams;
#define EID_FTPCLIENT_NOTIFICATION 9 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class FTPClientNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(FTPClientNotificationEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireNotification(FTPClientNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
TLSExtensions.CertificateStatus | TBD |
TLSExtensions.PreSharedIdentityHint | TBD |
Progress Event (FTPClient Class)
Reports the data transfer progress.
Syntax
ANSI (Cross Platform) virtual int FireProgress(FTPClientProgressEventParams *e);
typedef struct {
int64 Total;
int64 Current;
int Cancel; int reserved; } FTPClientProgressEventParams;
Unicode (Windows) virtual INT FireProgress(FTPClientProgressEventParams *e);
typedef struct {
LONG64 Total;
LONG64 Current;
BOOL Cancel; INT reserved; } FTPClientProgressEventParams;
#define EID_FTPCLIENT_PROGRESS 10 virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);
class FTPClientProgressEventParams { public: qint64 Total(); qint64 Current(); bool Cancel(); void SetCancel(bool bCancel); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Progress(FTPClientProgressEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireProgress(FTPClientProgressEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireTextDataLine(FTPClientTextDataLineEventParams *e);
typedef struct {
const char *TextLine; int reserved; } FTPClientTextDataLineEventParams;
Unicode (Windows) virtual INT FireTextDataLine(FTPClientTextDataLineEventParams *e);
typedef struct {
LPCWSTR TextLine; INT reserved; } FTPClientTextDataLineEventParams;
#define EID_FTPCLIENT_TEXTDATALINE 11 virtual INT SECUREBLACKBOX_CALL FireTextDataLine(LPSTR &lpszTextLine);
class FTPClientTextDataLineEventParams { public: const QString &TextLine(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TextDataLine(FTPClientTextDataLineEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireTextDataLine(FTPClientTextDataLineEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireTLSCertNeeded(FTPClientTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } FTPClientTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(FTPClientTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } FTPClientTLSCertNeededEventParams;
#define EID_FTPCLIENT_TLSCERTNEEDED 12 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class FTPClientTLSCertNeededEventParams { public: const QString &Host(); const QString &CANames(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertNeeded(FTPClientTLSCertNeededEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireTLSCertNeeded(FTPClientTLSCertNeededEventParams *e) {...}
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain 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
ANSI (Cross Platform) virtual int FireTLSCertValidate(FTPClientTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } FTPClientTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(FTPClientTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } FTPClientTLSCertValidateEventParams;
#define EID_FTPCLIENT_TLSCERTVALIDATE 13 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class FTPClientTLSCertValidateEventParams { public: const QString &ServerHost(); const QString &ServerIP(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(FTPClientTLSCertValidateEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireTLSCertValidate(FTPClientTLSCertValidateEventParams *e) {...}
Remarks
This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.
TLSEstablished Event (FTPClient Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(FTPClientTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } FTPClientTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(FTPClientTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } FTPClientTLSEstablishedEventParams;
#define EID_FTPCLIENT_TLSESTABLISHED 14 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class FTPClientTLSEstablishedEventParams { public: const QString &Host(); const QString &Version(); const QString &Ciphersuite(); const QByteArray &ConnectionId(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(FTPClientTLSEstablishedEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireTLSEstablished(FTPClientTLSEstablishedEventParams *e) {...}
Remarks
The class uses this event to notify the application about a successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (FTPClient Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(FTPClientTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } FTPClientTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(FTPClientTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } FTPClientTLSHandshakeEventParams;
#define EID_FTPCLIENT_TLSHANDSHAKE 15 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class FTPClientTLSHandshakeEventParams { public: const QString &Host(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(FTPClientTLSHandshakeEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireTLSHandshake(FTPClientTLSHandshakeEventParams *e) {...}
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.
TLSPSK Event (FTPClient Class)
Notifies the application about the PSK key exchange.
Syntax
ANSI (Cross Platform) virtual int FireTLSPSK(FTPClientTLSPSKEventParams *e);
typedef struct {
const char *Host;
const char *Hint; int reserved; } FTPClientTLSPSKEventParams;
Unicode (Windows) virtual INT FireTLSPSK(FTPClientTLSPSKEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Hint; INT reserved; } FTPClientTLSPSKEventParams;
#define EID_FTPCLIENT_TLSPSK 16 virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LPSTR &lpszHost, LPSTR &lpszHint);
class FTPClientTLSPSKEventParams { public: const QString &Host(); const QString &Hint(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSPSK(FTPClientTLSPSKEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireTLSPSK(FTPClientTLSPSKEventParams *e) {...}
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
ANSI (Cross Platform) virtual int FireTLSShutdown(FTPClientTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } FTPClientTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(FTPClientTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } FTPClientTLSShutdownEventParams;
#define EID_FTPCLIENT_TLSSHUTDOWN 17 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class FTPClientTLSShutdownEventParams { public: const QString &Host(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(FTPClientTLSShutdownEventParams *e);
// Or, subclass FTPClient and override this emitter function. virtual int FireTLSShutdown(FTPClientTLSShutdownEventParams *e) {...}
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
Certificate Type
Encapsulates an individual X.509 certificate.
Syntax
SecureBlackboxCertificate (declared in secureblackbox.h)
Remarks
This type keeps and provides access to X.509 certificate details.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw certificate data in DER format.
CA
int
Default Value: FALSE
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.
CAKeyID
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
CRLDistributionPoints
char*
Default Value: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
Curve
char*
Default Value: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
Fingerprint
char* (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
FriendlyName
char* (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
char* (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
KeyAlgorithm
char*
Default Value: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
char* (read-only)
Default Value: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
int
Default Value: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this field before generating the certificate to propagate the key usage flags to the new certificate.
KeyValid
int (read-only)
Default Value: FALSE
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
char*
Default Value: ""
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
OCSPNoCheck
int
Default Value: FALSE
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
PolicyIDs
char*
Default Value: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this field when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
PrivateKeyBytes
char* (read-only)
Default Value:
Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
PrivateKeyExists
int (read-only)
Default Value: FALSE
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
PrivateKeyExtractable
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
char* (read-only)
Default Value:
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
Qualified
int (read-only)
Default Value: FALSE
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
QualifiedStatements
int
Default Value: 0
Returns a simplified qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
int (read-only)
Default Value: FALSE
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
char*
Default Value:
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
SigAlgorithm
char* (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Subject
char* (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.
SubjectAlternativeName
char*
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
SubjectKeyID
char*
Default Value:
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
SubjectRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
Valid
int (read-only)
Default Value: FALSE
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
ValidFrom
char*
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
ValidTo
char*
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
Certificate()
Creates a new object with default field values.
CRL Type
Represents a Certificate Revocation List.
Syntax
SecureBlackboxCRL (declared in secureblackbox.h)
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
char* (read-only)
Default Value:
Returns the raw CRL data in DER format.
CAKeyID
char*
Default Value:
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
EntryCount
int (read-only)
Default Value: 0
Returns the number of certificate status entries in the CRL.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
The common name of the CRL issuer (CA), typically a company name.
IssuerRDN
char* (read-only)
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Location
char* (read-only)
Default Value: ""
The URL that the CRL was downloaded from.
NextUpdate
char*
Default Value: ""
The planned time and date of the next version of this CRL to be published.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this CRL.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
TBS
char* (read-only)
Default Value:
The to-be-signed part of the CRL (the CRL without the signature part).
ThisUpdate
char*
Default Value: ""
The date and time at which this version of the CRL was published.
Constructors
CRL()
Creates an empty CRL object.
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Syntax
SecureBlackboxExternalCrypto (declared in secureblackbox.h)
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
char*
Default Value: ""
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
CustomParams
char*
Default Value: ""
Custom parameters to be passed to the signing service (uninterpreted).
Data
char*
Default Value: ""
Additional data to be included in the async state and mirrored back by the requestor.
ExternalHashCalculation
int
Default Value: FALSE
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.
If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
HashAlgorithm
char*
Default Value: "SHA256"
Specifies the request's signature hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
KeyID
char*
Default Value: ""
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
KeySecret
char*
Default Value: ""
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the KeyID topic.
Method
int
Default Value: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Mode
int
Default Value: 0
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with the OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
PublicKeyAlgorithm
char*
Default Value: ""
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Constructors
ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
FTPListEntry Type
Represents a basic container for the remote file details.
Syntax
SecureBlackboxFTPListEntry (declared in secureblackbox.h)
Remarks
The class represents the details of a file entry returned by the FTP server.
Fields
AccessTime
char*
Default Value: ""
Contains the last access time for this file, in UTC.
CreationTime
char*
Default Value: ""
Contains this file's creation time, in UTC.
FileType
int
Default Value: 0
The type of the entry:
fetUnknown | 0 |
fetDirectory | 1 |
fetFile | 2 |
fetSymlink | 3 |
fetSpecial | 4 |
fetCurrentDirectory | 5 |
fetParentDirectory | 6 |
fetSocket | 7 |
fetCharDevice | 8 |
fetBlockDevice | 9 |
fetFIFO | 10 |
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
ModificationTime
char*
Default Value: ""
File last modification date/time.
Name
char*
Default Value: ""
The file or directory name.
Path
char*
Default Value: ""
The full path to the file or directory.
Principal
char*
Default Value: ""
Specifies the owner of the file/directory.
Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings.
Size
int64
Default Value: 0
File size in bytes.
UnixPerms
int
Default Value: 511
The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)).
UnparsedName
char*
Default Value: ""
The unparsed entry as returned by the server. Sometimes this is also known as "long name".
Constructors
FTPListEntry()
Creates a new FTPListEntry object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Syntax
SecureBlackboxOCSPResponse (declared in secureblackbox.h)
Remarks
OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).
An OCSP response is a snapshot of the certificate status at a given time.
Fields
Bytes
char* (read-only)
Default Value:
A buffer containing the raw OCSP response data.
EntryCount
int (read-only)
Default Value: 0
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
Indicates the issuer of this response (a CA or its authorized representative).
IssuerRDN
char* (read-only)
Default Value: ""
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Location
char* (read-only)
Default Value: ""
The location of the OCSP responder.
ProducedAt
char*
Default Value: ""
Specifies the time when the response was produced, in UTC.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this OCSP response.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Constructors
OCSPResponse()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Syntax
SecureBlackboxProxySettings (declared in secureblackbox.h)
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
Address
char*
Default Value: ""
The IP address of the proxy server.
Authentication
int
Default Value: 0
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Password
char*
Default Value: ""
The password to authenticate to the proxy server.
Port
int
Default Value: 0
The port on the proxy server to connect to.
ProxyType
int
Default Value: 0
The type of the proxy server.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
RequestHeaders
char*
Default Value: ""
Contains HTTP request headers for WebTunnel and HTTP proxy.
ResponseBody
char*
Default Value: ""
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ResponseHeaders
char*
Default Value: ""
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
UseIPv6
int
Default Value: FALSE
Specifies whether IPv6 should be used when connecting through the proxy.
Username
char*
Default Value: ""
Specifies the username credential for proxy authentication.
Constructors
ProxySettings()
Creates a new ProxySettings object.
SocketSettings Type
A container for the socket settings.
Syntax
SecureBlackboxSocketSettings (declared in secureblackbox.h)
Remarks
This type is a container for socket-layer parameters.
Fields
DNSMode
int
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
DNSPort
int
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
char*
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default Value: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
char*
Default Value: ""
The local network interface to bind the socket to.
LocalPort
int
Default Value: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default Value: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default Value: 60000
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
UseIPv6
int
Default Value: FALSE
Enables or disables IP protocol version 6.
Constructors
SocketSettings()
Creates a new SocketSettings object.
TLSConnectionInfo Type
Contains information about a network connection.
Syntax
SecureBlackboxTLSConnectionInfo (declared in secureblackbox.h)
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
int (read-only)
Default Value: FALSE
Indicates whether the encryption algorithm used is an AEAD cipher.
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
int (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
Ciphersuite
char* (read-only)
Default Value: ""
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
ClientAuthenticated
int (read-only)
Default Value: FALSE
Specifies whether client authentication was performed during this connection.
ClientAuthRequested
int (read-only)
Default Value: FALSE
Specifies whether client authentication was requested during this connection.
ConnectionEstablished
int (read-only)
Default Value: FALSE
Indicates whether the connection has been established fully.
ConnectionID
char* (read-only)
Default Value:
The unique identifier assigned to this connection.
DigestAlgorithm
char* (read-only)
Default Value: ""
The digest algorithm used in a TLS-enabled connection.
EncryptionAlgorithm
char* (read-only)
Default Value: ""
The symmetric encryption algorithm used in a TLS-enabled connection.
Exportable
int (read-only)
Default Value: FALSE
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
ID
int64 (read-only)
Default Value: -1
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
KeyExchangeAlgorithm
char* (read-only)
Default Value: ""
The key exchange algorithm used in a TLS-enabled connection.
KeyExchangeKeyBits
int (read-only)
Default Value: 0
The length of the key exchange key of a TLS-enabled connection.
NamedECCurve
char* (read-only)
Default Value: ""
The elliptic curve used in this connection.
PFSCipher
int (read-only)
Default Value: FALSE
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
PreSharedIdentity
char*
Default Value: ""
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedIdentityHint
char* (read-only)
Default Value: ""
A hint professed by the server to help the client select the PSK identity to use.
PublicKeyBits
int (read-only)
Default Value: 0
The length of the public key.
RemoteAddress
char* (read-only)
Default Value: ""
The client's IP address.
RemotePort
int (read-only)
Default Value: 0
The remote port of the client connection.
ResumedSession
int (read-only)
Default Value: FALSE
Indicates whether a TLS-enabled connection was spawned from another TLS connection
SecureConnection
int (read-only)
Default Value: FALSE
Indicates whether TLS or SSL is enabled for this connection.
ServerAuthenticated
int (read-only)
Default Value: FALSE
Indicates whether server authentication was performed during a TLS-enabled connection.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The signature algorithm used in a TLS handshake.
SymmetricBlockSize
int (read-only)
Default Value: 0
The block size of the symmetric algorithm used.
SymmetricKeyBits
int (read-only)
Default Value: 0
The key length of the symmetric algorithm used.
TotalBytesReceived
int64 (read-only)
Default Value: 0
The total number of bytes received over this connection.
TotalBytesSent
int64 (read-only)
Default Value: 0
The total number of bytes sent over this connection.
ValidationLog
char* (read-only)
Default Value: ""
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
Version
char* (read-only)
Default Value: ""
Indicates the version of SSL/TLS protocol negotiated during this connection.
Constructors
TLSConnectionInfo()
Creates a new TLSConnectionInfo object.
TLSSettings Type
A container for TLS connection settings.
Syntax
SecureBlackboxTLSSettings (declared in secureblackbox.h)
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
AutoValidateCertificates
int
Default Value: TRUE
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
BaseConfiguration
int
Default Value: 0
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Ciphersuites
char*
Default Value: ""
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
ClientAuth
int
Default Value: 0
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
ccatNoAuth | 0 | |
ccatRequestCert | 1 | |
ccatRequireCert | 2 |
ECCurves
char*
Default Value: ""
Defines the elliptic curves to enable.
Extensions
char*
Default Value: ""
Provides access to TLS extensions.
ForceResumeIfDestinationChanges
int
Default Value: FALSE
Whether to force TLS session resumption when the destination address changes.
PreSharedIdentity
char*
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedKey
char*
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
PreSharedKeyCiphersuite
char*
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
RenegotiationAttackPreventionMode
int
Default Value: 2
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
RevocationCheck
int
Default Value: 1
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
SSLOptions
int
Default Value: 16
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
TLSMode
int
Default Value: 0
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
UseExtendedMasterSecret
int
Default Value: FALSE
Enables the Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
int
Default Value: FALSE
Enables or disables the TLS session resumption capability.
Versions
int
Default Value: 16
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Constructors
TLSSettings()
Creates a new TLSSettings object.
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (declared in secureblackbox.h)
Remarks
SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the FTPClient class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
SecureBlackboxStream Type
Syntax
SecureBlackboxStream (declared in secureblackbox.h)
Remarks
The FTPClient class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the FTPClient class an instance of that concrete class.
When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
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
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 the TrustedCertificates property) are considered trusted.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
- CA, revocation source, TLS key usage requirements are not mandated
- Violation of OCSP issuer requirements are ignored
- The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
- Basic constraints and name constraints of CA certificates are ignored
- Some weaker algorithms are tolerated
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (FTPClient Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
FTPClient Errors
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |
18874369 | Unsupported file operation (SB_ERROR_FTP_UNSUPPORTED_FILE_OPERATION) |