# FTPServer Class

The FTPServer class provides server-side functionality for FTP and FTPS protocols.

## Syntax

```text
FTPServer
```

## Remarks

FTPServer supports FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations on the server over Transport Layer Security (TLS). TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.

## Property List

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

|  |  |
| --- | --- |
| [Active](#active-property-ftpserver-class) | Whether the server is active and can accept incoming connections. |
| [AllowAnonymous](#allowanonymous-property-ftpserver-class) | Allows and disallows anonymous connections. |
| [ClientFileEntry](#clientfileentry-property-ftpserver-class) | A container for current file entry details. |
| [DataHost](#datahost-property-ftpserver-class) | Host address for incoming data channel connections. |
| [DataPortRangeFrom](#dataportrangefrom-property-ftpserver-class) | Specifies the lower port range bound for passive mode data connections. |
| [DataPortRangeTo](#dataportrangeto-property-ftpserver-class) | Specifies the upper port range bound for passive mode data connections. |
| [ExternalCrypto](#externalcrypto-property-ftpserver-class) | Provides access to external signing and DC parameters. |
| [FIPSMode](#fipsmode-property-ftpserver-class) | Reserved. |
| [HandshakeTimeout](#handshaketimeout-property-ftpserver-class) | Specifies the handshake timeout in milliseconds. |
| [Host](#host-property-ftpserver-class) | Specifies the server host. |
| [ImplicitSSL](#implicitssl-property-ftpserver-class) | Enables or disables implicit SSL mode. |
| [PassiveModeHost](#passivemodehost-property-ftpserver-class) | The IP address of the passive mode host. |
| [PinnedClient](#pinnedclient-property-ftpserver-class) | Populates the pinned client details. |
| [PinnedClientChain](#pinnedclientchain-property-ftpserver-class) | Contains the certificate chain of the pinned client. |
| [Port](#port-property-ftpserver-class) | The port number to listen for incoming connections on. |
| [ReadOnly](#readonly-property-ftpserver-class) | Makes the server's file system read-only for all users. |
| [RootDirectory](#rootdirectory-property-ftpserver-class) | Specifies the server's root directory. |
| [SecurityOptions](#securityoptions-property-ftpserver-class) | Various options of the secure connection. |
| [SessionTimeout](#sessiontimeout-property-ftpserver-class) | Specifies the session timeout in milliseconds. |
| [SocketSettings](#socketsettings-property-ftpserver-class) | Manages network connection settings. |
| [TLSServerChain](#tlsserverchain-property-ftpserver-class) | The server's TLS certificates. |
| [TLSSettings](#tlssettings-property-ftpserver-class) | Manages TLS layer settings. |
| [Users](#users-property-ftpserver-class) | Provides a list of registered users. |
| [UseUTF8](#useutf8-property-ftpserver-class) | Enables or disables UTF8 file name conversions. |

## Method List

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

|  |  |
| --- | --- |
| [Cleanup](#cleanup-method-ftpserver-class) | Cleans up the server environment by purging expired sessions and cleaning caches. |
| [Config](#config-method-ftpserver-class) | Sets or retrieves a configuration setting. |
| [DoAction](#doaction-method-ftpserver-class) | Performs an additional action. |
| [DropClient](#dropclient-method-ftpserver-class) | Terminates a client connection. |
| [GetClientBuffer](#getclientbuffer-method-ftpserver-class) | Obtains a pending connection buffer. |
| [ListClients](#listclients-method-ftpserver-class) | Enumerates the connected clients. |
| [PinClient](#pinclient-method-ftpserver-class) | Takes a snapshot of the connection's properties. |
| [Reset](#reset-method-ftpserver-class) | Resets the class settings. |
| [SetClientBuffer](#setclientbuffer-method-ftpserver-class) | Commits a data buffer to the connection. |
| [SetClientFileEntry](#setclientfileentry-method-ftpserver-class) | Commits a file entry to the connection. |
| [Start](#start-method-ftpserver-class) | Starts the server. |
| [Stop](#stop-method-ftpserver-class) | Stops 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.*

|  |  |
| --- | --- |
| [Accept](#accept-event-ftpserver-class) | Reports an incoming connection. |
| [AfterChangeDirectory](#afterchangedirectory-event-ftpserver-class) | Signals the completion of a directory change operation. |
| [AfterCreateDirectory](#aftercreatedirectory-event-ftpserver-class) | Signals the completion of a directory creation operation. |
| [AfterRemoveDirectory](#afterremovedirectory-event-ftpserver-class) | Signals the completion of a directory removal operation. |
| [AfterRemoveFile](#afterremovefile-event-ftpserver-class) | Signals the completion of a file removal operation. |
| [AfterRenameFile](#afterrenamefile-event-ftpserver-class) | Signals the completion of a file renaming operation. |
| [AfterRequestAttributes](#afterrequestattributes-event-ftpserver-class) | Signals the completion of an attribute request. |
| [AuthAttempt](#authattempt-event-ftpserver-class) | Fires when a connected client makes an authentication attempt. |
| [BeforeChangeDirectory](#beforechangedirectory-event-ftpserver-class) | Notifies about an incoming change directory request. |
| [BeforeCreateDirectory](#beforecreatedirectory-event-ftpserver-class) | Notifies about an incoming create directory request. |
| [BeforeDownloadFile](#beforedownloadfile-event-ftpserver-class) | Notifies about an incoming file download request. |
| [BeforeFind](#beforefind-event-ftpserver-class) | Notifies about an incoming file listing request. |
| [BeforeRemoveDirectory](#beforeremovedirectory-event-ftpserver-class) | Notifies about an incoming directory removal request. |
| [BeforeRemoveFile](#beforeremovefile-event-ftpserver-class) | Notifies about an incoming file removal request. |
| [BeforeRenameFile](#beforerenamefile-event-ftpserver-class) | Notifies about an incoming file rename request. |
| [BeforeRequestAttributes](#beforerequestattributes-event-ftpserver-class) | Notifies about an incoming attributes request. |
| [BeforeSendReply](#beforesendreply-event-ftpserver-class) | Notifies the application of a command reply being sent. |
| [BeforeUploadFile](#beforeuploadfile-event-ftpserver-class) | Notifies about an incoming file upload request. |
| [ChangeDirectory](#changedirectory-event-ftpserver-class) | An override for a directory change operation. |
| [CommandProcessed](#commandprocessed-event-ftpserver-class) | Signals that a command has been processed by the server. |
| [CommandReceived](#commandreceived-event-ftpserver-class) | Signals that a command has been received from the client. |
| [Connect](#connect-event-ftpserver-class) | Reports an accepted connection. |
| [CreateDirectory](#createdirectory-event-ftpserver-class) | An override for a directory creation operation. |
| [Disconnect](#disconnect-event-ftpserver-class) | Fires to report a disconnected client. |
| [DownloadBegin](#downloadbegin-event-ftpserver-class) | The class fires this event to notify the application about the start of a file download. |
| [DownloadEnd](#downloadend-event-ftpserver-class) | Reports the completion of the download operation. |
| [DownloadFile](#downloadfile-event-ftpserver-class) | An override for a file download initiation operation. |
| [DownloadProgress](#downloadprogress-event-ftpserver-class) | Reports the progress of an active download operation. |
| [Error](#error-event-ftpserver-class) | Information about errors during data delivery. |
| [ExternalSign](#externalsign-event-ftpserver-class) | Handles remote or external signing initiated by the server protocol. |
| [FindClose](#findclose-event-ftpserver-class) | Signals the completion of a directory listing request. |
| [FindInit](#findinit-event-ftpserver-class) | An override for a directory listing initiation operation. |
| [FindNext](#findnext-event-ftpserver-class) | An override for a directory listing entry request operation. |
| [Notification](#notification-event-ftpserver-class) | This event notifies the application about an underlying control flow event. |
| [ReadFile](#readfile-event-ftpserver-class) | Requests a piece of file data from the application. |
| [RemoveDirectory](#removedirectory-event-ftpserver-class) | An override for a directory removal operation. |
| [RemoveFile](#removefile-event-ftpserver-class) | An override for a file remove operation. |
| [RenameFile](#renamefile-event-ftpserver-class) | An override for a file rename operation. |
| [RequestAttributes](#requestattributes-event-ftpserver-class) | An override for an attribute request. |
| [TLSCertValidate](#tlscertvalidate-event-ftpserver-class) | Fires when a client certificate needs to be validated. |
| [TLSEstablished](#tlsestablished-event-ftpserver-class) | Reports the setup of a TLS session. |
| [TLSHandshake](#tlshandshake-event-ftpserver-class) | Fires when a newly established client connection initiates a TLS handshake. |
| [TLSPSK](#tlspsk-event-ftpserver-class) | Requests a pre-shared key for TLS-PSK. |
| [TLSShutdown](#tlsshutdown-event-ftpserver-class) | Reports closure of a TLS session. |
| [TransferCompleted](#transfercompleted-event-ftpserver-class) | This event is fired when a customized upload or download operation completes. |
| [UploadBegin](#uploadbegin-event-ftpserver-class) | The server fires this event to notify the application about the start of a file upload operation. |
| [UploadEnd](#uploadend-event-ftpserver-class) | Reports the completion of the upload operation. |
| [UploadFile](#uploadfile-event-ftpserver-class) | An override for a file upload initiation operation. |
| [UploadProgress](#uploadprogress-event-ftpserver-class) | Reports the progress of an active upload operation. |
| [WriteFile](#writefile-event-ftpserver-class) | Hands a piece of file data to the application. |

## Config Settings

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

|  |  |
| --- | --- |
| [ActiveChannel](#ActiveChannel) | The channel to which the event that is being invoked corresponds. |
| [ClientAuth](#ClientAuth) | Enables or disables certificate-based client authentication. |
| [ControlChannelLog\[i\]](#ControlChannelLog[i]) | Returns the control channel log for a connection. |
| [DataPortRangeFilter](#DataPortRangeFilter) | Provides a flexible mechanism to set multiple passive mode data port ranges. |
| [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. |
| [MessageTable\[i\]](#MessageTable[i]) | Provides access to error code descriptions. |
| [RefreshUsers](#RefreshUsers) | Enables or disables real-time propagation of user information. |
| [SecurityOptions](#SecurityOptions) | Facilitates fine-tuning of lower-level security settings. |
| [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. |
| [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. |
| [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. |
| [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| [Cookies](#Cookies) | Gets or sets local cookies for the class. |
| [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. |
| [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. |
| [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. |
| [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. |
| [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. |
| [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. |
| [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. |
| [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. |
| [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. |
| [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. |
| [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. |
| [LogDestination](#LogDestination) | Specifies the debug log destination. |
| [LogDetails](#LogDetails) | Specifies the debug log details to dump. |
| [LogFile](#LogFile) | Specifies the debug log filename. |
| [LogFilters](#LogFilters) | Specifies the debug log filters. |
| [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. |
| [LogLevel](#LogLevel) | Specifies the debug log level. |
| [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. |
| [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. |
| [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. |
| [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. |
| [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
| [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. |
| [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. |
| [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. |
| [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. |
| [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. |
| [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. |
| [Tag](#Tag) | Allows to store any custom data. |
| [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. |
| [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. |
| [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. |
| [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. |
| [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. |
| [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. |
| [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. |
| [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. |
| [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. |
| [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. |
| [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
| [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. |
| [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. |
| [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. |

# Active Property ([FTPServer](#ftpserver-class) Class)

Whether the server is active and can accept incoming connections.

## Syntax

```text
ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();
```

## Default Value

FALSE

## Remarks

This read-only property returns True if the FTPS server is running and listening for incoming connections, and False otherwise.

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

## Data Type

Boolean

# AllowAnonymous Property ([FTPServer](#ftpserver-class) Class)

Allows and disallows anonymous connections.

## Syntax

```text
ANSI (Cross Platform)
int GetAllowAnonymous();int SetAllowAnonymous(int bAllowAnonymous);

Unicode (Windows)
BOOL GetAllowAnonymous();INT SetAllowAnonymous(BOOL bAllowAnonymous);
```

## Default Value

FALSE

## Remarks

Use this property to enable and disable support for anonymous connections.

## Data Type

Boolean

# ClientFileEntry Property ([FTPServer](#ftpserver-class) Class)

A container for current file entry details.

## Syntax

```text
SecureBlackboxFTPListEntry* GetClientFileEntry();
int SetClientFileEntry(SecureBlackboxFTPListEntry* val);
```

## Remarks

Use this object to specify file entry details for a file listing or attributes request, before committing them to the server with [SetClientFileEntry](#setclientfileentry-method-ftpserver-class) method.

This property is not available at design time.

## Data Type

[SecureBlackboxFTPListEntry](#ftplistentry-type)

# DataHost Property ([FTPServer](#ftpserver-class) Class)

Host address for incoming data channel connections.

## Syntax

```text
ANSI (Cross Platform)
char* GetDataHost();int SetDataHost(const char* lpszDataHost);

Unicode (Windows)
LPWSTR GetDataHost();INT SetDataHost(LPCWSTR lpszDataHost);
```

## Default Value

""

## Remarks

Use this property to specify the address for incoming data channel connections, if it is different to [Host](#host-property-ftpserver-class).

In some network environments, in particular, where the server is behind a NAT, there may be a requirement to use a different host address for data connections.

## Data Type

String

# DataPortRangeFrom Property ([FTPServer](#ftpserver-class) Class)

Specifies the lower port range bound for passive mode data connections.

## Syntax

```text
ANSI (Cross Platform)
int GetDataPortRangeFrom();int SetDataPortRangeFrom(int iDataPortRangeFrom);

Unicode (Windows)
INT GetDataPortRangeFrom();INT SetDataPortRangeFrom(INT iDataPortRangeFrom);
```

## Default Value

0

## Remarks

Use this property in combination with DataPortRangeT to limit the port range for passive mode data connections. The value of 0 (zero) stands for no lower bound.

## Data Type

Integer

# DataPortRangeTo Property ([FTPServer](#ftpserver-class) Class)

Specifies the upper port range bound for passive mode data connections.

## Syntax

```text
ANSI (Cross Platform)
int GetDataPortRangeTo();int SetDataPortRangeTo(int iDataPortRangeTo);

Unicode (Windows)
INT GetDataPortRangeTo();INT SetDataPortRangeTo(INT iDataPortRangeTo);
```

## Default Value

0

## Remarks

Use this property in combination with DataPortRangeFrom to limit the port range for passive mode data connections. The value of 0 (zero) stands for no upper bound.

## Data Type

Integer

# ExternalCrypto Property ([FTPServer](#ftpserver-class) Class)

Provides access to external signing and DC parameters.

## Syntax

```text
SecureBlackboxExternalCrypto* GetExternalCrypto();
```

## Remarks

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

This property is read-only.

## Data Type

[SecureBlackboxExternalCrypto](#externalcrypto-type)

# FIPSMode Property ([FTPServer](#ftpserver-class) Class)

Reserved.

## Syntax

```text
ANSI (Cross Platform)
int GetFIPSMode();int SetFIPSMode(int bFIPSMode);

Unicode (Windows)
BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode);
```

## Default Value

FALSE

## Remarks

This property is reserved for future use.

## Data Type

Boolean

# HandshakeTimeout Property ([FTPServer](#ftpserver-class) Class)

Specifies the handshake timeout in milliseconds.

## Syntax

```text
ANSI (Cross Platform)
int GetHandshakeTimeout();int SetHandshakeTimeout(int iHandshakeTimeout);

Unicode (Windows)
INT GetHandshakeTimeout();INT SetHandshakeTimeout(INT iHandshakeTimeout);
```

## Default Value

20000

## Remarks

Use this property to set the TLS handshake timeout.

## Data Type

Integer

# Host Property ([FTPServer](#ftpserver-class) Class)

Specifies the server host.

## Syntax

```text
ANSI (Cross Platform)
char* GetHost();int SetHost(const char* lpszHost);

Unicode (Windows)
LPWSTR GetHost();INT SetHost(LPCWSTR lpszHost);
```

## Default Value

""

## Remarks

Use this property to specify the IP address on which to listen for incoming FTP connections. Use [Port](#port-property-ftpserver-class) to specify the listening port number.

## Data Type

String

# ImplicitSSL Property ([FTPServer](#ftpserver-class) Class)

Enables or disables implicit SSL mode.

## Syntax

```text
ANSI (Cross Platform)
int GetImplicitSSL();int SetImplicitSSL(int bImplicitSSL);

Unicode (Windows)
BOOL GetImplicitSSL();INT SetImplicitSSL(BOOL bImplicitSSL);
```

## Default Value

FALSE

## Remarks

The server can only work in one mode, explicit or implicit. Explicit mode, also called AUTH TLS, supports both TLS and plain connections. Implicit mode, also called 'dedicated port mode,' only supports TLS connections.

## Data Type

Boolean

# PassiveModeHost Property ([FTPServer](#ftpserver-class) Class)

The IP address of the passive mode host.

## Syntax

```text
ANSI (Cross Platform)
char* GetPassiveModeHost();int SetPassiveModeHost(const char* lpszPassiveModeHost);

Unicode (Windows)
LPWSTR GetPassiveModeHost();INT SetPassiveModeHost(LPCWSTR lpszPassiveModeHost);
```

## Default Value

""

## Remarks

Use this property to specify the address on which to listen for passive mode connections.

## Data Type

String

# PinnedClient Property ([FTPServer](#ftpserver-class) Class)

Populates the pinned client details.

## Syntax

```text
SecureBlackboxTLSConnectionInfo* GetPinnedClient();
```

## Remarks

Use this property to access the details of the client connection previously pinned with [PinClient](#pinclient-method-ftpserver-class) method.

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

## Data Type

[SecureBlackboxTLSConnectionInfo](#tlsconnectioninfo-type)

# PinnedClientChain Property ([FTPServer](#ftpserver-class) Class)

Contains the certificate chain of the pinned client.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetPinnedClientChain();
```

## Remarks

Use this property to access the certificate chain of the client connection pinned previously with a [PinClient](#pinclient-method-ftpserver-class) call.

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

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# Port Property ([FTPServer](#ftpserver-class) Class)

The port number to listen for incoming connections on.

## Syntax

```text
ANSI (Cross Platform)
int GetPort();int SetPort(int iPort);

Unicode (Windows)
INT GetPort();INT SetPort(INT iPort);
```

## Default Value

21

## Remarks

Use this property to specify the port number to listen for incoming connections on.

## Data Type

Integer

# ReadOnly Property ([FTPServer](#ftpserver-class) Class)

Makes the server's file system read-only for all users.

## Syntax

```text
ANSI (Cross Platform)
int GetReadOnly();int SetReadOnly(int bReadOnly);

Unicode (Windows)
BOOL GetReadOnly();INT SetReadOnly(BOOL bReadOnly);
```

## Default Value

FALSE

## Remarks

Set this property to true to present the server's file system as read-only for all connecting users.

## Data Type

Boolean

# RootDirectory Property ([FTPServer](#ftpserver-class) Class)

Specifies the server's root directory.

## Syntax

```text
ANSI (Cross Platform)
char* GetRootDirectory();int SetRootDirectory(const char* lpszRootDirectory);

Unicode (Windows)
LPWSTR GetRootDirectory();INT SetRootDirectory(LPCWSTR lpszRootDirectory);
```

## Default Value

""

## Remarks

Use this property to specify the shared root directory for all client sessions.

## Data Type

String

# SecurityOptions Property ([FTPServer](#ftpserver-class) Class)

Various options of the secure connection.

## Syntax

```text
ANSI (Cross Platform)
int GetSecurityOptions();int SetSecurityOptions(int iSecurityOptions);

Unicode (Windows)
INT GetSecurityOptions();INT SetSecurityOptions(INT iSecurityOptions);
```

## Default Value

63

## Remarks

Various options of the secure connection:

|  |  |  |
| --- | --- | --- |
| cfsoPlainLogin | 1 | Allow logins over insecure connections |
| cfsoEncryption | 2 | Enable encryption |
| cfsoAuth | 4 | Enable AUTH command (explicit TLS) |
| cfsoClearControlChannel | 8 | Allow clear control channel mode |
| cfsoClearDataChannel | 16 | Allow clear data channel TLS connections |
| cfsoEncryptedDataChannel | 32 | Allow encrypted data channel TLS connections |

## Data Type

Integer

# SessionTimeout Property ([FTPServer](#ftpserver-class) Class)

Specifies the session timeout in milliseconds.

## Syntax

```text
ANSI (Cross Platform)
int GetSessionTimeout();int SetSessionTimeout(int iSessionTimeout);

Unicode (Windows)
INT GetSessionTimeout();INT SetSessionTimeout(INT iSessionTimeout);
```

## Default Value

360000

## Remarks

Specifies the maximum inactivity time (in milliseconds) after which the session will be forcibly closed.

## Data Type

Integer

# SocketSettings Property ([FTPServer](#ftpserver-class) Class)

Manages network connection settings.

## Syntax

```text
SecureBlackboxSocketSettings* GetSocketSettings();
```

## Remarks

Use this property to tune up network connection parameters.

This property is read-only.

## Data Type

[SecureBlackboxSocketSettings](#socketsettings-type)

# TLSServerChain Property ([FTPServer](#ftpserver-class) Class)

The server's TLS certificates.

## Syntax

```text
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int SetTLSServerChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
```

## Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

 A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# TLSSettings Property ([FTPServer](#ftpserver-class) Class)

Manages TLS layer settings.

## Syntax

```text
SecureBlackboxTLSSettings* GetTLSSettings();
```

## Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

## Data Type

[SecureBlackboxTLSSettings](#tlssettings-type)

# Users Property ([FTPServer](#ftpserver-class) Class)

Provides a list of registered users.

## Syntax

```text
SecureBlackboxList<SecureBlackboxUserAccount>* GetUsers();
int SetUsers(SecureBlackboxList<SecureBlackboxUserAccount>* val);
```

## Remarks

Assign a list of 'known' users to this property to automate authentication handling by the class.

This property is not available at design time.

## Data Type

[SecureBlackboxUserAccount](#useraccount-type)

# UseUTF8 Property ([FTPServer](#ftpserver-class) Class)

Enables or disables UTF8 file name conversions.

## Syntax

```text
ANSI (Cross Platform)
int GetUseUTF8();int SetUseUTF8(int bUseUTF8);

Unicode (Windows)
BOOL GetUseUTF8();INT SetUseUTF8(BOOL bUseUTF8);
```

## Default Value

TRUE

## Remarks

Use this property to enable and disable UTF8 file name conversion. The server typically adjusts to the right setting automatically, but you may use this property to enforce the needed behaviour.

## Data Type

Boolean

# Cleanup Method ([FTPServer](#ftpserver-class) Class)

Cleans up the server environment by purging expired sessions and cleaning caches.

## Syntax

```text
ANSI (Cross Platform)
int Cleanup();

Unicode (Windows)
INT Cleanup();
```

## Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

## 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 ([FTPServer](#ftpserver-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-ftpserver-class) for the class.

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

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

To read (query) the value of a [configuration setting](#config-settings-ftpserver-class), 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.

# DoAction Method ([FTPServer](#ftpserver-class) Class)

Performs an additional action.

## Syntax

```text
ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
```

## Remarks

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

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

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

Common ActionIDs:

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

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

# DropClient Method ([FTPServer](#ftpserver-class) Class)

Terminates a client connection.

## Syntax

```text
ANSI (Cross Platform)
int DropClient(int64 lConnectionId, int bForced);

Unicode (Windows)
INT DropClient(LONG64 lConnectionId, BOOL bForced);
```

## Remarks

Call this method to shut down a connected client. *Forced* indicates whether the connection should be closed in a graceful manner.

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

# GetClientBuffer Method ([FTPServer](#ftpserver-class) Class)

Obtains a pending connection buffer.

## Syntax

```text
ANSI (Cross Platform)
char* GetClientBuffer(int64 lConnectionID, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetClientBuffer(LONG64 lConnectionID, LPINT lpSize = NULL);
```

## Remarks

Use this method to obtain a pending connection buffer from your [WriteFile](#writefile-event-ftpserver-class) event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

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

# ListClients Method ([FTPServer](#ftpserver-class) Class)

Enumerates the connected clients.

## Syntax

```text
ANSI (Cross Platform)
char* ListClients();

Unicode (Windows)
LPWSTR ListClients();
```

## Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

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

# PinClient Method ([FTPServer](#ftpserver-class) Class)

Takes a snapshot of the connection's properties.

## Syntax

```text
ANSI (Cross Platform)
int PinClient(int64 lConnectionId);

Unicode (Windows)
INT PinClient(LONG64 lConnectionId);
```

## Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in [PinnedClient](#pinnedclient-property-ftpserver-class) and [PinnedClientChain](#pinnedclientchain-property-ftpserver-class) properties.

## 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 ([FTPServer](#ftpserver-class) Class)

Resets the class settings.

## Syntax

```text
ANSI (Cross Platform)
int Reset();

Unicode (Windows)
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.)

# SetClientBuffer Method ([FTPServer](#ftpserver-class) Class)

Commits a data buffer to the connection.

## Syntax

```text
ANSI (Cross Platform)
int SetClientBuffer(int64 lConnectionID, const char* lpValue, int lenValue);

Unicode (Windows)
INT SetClientBuffer(LONG64 lConnectionID, LPCSTR lpValue, INT lenValue);
```

## Remarks

Use this method from your [ReadFile](#readfile-event-ftpserver-class) event handler to commit a chunk of file data to the server component.

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

# SetClientFileEntry Method ([FTPServer](#ftpserver-class) Class)

Commits a file entry to the connection.

## Syntax

```text
ANSI (Cross Platform)
int SetClientFileEntry(int64 lConnectionID);

Unicode (Windows)
INT SetClientFileEntry(LONG64 lConnectionID);
```

## Remarks

Use this method to commit a file details entry provided in [ClientFileEntry](#clientfileentry-property-ftpserver-class) property to *ConnectionID* connection. This method is supposed to be used from a [FindNext](#findnext-event-ftpserver-class) event handler.

Please note that events like [FindNext](#findnext-event-ftpserver-class) may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in [ClientFileEntry](#clientfileentry-property-ftpserver-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.)

# Start Method ([FTPServer](#ftpserver-class) Class)

Starts the server.

## Syntax

```text
ANSI (Cross Platform)
int Start();

Unicode (Windows)
INT Start();
```

## Remarks

Call this method to start listening for incoming connections on port [Port](#port-property-ftpserver-class). Call [Stop](#stop-method-ftpserver-class) to deactivate 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.)

# Stop Method ([FTPServer](#ftpserver-class) Class)

Stops the server.

## Syntax

```text
ANSI (Cross Platform)
int Stop();

Unicode (Windows)
INT Stop();
```

## Remarks

Call this method to terminate all active sessions and stop listening for new incoming connections.

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

# Accept Event ([FTPServer](#ftpserver-class) Class)

Reports an incoming connection.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAccept(FTPServerAcceptEventParams *e);
typedef struct {  const char *RemoteAddress;  int RemotePort;  int Accept;
  int reserved;
} FTPServerAcceptEventParams;

Unicode (Windows)
virtual INT FireAccept(FTPServerAcceptEventParams *e);
typedef struct {  LPCWSTR RemoteAddress;  INT RemotePort;  BOOL Accept;
  INT reserved;
} FTPServerAcceptEventParams;
```

## Remarks

This event is fired when a new connection from *RemoteAddress*:*RemotePort* is ready to be accepted. Use the *Accept* parameter to accept or decline it.

Subscribe to [Connect](#connect-event-ftpserver-class) event to be notified of every connection that has been set up.

# AfterChangeDirectory Event ([FTPServer](#ftpserver-class) Class)

Signals the completion of a directory change operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterChangeDirectory(FTPServerAfterChangeDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Directory;  int OperationStatus;
  int reserved;
} FTPServerAfterChangeDirectoryEventParams;

Unicode (Windows)
virtual INT FireAfterChangeDirectory(FTPServerAfterChangeDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Directory;  INT OperationStatus;
  INT reserved;
} FTPServerAfterChangeDirectoryEventParams;
```

## Remarks

The class fires this event upon completion of a directory change operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterCreateDirectory Event ([FTPServer](#ftpserver-class) Class)

Signals the completion of a directory creation operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterCreateDirectory(FTPServerAfterCreateDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Directory;  int OperationStatus;
  int reserved;
} FTPServerAfterCreateDirectoryEventParams;

Unicode (Windows)
virtual INT FireAfterCreateDirectory(FTPServerAfterCreateDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Directory;  INT OperationStatus;
  INT reserved;
} FTPServerAfterCreateDirectoryEventParams;
```

## Remarks

The class fires this event upon completion of a directory creation operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterRemoveDirectory Event ([FTPServer](#ftpserver-class) Class)

Signals the completion of a directory removal operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterRemoveDirectory(FTPServerAfterRemoveDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Directory;  int OperationStatus;
  int reserved;
} FTPServerAfterRemoveDirectoryEventParams;

Unicode (Windows)
virtual INT FireAfterRemoveDirectory(FTPServerAfterRemoveDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Directory;  INT OperationStatus;
  INT reserved;
} FTPServerAfterRemoveDirectoryEventParams;
```

## Remarks

The class fires this event upon completion of a directory removal operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterRemoveFile Event ([FTPServer](#ftpserver-class) Class)

Signals the completion of a file removal operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterRemoveFile(FTPServerAfterRemoveFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int OperationStatus;
  int reserved;
} FTPServerAfterRemoveFileEventParams;

Unicode (Windows)
virtual INT FireAfterRemoveFile(FTPServerAfterRemoveFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  INT OperationStatus;
  INT reserved;
} FTPServerAfterRemoveFileEventParams;
```

## Remarks

The class fires this event upon completion of a file removal operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterRenameFile Event ([FTPServer](#ftpserver-class) Class)

Signals the completion of a file renaming operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterRenameFile(FTPServerAfterRenameFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *OldPath;  const char *NewPath;  int OperationStatus;
  int reserved;
} FTPServerAfterRenameFileEventParams;

Unicode (Windows)
virtual INT FireAfterRenameFile(FTPServerAfterRenameFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR OldPath;  LPCWSTR NewPath;  INT OperationStatus;
  INT reserved;
} FTPServerAfterRenameFileEventParams;
```

## Remarks

The class fires this event upon completion of a file renaming operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AfterRequestAttributes Event ([FTPServer](#ftpserver-class) Class)

Signals the completion of an attribute request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAfterRequestAttributes(FTPServerAfterRequestAttributesEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int OperationStatus;
  int reserved;
} FTPServerAfterRequestAttributesEventParams;

Unicode (Windows)
virtual INT FireAfterRequestAttributes(FTPServerAfterRequestAttributesEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  INT OperationStatus;
  INT reserved;
} FTPServerAfterRequestAttributesEventParams;
```

## Remarks

The class fires this event upon completion of an attribute request. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# AuthAttempt Event ([FTPServer](#ftpserver-class) Class)

Fires when a connected client makes an authentication attempt.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireAuthAttempt(FTPServerAuthAttemptEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Username;  const char *Password;  int Allow;  char *BasePath;
  int reserved;
} FTPServerAuthAttemptEventParams;

Unicode (Windows)
virtual INT FireAuthAttempt(FTPServerAuthAttemptEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Username;  LPCWSTR Password;  BOOL Allow;  LPWSTR BasePath;
  INT reserved;
} FTPServerAuthAttemptEventParams;
```

## Remarks

The class fires this event whenever a client attempts to authenticate itself. Use the *Allow* parameter to let the client through.

The *BasePath* parameter specifies the home directory that will be used for this client. This is taken from the client's record in [Users](#users-property-ftpserver-class), or from [RootDirectory](#rootdirectory-property-ftpserver-class) if the client is not present in the list. You can adjust it in the event handler if required.

*ConnectionID* contains the unique session identifier for that client, and *Username* and *Password* contain the professed credentials.

# BeforeChangeDirectory Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming change directory request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeChangeDirectory(FTPServerBeforeChangeDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Directory;  int Action;
  int reserved;
} FTPServerBeforeChangeDirectoryEventParams;

Unicode (Windows)
virtual INT FireBeforeChangeDirectory(FTPServerBeforeChangeDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Directory;  INT Action;
  INT reserved;
} FTPServerBeforeChangeDirectoryEventParams;
```

## Remarks

The class fires this event to notify the application about a received directory change request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [ChangeDirectory](#changedirectory-event-ftpserver-class) to be notified when to perform the request. It is the [ChangeDirectory](#changedirectory-event-ftpserver-class) event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the [AfterChangeDirectory](#afterchangedirectory-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

# BeforeCreateDirectory Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming create directory request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeCreateDirectory(FTPServerBeforeCreateDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Directory;  int Action;
  int reserved;
} FTPServerBeforeCreateDirectoryEventParams;

Unicode (Windows)
virtual INT FireBeforeCreateDirectory(FTPServerBeforeCreateDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Directory;  INT Action;
  INT reserved;
} FTPServerBeforeCreateDirectoryEventParams;
```

## Remarks

The class fires this event to notify the application about a received MKDIR request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [CreateDirectory](#createdirectory-event-ftpserver-class) to be notified when to perform the request. It is the [CreateDirectory](#createdirectory-event-ftpserver-class) event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the [AfterCreateDirectory](#aftercreatedirectory-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

# BeforeDownloadFile Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming file download request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeDownloadFile(FTPServerBeforeDownloadFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int64 RestartAt;  int Action;
  int reserved;
} FTPServerBeforeDownloadFileEventParams;

Unicode (Windows)
virtual INT FireBeforeDownloadFile(FTPServerBeforeDownloadFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LONG64 RestartAt;  INT Action;
  INT reserved;
} FTPServerBeforeDownloadFileEventParams;
```

## Remarks

The class fires this event to notify the application about a received download request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [DownloadFile](#downloadfile-event-ftpserver-class) to be notified when to perform the request. It is the [DownloadFile](#downloadfile-event-ftpserver-class) event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the [TransferCompleted](#transfercompleted-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

# BeforeFind Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming file listing request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeFind(FTPServerBeforeFindEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Directory;  int Action;
  int reserved;
} FTPServerBeforeFindEventParams;

Unicode (Windows)
virtual INT FireBeforeFind(FTPServerBeforeFindEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Directory;  INT Action;
  INT reserved;
} FTPServerBeforeFindEventParams;
```

## Remarks

The class fires this event to notify the application about a received file listing request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [FindInit](#findinit-event-ftpserver-class), [FindNext](#findnext-event-ftpserver-class), and [FindClose](#findclose-event-ftpserver-class) to be notified when to perform the request. It is the [FindInit](#findinit-event-ftpserver-class) and [FindNext](#findnext-event-ftpserver-class) events handler where you should perform the overridden listing actions.

Upon completion of the request, either in manual or override mode, the [FindClose](#findclose-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

# BeforeRemoveDirectory Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming directory removal request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeRemoveDirectory(FTPServerBeforeRemoveDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Directory;  int Action;
  int reserved;
} FTPServerBeforeRemoveDirectoryEventParams;

Unicode (Windows)
virtual INT FireBeforeRemoveDirectory(FTPServerBeforeRemoveDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Directory;  INT Action;
  INT reserved;
} FTPServerBeforeRemoveDirectoryEventParams;
```

## Remarks

The class fires this event to notify the application about a received directory removal request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [RemoveDirectory](#removedirectory-event-ftpserver-class) to be notified when to perform the request. It is the [RemoveDirectory](#removedirectory-event-ftpserver-class) event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the [AfterRemoveDirectory](#afterremovedirectory-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

# BeforeRemoveFile Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming file removal request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeRemoveFile(FTPServerBeforeRemoveFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int Action;
  int reserved;
} FTPServerBeforeRemoveFileEventParams;

Unicode (Windows)
virtual INT FireBeforeRemoveFile(FTPServerBeforeRemoveFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  INT Action;
  INT reserved;
} FTPServerBeforeRemoveFileEventParams;
```

## Remarks

The class fires this event to notify the application about a received file deletion request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [RemoveFile](#removefile-event-ftpserver-class) to be notified when to perform the request. It is the [RemoveFile](#removefile-event-ftpserver-class) event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the [AfterRemoveFile](#afterremovefile-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

Note that you must subscribe to [BeforeRequestAttributes](#beforerequestattributes-event-ftpserver-class) and [RequestAttributes](#requestattributes-event-ftpserver-class) events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the deletion procedure. In the virtualized case, you can confirm the existence of the file by returning its details from [RequestAttributes](#requestattributes-event-ftpserver-class) call.

# BeforeRenameFile Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming file rename request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeRenameFile(FTPServerBeforeRenameFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *OldPath;  const char *NewPath;  int Action;
  int reserved;
} FTPServerBeforeRenameFileEventParams;

Unicode (Windows)
virtual INT FireBeforeRenameFile(FTPServerBeforeRenameFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR OldPath;  LPCWSTR NewPath;  INT Action;
  INT reserved;
} FTPServerBeforeRenameFileEventParams;
```

## Remarks

The class fires this event to notify the application about a received file rename request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [RenameFile](#renamefile-event-ftpserver-class) to be notified when to perform the request. It is the [RenameFile](#renamefile-event-ftpserver-class) event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the [AfterRenameFile](#afterrenamefile-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

Note that you must subscribe to [BeforeRequestAttributes](#beforerequestattributes-event-ftpserver-class) and [RequestAttributes](#requestattributes-event-ftpserver-class) events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the renaming procedure. In the virtualized case, you can confirm the existence of the file by returning its details from [RequestAttributes](#requestattributes-event-ftpserver-class) call.

# BeforeRequestAttributes Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming attributes request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeRequestAttributes(FTPServerBeforeRequestAttributesEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int Action;
  int reserved;
} FTPServerBeforeRequestAttributesEventParams;

Unicode (Windows)
virtual INT FireBeforeRequestAttributes(FTPServerBeforeRequestAttributesEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  INT Action;
  INT reserved;
} FTPServerBeforeRequestAttributesEventParams;
```

## Remarks

The class fires this event to notify the application about a received attributes request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [RequestAttributes](#requestattributes-event-ftpserver-class) to be notified when to perform the request. It is the [RequestAttributes](#requestattributes-event-ftpserver-class) event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the [AfterRequestAttributes](#afterrequestattributes-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

# BeforeSendReply Event ([FTPServer](#ftpserver-class) Class)

Notifies the application of a command reply being sent.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeSendReply(FTPServerBeforeSendReplyEventParams *e);
typedef struct {  int64 ConnectionID;  int Code;  char *Reply;  const char *Command;
  int reserved;
} FTPServerBeforeSendReplyEventParams;

Unicode (Windows)
virtual INT FireBeforeSendReply(FTPServerBeforeSendReplyEventParams *e);
typedef struct {  LONG64 ConnectionID;  INT Code;  LPWSTR Reply;  LPCWSTR Command;
  INT reserved;
} FTPServerBeforeSendReplyEventParams;
```

## Remarks

The class fires this event to tell the application that a command reply is about to be sent. The *Command* parameter indicates the command that induced the reply, and *Code* and *Reply* indicate the pre-generated response.

You can alter the response parameters in your code to send bespoke replies.

# BeforeUploadFile Event ([FTPServer](#ftpserver-class) Class)

Notifies about an incoming file upload request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeUploadFile(FTPServerBeforeUploadFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int64 RestartAt;  int Append;  int Action;
  int reserved;
} FTPServerBeforeUploadFileEventParams;

Unicode (Windows)
virtual INT FireBeforeUploadFile(FTPServerBeforeUploadFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LONG64 RestartAt;  BOOL Append;  INT Action;
  INT reserved;
} FTPServerBeforeUploadFileEventParams;
```

## Remarks

The class fires this event to notify the application about a received upload request. *ConnectionID* identifies the connected client.

Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to [UploadFile](#uploadfile-event-ftpserver-class) to be notified when to perform the request. It is the [UploadFile](#uploadfile-event-ftpserver-class) event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the [TransferCompleted](#transfercompleted-event-ftpserver-class) event will be fired.

Choose *Action* as one of the following values:

|  |  |  |
| --- | --- | --- |
| fraAuto | 1 | Handle the requested action automatically by the server |
| fraCustom | 2 | Override the action using the user code logic |
| fraAbort | 3 | Abort the requested action |

# ChangeDirectory Event ([FTPServer](#ftpserver-class) Class)

An override for a directory change operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireChangeDirectory(FTPServerChangeDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  char *Directory;  int OperationStatus;
  int reserved;
} FTPServerChangeDirectoryEventParams;

Unicode (Windows)
virtual INT FireChangeDirectory(FTPServerChangeDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPWSTR Directory;  INT OperationStatus;
  INT reserved;
} FTPServerChangeDirectoryEventParams;
```

## Remarks

The class fires this event to let the application perform an overridden directory change operation.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeChangeDirectory](#beforechangedirectory-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by [AfterChangeDirectory](#afterchangedirectory-event-ftpserver-class) call which will let you make final adjustments to the returned code.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# CommandProcessed Event ([FTPServer](#ftpserver-class) Class)

Signals that a command has been processed by the server.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCommandProcessed(FTPServerCommandProcessedEventParams *e);
typedef struct {  int64 ConnectionID;  const char *CurrentDirectory;  const char *Command;  int ReplyCode;
  int reserved;
} FTPServerCommandProcessedEventParams;

Unicode (Windows)
virtual INT FireCommandProcessed(FTPServerCommandProcessedEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR CurrentDirectory;  LPCWSTR Command;  INT ReplyCode;
  INT reserved;
} FTPServerCommandProcessedEventParams;
```

## Remarks

The class fires this event to signal that a command has been processed by the server, and a reply code has been generated.

You can adjust the reply code and the textual comment associated with it in [BeforeSendReply](#beforesendreply-event-ftpserver-class) event handler.

# CommandReceived Event ([FTPServer](#ftpserver-class) Class)

Signals that a command has been received from the client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCommandReceived(FTPServerCommandReceivedEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Command;  const char *Parameters;  int Ignore;
  int reserved;
} FTPServerCommandReceivedEventParams;

Unicode (Windows)
virtual INT FireCommandReceived(FTPServerCommandReceivedEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Command;  LPCWSTR Parameters;  BOOL Ignore;
  INT reserved;
} FTPServerCommandReceivedEventParams;
```

## Remarks

The class fires this event to notify the application of an incoming command. Set *Ignore* to True to stop the server from handling the command.

When the command has been processed, the server will report it via the [CommandProcessed](#commandprocessed-event-ftpserver-class) call.

# Connect Event ([FTPServer](#ftpserver-class) Class)

Reports an accepted connection.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireConnect(FTPServerConnectEventParams *e);
typedef struct {  int64 ConnectionID;  const char *RemoteAddress;  int Port;
  int reserved;
} FTPServerConnectEventParams;

Unicode (Windows)
virtual INT FireConnect(FTPServerConnectEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR RemoteAddress;  INT Port;
  INT reserved;
} FTPServerConnectEventParams;
```

## Remarks

The class fires this event to report that a new connection has been established. *ConnectionId* indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as [AuthAttempt](#authattempt-event-ftpserver-class) or [BeforeUploadFile](#beforeuploadfile-event-ftpserver-class).

# CreateDirectory Event ([FTPServer](#ftpserver-class) Class)

An override for a directory creation operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireCreateDirectory(FTPServerCreateDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  char *Directory;  int OperationStatus;
  int reserved;
} FTPServerCreateDirectoryEventParams;

Unicode (Windows)
virtual INT FireCreateDirectory(FTPServerCreateDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPWSTR Directory;  INT OperationStatus;
  INT reserved;
} FTPServerCreateDirectoryEventParams;
```

## Remarks

The class fires this event to let the application perform an overridden directory creation operation.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeCreateDirectory](#beforecreatedirectory-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by [AfterCreateDirectory](#aftercreatedirectory-event-ftpserver-class) call which will let you make final adjustments to the returned code.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Disconnect Event ([FTPServer](#ftpserver-class) Class)

Fires to report a disconnected client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDisconnect(FTPServerDisconnectEventParams *e);
typedef struct {  int64 ConnectionID;
  int reserved;
} FTPServerDisconnectEventParams;

Unicode (Windows)
virtual INT FireDisconnect(FTPServerDisconnectEventParams *e);
typedef struct {  LONG64 ConnectionID;
  INT reserved;
} FTPServerDisconnectEventParams;
```

## Remarks

The class fires this event when a connected client disconnects.

# DownloadBegin Event ([FTPServer](#ftpserver-class) Class)

The class fires this event to notify the application about the start of a file download.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDownloadBegin(FTPServerDownloadBeginEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;
  int reserved;
} FTPServerDownloadBeginEventParams;

Unicode (Windows)
virtual INT FireDownloadBegin(FTPServerDownloadBeginEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;
  INT reserved;
} FTPServerDownloadBeginEventParams;
```

## Remarks

Subscribe to this event to get notified about the beginning of a file download operation. The requested file is specified via the *Path* property.

# DownloadEnd Event ([FTPServer](#ftpserver-class) Class)

Reports the completion of the download operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDownloadEnd(FTPServerDownloadEndEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;
  int reserved;
} FTPServerDownloadEndEventParams;

Unicode (Windows)
virtual INT FireDownloadEnd(FTPServerDownloadEndEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;
  INT reserved;
} FTPServerDownloadEndEventParams;
```

## Remarks

Use this event to get notified about completion of the early initiated file download operation.

# DownloadFile Event ([FTPServer](#ftpserver-class) Class)

An override for a file download initiation operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDownloadFile(FTPServerDownloadFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int64 RestartAt;  int OperationStatus;
  int reserved;
} FTPServerDownloadFileEventParams;

Unicode (Windows)
virtual INT FireDownloadFile(FTPServerDownloadFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LONG64 RestartAt;  INT OperationStatus;
  INT reserved;
} FTPServerDownloadFileEventParams;
```

## Remarks

The class fires this event to let the application perform an overridden file download initiation operation.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeDownloadFile](#beforedownloadfile-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by a number of [ReadFile](#readfile-event-ftpserver-class) calls, requesting the file data from your code, followed by a single [TransferCompleted](#transfercompleted-event-ftpserver-class) call.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# DownloadProgress Event ([FTPServer](#ftpserver-class) Class)

Reports the progress of an active download operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireDownloadProgress(FTPServerDownloadProgressEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int64 Progress;  int64 Total;
  int reserved;
} FTPServerDownloadProgressEventParams;

Unicode (Windows)
virtual INT FireDownloadProgress(FTPServerDownloadProgressEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LONG64 Progress;  LONG64 Total;
  INT reserved;
} FTPServerDownloadProgressEventParams;
```

## Remarks

Subscribe to this event to be notified about the progress of an active download operation.

The *Path* parameter contains the path to the file being downloaded, and *Progress* and *Total* reflect the operation progress. Note that the *Total* parameter may be set to -1 if the size of the downloaded file is not known.

# Error Event ([FTPServer](#ftpserver-class) Class)

Information about errors during data delivery.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireError(FTPServerErrorEventParams *e);
typedef struct {  int64 ConnectionID;  int ErrorCode;  int Fatal;  int Remote;  const char *Description;
  int reserved;
} FTPServerErrorEventParams;

Unicode (Windows)
virtual INT FireError(FTPServerErrorEventParams *e);
typedef struct {  LONG64 ConnectionID;  INT ErrorCode;  BOOL Fatal;  BOOL Remote;  LPCWSTR Description;
  INT reserved;
} FTPServerErrorEventParams;
```

## Remarks

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

*ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [FTP](#trappable-errors-ftpserver-class) section.

# ExternalSign Event ([FTPServer](#ftpserver-class) Class)

Handles remote or external signing initiated by the server protocol.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireExternalSign(FTPServerExternalSignEventParams *e);
typedef struct {  int64 ConnectionID;  const char *OperationId;  const char *HashAlgorithm;  const char *Pars;  const char *Data;  char *SignedData;
  int reserved;
} FTPServerExternalSignEventParams;

Unicode (Windows)
virtual INT FireExternalSign(FTPServerExternalSignEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR OperationId;  LPCWSTR HashAlgorithm;  LPCWSTR Pars;  LPCWSTR Data;  LPWSTR SignedData;
  INT reserved;
} FTPServerExternalSignEventParams;
```

## Remarks

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

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

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

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

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

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

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

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

# FindClose Event ([FTPServer](#ftpserver-class) Class)

Signals the completion of a directory listing request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireFindClose(FTPServerFindCloseEventParams *e);
typedef struct {  int64 ConnectionID;  int OperationStatus;
  int reserved;
} FTPServerFindCloseEventParams;

Unicode (Windows)
virtual INT FireFindClose(FTPServerFindCloseEventParams *e);
typedef struct {  LONG64 ConnectionID;  INT OperationStatus;
  INT reserved;
} FTPServerFindCloseEventParams;
```

## Remarks

The class fires this event upon completion of a directory listing request. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter.

# FindInit Event ([FTPServer](#ftpserver-class) Class)

An override for a directory listing initiation operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireFindInit(FTPServerFindInitEventParams *e);
typedef struct {  int64 ConnectionID;  char *Directory;  int OperationStatus;
  int reserved;
} FTPServerFindInitEventParams;

Unicode (Windows)
virtual INT FireFindInit(FTPServerFindInitEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPWSTR Directory;  INT OperationStatus;
  INT reserved;
} FTPServerFindInitEventParams;
```

## Remarks

The class fires this event to let the application prepare for directory listing retrieval.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeFind](#beforefind-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by a number of [FindNext](#findnext-event-ftpserver-class) calls, requesting the directory listing entry by entry from your code, followed by a [FindClose](#findclose-event-ftpserver-class) call.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# FindNext Event ([FTPServer](#ftpserver-class) Class)

An override for a directory listing entry request operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireFindNext(FTPServerFindNextEventParams *e);
typedef struct {  int64 ConnectionID;  int OperationStatus;
  int reserved;
} FTPServerFindNextEventParams;

Unicode (Windows)
virtual INT FireFindNext(FTPServerFindNextEventParams *e);
typedef struct {  LONG64 ConnectionID;  INT OperationStatus;
  INT reserved;
} FTPServerFindNextEventParams;
```

## Remarks

The class fires this event in a loop after calling [FindInit](#findinit-event-ftpserver-class) to request one directory entry from the application.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeFind](#beforefind-event-ftpserver-class) event. No default listing operation will be performed by the server component.

Inside the handler, pass the entry details to the server component by tuning up the [ClientFileEntry](#clientfileentry-property-ftpserver-class) object to contain the details of the requested entry, and committing those details to the component with [SetClientFileEntry](#setclientfileentry-method-ftpserver-class) method.

Use the *OperationStatus* parameter to return the operation result back to the server. After submitting all the directory entries to the component, set *OperationStatus* to ostEOF to tell the components that no more entries are left.

This event will be followed by [FindClose](#findclose-event-ftpserver-class) call which will let you make final adjustments to the returned code.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# Notification Event ([FTPServer](#ftpserver-class) Class)

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

## Syntax

```text
ANSI (Cross Platform)
virtual int FireNotification(FTPServerNotificationEventParams *e);
typedef struct {  const char *EventID;  const char *EventParam;
  int reserved;
} FTPServerNotificationEventParams;

Unicode (Windows)
virtual INT FireNotification(FTPServerNotificationEventParams *e);
typedef struct {  LPCWSTR EventID;  LPCWSTR EventParam;
  INT reserved;
} FTPServerNotificationEventParams;
```

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

|  |  |
| --- | --- |
| DownloadProgress | Reports the progress of the current download operation. The EventParam value passed with this EventID is a string of the following format: ConnectionID=3;Path=/dir/file;Progress=2048;Total=16000 |
| UploadProgress | Reports the progress of the current upload operation. The format of EventParam is identical to the one used by the DownloadProgress. |
| DownloadBegin | Indicates the start of the download operation. The EventParam value has the following format: ConnectionID=8;Path=/dir/file |
| UploadBegin | Indicates the start of the upload operation. The EventParam format is the same as with the DownloadBegin event ID. |
| DownloadEnd | Indicates the completion of the download operation. The EventParam value has the following format: ConnectionID=8;Path=/dir/file |
| UploadEnd | Indicates the completion of the upload operation. The EventParam format is the same as with the DownloadEnd event ID. |
| ListeningStarted | Notifies the application that the server has started listening for incoming connections. |
| ListeningStopped | Notifies the application that the server has stopped listening to incoming connections. |

# ReadFile Event ([FTPServer](#ftpserver-class) Class)

Requests a piece of file data from the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireReadFile(FTPServerReadFileEventParams *e);
typedef struct {  int64 ConnectionID;  int Size;  int OperationStatus;
  int reserved;
} FTPServerReadFileEventParams;

Unicode (Windows)
virtual INT FireReadFile(FTPServerReadFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  INT Size;  INT OperationStatus;
  INT reserved;
} FTPServerReadFileEventParams;
```

## Remarks

The class fires this event repeatedly during an overridden download operation to request file data from the application.

The handler of this event should read up to *Size* bytes from the downloaded file, and pass them to the component with a [SetClientBuffer](#setclientbuffer-method-ftpserver-class) call.

Use the *OperationStatus* parameter to return the operation result back to the server. When the file has been read up to its end, set *OperationStatus* to ostEOF to tell the components that no more ReadFile calls are needed.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# RemoveDirectory Event ([FTPServer](#ftpserver-class) Class)

An override for a directory removal operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRemoveDirectory(FTPServerRemoveDirectoryEventParams *e);
typedef struct {  int64 ConnectionID;  char *Directory;  int OperationStatus;
  int reserved;
} FTPServerRemoveDirectoryEventParams;

Unicode (Windows)
virtual INT FireRemoveDirectory(FTPServerRemoveDirectoryEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPWSTR Directory;  INT OperationStatus;
  INT reserved;
} FTPServerRemoveDirectoryEventParams;
```

## Remarks

The class fires this event to let the application perform an overridden directory removal operation.

This event only fires if Action = fraCustom was passed back from [BeforeRemoveDirectory](#beforeremovedirectory-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by [AfterRemoveDirectory](#afterremovedirectory-event-ftpserver-class) call which will let you make final adjustments to the returned code.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# RemoveFile Event ([FTPServer](#ftpserver-class) Class)

An override for a file remove operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRemoveFile(FTPServerRemoveFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int OperationStatus;
  int reserved;
} FTPServerRemoveFileEventParams;

Unicode (Windows)
virtual INT FireRemoveFile(FTPServerRemoveFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  INT OperationStatus;
  INT reserved;
} FTPServerRemoveFileEventParams;
```

## Remarks

The class fires this event to let the application perform an overridden file removal operation.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeRemoveFile](#beforeremovefile-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by [AfterRemoveFile](#afterremovefile-event-ftpserver-class) call which will let you make final adjustments to the returned code.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

Please see a remark about virtualizing file removals in the [BeforeRemoveFile](#beforeremovefile-event-ftpserver-class) topic.

# RenameFile Event ([FTPServer](#ftpserver-class) Class)

An override for a file rename operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRenameFile(FTPServerRenameFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *OldPath;  const char *NewPath;  int OperationStatus;
  int reserved;
} FTPServerRenameFileEventParams;

Unicode (Windows)
virtual INT FireRenameFile(FTPServerRenameFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR OldPath;  LPCWSTR NewPath;  INT OperationStatus;
  INT reserved;
} FTPServerRenameFileEventParams;
```

## Remarks

The class fires this event to let the application perform an overridden file rename operation.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeRenameFile](#beforerenamefile-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by [AfterRenameFile](#afterrenamefile-event-ftpserver-class) call which will let you make final adjustments to the returned code.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

Please see a remark about virtualizing file renamings in the [BeforeRenameFile](#beforerenamefile-event-ftpserver-class) topic.

# RequestAttributes Event ([FTPServer](#ftpserver-class) Class)

An override for an attribute request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRequestAttributes(FTPServerRequestAttributesEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int OperationStatus;
  int reserved;
} FTPServerRequestAttributesEventParams;

Unicode (Windows)
virtual INT FireRequestAttributes(FTPServerRequestAttributesEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  INT OperationStatus;
  INT reserved;
} FTPServerRequestAttributesEventParams;
```

## Remarks

The class fires this event to let the application handle an overridden attribute request operation.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeRequestAttributes](#beforerequestattributes-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by [AfterRequestAttributes](#afterrequestattributes-event-ftpserver-class) call which will let you make final adjustments to the returned code.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# TLSCertValidate Event ([FTPServer](#ftpserver-class) Class)

Fires when a client certificate needs to be validated.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSCertValidate(FTPServerTLSCertValidateEventParams *e);
typedef struct {  int64 ConnectionID;  int Accept;
  int reserved;
} FTPServerTLSCertValidateEventParams;

Unicode (Windows)
virtual INT FireTLSCertValidate(FTPServerTLSCertValidateEventParams *e);
typedef struct {  LONG64 ConnectionID;  BOOL Accept;
  INT reserved;
} FTPServerTLSCertValidateEventParams;
```

## Remarks

The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the *Accept* parameter.

# TLSEstablished Event ([FTPServer](#ftpserver-class) Class)

Reports the setup of a TLS session.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSEstablished(FTPServerTLSEstablishedEventParams *e);
typedef struct {  int64 ConnectionID;
  int reserved;
} FTPServerTLSEstablishedEventParams;

Unicode (Windows)
virtual INT FireTLSEstablished(FTPServerTLSEstablishedEventParams *e);
typedef struct {  LONG64 ConnectionID;
  INT reserved;
} FTPServerTLSEstablishedEventParams;
```

## Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

# TLSHandshake Event ([FTPServer](#ftpserver-class) Class)

Fires when a newly established client connection initiates a TLS handshake.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSHandshake(FTPServerTLSHandshakeEventParams *e);
typedef struct {  int64 ConnectionID;  const char *ServerName;  int Abort;
  int reserved;
} FTPServerTLSHandshakeEventParams;

Unicode (Windows)
virtual INT FireTLSHandshake(FTPServerTLSHandshakeEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR ServerName;  BOOL Abort;
  INT reserved;
} FTPServerTLSHandshakeEventParams;
```

## Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The *ServerName* parameter specifies the requested host from the client hello message.

# TLSPSK Event ([FTPServer](#ftpserver-class) Class)

Requests a pre-shared key for TLS-PSK.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSPSK(FTPServerTLSPSKEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Identity;  char *PSK;  char *Ciphersuite;
  int reserved;
} FTPServerTLSPSKEventParams;

Unicode (Windows)
virtual INT FireTLSPSK(FTPServerTLSPSKEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Identity;  LPWSTR PSK;  LPWSTR Ciphersuite;
  INT reserved;
} FTPServerTLSPSKEventParams;
```

## Remarks

The class fires this event to report that a client has requested a TLS-PSK negotiation. *ConnectionId* indicates the unique connection ID that requested the PSK handshake.

Use *Identity* to look up for the corresponding pre-shared key in the server's database, then assign the key to the *PSK* parameter. If TLS 1.3 PSK is used, you will also need to assign the *Ciphersuite* parameter with the cipher suite associated with that identity and their key.

# TLSShutdown Event ([FTPServer](#ftpserver-class) Class)

Reports closure of a TLS session.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTLSShutdown(FTPServerTLSShutdownEventParams *e);
typedef struct {  int64 ConnectionID;
  int reserved;
} FTPServerTLSShutdownEventParams;

Unicode (Windows)
virtual INT FireTLSShutdown(FTPServerTLSShutdownEventParams *e);
typedef struct {  LONG64 ConnectionID;
  INT reserved;
} FTPServerTLSShutdownEventParams;
```

## Remarks

The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a [Disconnect](#disconnect-event-ftpserver-class), which marks the closure of the underlying TCP session.

# TransferCompleted Event ([FTPServer](#ftpserver-class) Class)

This event is fired when a customized upload or download operation completes.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireTransferCompleted(FTPServerTransferCompletedEventParams *e);
typedef struct {  int64 ConnectionID;  int OperationStatus;
  int reserved;
} FTPServerTransferCompletedEventParams;

Unicode (Windows)
virtual INT FireTransferCompleted(FTPServerTransferCompletedEventParams *e);
typedef struct {  LONG64 ConnectionID;  INT OperationStatus;
  INT reserved;
} FTPServerTransferCompletedEventParams;
```

## Remarks

This event is fired when a customized transfer operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with [BeforeUploadFile](#beforeuploadfile-event-ftpserver-class) or [BeforeDownloadFile](#beforedownloadfile-event-ftpserver-class) event, and with Action parameter set to fraCustom.

The *ConnectionID* parameter specifies the session to which the event belongs, and *OperationStatus* reports the outcome of the transfer operation.

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# UploadBegin Event ([FTPServer](#ftpserver-class) Class)

The server fires this event to notify the application about the start of a file upload operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireUploadBegin(FTPServerUploadBeginEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;
  int reserved;
} FTPServerUploadBeginEventParams;

Unicode (Windows)
virtual INT FireUploadBegin(FTPServerUploadBeginEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;
  INT reserved;
} FTPServerUploadBeginEventParams;
```

## Remarks

Use this event to get notified about the beginning of a file upload operation. The file that is about to be uploaded is specified via the *Path* property.

# UploadEnd Event ([FTPServer](#ftpserver-class) Class)

Reports the completion of the upload operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireUploadEnd(FTPServerUploadEndEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;
  int reserved;
} FTPServerUploadEndEventParams;

Unicode (Windows)
virtual INT FireUploadEnd(FTPServerUploadEndEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;
  INT reserved;
} FTPServerUploadEndEventParams;
```

## Remarks

Use this event to receive notifications about completion of file upload operations.

# UploadFile Event ([FTPServer](#ftpserver-class) Class)

An override for a file upload initiation operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireUploadFile(FTPServerUploadFileEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int64 RestartAt;  int Append;  int OperationStatus;
  int reserved;
} FTPServerUploadFileEventParams;

Unicode (Windows)
virtual INT FireUploadFile(FTPServerUploadFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LONG64 RestartAt;  BOOL Append;  INT OperationStatus;
  INT reserved;
} FTPServerUploadFileEventParams;
```

## Remarks

The class fires this event to let the application perform an overridden file upload initiation operation.

This event only fires if Action = [fraCustom](constants.md#const_fraCustom) was passed back from [BeforeUploadFile](#beforeuploadfile-event-ftpserver-class) event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the *OperationStatus* parameter to return the operation result back to the server.

This event will be followed by a number of [WriteFile](#writefile-event-ftpserver-class) calls, passing the file data to your code, followed by a single [TransferCompleted](#transfercompleted-event-ftpserver-class) call.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

# UploadProgress Event ([FTPServer](#ftpserver-class) Class)

Reports the progress of an active upload operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireUploadProgress(FTPServerUploadProgressEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int64 Progress;  int64 Total;
  int reserved;
} FTPServerUploadProgressEventParams;

Unicode (Windows)
virtual INT FireUploadProgress(FTPServerUploadProgressEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LONG64 Progress;  LONG64 Total;
  INT reserved;
} FTPServerUploadProgressEventParams;
```

## Remarks

Subscribe to this event to be notified about the progress of an active upload operation.

The *Path* parameter specifies the path to the file being uploaded, and *Progress* and *Total* reflect the operation progress. The *Total* parameter may be set to -1 if the size of the uploaded file is not known.

# WriteFile Event ([FTPServer](#ftpserver-class) Class)

Hands a piece of file data to the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireWriteFile(FTPServerWriteFileEventParams *e);
typedef struct {  int64 ConnectionID;  int OperationStatus;
  int reserved;
} FTPServerWriteFileEventParams;

Unicode (Windows)
virtual INT FireWriteFile(FTPServerWriteFileEventParams *e);
typedef struct {  LONG64 ConnectionID;  INT OperationStatus;
  INT reserved;
} FTPServerWriteFileEventParams;
```

## Remarks

The class fires this event repeatedly during an overridden upload operation to pass file data to the application.

The handler of this event should retrieve the pending data buffer with a [GetClientBuffer](#getclientbuffer-method-ftpserver-class) call, and write it to the end of the file that is being uploaded.

Use the *OperationStatus* parameter to return the operation result back to the server.

Set *OperationStatus* to one of the following values:

|  |  |  |
| --- | --- | --- |
| ostOk | 1 |  |
| ostNoSuchFile | 2 |  |
| ostAccessDenied | 3 |  |
| ostWriteProtect | 4 |  |
| ostUnsupported | 5 |  |
| ostInvalidParameter | 6 |  |
| ostEOF | 7 |  |

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

The following fields are available:

- [Bytes](#Certificate_f_Bytes)

- [CA](#Certificate_f_CA)

- [CAKeyID](#Certificate_f_CAKeyID)

- [CertType](#Certificate_f_CertType)

- [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints)

- [Curve](#Certificate_f_Curve)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FriendlyName](#Certificate_f_FriendlyName)

- [Handle](#Certificate_f_Handle)

- [HashAlgorithm](#Certificate_f_HashAlgorithm)

- [Issuer](#Certificate_f_Issuer)

- [IssuerRDN](#Certificate_f_IssuerRDN)

- [KeyAlgorithm](#Certificate_f_KeyAlgorithm)

- [KeyBits](#Certificate_f_KeyBits)

- [KeyFingerprint](#Certificate_f_KeyFingerprint)

- [KeyUsage](#Certificate_f_KeyUsage)

- [KeyValid](#Certificate_f_KeyValid)

- [OCSPLocations](#Certificate_f_OCSPLocations)

- [OCSPNoCheck](#Certificate_f_OCSPNoCheck)

- [Origin](#Certificate_f_Origin)

- [PolicyIDs](#Certificate_f_PolicyIDs)

- [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes)

- [PrivateKeyExists](#Certificate_f_PrivateKeyExists)

- [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable)

- [PublicKeyBytes](#Certificate_f_PublicKeyBytes)

- [Qualified](#Certificate_f_Qualified)

- [QualifiedStatements](#Certificate_f_QualifiedStatements)

- [Qualifiers](#Certificate_f_Qualifiers)

- [SelfSigned](#Certificate_f_SelfSigned)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SigAlgorithm](#Certificate_f_SigAlgorithm)

- [Source](#Certificate_f_Source)

- [Subject](#Certificate_f_Subject)

- [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName)

- [SubjectKeyID](#Certificate_f_SubjectKeyID)

- [SubjectRDN](#Certificate_f_SubjectRDN)

- [Valid](#Certificate_f_Valid)

- [ValidFrom](#Certificate_f_ValidFrom)

- [ValidTo](#Certificate_f_ValidTo)

## Fields

 **Bytes** *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](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

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

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

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

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

```text
  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](#Certificate_f_SigAlgorithm) to find out the hash algorithm that is part of the certificate signature.

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

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

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

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

Returns the length of the public key in bits.

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

 **KeyFingerprint** *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](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

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

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

This value is a bit mask of the following values:

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

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

 **KeyValid** *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](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate.

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

 **OCSPNoCheck** *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](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

 **PrivateKeyExtractable** *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](#Certificate_f_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](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

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

 **SubjectKeyID** *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](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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

```text
Certificate()
```

 Creates a new object with default field values.

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

The following fields are available:

- [AsyncDocumentID](#ExternalCrypto_f_AsyncDocumentID)

- [CustomParams](#ExternalCrypto_f_CustomParams)

- [Data](#ExternalCrypto_f_Data)

- [ExternalHashCalculation](#ExternalCrypto_f_ExternalHashCalculation)

- [HashAlgorithm](#ExternalCrypto_f_HashAlgorithm)

- [KeyID](#ExternalCrypto_f_KeyID)

- [KeySecret](#ExternalCrypto_f_KeySecret)

- [Method](#ExternalCrypto_f_Method)

- [Mode](#ExternalCrypto_f_Mode)

- [PublicKeyAlgorithm](#ExternalCrypto_f_PublicKeyAlgorithm)

## Fields

 **AsyncDocumentID** *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](#ExternalCrypto_f_KeySecret) to pass the key itself.

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

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

Example:

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

 **KeySecret** *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](#ExternalCrypto_f_KeyID) topic.

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

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

Available options:

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

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

Specifies the external cryptography mode.

Available options:

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

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

## Constructors

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

The following fields are available:

- [AccessTime](#FTPListEntry_f_AccessTime)

- [CreationTime](#FTPListEntry_f_CreationTime)

- [EntryFormat](#FTPListEntry_f_EntryFormat)

- [FileType](#FTPListEntry_f_FileType)

- [Handle](#FTPListEntry_f_Handle)

- [ModificationTime](#FTPListEntry_f_ModificationTime)

- [Name](#FTPListEntry_f_Name)

- [Path](#FTPListEntry_f_Path)

- [Principal](#FTPListEntry_f_Principal)

- [Size](#FTPListEntry_f_Size)

- [UnixPerms](#FTPListEntry_f_UnixPerms)

- [UnparsedName](#FTPListEntry_f_UnparsedName)

## Fields

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

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

The file listing format:

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

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

The type of the entry:

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

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

```text
  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

```text
FTPListEntry()
```

 Creates a new FTPListEntry 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.

The following fields are available:

- [DNSMode](#SocketSettings_f_DNSMode)

- [DNSPort](#SocketSettings_f_DNSPort)

- [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout)

- [DNSServers](#SocketSettings_f_DNSServers)

- [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout)

- [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit)

- [LocalAddress](#SocketSettings_f_LocalAddress)

- [LocalPort](#SocketSettings_f_LocalPort)

- [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit)

- [Timeout](#SocketSettings_f_Timeout)

- [UseIPv6](#SocketSettings_f_UseIPv6)

## Fields

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

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

|  |  |
| --- | --- |
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |

 **DNSPort** *int*
*Default Value: 0*

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

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

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

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

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

The following fields are available:

- [AEADCipher](#TLSConnectionInfo_f_AEADCipher)

- [ChainValidationDetails](#TLSConnectionInfo_f_ChainValidationDetails)

- [ChainValidationResult](#TLSConnectionInfo_f_ChainValidationResult)

- [Ciphersuite](#TLSConnectionInfo_f_Ciphersuite)

- [ClientAuthenticated](#TLSConnectionInfo_f_ClientAuthenticated)

- [ClientAuthRequested](#TLSConnectionInfo_f_ClientAuthRequested)

- [ConnectionEstablished](#TLSConnectionInfo_f_ConnectionEstablished)

- [ConnectionID](#TLSConnectionInfo_f_ConnectionID)

- [DigestAlgorithm](#TLSConnectionInfo_f_DigestAlgorithm)

- [EncryptionAlgorithm](#TLSConnectionInfo_f_EncryptionAlgorithm)

- [Exportable](#TLSConnectionInfo_f_Exportable)

- [Group](#TLSConnectionInfo_f_Group)

- [ID](#TLSConnectionInfo_f_ID)

- [KeyExchangeAlgorithm](#TLSConnectionInfo_f_KeyExchangeAlgorithm)

- [KeyExchangeKeyBits](#TLSConnectionInfo_f_KeyExchangeKeyBits)

- [PFSCipher](#TLSConnectionInfo_f_PFSCipher)

- [PreSharedIdentity](#TLSConnectionInfo_f_PreSharedIdentity)

- [PreSharedIdentityHint](#TLSConnectionInfo_f_PreSharedIdentityHint)

- [PublicKeyBits](#TLSConnectionInfo_f_PublicKeyBits)

- [RemoteAddress](#TLSConnectionInfo_f_RemoteAddress)

- [RemotePort](#TLSConnectionInfo_f_RemotePort)

- [ResumedSession](#TLSConnectionInfo_f_ResumedSession)

- [SecureConnection](#TLSConnectionInfo_f_SecureConnection)

- [ServerAuthenticated](#TLSConnectionInfo_f_ServerAuthenticated)

- [SignatureAlgorithm](#TLSConnectionInfo_f_SignatureAlgorithm)

- [SymmetricBlockSize](#TLSConnectionInfo_f_SymmetricBlockSize)

- [SymmetricKeyBits](#TLSConnectionInfo_f_SymmetricKeyBits)

- [TotalBytesReceived](#TLSConnectionInfo_f_TotalBytesReceived)

- [TotalBytesSent](#TLSConnectionInfo_f_TotalBytesSent)

- [ValidationLog](#TLSConnectionInfo_f_ValidationLog)

- [Version](#TLSConnectionInfo_f_Version)

## Fields

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

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

The elliptic curve used in this connection.

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

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

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

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

The following fields are available:

- [AutoValidateCertificates](#TLSSettings_f_AutoValidateCertificates)

- [BaseConfiguration](#TLSSettings_f_BaseConfiguration)

- [Ciphersuites](#TLSSettings_f_Ciphersuites)

- [ClientAuth](#TLSSettings_f_ClientAuth)

- [Extensions](#TLSSettings_f_Extensions)

- [ForceResumeIfDestinationChanges](#TLSSettings_f_ForceResumeIfDestinationChanges)

- [Groups](#TLSSettings_f_Groups)

- [PreSharedIdentity](#TLSSettings_f_PreSharedIdentity)

- [PreSharedKey](#TLSSettings_f_PreSharedKey)

- [PreSharedKeyCiphersuite](#TLSSettings_f_PreSharedKeyCiphersuite)

- [RenegotiationAttackPreventionMode](#TLSSettings_f_RenegotiationAttackPreventionMode)

- [RevocationCheck](#TLSSettings_f_RevocationCheck)

- [SSLOptions](#TLSSettings_f_SSLOptions)

- [TLSMode](#TLSSettings_f_TLSMode)

- [UseExtendedMasterSecret](#TLSSettings_f_UseExtendedMasterSecret)

- [UseSessionResumption](#TLSSettings_f_UseSessionResumption)

- [Versions](#TLSSettings_f_Versions)

## Fields

 **AutoValidateCertificates** *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](#TLSSettings_f_BaseConfiguration). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

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

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

Enables or disables certificate-based client authentication.

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

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

 **Extensions** *char**
*Default Value: ""*

Provides access to TLS extensions.

 **ForceResumeIfDestinationChanges** *int*
*Default Value: FALSE*

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

 **Groups** *char**
*Default Value: ""*

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

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

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

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

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

**Elliptic curve-based groups:**

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

**Finite field-based groups:**

- FFDHE2048
- FFDHE3072
- FFDHE4096
- FFDHE6144
- FFDHE8192

**Post-Quantum and Hybrid groups:**

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

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

 **PreSharedIdentity** *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: TRUE*

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: 48*

The SSL/TLS versions to enable by default.

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

## Constructors

```text
TLSSettings()
```

 Creates a new TLSSettings object.

# UserAccount Type

A container for user account information.

## Syntax

 *SecureBlackboxUserAccount* (declared in *secureblackbox.h*)

## Remarks

UserAccount objects are used to store user account information, such as logins and passwords.

The following fields are available:

- [AssociatedData](#UserAccount_f_AssociatedData)

- [BasePath](#UserAccount_f_BasePath)

- [Certificate](#UserAccount_f_Certificate)

- [Data](#UserAccount_f_Data)

- [Email](#UserAccount_f_Email)

- [Handle](#UserAccount_f_Handle)

- [HashAlgorithm](#UserAccount_f_HashAlgorithm)

- [IncomingSpeedLimit](#UserAccount_f_IncomingSpeedLimit)

- [OtpAlgorithm](#UserAccount_f_OtpAlgorithm)

- [OTPLen](#UserAccount_f_OTPLen)

- [OtpValue](#UserAccount_f_OtpValue)

- [OutgoingSpeedLimit](#UserAccount_f_OutgoingSpeedLimit)

- [Password](#UserAccount_f_Password)

- [SharedSecret](#UserAccount_f_SharedSecret)

- [SSHKey](#UserAccount_f_SSHKey)

- [Username](#UserAccount_f_Username)

## Fields

 **AssociatedData** *char**
*Default Value: *

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

 **BasePath** *char**
*Default Value: ""*

Base path for this user in the server's file system.

 **Certificate** *char**
*Default Value: *

Contains the user's certificate.

 **Data** *char**
*Default Value: ""*

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

 **Email** *char**
*Default Value: ""*

The user's email address.

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

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

 **HashAlgorithm** *char**
*Default Value: ""*

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:

|  |  |  |
| --- | --- | --- |
| SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 |  |
| SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 |  |
| SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 |  |

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

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

 **OtpAlgorithm** *int*
*Default Value: 0*

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.

|  |  |  |
| --- | --- | --- |
| oaHmac | 0 |  |
| oaTime | 1 |  |

 **OTPLen** *int*
*Default Value: 0*

Specifies the length of the user's OTP password.

 **OtpValue** *int*
*Default Value: 0*

The user's time interval (TOTP) or Counter (HOTP).

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

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

 **Password** *char**
*Default Value: ""*

The user's authentication password.

 **SharedSecret** *char**
*Default Value: *

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

 **SSHKey** *char**
*Default Value: *

Contains the user's SSH key.

 **Username** *char**
*Default Value: ""*

The registered name (login) of the user.

## Constructors

```text
UserAccount()
```

 Creates a new UserAccount 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 FTPServer class.

```text
int GetCount() {}
```

```text
int SetCount(int count) {}
```

```text
T* Get(int index) {}
```

```text
T* Set(int index, T* value) {}
```

|  |  |
| --- | --- |
| Methods |  |
| GetCount | This method returns the current size of the collection. |
| 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. |
| 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. |
| 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. |

# Config Settings ([FTPServer](#ftpserver-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-ftpserver-class) method.

### FTPServer Config Settings

**ActiveChannel**: The channel to which the event that is being invoked corresponds.Use this property to find out which channel, command or data, has invoked the current event. This property returns reliable values and should only be checked while inside an event handler. facCmd = 0; facData = 1;

**ClientAuth**: Enables or disables certificate-based client authentication.Set this property to one of the below values to tune up the client authentication logic:

|  |  |  |
| --- | --- | --- |
| 0 |  | No client authentication (the default setting) |
| 1 |  | Request certificates. The server will ask connecting clients for their certificates. Non-authenticated client connections will be accepted anyway. |
| 2 |  | Require certificates. The server will ask connecting clients for their certificates. If a client fails to provide a certificate, the server will terminate the connection. |

If this property is set to 1 or 2, the component will request certificates from the connecting clients. Depending on the setting, the clients that fail to provide their certificate in response will be allowed or disallowed to proceed with the connection. The server signals about a received certificate by firing its CertificateValidate event. Use [PinClient](#pinclient-method-ftpserver-class) method in the event handler to pin the client details, and access the provided certificate chain via the [PinnedClientChain](#pinnedclientchain-property-ftpserver-class) property.

Note that this event is fired from the connecting clients threads, so please make sure you avoid bottlenecks in the event handler and put appropriate thread safety measures in place.

Unlike the client-side components, the server component does not perform automated certificate validation against the local security policy. You must perform appropriate certificate validation steps in your CertificateValidate event handler.

**ControlChannelLog[i]**: Returns the control channel log for a connection.Use this setting to retrieve the control channel log for a particular client connection. Any sensitive data, such as passwords, is returned masked.

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

**DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously.

**MessageTable[i]**: Provides access to error code descriptions.Use this property to get or set textual error code descriptions (e.g. 226 = Transfer Complete).

**RefreshUsers**: Enables or disables real-time propagation of user information.Set this property to true to make the content of the Users property propagate to the server immediately. The default setting is false, which delays the effect of any changes in the Users setting until the server is restarted.

**SecurityOptions**: Facilitates fine-tuning of lower-level security settings.This property is a bit mask offering the following individual parameters:

- cfsoPlainLogin (1)
- cfsoEncryption (2)
- cfsoAuth (4);
- cfsoClearControlChannel (8)
- cfsoClearDataChannel (16)
- cfsoEncryptedDataChannel (32)

 Combine the above parameters to enable or disable certain security aspects of the server.

### Base Config Settings

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

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

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

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

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

Supported values are:

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

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

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

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

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

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

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

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

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

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

Supported Values:

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

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

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

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

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

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

Supported values are:

|  |  |  |
| --- | --- | --- |
| file |  | File |
| console |  | Console |
| systemlog |  | System Log (supported for Android only) |
| debugger |  | Debugger (supported for VCL for Windows and .Net) |

**LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

|  |  |  |
| --- | --- | --- |
| time |  | Current time |
| level |  | Level |
| package |  | Package name |
| module |  | Module name |
| class |  | Class name |
| method |  | Method name |
| threadid |  | Thread Id |
| contenttype |  | Content type |
| content |  | Content |
| all |  | All details |

**LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file.

**LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

|  |  |  |
| --- | --- | --- |
| exclude-package |  | Exclude a package specified in the value |
| exclude-module |  | Exclude a module specified in the value |
| exclude-class |  | Exclude a class specified in the value |
| exclude-method |  | Exclude a method specified in the value |
| include-package |  | Include a package specified in the value |
| include-module |  | Include a module specified in the value |
| include-class |  | Include a class specified in the value |
| include-method |  | Include a method specified in the value |

**LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:

|  |  |  |
| --- | --- | --- |
| none |  | No flush (caching only) |
| immediate |  | Immediate flush (real-time logging) |
| maxcount |  | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |

**LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level.

Supported values are:

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

**LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

**LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:

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

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

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

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

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

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

Supported Values:

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

Example (default value):

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

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

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

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

Example:

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

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

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

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

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

Supported values are:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Syntax:

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

Where:

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

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

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

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER:

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

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

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

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

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

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

# Trappable Errors ([FTPServer](#ftpserver-class) 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.

### FTPServer Errors

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