# WebDAVServer Class

The WebDAVServer class offers server-side functionality for the WebDAV protocol.

## Syntax

```text
WebDAVServer
```

## Remarks

Both plain (HTTP) and secure (HTTPS) connection types are supported.

## 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-webdavserver-class) | Indicates whether the server is active and is listening to new connections. |
| [AuthRealm](#authrealm-property-webdavserver-class) | Specifies authentication realm for digest and NTLM authentication. |
| [AuthTypes](#authtypes-property-webdavserver-class) | Defines allowed HTTP authentication types. |
| [BoundPort](#boundport-property-webdavserver-class) | Indicates the bound listening port. |
| [ClientFileEntry](#clientfileentry-property-webdavserver-class) | A container for current file entry details. |
| [DocumentRoot](#documentroot-property-webdavserver-class) | The document root of the server. |
| [ExternalCrypto](#externalcrypto-property-webdavserver-class) | Provides access to external signing and DC parameters. |
| [FIPSMode](#fipsmode-property-webdavserver-class) | Reserved. |
| [Host](#host-property-webdavserver-class) | The host to bind the listening port to. |
| [MetadataFlushTimeout](#metadataflushtimeout-property-webdavserver-class) | Specifies metadata flush timeout. |
| [MetadataRoot](#metadataroot-property-webdavserver-class) | The metadata directory root. |
| [PinnedClient](#pinnedclient-property-webdavserver-class) | Populates the pinned client details. |
| [PinnedClientChain](#pinnedclientchain-property-webdavserver-class) | Contains the certificate chain of the pinned client. |
| [Port](#port-property-webdavserver-class) | Specifies the port number to listen for connections on. |
| [PortRangeFrom](#portrangefrom-property-webdavserver-class) | Specifies the lower limit of the listening port range for incoming connections. |
| [PortRangeTo](#portrangeto-property-webdavserver-class) | Specifies the upper limit of the listening port range for incoming connections. |
| [SocketSettings](#socketsettings-property-webdavserver-class) | Manages network connection settings. |
| [TLSServerChain](#tlsserverchain-property-webdavserver-class) | The server's TLS certificates. |
| [TLSSettings](#tlssettings-property-webdavserver-class) | Manages TLS layer settings. |
| [Users](#users-property-webdavserver-class) | Provides a list of registered users. |
| [WebsiteName](#websitename-property-webdavserver-class) | Specifies the web site name to use in the certificate. |

## 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-webdavserver-class) | Cleans up the server environment by purging expired sessions and cleaning caches. |
| [Config](#config-method-webdavserver-class) | Sets or retrieves a configuration setting. |
| [DoAction](#doaction-method-webdavserver-class) | Performs an additional action. |
| [DropClient](#dropclient-method-webdavserver-class) | Terminates a client connection. |
| [GetClientBuffer](#getclientbuffer-method-webdavserver-class) | Obtains a pending connection buffer. |
| [GetRequestBytes](#getrequestbytes-method-webdavserver-class) | Returns the contents of the client's HTTP request. |
| [GetRequestHeader](#getrequestheader-method-webdavserver-class) | Returns a request header value. |
| [GetRequestStream](#getrequeststream-method-webdavserver-class) | Returns the contents of the client's HTTP request. |
| [GetRequestString](#getrequeststring-method-webdavserver-class) | Returns the contents of the client's HTTP request. |
| [GetRequestUsername](#getrequestusername-method-webdavserver-class) | Returns the username for a connection. |
| [GetResponseHeader](#getresponseheader-method-webdavserver-class) | Returns a response header value. |
| [ListClients](#listclients-method-webdavserver-class) | Enumerates the connected clients. |
| [PinClient](#pinclient-method-webdavserver-class) | Takes a snapshot of the connection's properties. |
| [ProcessGenericRequest](#processgenericrequest-method-webdavserver-class) | Processes a generic HTTP request. |
| [ProcessGenericRequestStream](#processgenericrequeststream-method-webdavserver-class) | Processes a generic HTTP request from a stream. |
| [Reset](#reset-method-webdavserver-class) | Resets the class settings. |
| [SetClientBuffer](#setclientbuffer-method-webdavserver-class) | Commits a data buffer to the connection. |
| [SetClientFileEntry](#setclientfileentry-method-webdavserver-class) | Commits a file entry to the connection. |
| [SetResponseBytes](#setresponsebytes-method-webdavserver-class) | Sets a byte array to be served as a response. |
| [SetResponseFile](#setresponsefile-method-webdavserver-class) | Sets a file to be served as a response. |
| [SetResponseHeader](#setresponseheader-method-webdavserver-class) | Sets a response header. |
| [SetResponseStatus](#setresponsestatus-method-webdavserver-class) | Sets an HTTP status to be sent with the response. |
| [SetResponseStream](#setresponsestream-method-webdavserver-class) | Sets a stream to be served as a response. |
| [SetResponseString](#setresponsestring-method-webdavserver-class) | Sets a string to be served as a response. |
| [Start](#start-method-webdavserver-class) | Starts the server. |
| [Stop](#stop-method-webdavserver-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-webdavserver-class) | Reports an incoming connection. |
| [AfterBrowse](#afterbrowse-event-webdavserver-class) | WebDAVServer uses this event to notify the application about the completion of the browsing operation. |
| [AfterCopyObject](#aftercopyobject-event-webdavserver-class) | This event notifies the application about the completion of the copy operation. |
| [AfterCreateCalendar](#aftercreatecalendar-event-webdavserver-class) | This event reports the completion of calendar creation request. |
| [AfterCreateCollection](#aftercreatecollection-event-webdavserver-class) | WebDAVServer uses this event to report completion of the collection creation operation. |
| [AfterCustomRequest](#aftercustomrequest-event-webdavserver-class) | This event reports the completion of the custom request. |
| [AfterLockObject](#afterlockobject-event-webdavserver-class) | Reports the completion of the object locking operation. |
| [AfterRefreshLock](#afterrefreshlock-event-webdavserver-class) | Reports the completion of the lock refresh operation. |
| [AfterRemoveObject](#afterremoveobject-event-webdavserver-class) | This event notifies the application about the completion of object deletion operation. |
| [AfterRenameObject](#afterrenameobject-event-webdavserver-class) | The class uses this event to notify the application about the completion of the object rename operation. |
| [AfterSetAttributes](#aftersetattributes-event-webdavserver-class) | WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation. |
| [AfterUnlockObject](#afterunlockobject-event-webdavserver-class) | Notifies the application about the completion of the object unlocking operation. |
| [AuthAttempt](#authattempt-event-webdavserver-class) | Fires when a connected client makes an authentication attempt. |
| [BeforeBrowse](#beforebrowse-event-webdavserver-class) | Fires when a Browse request is received. |
| [BeforeCopyObject](#beforecopyobject-event-webdavserver-class) | Fires when a Copy Object request is received. |
| [BeforeCreateCalendar](#beforecreatecalendar-event-webdavserver-class) | Fires when a Create Calendar request is received from a client. |
| [BeforeCreateCollection](#beforecreatecollection-event-webdavserver-class) | Fires when a Create Collection request is received from a client. |
| [BeforeCustomRequest](#beforecustomrequest-event-webdavserver-class) | Notifies the application about an incoming custom request. |
| [BeforeDownloadObject](#beforedownloadobject-event-webdavserver-class) | Fires when an object download request is received. |
| [BeforeLockObject](#beforelockobject-event-webdavserver-class) | Fires when a lock request is received. |
| [BeforeRefreshLock](#beforerefreshlock-event-webdavserver-class) | Reports the receipt of lock refresh request. |
| [BeforeRemoveObject](#beforeremoveobject-event-webdavserver-class) | Fires when an object deletion request is received. |
| [BeforeRenameObject](#beforerenameobject-event-webdavserver-class) | Reports object renaming requests. |
| [BeforeRequest](#beforerequest-event-webdavserver-class) | Fires before a DAV request is processed. |
| [BeforeSetAttributes](#beforesetattributes-event-webdavserver-class) | Notifies the application about attribute change request. |
| [BeforeUnlockObject](#beforeunlockobject-event-webdavserver-class) | Fires when an unlock request is received. |
| [BeforeUploadObject](#beforeuploadobject-event-webdavserver-class) | Fires when an object upload request is received. |
| [ClearAttribute](#clearattribute-event-webdavserver-class) | Reports an attribute clearance request. |
| [Connect](#connect-event-webdavserver-class) | Reports an accepted connection. |
| [CopyObject](#copyobject-event-webdavserver-class) | Lets the application handle the Copy Object request. |
| [CreateCalendar](#createcalendar-event-webdavserver-class) | Lets the application handle a calendar creation request. |
| [CreateCollection](#createcollection-event-webdavserver-class) | Lets the application respond to collection creation request. |
| [CustomRequest](#customrequest-event-webdavserver-class) | Use this event to respond to non-standard DAV requests. |
| [Data](#data-event-webdavserver-class) | Supplies a data chunk received from a client. |
| [Disconnect](#disconnect-event-webdavserver-class) | Fires to report a disconnected client. |
| [DownloadObject](#downloadobject-event-webdavserver-class) | Allows the application respond to Download Object request. |
| [DownloadObjectCompleted](#downloadobjectcompleted-event-webdavserver-class) | This event is fired when a download operation completes. |
| [Error](#error-event-webdavserver-class) | Information about errors during data delivery. |
| [ExternalSign](#externalsign-event-webdavserver-class) | Handles remote or external signing initiated by the server protocol. |
| [FileError](#fileerror-event-webdavserver-class) | Reports a file access error to the application. |
| [HeadersPrepared](#headersprepared-event-webdavserver-class) | Fires when the response headers have been formed and are ready to be sent to the server. |
| [ListAttributes](#listattributes-event-webdavserver-class) | Requests object attributes from the application in fraCustom handling mode. |
| [ListSubObjects](#listsubobjects-event-webdavserver-class) | Requests a list of sub-objects of an object. The class uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF. |
| [LockObject](#lockobject-event-webdavserver-class) | Virtualizes the object locking operation. |
| [Notification](#notification-event-webdavserver-class) | This event notifies the application about an underlying control flow event. |
| [QueryQuota](#queryquota-event-webdavserver-class) | Reflects a quota enquiry by a client. |
| [ReadAttribute](#readattribute-event-webdavserver-class) | Requests value of an attribute from the application in fraCustom mode. |
| [ReadObject](#readobject-event-webdavserver-class) | Requests a piece of object data from the application. |
| [RefreshLock](#refreshlock-event-webdavserver-class) | Notifies the application about a lock refresh request. |
| [RemoveObject](#removeobject-event-webdavserver-class) | Notifies the application about object deletion requests. |
| [RenameObject](#renameobject-event-webdavserver-class) | Notifies the application about object name change requests. |
| [ResourceAccess](#resourceaccess-event-webdavserver-class) | Reports an attempt to access a resource. |
| [SetAttribute](#setattribute-event-webdavserver-class) | Lets the application customize attribute assignment requests. |
| [TLSCertValidate](#tlscertvalidate-event-webdavserver-class) | Fires when a client certificate needs to be validated. |
| [TLSEstablished](#tlsestablished-event-webdavserver-class) | Reports the setup of a TLS session. |
| [TLSHandshake](#tlshandshake-event-webdavserver-class) | Fires when a newly established client connection initiates a TLS handshake. |
| [TLSPSK](#tlspsk-event-webdavserver-class) | Requests a pre-shared key for TLS-PSK. |
| [TLSShutdown](#tlsshutdown-event-webdavserver-class) | Reports closure of a TLS session. |
| [UnlockObject](#unlockobject-event-webdavserver-class) | Virtualizes the object unlocking operation. |
| [UploadObject](#uploadobject-event-webdavserver-class) | Lets the application respond to the Upload Object request. |
| [UploadObjectCompleted](#uploadobjectcompleted-event-webdavserver-class) | This event is fired when a upload operation completes. |
| [WriteObject](#writeobject-event-webdavserver-class) | Hands a piece of object 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.*

|  |  |
| --- | --- |
| [BoundAddress](#BoundAddress) | Returns the bound address of the listening socket. |
| [BoundPort](#BoundPort) | The port that was bound by the server. |
| [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. |
| [HandshakeTimeout](#HandshakeTimeout) | The HTTPS handshake timeout. |
| [Host](#Host) | The host to bind to. |
| [HTTPStatusCode\[i\]](#HTTPStatusCode[i]) | Provides means to set a custom HTTP status code. |
| [Port](#Port) | The port to listen on. |
| [PortRangeFrom](#PortRangeFrom) | The lower bound of allowed port scope to listen on. |
| [PortRangeTo](#PortRangeTo) | The higher bound of allowed port scope to listen on. |
| [PreSharedIdentityHint](#PreSharedIdentityHint) | Gets or sets the PSK identity hint. |
| [SessionTimeout](#SessionTimeout) | The HTTP session timeout. |
| [SleepLen](#SleepLen) | Adjusts the server loop idling time. |
| [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the class for the current session. |
| [TLSExtensions](#TLSExtensions) | TBD. |
| [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the class. |
| [TLSPeerExtensions](#TLSPeerExtensions) | TBD. |
| [TLSServerCertIndex](#TLSServerCertIndex) | Specifies the index of the server certificate to use. |
| [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the class. |
| [WebsiteName](#WebsiteName) | The website name for the TLS certificate. |
| [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 ([WebDAVServer](#webdavserver-class) Class)

Indicates whether the server is active and is listening to new connections.

## Syntax

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

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

## Default Value

FALSE

## Remarks

This read-only property returns True if the server is listening to incoming connections.

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

## Data Type

Boolean

# AuthRealm Property ([WebDAVServer](#webdavserver-class) Class)

Specifies authentication realm for digest and NTLM authentication.

## Syntax

```text
ANSI (Cross Platform)
char* GetAuthRealm();int SetAuthRealm(const char* lpszAuthRealm);

Unicode (Windows)
LPWSTR GetAuthRealm();INT SetAuthRealm(LPCWSTR lpszAuthRealm);
```

## Default Value

"SecureBlackbox"

## Remarks

Specifies authentication realm for digest and NTLM authentication types.

## Data Type

String

# AuthTypes Property ([WebDAVServer](#webdavserver-class) Class)

Defines allowed HTTP authentication types.

## Syntax

```text
ANSI (Cross Platform)
int GetAuthTypes();int SetAuthTypes(int iAuthTypes);

Unicode (Windows)
INT GetAuthTypes();INT SetAuthTypes(INT iAuthTypes);
```

## Default Value

0

## Remarks

Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags:

|  |  |  |
| --- | --- | --- |
| haBasic | 0x01 | Basic authentication |
| haDigest | 0x02 | Digest authentication (RFC 2617) |
| haNTLM | 0x04 | Windows NTLM authentication |
| haKerberos | 0x08 | Kerberos (Negotiate) authentication |
| haOAuth2 | 0x10 | OAuth2 authentication |

## Data Type

Integer

# BoundPort Property ([WebDAVServer](#webdavserver-class) Class)

Indicates the bound listening port.

## Syntax

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

Unicode (Windows)
INT GetBoundPort();
```

## Default Value

0

## Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals [Port](#port-property-webdavserver-class) if it is provided, or is allocated dynamically if configured to fall in the range between [PortRangeFrom](#portrangefrom-property-webdavserver-class) and [PortRangeTo](#portrangeto-property-webdavserver-class) constraints.

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

## Data Type

Integer

# ClientFileEntry Property ([WebDAVServer](#webdavserver-class) Class)

A container for current file entry details.

## Syntax

```text
SecureBlackboxWebDAVListEntry* GetClientFileEntry();
int SetClientFileEntry(SecureBlackboxWebDAVListEntry* 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-webdavserver-class) method.

This property is not available at design time.

## Data Type

[SecureBlackboxWebDAVListEntry](#webdavlistentry-type)

# DocumentRoot Property ([WebDAVServer](#webdavserver-class) Class)

The document root of the server.

## Syntax

```text
ANSI (Cross Platform)
char* GetDocumentRoot();int SetDocumentRoot(const char* lpszDocumentRoot);

Unicode (Windows)
LPWSTR GetDocumentRoot();INT SetDocumentRoot(LPCWSTR lpszDocumentRoot);
```

## Default Value

""

## Remarks

Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory).

## Data Type

String

# ExternalCrypto Property ([WebDAVServer](#webdavserver-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-webdavserver-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 ([WebDAVServer](#webdavserver-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

# Host Property ([WebDAVServer](#webdavserver-class) Class)

The host to bind the listening port to.

## 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 to incoming connections.

## Data Type

String

# MetadataFlushTimeout Property ([WebDAVServer](#webdavserver-class) Class)

Specifies metadata flush timeout.

## Syntax

```text
ANSI (Cross Platform)
int GetMetadataFlushTimeout();int SetMetadataFlushTimeout(int iMetadataFlushTimeout);

Unicode (Windows)
INT GetMetadataFlushTimeout();INT SetMetadataFlushTimeout(INT iMetadataFlushTimeout);
```

## Default Value

600

## Remarks

Use this property to specify metadata flush timeout in seconds.

## Data Type

Integer

# MetadataRoot Property ([WebDAVServer](#webdavserver-class) Class)

The metadata directory root.

## Syntax

```text
ANSI (Cross Platform)
char* GetMetadataRoot();int SetMetadataRoot(const char* lpszMetadataRoot);

Unicode (Windows)
LPWSTR GetMetadataRoot();INT SetMetadataRoot(LPCWSTR lpszMetadataRoot);
```

## Default Value

""

## Remarks

The metadata directory is a dedicated location for storing properties of the files served by the WebDAVServer.

## Data Type

String

# PinnedClient Property ([WebDAVServer](#webdavserver-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-webdavserver-class) method.

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

## Data Type

[SecureBlackboxTLSConnectionInfo](#tlsconnectioninfo-type)

# PinnedClientChain Property ([WebDAVServer](#webdavserver-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-webdavserver-class) call.

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

## Data Type

[SecureBlackboxCertificate](#certificate-type)

# Port Property ([WebDAVServer](#webdavserver-class) Class)

Specifies the port number to listen for connections on.

## Syntax

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

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

## Default Value

80

## Remarks

Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server.

Alternatively, you may specify the acceptable range of listening ports via [PortRangeFrom](#portrangefrom-property-webdavserver-class) and [PortRangeTo](#portrangeto-property-webdavserver-class) properties. In this case the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-webdavserver-class).

## Data Type

Integer

# PortRangeFrom Property ([WebDAVServer](#webdavserver-class) Class)

Specifies the lower limit of the listening port range for incoming connections.

## Syntax

```text
ANSI (Cross Platform)
int GetPortRangeFrom();int SetPortRangeFrom(int iPortRangeFrom);

Unicode (Windows)
INT GetPortRangeFrom();INT SetPortRangeFrom(INT iPortRangeFrom);
```

## Default Value

0

## Remarks

Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via [Port](#port-property-webdavserver-class)), the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-webdavserver-class).

## Data Type

Integer

# PortRangeTo Property ([WebDAVServer](#webdavserver-class) Class)

Specifies the upper limit of the listening port range for incoming connections.

## Syntax

```text
ANSI (Cross Platform)
int GetPortRangeTo();int SetPortRangeTo(int iPortRangeTo);

Unicode (Windows)
INT GetPortRangeTo();INT SetPortRangeTo(INT iPortRangeTo);
```

## Default Value

0

## Remarks

Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via [Port](#port-property-webdavserver-class)), the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-webdavserver-class).

## Data Type

Integer

# SocketSettings Property ([WebDAVServer](#webdavserver-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 ([WebDAVServer](#webdavserver-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 ([WebDAVServer](#webdavserver-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 ([WebDAVServer](#webdavserver-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 class.

This property is not available at design time.

## Data Type

[SecureBlackboxUserAccount](#useraccount-type)

# WebsiteName Property ([WebDAVServer](#webdavserver-class) Class)

Specifies the web site name to use in the certificate.

## Syntax

```text
ANSI (Cross Platform)
char* GetWebsiteName();int SetWebsiteName(const char* lpszWebsiteName);

Unicode (Windows)
LPWSTR GetWebsiteName();INT SetWebsiteName(LPCWSTR lpszWebsiteName);
```

## Default Value

"SecureBlackbox"

## Remarks

If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'.

## Data Type

String

# Cleanup Method ([WebDAVServer](#webdavserver-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 ([WebDAVServer](#webdavserver-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-webdavserver-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-webdavserver-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 ([WebDAVServer](#webdavserver-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 ([WebDAVServer](#webdavserver-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 ([WebDAVServer](#webdavserver-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 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.

# GetRequestBytes Method ([WebDAVServer](#webdavserver-class) Class)

Returns the contents of the client's HTTP request.

## Syntax

```text
ANSI (Cross Platform)
char* GetRequestBytes(int64 lConnectionId, const char* lpszRequestFilter, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetRequestBytes(LONG64 lConnectionId, LPCWSTR lpszRequestFilter, LPINT lpSize = NULL);
```

## Remarks

Use this method to get the body of the client's HTTP request in your [CustomRequest](#customrequest-event-webdavserver-class) event handler. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

The *RequestFilter* parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

|  |  |
| --- | --- |
| params | Request query parameters only. |
| params[Index] | A specific request parameter, by index. |
| params['Name'] | A specific request parameter, by name. |
| parts[Index] | The body of a particular part of a multipart message. |

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

# GetRequestHeader Method ([WebDAVServer](#webdavserver-class) Class)

Returns a request header value.

## Syntax

```text
ANSI (Cross Platform)
char* GetRequestHeader(int64 lConnectionId, const char* lpszHeaderName);

Unicode (Windows)
LPWSTR GetRequestHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
```

## Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as [BeforeLockObject](#beforelockobject-event-webdavserver-class) or [CustomRequest](#customrequest-event-webdavserver-class).

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

# GetRequestStream Method ([WebDAVServer](#webdavserver-class) Class)

Returns the contents of the client's HTTP request.

## Syntax

```text
ANSI (Cross Platform)
int GetRequestStream(int64 lConnectionId, const char* lpszRequestFilter, SecureBlackboxStream* sOutputStream);

Unicode (Windows)
INT GetRequestStream(LONG64 lConnectionId, LPCWSTR lpszRequestFilter, SecureBlackboxStream* sOutputStream);
```

## Remarks

Use this method to get the body of the client's HTTP request into a stream. Note that the body of GET and HEAD requests is empty.

The *RequestFilter* parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

|  |  |
| --- | --- |
| params | Request query parameters only. |
| params[Index] | A specific request parameter, by index. |
| params['Name'] | A specific request parameter, by name. |
| parts[Index] | The body of a particular part of a multipart message. |

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

# GetRequestString Method ([WebDAVServer](#webdavserver-class) Class)

Returns the contents of the client's HTTP request.

## Syntax

```text
ANSI (Cross Platform)
char* GetRequestString(int64 lConnectionId, const char* lpszRequestFilter);

Unicode (Windows)
LPWSTR GetRequestString(LONG64 lConnectionId, LPCWSTR lpszRequestFilter);
```

## Remarks

Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty.

The *RequestFilter* parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported:

|  |  |
| --- | --- |
| params | Request query parameters only. |
| params[Index] | A specific request parameter, by index. |
| params['Name'] | A specific request parameter, by name. |
| parts[Index] | The body of a particular part of a multipart message. |

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

# GetRequestUsername Method ([WebDAVServer](#webdavserver-class) Class)

Returns the username for a connection.

## Syntax

```text
ANSI (Cross Platform)
char* GetRequestUsername(int64 lConnectionId);

Unicode (Windows)
LPWSTR GetRequestUsername(LONG64 lConnectionId);
```

## Remarks

Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the 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.

# GetResponseHeader Method ([WebDAVServer](#webdavserver-class) Class)

Returns a response header value.

## Syntax

```text
ANSI (Cross Platform)
char* GetResponseHeader(int64 lConnectionId, const char* lpszHeaderName);

Unicode (Windows)
LPWSTR GetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
```

## Remarks

Use this method to get the value of a response header. A good place to call this method is [HeadersPrepared](#headersprepared-event-webdavserver-class) event. Call the method with empty *HeaderName* to get the whole response header.

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

# ListClients Method ([WebDAVServer](#webdavserver-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 ([WebDAVServer](#webdavserver-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-webdavserver-class) and [PinnedClientChain](#pinnedclientchain-property-webdavserver-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.)

# ProcessGenericRequest Method ([WebDAVServer](#webdavserver-class) Class)

Processes a generic HTTP request.

## Syntax

```text
ANSI (Cross Platform)
char* ProcessGenericRequest(int64 lConnectionId, const char* lpRequestBytes, int lenRequestBytes, int *lpSize = NULL);

Unicode (Windows)
LPSTR ProcessGenericRequest(LONG64 lConnectionId, LPCSTR lpRequestBytes, INT lenRequestBytes, LPINT lpSize = NULL);
```

## Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. *ConnectionId* allows to identify the request in the events.

The method returns the complete HTTP response including HTTP headers.

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

# ProcessGenericRequestStream Method ([WebDAVServer](#webdavserver-class) Class)

Processes a generic HTTP request from a stream.

## Syntax

```text
ANSI (Cross Platform)
int ProcessGenericRequestStream(int64 lConnectionId, const char* lpszRequestHeaders, SecureBlackboxStream* sRequestData, SecureBlackboxStream* sResponseData);

Unicode (Windows)
INT ProcessGenericRequestStream(LONG64 lConnectionId, LPCWSTR lpszRequestHeaders, SecureBlackboxStream* sRequestData, SecureBlackboxStream* sResponseData);
```

## Remarks

This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel.

The method expects the request headers in *RequestHeaders*, and the request data is read from *RequestData* stream. Once the request is processed, the response headers are reported through [HeadersPrepared](#headersprepared-event-webdavserver-class) event before any data is written to *ResponseData* stream. *ConnectionId* allows to identify the request in the events.

This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application.

## 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 ([WebDAVServer](#webdavserver-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 ([WebDAVServer](#webdavserver-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 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 ([WebDAVServer](#webdavserver-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-webdavserver-class) property to *ConnectionID* connection. This method is supposed to be used from a FindNext event handler.

Please note that events like FindNext 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-webdavserver-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.)

# SetResponseBytes Method ([WebDAVServer](#webdavserver-class) Class)

Sets a byte array to be served as a response.

## Syntax

```text
ANSI (Cross Platform)
int SetResponseBytes(int64 lConnectionId, const char* lpBytes, int lenBytes, const char* lpszContentType, const char* lpszResponseFilter);

Unicode (Windows)
INT SetResponseBytes(LONG64 lConnectionId, LPCSTR lpBytes, INT lenBytes, LPCWSTR lpszContentType, LPCWSTR lpszResponseFilter);
```

## Remarks

Use this property to provide the response content in a byte array when serving custom requests in your [CustomRequest](#customrequest-event-webdavserver-class) handler. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*:

|  |  |
| --- | --- |
| parts[Index] | The body of a particular part of a multipart response. |

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

# SetResponseFile Method ([WebDAVServer](#webdavserver-class) Class)

Sets a file to be served as a response.

## Syntax

```text
ANSI (Cross Platform)
int SetResponseFile(int64 lConnectionId, const char* lpszFileName, const char* lpszContentType, const char* lpszResponseFilter);

Unicode (Windows)
INT SetResponseFile(LONG64 lConnectionId, LPCWSTR lpszFileName, LPCWSTR lpszContentType, LPCWSTR lpszResponseFilter);
```

## Remarks

Use this property to provide the response content in a file. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*:

|  |  |
| --- | --- |
| parts[Index] | The body of a particular part of a multipart response. |

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

# SetResponseHeader Method ([WebDAVServer](#webdavserver-class) Class)

Sets a response header.

## Syntax

```text
ANSI (Cross Platform)
int SetResponseHeader(int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue);

Unicode (Windows)
INT SetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName, LPCWSTR lpszValue);
```

## Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as [LockObject](#lockobject-event-webdavserver-class) or [CustomRequest](#customrequest-event-webdavserver-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.)

# SetResponseStatus Method ([WebDAVServer](#webdavserver-class) Class)

Sets an HTTP status to be sent with the response.

## Syntax

```text
ANSI (Cross Platform)
int SetResponseStatus(int64 lConnectionId, int iStatusCode);

Unicode (Windows)
INT SetResponseStatus(LONG64 lConnectionId, INT iStatusCode);
```

## Remarks

Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as [CustomRequest](#customrequest-event-webdavserver-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.)

# SetResponseStream Method ([WebDAVServer](#webdavserver-class) Class)

Sets a stream to be served as a response.

## Syntax

```text
ANSI (Cross Platform)
int SetResponseStream(int64 lConnectionId, SecureBlackboxStream* sDataStream, int bCloseStream, const char* lpszContentType, const char* lpszResponseFilter);

Unicode (Windows)
INT SetResponseStream(LONG64 lConnectionId, SecureBlackboxStream* sDataStream, BOOL bCloseStream, LPCWSTR lpszContentType, LPCWSTR lpszResponseFilter);
```

## Remarks

Use this property to provide the response content in a stream. Set *CloseStream* to indicate that the stream should be disposed of once sent. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*:

|  |  |
| --- | --- |
| parts[Index] | The body of a particular part of a multipart response. |

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

# SetResponseString Method ([WebDAVServer](#webdavserver-class) Class)

Sets a string to be served as a response.

## Syntax

```text
ANSI (Cross Platform)
int SetResponseString(int64 lConnectionId, const char* lpszDataStr, const char* lpszContentType, const char* lpszResponseFilter);

Unicode (Windows)
INT SetResponseString(LONG64 lConnectionId, LPCWSTR lpszDataStr, LPCWSTR lpszContentType, LPCWSTR lpszResponseFilter);
```

## Remarks

Use this property to provide the response content in a string. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*:

|  |  |
| --- | --- |
| parts[Index] | The body of a particular part of a multipart response. |

## 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 ([WebDAVServer](#webdavserver-class) Class)

Starts the server.

## Syntax

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

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

## Remarks

Use this method to activate the server and start listening to 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.)

# Stop Method ([WebDAVServer](#webdavserver-class) Class)

Stops the server.

## Syntax

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

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

## Remarks

Call this method to stop listening to incoming connections and 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.)

# Accept Event ([WebDAVServer](#webdavserver-class) Class)

Reports an incoming connection.

## Syntax

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

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

## 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-webdavserver-class) event to be notified of every connection that has been set up.

# AfterBrowse Event ([WebDAVServer](#webdavserver-class) Class)

WebDAVServer uses this event to notify the application about the completion of the browsing operation.

## Syntax

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

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

## Remarks

The *ConnectionID* parameter identifies the client connection, and the *Path* parameter specifies the browsing path.

This event is typically fired after the [BeforeBrowse](#beforebrowse-event-webdavserver-class) event.

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

# AfterCopyObject Event ([WebDAVServer](#webdavserver-class) Class)

This event notifies the application about the completion of the copy operation.

## Syntax

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

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

## Remarks

AfterCopyObject is typically preceded by [BeforeCopyObject](#beforecopyobject-event-webdavserver-class) and [CopyObject](#copyobject-event-webdavserver-class) events. The *OldPath* and *NewPath* parameters contain the origin and destination names of the copied object.

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

# AfterCreateCalendar Event ([WebDAVServer](#webdavserver-class) Class)

This event reports the completion of calendar creation request.

## Syntax

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

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

## Remarks

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

# AfterCreateCollection Event ([WebDAVServer](#webdavserver-class) Class)

WebDAVServer uses this event to report completion of the collection creation operation.

## Syntax

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

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

## Remarks

This event is preceded by [BeforeCreateCollection](#beforecreatecollection-event-webdavserver-class) and [CreateCollection](#createcollection-event-webdavserver-class) events. It lets you alter the operation status passed back to the client.

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

# AfterCustomRequest Event ([WebDAVServer](#webdavserver-class) Class)

This event reports the completion of the custom request.

## Syntax

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

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

## Remarks

Use this event to track the completion of an earlier reported custom request and adjust the operation status through the *OperationStatus* parameter as required.

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

# AfterLockObject Event ([WebDAVServer](#webdavserver-class) Class)

Reports the completion of the object locking operation.

## Syntax

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

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

## Remarks

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

# AfterRefreshLock Event ([WebDAVServer](#webdavserver-class) Class)

Reports the completion of the lock refresh operation.

## Syntax

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

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

## Remarks

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

# AfterRemoveObject Event ([WebDAVServer](#webdavserver-class) Class)

This event notifies the application about the completion of object deletion operation.

## Syntax

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

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

## Remarks

This event follows [BeforeRemoveObject](#beforeremoveobject-event-webdavserver-class) and [RemoveObject](#removeobject-event-webdavserver-class) events. It is fired upon completion of the operation and lets you adjust the operation status if required:

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

# AfterRenameObject Event ([WebDAVServer](#webdavserver-class) Class)

The class uses this event to notify the application about the completion of the object rename operation.

## Syntax

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

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

## Remarks

The *OldPath* and *NewPath* provide the old and new path of the renamed object respectively.

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

# AfterSetAttributes Event ([WebDAVServer](#webdavserver-class) Class)

WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation.

## Syntax

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

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

## Remarks

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

# AfterUnlockObject Event ([WebDAVServer](#webdavserver-class) Class)

Notifies the application about the completion of the object unlocking operation.

## Syntax

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

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

## Remarks

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 ([WebDAVServer](#webdavserver-class) Class)

Fires when a connected client makes an authentication attempt.

## Syntax

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

Unicode (Windows)
virtual INT FireAuthAttempt(WebDAVServerAuthAttemptEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR HTTPMethod;  LPCWSTR URI;  LPCWSTR AuthMethod;  LPCWSTR Username;  LPCWSTR Password;  BOOL Allow;
  INT reserved;
} WebDAVServerAuthAttemptEventParams;
```

## Remarks

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

*ConnectionID* contains the unique session identifier for that client, *HTTPMethod* specifies the HTTP method (GET, POST, etc.) used to access the *URI* resource, *AuthMethod* specifies the authentication method, and *Username* and *Password* contain the professed credentials.

**Note:** In case of OAuth 2.0 authentication, *Password* contains an access token to be validated.

# BeforeBrowse Event ([WebDAVServer](#webdavserver-class) Class)

Fires when a Browse request is received.

## Syntax

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

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

## Remarks

The class uses this event to notify the application that a Browse request has been received from the client. The *Path* parameter contains the path parameter from the 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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a series of events that request the details of the object residing at *Path*: [ListAttributes](#listattributes-event-webdavserver-class), [ListSubObjects](#listsubobjects-event-webdavserver-class), and [ReadAttribute](#readattribute-event-webdavserver-class).

# BeforeCopyObject Event ([WebDAVServer](#webdavserver-class) Class)

Fires when a Copy Object request is received.

## Syntax

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

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

## Remarks

The class fires this event to notify the application that a Copy Object request was received. The *OldPath* and *NewPath* parameters specify the source and destination paths for the object to be copied. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [CopyObject](#copyobject-event-webdavserver-class) call, allowing you to virtualize the copy operation.

# BeforeCreateCalendar Event ([WebDAVServer](#webdavserver-class) Class)

Fires when a Create Calendar request is received from a client.

## Syntax

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

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

## Remarks

The class fires this event to notify the application about a received Create Calendar request. The *Path* parameter specifies the location of the new calendar. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [CreateCalendar](#createcalendar-event-webdavserver-class) call, allowing you to virtualize the calendar creation operation.

# BeforeCreateCollection Event ([WebDAVServer](#webdavserver-class) Class)

Fires when a Create Collection request is received from a client.

## Syntax

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

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

## Remarks

The class uses this event to notify the application about an incoming collection creation request. The *Path* parameter advises on the location of the new collection. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [CreateCollection](#createcollection-event-webdavserver-class) call.

# BeforeCustomRequest Event ([WebDAVServer](#webdavserver-class) Class)

Notifies the application about an incoming custom request.

## Syntax

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

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

## Remarks

The class uses this event to notify the user code about an incoming custom request (a generic request, unknown to the server, and not covered by the other handlers). The *RequestMethod* parameter specifies the HTTP request method used (GET, POST, PUT, ...), and *Path* indicates the requested path. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [CustomRequest](#customrequest-event-webdavserver-class) call, allowing you to respond to the request.

# BeforeDownloadObject Event ([WebDAVServer](#webdavserver-class) Class)

Fires when an object download request is received.

## Syntax

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

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

## Remarks

The class fires this event to notify the application about an incoming object download request. The *Path* parameter contains the path of the requested object. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by [DownloadObject](#downloadobject-event-webdavserver-class), [ReadObject](#readobject-event-webdavserver-class), and [DownloadObjectCompleted](#downloadobjectcompleted-event-webdavserver-class) calls, allowing you to supply the object data to the client.

# BeforeLockObject Event ([WebDAVServer](#webdavserver-class) Class)

Fires when a lock request is received.

## Syntax

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

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

## Remarks

The class uses this event to notify the application that an object lock request was received. The *Path* parameter contains the path to be locked. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [LockObject](#lockobject-event-webdavserver-class) call which expects you to perform the locking as required.

# BeforeRefreshLock Event ([WebDAVServer](#webdavserver-class) Class)

Reports the receipt of lock refresh request.

## Syntax

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

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

## Remarks

Use this event to be notified about refresh requests for existing locks. The *Path* parameter contains the path on which to refresh the lock. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [RefreshLock](#refreshlock-event-webdavserver-class) call, allowing you to virtualize the operation.

# BeforeRemoveObject Event ([WebDAVServer](#webdavserver-class) Class)

Fires when an object deletion request is received.

## Syntax

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

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

## Remarks

Use this event to track object deletion requests. The *Path* parameter contains the path of the object to be deleted. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [RemoveObject](#removeobject-event-webdavserver-class) call, allowing you to virtualize the deletion operation.

# BeforeRenameObject Event ([WebDAVServer](#webdavserver-class) Class)

Reports object renaming requests.

## Syntax

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

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

## Remarks

The server uses this event to notify the application about incoming object rename requests. *OldPath* and *NewPath* contain the existing and the new path for the object. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [RenameObject](#renameobject-event-webdavserver-class) call, where your code is expected to perform the renaming operation.

# BeforeRequest Event ([WebDAVServer](#webdavserver-class) Class)

Fires before a DAV request is processed.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireBeforeRequest(WebDAVServerBeforeRequestEventParams *e);
typedef struct {  int64 ConnectionID;  const char *HTTPMethod;  const char *URL;  int Accept;
  int reserved;
} WebDAVServerBeforeRequestEventParams;

Unicode (Windows)
virtual INT FireBeforeRequest(WebDAVServerBeforeRequestEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR HTTPMethod;  LPCWSTR URL;  BOOL Accept;
  INT reserved;
} WebDAVServerBeforeRequestEventParams;
```

## Remarks

This event fires before an incoming request is processed. *ConnectionID* indicates the client's unique connection ID; *HTTPMethod* specifies the HTTP method being used to submit the request, and *URL* signifies the object's URL.

Use *Accept* parameter to accept or reject the request.

# BeforeSetAttributes Event ([WebDAVServer](#webdavserver-class) Class)

Notifies the application about attribute change request.

## Syntax

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

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

## Remarks

Use this event to react to object attributes change requests. The *Path* parameter contains the object path. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a series of [SetAttribute](#setattribute-event-webdavserver-class) and/or [ClearAttribute](#clearattribute-event-webdavserver-class) calls, for each attribute to be set or cleared.

# BeforeUnlockObject Event ([WebDAVServer](#webdavserver-class) Class)

Fires when an unlock request is received.

## Syntax

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

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

## Remarks

The class uses this event to notify the application about the received unlock request. The *Path* parameter contains the path to be unlocked. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by a [UnlockObject](#unlockobject-event-webdavserver-class) call.

# BeforeUploadObject Event ([WebDAVServer](#webdavserver-class) Class)

Fires when an object upload request is received.

## Syntax

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

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

## Remarks

The class fires this event to notify the application about an incoming object upload request. The *Path* parameter contains the path of the requested object. *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.

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 |

If *fraCustom* Action is chosen, this event will be followed by [UploadObject](#uploadobject-event-webdavserver-class), [WriteObject](#writeobject-event-webdavserver-class), and [UploadObjectCompleted](#uploadobjectcompleted-event-webdavserver-class) calls, allowing your code to process/store the object data.

# ClearAttribute Event ([WebDAVServer](#webdavserver-class) Class)

Reports an attribute clearance request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireClearAttribute(WebDAVServerClearAttributeEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  const char *NS;  const char *Name;  int OperationStatus;
  int reserved;
} WebDAVServerClearAttributeEventParams;

Unicode (Windows)
virtual INT FireClearAttribute(WebDAVServerClearAttributeEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LPCWSTR NS;  LPCWSTR Name;  INT OperationStatus;
  INT reserved;
} WebDAVServerClearAttributeEventParams;
```

## Remarks

This event fires to notify the application about an attribute clearance (removal) request. Use this handler to respond to this request by making the necessary changes to the locally stored resource attributes. The *ConnectionID* specifies the unique client ID, *Path* contains the resource path, and the *NS:Name* pair specifies the attribute to be cleared.

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

# Connect Event ([WebDAVServer](#webdavserver-class) Class)

Reports an accepted connection.

## Syntax

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

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

## Remarks

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 GetRequest or [AuthAttempt](#authattempt-event-webdavserver-class).

# CopyObject Event ([WebDAVServer](#webdavserver-class) Class)

Lets the application handle the Copy Object request.

## Syntax

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

Unicode (Windows)
virtual INT FireCopyObject(WebDAVServerCopyObjectEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR OldPath;  LPCWSTR NewPath;  BOOL Overwrite;  INT Depth;  INT OperationStatus;
  INT reserved;
} WebDAVServerCopyObjectEventParams;
```

## Remarks

Use this event handler to respond to the received Copy Object request by creating a copy of *OldPath* resource at *NewPath*.

*ConnectionID* specifies the unique client connection identifier, *Overwrite* indicates whether any existing resource(s) should be overwritten, and *Depth* specifies the depth of the resource tree to be copied.

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

# CreateCalendar Event ([WebDAVServer](#webdavserver-class) Class)

Lets the application handle a calendar creation request.

## Syntax

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

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

## Remarks

Use this method to respond to a calendar creation request with a custom action. This event fires if *fraCustom* action was returned from the preceding [BeforeCreateCalendar](#beforecreatecalendar-event-webdavserver-class) call.

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

# CreateCollection Event ([WebDAVServer](#webdavserver-class) Class)

Lets the application respond to collection creation request.

## Syntax

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

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

## Remarks

The class uses this event to let the application respond to collection creation requests. This event fires if *fraCustom* action was returned from the preceding [BeforeCreateCollection](#beforecreatecollection-event-webdavserver-class) call. The handler of this event is expected to create a new collection at *Path*.

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

# CustomRequest Event ([WebDAVServer](#webdavserver-class) Class)

Use this event to respond to non-standard DAV requests.

## Syntax

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

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

## Remarks

This event allows the application to respond in a virtualized manner to non-standard DAV requests. It will fire if *fraCustom* action was selected in the earlier [BeforeCustomRequest](#beforecustomrequest-event-webdavserver-class) call.

The *RequestMethod* specifies the HTTP method used for this request (GET, PUT, POST etc.), and the *Path* contains the requested path.

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

# Data Event ([WebDAVServer](#webdavserver-class) Class)

Supplies a data chunk received from a client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireData(WebDAVServerDataEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Buffer;
  int lenBuffer;
  int reserved;
} WebDAVServerDataEventParams;

Unicode (Windows)
virtual INT FireData(WebDAVServerDataEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCSTR Buffer;
  INT lenBuffer;
  INT reserved;
} WebDAVServerDataEventParams;
```

## Remarks

This event is fired to supply another piece of data received from a client. This event may fire multiple times.

# Disconnect Event ([WebDAVServer](#webdavserver-class) Class)

Fires to report a disconnected client.

## Syntax

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

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

## Remarks

class fires this event when a connected client disconnects.

# DownloadObject Event ([WebDAVServer](#webdavserver-class) Class)

Allows the application respond to Download Object request.

## Syntax

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

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

## Remarks

Use this event to implement custom handler of the Download operation. This event is followed by a series of [ReadObject](#readobject-event-webdavserver-class) calls, which are then followed by [DownloadObjectCompleted](#downloadobjectcompleted-event-webdavserver-class) that signifies completion of the transfer 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 |  |

# DownloadObjectCompleted Event ([WebDAVServer](#webdavserver-class) Class)

This event is fired when a download operation completes.

## Syntax

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

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

## Remarks

This event is fired when a download operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeDownloadFile 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 |  |

# Error Event ([WebDAVServer](#webdavserver-class) Class)

Information about errors during data delivery.

## Syntax

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

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

## 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 [HTTPS](#trappable-errors-webdavserver-class) section.

# ExternalSign Event ([WebDAVServer](#webdavserver-class) Class)

Handles remote or external signing initiated by the server protocol.

## Syntax

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

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

## 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();
};
```

# FileError Event ([WebDAVServer](#webdavserver-class) Class)

Reports a file access error to the application.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireFileError(WebDAVServerFileErrorEventParams *e);
typedef struct {  int64 ConnectionID;  const char *FileName;  int ErrorCode;
  int reserved;
} WebDAVServerFileErrorEventParams;

Unicode (Windows)
virtual INT FireFileError(WebDAVServerFileErrorEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR FileName;  INT ErrorCode;
  INT reserved;
} WebDAVServerFileErrorEventParams;
```

## Remarks

class uses this event to report a file access errors. *FileName* and *ErrorCode* contain the file path and the error code respectively.

# HeadersPrepared Event ([WebDAVServer](#webdavserver-class) Class)

Fires when the response headers have been formed and are ready to be sent to the server.

## Syntax

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

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

## Remarks

The class fires this event when the response headers are ready to be sent to the server. *ConnectionID* indicates the connection that processed the request.

Use [GetResponseHeader](#getresponseheader-method-webdavserver-class) method with an empty header name to get the whole response header.

# ListAttributes Event ([WebDAVServer](#webdavserver-class) Class)

Requests object attributes from the application in fraCustom handling mode.

## Syntax

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

Unicode (Windows)
virtual INT FireListAttributes(WebDAVServerListAttributesEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LPWSTR Attributes;
  INT reserved;
} WebDAVServerListAttributesEventParams;
```

## Remarks

The class uses this event to request a set of attributes supported/kept for the object at *Path*. Return the list via the *Attributes* parameter as a string of CRLF-separated attribute names.

After firing this event, the class may request values for individual attributes via a series of [ReadAttribute](#readattribute-event-webdavserver-class) calls.

This event only fires if *fraCustom* action type was returned from the preceding [BeforeBrowse](#beforebrowse-event-webdavserver-class) event call.

# ListSubObjects Event ([WebDAVServer](#webdavserver-class) Class)

Requests a list of sub-objects of an object. The class uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireListSubObjects(WebDAVServerListSubObjectsEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  int Recursive;  char *Objects;  int OperationStatus;
  int reserved;
} WebDAVServerListSubObjectsEventParams;

Unicode (Windows)
virtual INT FireListSubObjects(WebDAVServerListSubObjectsEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  BOOL Recursive;  LPWSTR Objects;  INT OperationStatus;
  INT reserved;
} WebDAVServerListSubObjectsEventParams;
```

## Remarks

Set the status of the operation through the *OperationStatus* parameter as required:

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

# LockObject Event ([WebDAVServer](#webdavserver-class) Class)

Virtualizes the object locking operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireLockObject(WebDAVServerLockObjectEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  const char *Owner;  int Exclusive;  int Depth;  int64 Timeout;  char *Token;
  int reserved;
} WebDAVServerLockObjectEventParams;

Unicode (Windows)
virtual INT FireLockObject(WebDAVServerLockObjectEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LPCWSTR Owner;  BOOL Exclusive;  INT Depth;  LONG64 Timeout;  LPWSTR Token;
  INT reserved;
} WebDAVServerLockObjectEventParams;
```

## Remarks

The class uses this event to request a lock on the object at *Path* from the application. This event is only fired if *fraCustom* action was returned from the preceding [BeforeLockObject](#beforelockobject-event-webdavserver-class) call.

The *Owner*, *Exclusive*, *Depth*, and *Timeout* parameters specify the respective parameters of the requested lock. In response to this event, generate a lock token and return it via the *Token* parameter.

# Notification Event ([WebDAVServer](#webdavserver-class) Class)

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

## Syntax

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

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

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

# QueryQuota Event ([WebDAVServer](#webdavserver-class) Class)

Reflects a quota enquiry by a client.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireQueryQuota(WebDAVServerQueryQuotaEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Username;  int64 *pAvailable;  int64 *pUsed;
  int reserved;
} WebDAVServerQueryQuotaEventParams;

Unicode (Windows)
virtual INT FireQueryQuota(WebDAVServerQueryQuotaEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Username;  LONG64 *pAvailable;  LONG64 *pUsed;
  INT reserved;
} WebDAVServerQueryQuotaEventParams;
```

## Remarks

This event fires in response to a client's enquire about their quota status. Subscribe to this event to react to such enquiries in a customized manner. Use *Available* and *Used* properties to report the respective amounts back to the client.

# ReadAttribute Event ([WebDAVServer](#webdavserver-class) Class)

Requests value of an attribute from the application in fraCustom mode.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireReadAttribute(WebDAVServerReadAttributeEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  const char *NS;  const char *Name;  char *Value;  int OperationStatus;
  int reserved;
} WebDAVServerReadAttributeEventParams;

Unicode (Windows)
virtual INT FireReadAttribute(WebDAVServerReadAttributeEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LPCWSTR NS;  LPCWSTR Name;  LPWSTR Value;  INT OperationStatus;
  INT reserved;
} WebDAVServerReadAttributeEventParams;
```

## Remarks

The class fires this event to request value of the *NS:Name* attribute of the object residing at *Path*. In the event handler, pass the attribute value via the *Value* parameter and set *OperationStatus* as required.

This event only fires if *fraCustom* action type was returned from the preceding [BeforeBrowse](#beforebrowse-event-webdavserver-class) event call.

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

# ReadObject Event ([WebDAVServer](#webdavserver-class) Class)

Requests a piece of object data from the application.

## Syntax

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

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

## Remarks

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

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

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

# RefreshLock Event ([WebDAVServer](#webdavserver-class) Class)

Notifies the application about a lock refresh request.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireRefreshLock(WebDAVServerRefreshLockEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  const char *Token;  int64 Timeout;  int LockFound;
  int reserved;
} WebDAVServerRefreshLockEventParams;

Unicode (Windows)
virtual INT FireRefreshLock(WebDAVServerRefreshLockEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LPCWSTR Token;  LONG64 Timeout;  BOOL LockFound;
  INT reserved;
} WebDAVServerRefreshLockEventParams;
```

## Remarks

The class uses this event to request extension of a lock on the object at *Path*. This event only fires if *fraCustom* action was returned from the preceding [BeforeRefreshLock](#beforerefreshlock-event-webdavserver-class) call.

In response to this event, check the validity of the provided *Token* for the object at *Path*, and extend the lock by *Timeout* milliseconds if the values match. Set the *LockFound* result as required.

# RemoveObject Event ([WebDAVServer](#webdavserver-class) Class)

Notifies the application about object deletion requests.

## Syntax

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

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

## Remarks

The class uses this event to notify the application about an incoming deletion request for the object at *Path*. This event only fires if *fraCustom* action was returned from the preceding [BeforeRemoveObject](#beforeremoveobject-event-webdavserver-class) call.

The handler of this event should remove the object, if appropriate, and set the *OperationStatus* parameter to signify the actual operation result.

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

# RenameObject Event ([WebDAVServer](#webdavserver-class) Class)

Notifies the application about object name change requests.

## Syntax

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

Unicode (Windows)
virtual INT FireRenameObject(WebDAVServerRenameObjectEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR OldPath;  LPCWSTR NewPath;  BOOL Overwrite;  INT OperationStatus;
  INT reserved;
} WebDAVServerRenameObjectEventParams;
```

## Remarks

The class uses this event to notify the application about an incoming rename request for the object at *OldPath*. The *Overwrite* parameter advises whether any objects currently existing at *NewPath* should be overwritten. This event only fires if *fraCustom* action was returned from the preceding [BeforeRenameObject](#beforerenameobject-event-webdavserver-class) call.

The handler of this event should rename the object to *NewPath* (if appropriate) and set the *OperationStatus* parameter to signify the actual operation result.

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

# ResourceAccess Event ([WebDAVServer](#webdavserver-class) Class)

Reports an attempt to access a resource.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireResourceAccess(WebDAVServerResourceAccessEventParams *e);
typedef struct {  int64 ConnectionID;  const char *HTTPMethod;  const char *URI;  int Allow;  char *RedirectURI;
  int reserved;
} WebDAVServerResourceAccessEventParams;

Unicode (Windows)
virtual INT FireResourceAccess(WebDAVServerResourceAccessEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR HTTPMethod;  LPCWSTR URI;  BOOL Allow;  LPWSTR RedirectURI;
  INT reserved;
} WebDAVServerResourceAccessEventParams;
```

## Remarks

The class fires this event to notify the application about a request received from the client. The *HTTPMethod* parameter indicates the HTTP method used (GET, POST, etc.)

*ConnectionID* indicates the connection that sent the request and *URI* suggests the requested resource.

Set *Allow* to false to prevent the client from accessing the resource. The class will automatically send a "forbidden" status code (403).

Set a non-empty value to *RedirectURI* to notify the client that the resource has moved to another place. The class will automatically send a "found" status code (302). If *Allow* is set to false, the value of *RedirectURI* is ignored.

# SetAttribute Event ([WebDAVServer](#webdavserver-class) Class)

Lets the application customize attribute assignment requests.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireSetAttribute(WebDAVServerSetAttributeEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  const char *NS;  const char *Name;  const char *Value;  int OperationStatus;
  int reserved;
} WebDAVServerSetAttributeEventParams;

Unicode (Windows)
virtual INT FireSetAttribute(WebDAVServerSetAttributeEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LPCWSTR NS;  LPCWSTR Name;  LPCWSTR Value;  INT OperationStatus;
  INT reserved;
} WebDAVServerSetAttributeEventParams;
```

## Remarks

The class uses this event to pass attribute assignment requests to the application. This event may fire multiple times after a [BeforeSetAttributes](#beforesetattributes-event-webdavserver-class) call, one for each attribute, if *fraCustom* action was chosen.

In the handler of this event, assign *Value* to the attribute *NS:Name* of the object at *Path*. Set *OperationStatus* in accordance with the outcome of the operation.

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

# TLSCertValidate Event ([WebDAVServer](#webdavserver-class) Class)

Fires when a client certificate needs to be validated.

## Syntax

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

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

## Remarks

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 ([WebDAVServer](#webdavserver-class) Class)

Reports the setup of a TLS session.

## Syntax

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

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

## Remarks

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

# TLSHandshake Event ([WebDAVServer](#webdavserver-class) Class)

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

## Syntax

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

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

## 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 ([WebDAVServer](#webdavserver-class) Class)

Requests a pre-shared key for TLS-PSK.

## Syntax

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

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

## 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 ([WebDAVServer](#webdavserver-class) Class)

Reports closure of a TLS session.

## Syntax

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

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

## 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-webdavserver-class), which marks the closure of the underlying TCP session.

# UnlockObject Event ([WebDAVServer](#webdavserver-class) Class)

Virtualizes the object unlocking operation.

## Syntax

```text
ANSI (Cross Platform)
virtual int FireUnlockObject(WebDAVServerUnlockObjectEventParams *e);
typedef struct {  int64 ConnectionID;  const char *Path;  const char *Token;  int LockFound;
  int reserved;
} WebDAVServerUnlockObjectEventParams;

Unicode (Windows)
virtual INT FireUnlockObject(WebDAVServerUnlockObjectEventParams *e);
typedef struct {  LONG64 ConnectionID;  LPCWSTR Path;  LPCWSTR Token;  BOOL LockFound;
  INT reserved;
} WebDAVServerUnlockObjectEventParams;
```

## Remarks

The class uses this event to notify the application of the incoming unlock request. This event only fires if *fraCustom* action was returned from the preceding [BeforeUnlockObject](#beforeunlockobject-event-webdavserver-class) call.

In response to this event, check the validity of the provided *Token* for the object at *Path*, and cancel the lock if the values match. Set the *LockFound* result as required.

# UploadObject Event ([WebDAVServer](#webdavserver-class) Class)

Lets the application respond to the Upload Object request.

## Syntax

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

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

## Remarks

Use this event handler to respond to the received Upload Object request by reserving a place for the new object at *Path*. This event, if *OperationStatus* allows, will be followed by a series of [WriteObject](#writeobject-event-webdavserver-class) calls, passing object data in chunks, before a [UploadObjectCompleted](#uploadobjectcompleted-event-webdavserver-class) call signals completion of the upload 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 |  |

# UploadObjectCompleted Event ([WebDAVServer](#webdavserver-class) Class)

This event is fired when a upload operation completes.

## Syntax

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

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

## Remarks

This event is fired when a upload operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeUploadFile 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 |  |

# WriteObject Event ([WebDAVServer](#webdavserver-class) Class)

Hands a piece of object data to the application.

## Syntax

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

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

## Remarks

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

The handler of this event should retrieve the pending data buffer with a [GetClientBuffer](#getclientbuffer-method-webdavserver-class) call, and write it to the end of the object 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.

# 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

# WebDAVListEntry Type

Contains a set of attributes of a single WebDAV object.

## Syntax

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

## Remarks

This type represents a single entry returned by the list command.

The following fields are available:

- [ATime](#WebDAVListEntry_f_ATime)

- [ContentType](#WebDAVListEntry_f_ContentType)

- [CTime](#WebDAVListEntry_f_CTime)

- [Directory](#WebDAVListEntry_f_Directory)

- [DisplayName](#WebDAVListEntry_f_DisplayName)

- [ETag](#WebDAVListEntry_f_ETag)

- [FullURL](#WebDAVListEntry_f_FullURL)

- [MTime](#WebDAVListEntry_f_MTime)

- [ParentURL](#WebDAVListEntry_f_ParentURL)

- [Size](#WebDAVListEntry_f_Size)

- [SupportsExclusiveLock](#WebDAVListEntry_f_SupportsExclusiveLock)

- [SupportsSharedLock](#WebDAVListEntry_f_SupportsSharedLock)

- [URL](#WebDAVListEntry_f_URL)

## Fields

 **ATime** *char**
*Default Value: ""*

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

 **ContentType** *char**
*Default Value: ""*

The object's content type.

 **CTime** *char**
*Default Value: ""*

Contains this object's creation time, in UTC.

 **Directory** *int*
*Default Value: FALSE*

Specifies whether this object is a directory.

 **DisplayName** *char**
*Default Value: ""*

Contains the display name of the object.

 **ETag** *char**
*Default Value: ""*

An e-tag of the object.

 **FullURL** *char**
*Default Value: ""*

A full path to the object.

 **MTime** *char**
*Default Value: ""*

The last modification time of the object, in UTC.

 **ParentURL** *char**
*Default Value: ""*

Specifies the object's parent URL.

 **Size** *int64*
*Default Value: 0*

The size of the object in bytes.

 **SupportsExclusiveLock** *int*
*Default Value: FALSE*

Indicates whether the entry supports exclusive locking.

 **SupportsSharedLock** *int*
*Default Value: FALSE*

Indicates whether the entry supports shared lock.

 **URL** *char**
*Default Value: ""*

A URL of the object.

## Constructors

```text
WebDAVListEntry()
```

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

# SecureBlackboxStream Type

## Syntax

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

## Remarks

 The WebDAVServer class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the WebDAVServer class an instance of that concrete class.

 When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

```text
bool CanRead() { return true; }
```

```text
bool CanSeek() { return true; }
```

```text
bool CanWrite() { return true; }
```

```text
int64 GetLength() = 0;
```

```text
void Close() {}
```

```text
int Flush() { return 0; }
```

```text
int Read(void* buffer, int count) = 0;
```

```text
int64 Seek(int64 offset, int seekOrigin) = 0;
```

```text
int Write(const void* buffer, int count) = 0;
```

|  |  |
| --- | --- |
| Properties |  |
| CanRead | Whether the stream supports reading. |
| CanSeek | Whether the stream supports seeking. |
| CanWrite | Whether the stream supports writing. |
| Length | Gets the length of the stream, in bytes. |
| Methods |  |
| Close | Closes the stream, releasing all resources currently allocated for it. This method is called automatically when a SecureBlackboxStream object is deleted. |
| Flush | Forces all data held by the stream's buffers to be written out to storage. Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read | Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek | Sets the current position within the stream based on a particular point of origin. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write | Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |

# Config Settings ([WebDAVServer](#webdavserver-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-webdavserver-class) method.

### WebDAVServer Config Settings

**BoundAddress**: Returns the bound address of the listening socket.Use this property to obtain the bound address of the listening socket.

**BoundPort**: The port that was bound by the server.Returns the port number that was bound by the server.

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

**HandshakeTimeout**: The HTTPS handshake timeout.The HTTPS handshake timeout in milliseconds.

**Host**: The host to bind to.Specifies a specific interface the server should listen on.

**HTTPStatusCode[i]**: Provides means to set a custom HTTP status code.Use this indexed property to set a custom HTTP status code for a specific client.

**Port**: The port to listen on.This config setting mimics the Port property. Please use that instead.

**PortRangeFrom**: The lower bound of allowed port scope to listen on.Specifies the lowest port number the server may use if dynamic allocation is used.

**PortRangeTo**: The higher bound of allowed port scope to listen on.Specifies the highest port number the server may use if dynamic allocation is used.

**PreSharedIdentityHint**: Gets or sets the PSK identity hint.Use this property to get or set the PSK identity hint to be used during PSK-based TLS handshake.

**SessionTimeout**: The HTTP session timeout.The HTTP session timeout in milliseconds.

**SleepLen**: Adjusts the server loop idling time.Use this property to adjust the server connection loop idling time between consecutive connection read calls. Increasing this setting may help combat excessive CPU usage in performance-restricted or busy environments. Setting it to zero removes the idling altogether, which maximizes the throughput but may cause excessive CPU load.

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

**TLSExtensions**: TBD.TBD

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

**TLSPeerExtensions**: TBD.TBD

**TLSServerCertIndex**: Specifies the index of the server certificate to use.This setting allows your code to specify the exact certificate/chain to use for the TLS handshake that has just commenced, if your server is configured with more than one chain. This property should typically be adjusted from within the OnTLSHandshake event handler.

Note: the server component normally picks up the most appropriate certificate automatically. This setting is a wiretap for scenarios where unusual or cherry-picked certificate selection logic may be necessary.

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

**WebsiteName**: The website name for the TLS certificate.Assign this property with a name to put in a self-generated TLS certificate.

### 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 ([WebDAVServer](#webdavserver-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.

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