WebDAVServer Class
Properties Methods Events Config Settings Errors
The WebDAVServer class offers server-side functionality for the WebDAV protocol.
Syntax
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 | Indicates whether the server is active and is listening to new connections. |
AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
AuthTypes | Defines allowed HTTP authentication types. |
BoundPort | Indicates the bound listening port. |
ClientFileEntry | A container for current file entry details. |
DocumentRoot | The document root of the server. |
ExternalCrypto | Provides access to external signing and DC parameters. |
FIPSMode | Reserved. |
Host | The host to bind the listening port to. |
MetadataFlushTimeout | Specifies metadata flush timeout. |
MetadataRoot | The metadata directory root. |
PinnedClient | Populates the pinned client details. |
PinnedClientChain | Contains the certificate chain of the pinned client. |
Port | Specifies the port number to listen for connections on. |
PortRangeFrom | Specifies the lower limit of the listening port range for incoming connections. |
PortRangeTo | Specifies the upper limit of the listening port range for incoming connections. |
SocketSettings | Manages network connection settings. |
TLSServerChain | The server's TLS certificates. |
TLSSettings | Manages TLS layer settings. |
Users | Provides a list of registered users. |
WebsiteName | 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 | Cleans up the server environment by purging expired sessions and cleaning caches. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
DropClient | Terminates a client connection. |
GetClientBuffer | Obtains a pending connection buffer. |
GetRequestBytes | Returns the contents of the client's HTTP request. |
GetRequestHeader | Returns a request header value. |
GetRequestStream | Returns the contents of the client's HTTP request. |
GetRequestString | Returns the contents of the client's HTTP request. |
GetRequestUsername | Returns the username for a connection. |
GetResponseHeader | Returns a response header value. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
ProcessGenericRequest | Processes a generic HTTP request. |
ProcessGenericRequestStream | Processes a generic HTTP request from a stream. |
Reset | Resets the class settings. |
SetClientBuffer | Commits a data buffer to the connection. |
SetClientFileEntry | Commits a file entry to the connection. |
SetResponseBytes | Sets a byte array to be served as a response. |
SetResponseFile | Sets a file to be served as a response. |
SetResponseHeader | Sets a response header. |
SetResponseStatus | Sets an HTTP status to be sent with the response. |
SetResponseStream | Sets a stream to be served as a response. |
SetResponseString | Sets a string to be served as a response. |
Start | Starts the server. |
Stop | 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 | Reports an incoming connection. |
AfterBrowse | WebDAVServer uses this event to notify the application about the completion of the browsing operation. |
AfterCopyObject | This event notifies the application about the completion of the copy operation. |
AfterCreateCalendar | This event reports the completion of calendar creation request. |
AfterCreateCollection | WebDAVServer uses this event to report completion of the collection creation operation. |
AfterCustomRequest | This event reports the completion of the custom request. |
AfterLockObject | Reports the completion of the object locking operation. |
AfterRefreshLock | Reports the completion of the lock refresh operation. |
AfterRemoveObject | This event notifies the application about the completion of object deletion operation. |
AfterRenameObject | The class uses this event to notify the application about the completion of the object rename operation. |
AfterSetAttributes | WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation. |
AfterUnlockObject | Notifies the application about the completion of the object unlocking operation. |
AuthAttempt | Fires when a connected client makes an authentication attempt. |
BeforeBrowse | Fires when a Browse request is received. |
BeforeCopyObject | Fires when a Copy Object request is received. |
BeforeCreateCalendar | Fires when a Create Calendar request is received from a client. |
BeforeCreateCollection | Fires when a Create Collection request is received from a client. |
BeforeCustomRequest | Notifies the application about an incoming custom request. |
BeforeDownloadObject | Fires when an object download request is received. |
BeforeLockObject | Fires when a lock request is received. |
BeforeRefreshLock | Reports the receipt of lock refresh request. |
BeforeRemoveObject | Fires when an object deletion request is received. |
BeforeRenameObject | Reports object renaming requests. |
BeforeRequest | Fires before a DAV request is processed. |
BeforeSetAttributes | Notifies the application about attribute change request. |
BeforeUnlockObject | Fires when an unlock request is received. |
BeforeUploadObject | Fires when an object upload request is received. |
ClearAttribute | Reports an attribute clearance request. |
Connect | Reports an accepted connection. |
CopyObject | Lets the application handle the Copy Object request. |
CreateCalendar | Lets the application handle a calendar creation request. |
CreateCollection | Lets the application respond to collection creation request. |
CustomRequest | Use this event to respond to non-standard DAV requests. |
Data | Supplies a data chunk received from a client. |
Disconnect | Fires to report a disconnected client. |
DownloadObject | Allows the application respond to Download Object request. |
DownloadObjectCompleted | This event is fired when a download operation completes. |
Error | Information about errors during data delivery. |
ExternalSign | Handles remote or external signing initiated by the server protocol. |
FileError | Reports a file access error to the application. |
HeadersPrepared | Fires when the response headers have been formed and are ready to be sent to the server. |
ListAttributes | Requests object attributes from the application in fraCustom handling mode. |
ListSubObjects | 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 | Virtualizes the object locking operation. |
Notification | This event notifies the application about an underlying control flow event. |
QueryQuota | Reflects a quota enquiry by a client. |
ReadAttribute | Requests value of an attribute from the application in fraCustom mode. |
ReadObject | Requests a piece of object data from the application. |
RefreshLock | Notifies the application about a lock refresh request. |
RemoveObject | Notifies the application about object deletion requests. |
RenameObject | Notifies the application about object name change requests. |
ResourceAccess | Reports an attempt to access a resource. |
SetAttribute | Lets the application customize attribute assignment requests. |
TLSCertValidate | Fires when a client certificate needs to be validated. |
TLSEstablished | Reports the setup of a TLS session. |
TLSHandshake | Fires when a newly established client connection initiates a TLS handshake. |
TLSPSK | Requests a pre-shared key for TLS-PSK. |
TLSShutdown | Reports closure of a TLS session. |
UnlockObject | Virtualizes the object unlocking operation. |
UploadObject | Lets the application respond to the Upload Object request. |
UploadObjectCompleted | This event is fired when a upload operation completes. |
WriteObject | 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 | Returns the bound address of the listening socket. |
BoundPort | The port that was bound by the server. |
DualStack | Allows the use of ip4 and ip6 simultaneously. |
HandshakeTimeout | The HTTPS handshake timeout. |
Host | The host to bind to. |
HTTPStatusCode[i] | Provides means to set a custom HTTP status code. |
Port | The port to listen on. |
PortRangeFrom | The lower bound of allowed port scope to listen on. |
PortRangeTo | The higher bound of allowed port scope to listen on. |
PreSharedIdentityHint | Gets or sets the PSK identity hint. |
SessionTimeout | The HTTP session timeout. |
SleepLen | Adjusts the server loop idling time. |
TLSExtensions | TBD. |
TLSPeerExtensions | TBD. |
TLSServerCertIndex | Specifies the index of the server certificate to use. |
WebsiteName | The website name for the TLS certificate. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
PKICachePath | Specifies the file system path where cached PKI data is stored. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
Active Property (WebDAVServer Class)
Indicates whether the server is active and is listening to new connections.
Syntax
ANSI (Cross Platform) int GetActive(); Unicode (Windows) BOOL GetActive();
int secureblackbox_webdavserver_getactive(void* lpObj);
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 Class)
Specifies authentication realm for digest and NTLM authentication.
Syntax
ANSI (Cross Platform) char* GetAuthRealm();
int SetAuthRealm(const char* lpszAuthRealm); Unicode (Windows) LPWSTR GetAuthRealm();
INT SetAuthRealm(LPCWSTR lpszAuthRealm);
char* secureblackbox_webdavserver_getauthrealm(void* lpObj);
int secureblackbox_webdavserver_setauthrealm(void* lpObj, const char* lpszAuthRealm);
QString GetAuthRealm();
int SetAuthRealm(QString qsAuthRealm);
Default Value
"SecureBlackbox"
Remarks
Specifies authentication realm for digest and NTLM authentication types.
Data Type
String
AuthTypes Property (WebDAVServer Class)
Defines allowed HTTP authentication types.
Syntax
ANSI (Cross Platform) int GetAuthTypes();
int SetAuthTypes(int iAuthTypes); Unicode (Windows) INT GetAuthTypes();
INT SetAuthTypes(INT iAuthTypes);
int secureblackbox_webdavserver_getauthtypes(void* lpObj);
int secureblackbox_webdavserver_setauthtypes(void* lpObj, int iAuthTypes);
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 Class)
Indicates the bound listening port.
Syntax
ANSI (Cross Platform) int GetBoundPort(); Unicode (Windows) INT GetBoundPort();
int secureblackbox_webdavserver_getboundport(void* lpObj);
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 if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.
This property is read-only and not available at design time.
Data Type
Integer
ClientFileEntry Property (WebDAVServer Class)
A container for current file entry details.
Syntax
SecureBlackboxWebDAVListEntry* GetClientFileEntry(); int SetClientFileEntry(SecureBlackboxWebDAVListEntry* val);
char* secureblackbox_webdavserver_getclientfileentryatime(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryatime(void* lpObj, const char* lpszClientFileEntryATime);
char* secureblackbox_webdavserver_getclientfileentrycontenttype(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrycontenttype(void* lpObj, const char* lpszClientFileEntryContentType);
char* secureblackbox_webdavserver_getclientfileentryctime(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryctime(void* lpObj, const char* lpszClientFileEntryCTime);
int secureblackbox_webdavserver_getclientfileentrydirectory(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrydirectory(void* lpObj, int bClientFileEntryDirectory);
char* secureblackbox_webdavserver_getclientfileentrydisplayname(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrydisplayname(void* lpObj, const char* lpszClientFileEntryDisplayName);
char* secureblackbox_webdavserver_getclientfileentryetag(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryetag(void* lpObj, const char* lpszClientFileEntryETag);
char* secureblackbox_webdavserver_getclientfileentryfullurl(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryfullurl(void* lpObj, const char* lpszClientFileEntryFullURL);
char* secureblackbox_webdavserver_getclientfileentrymtime(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrymtime(void* lpObj, const char* lpszClientFileEntryMTime);
char* secureblackbox_webdavserver_getclientfileentryparenturl(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryparenturl(void* lpObj, const char* lpszClientFileEntryParentURL);
int64 secureblackbox_webdavserver_getclientfileentrysize(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrysize(void* lpObj, int64 lClientFileEntrySize);
int secureblackbox_webdavserver_getclientfileentrysupportsexclusivelock(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrysupportsexclusivelock(void* lpObj, int bClientFileEntrySupportsExclusiveLock);
int secureblackbox_webdavserver_getclientfileentrysupportssharedlock(void* lpObj);
int secureblackbox_webdavserver_setclientfileentrysupportssharedlock(void* lpObj, int bClientFileEntrySupportsSharedLock);
char* secureblackbox_webdavserver_getclientfileentryurl(void* lpObj);
int secureblackbox_webdavserver_setclientfileentryurl(void* lpObj, const char* lpszClientFileEntryURL);
QString GetClientFileEntryATime();
int SetClientFileEntryATime(QString qsClientFileEntryATime); QString GetClientFileEntryContentType();
int SetClientFileEntryContentType(QString qsClientFileEntryContentType); QString GetClientFileEntryCTime();
int SetClientFileEntryCTime(QString qsClientFileEntryCTime); bool GetClientFileEntryDirectory();
int SetClientFileEntryDirectory(bool bClientFileEntryDirectory); QString GetClientFileEntryDisplayName();
int SetClientFileEntryDisplayName(QString qsClientFileEntryDisplayName); QString GetClientFileEntryETag();
int SetClientFileEntryETag(QString qsClientFileEntryETag); QString GetClientFileEntryFullURL();
int SetClientFileEntryFullURL(QString qsClientFileEntryFullURL); QString GetClientFileEntryMTime();
int SetClientFileEntryMTime(QString qsClientFileEntryMTime); QString GetClientFileEntryParentURL();
int SetClientFileEntryParentURL(QString qsClientFileEntryParentURL); qint64 GetClientFileEntrySize();
int SetClientFileEntrySize(qint64 lClientFileEntrySize); bool GetClientFileEntrySupportsExclusiveLock();
int SetClientFileEntrySupportsExclusiveLock(bool bClientFileEntrySupportsExclusiveLock); bool GetClientFileEntrySupportsSharedLock();
int SetClientFileEntrySupportsSharedLock(bool bClientFileEntrySupportsSharedLock); QString GetClientFileEntryURL();
int SetClientFileEntryURL(QString qsClientFileEntryURL);
Remarks
Use this object to specify file entry details for a file listing or attributes request, before committing them to the server with SetClientFileEntry method.
This property is not available at design time.
Data Type
DocumentRoot Property (WebDAVServer Class)
The document root of the server.
Syntax
ANSI (Cross Platform) char* GetDocumentRoot();
int SetDocumentRoot(const char* lpszDocumentRoot); Unicode (Windows) LPWSTR GetDocumentRoot();
INT SetDocumentRoot(LPCWSTR lpszDocumentRoot);
char* secureblackbox_webdavserver_getdocumentroot(void* lpObj);
int secureblackbox_webdavserver_setdocumentroot(void* lpObj, const char* lpszDocumentRoot);
QString GetDocumentRoot();
int SetDocumentRoot(QString qsDocumentRoot);
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 Class)
Provides access to external signing and DC parameters.
Syntax
SecureBlackboxExternalCrypto* GetExternalCrypto();
char* secureblackbox_webdavserver_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_webdavserver_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
char* secureblackbox_webdavserver_getexternalcryptodata(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
int secureblackbox_webdavserver_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
char* secureblackbox_webdavserver_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
char* secureblackbox_webdavserver_getexternalcryptokeyid(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
char* secureblackbox_webdavserver_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
int secureblackbox_webdavserver_getexternalcryptomethod(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int secureblackbox_webdavserver_getexternalcryptomode(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
char* secureblackbox_webdavserver_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_webdavserver_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID); QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams); QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData); bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation); QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm); QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID); QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret); int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Remarks
Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).
This property is read-only.
Data Type
FIPSMode Property (WebDAVServer Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_webdavserver_getfipsmode(void* lpObj);
int secureblackbox_webdavserver_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
FALSE
Remarks
This property is reserved for future use.
Data Type
Boolean
Host Property (WebDAVServer Class)
The host to bind the listening port to.
Syntax
ANSI (Cross Platform) char* GetHost();
int SetHost(const char* lpszHost); Unicode (Windows) LPWSTR GetHost();
INT SetHost(LPCWSTR lpszHost);
char* secureblackbox_webdavserver_gethost(void* lpObj);
int secureblackbox_webdavserver_sethost(void* lpObj, const char* lpszHost);
QString GetHost();
int SetHost(QString qsHost);
Default Value
""
Remarks
Use this property to specify the IP address on which to listen to incoming connections.
Data Type
String
MetadataFlushTimeout Property (WebDAVServer Class)
Specifies metadata flush timeout.
Syntax
ANSI (Cross Platform) int GetMetadataFlushTimeout();
int SetMetadataFlushTimeout(int iMetadataFlushTimeout); Unicode (Windows) INT GetMetadataFlushTimeout();
INT SetMetadataFlushTimeout(INT iMetadataFlushTimeout);
int secureblackbox_webdavserver_getmetadataflushtimeout(void* lpObj);
int secureblackbox_webdavserver_setmetadataflushtimeout(void* lpObj, int iMetadataFlushTimeout);
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 Class)
The metadata directory root.
Syntax
ANSI (Cross Platform) char* GetMetadataRoot();
int SetMetadataRoot(const char* lpszMetadataRoot); Unicode (Windows) LPWSTR GetMetadataRoot();
INT SetMetadataRoot(LPCWSTR lpszMetadataRoot);
char* secureblackbox_webdavserver_getmetadataroot(void* lpObj);
int secureblackbox_webdavserver_setmetadataroot(void* lpObj, const char* lpszMetadataRoot);
QString GetMetadataRoot();
int SetMetadataRoot(QString qsMetadataRoot);
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 Class)
Populates the pinned client details.
Syntax
SecureBlackboxTLSConnectionInfo* GetPinnedClient();
int secureblackbox_webdavserver_getpinnedclientaeadcipher(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientchainvalidationdetails(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientchainvalidationresult(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientciphersuite(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientclientauthenticated(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientclientauthrequested(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientconnectionestablished(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientconnectionid(void* lpObj, char** lpPinnedClientConnectionID, int* lenPinnedClientConnectionID);
char* secureblackbox_webdavserver_getpinnedclientdigestalgorithm(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientencryptionalgorithm(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientexportable(void* lpObj);
int64 secureblackbox_webdavserver_getpinnedclientid(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientkeyexchangealgorithm(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientkeyexchangekeybits(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientnamedeccurve(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientpfscipher(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientpresharedidentity(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientpresharedidentityhint(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientpublickeybits(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientremoteaddress(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientremoteport(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientresumedsession(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientsecureconnection(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientserverauthenticated(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientsignaturealgorithm(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientsymmetricblocksize(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientsymmetrickeybits(void* lpObj);
int64 secureblackbox_webdavserver_getpinnedclienttotalbytesreceived(void* lpObj);
int64 secureblackbox_webdavserver_getpinnedclienttotalbytessent(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientvalidationlog(void* lpObj);
char* secureblackbox_webdavserver_getpinnedclientversion(void* lpObj);
bool GetPinnedClientAEADCipher(); int GetPinnedClientChainValidationDetails(); int GetPinnedClientChainValidationResult(); QString GetPinnedClientCiphersuite(); bool GetPinnedClientClientAuthenticated(); bool GetPinnedClientClientAuthRequested(); bool GetPinnedClientConnectionEstablished(); QByteArray GetPinnedClientConnectionID(); QString GetPinnedClientDigestAlgorithm(); QString GetPinnedClientEncryptionAlgorithm(); bool GetPinnedClientExportable(); qint64 GetPinnedClientID(); QString GetPinnedClientKeyExchangeAlgorithm(); int GetPinnedClientKeyExchangeKeyBits(); QString GetPinnedClientNamedECCurve(); bool GetPinnedClientPFSCipher(); QString GetPinnedClientPreSharedIdentity(); QString GetPinnedClientPreSharedIdentityHint(); int GetPinnedClientPublicKeyBits(); QString GetPinnedClientRemoteAddress(); int GetPinnedClientRemotePort(); bool GetPinnedClientResumedSession(); bool GetPinnedClientSecureConnection(); bool GetPinnedClientServerAuthenticated(); QString GetPinnedClientSignatureAlgorithm(); int GetPinnedClientSymmetricBlockSize(); int GetPinnedClientSymmetricKeyBits(); qint64 GetPinnedClientTotalBytesReceived(); qint64 GetPinnedClientTotalBytesSent(); QString GetPinnedClientValidationLog(); QString GetPinnedClientVersion();
Remarks
Use this property to access the details of the client connection previously pinned with PinClient method.
This property is read-only and not available at design time.
Data Type
SecureBlackboxTLSConnectionInfo
PinnedClientChain Property (WebDAVServer Class)
Contains the certificate chain of the pinned client.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetPinnedClientChain();
int secureblackbox_webdavserver_getpinnedclientcertcount(void* lpObj);
int secureblackbox_webdavserver_getpinnedclientcertbytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertBytes, int* lenPinnedClientCertBytes);
int secureblackbox_webdavserver_getpinnedclientcertca(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertcakeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertCAKeyID, int* lenPinnedClientCertCAKeyID);
int secureblackbox_webdavserver_getpinnedclientcertcerttype(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertcrldistributionpoints(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertcurve(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertfingerprint(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertfriendlyname(void* lpObj, int pinnedclientcertindex);
int64 secureblackbox_webdavserver_getpinnedclientcerthandle(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcerthashalgorithm(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertissuer(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertissuerrdn(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertkeyalgorithm(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertkeybits(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertkeyfingerprint(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertkeyusage(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertkeyvalid(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertocsplocations(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertocspnocheck(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertorigin(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertpolicyids(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertprivatekeybytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertPrivateKeyBytes, int* lenPinnedClientCertPrivateKeyBytes);
int secureblackbox_webdavserver_getpinnedclientcertprivatekeyexists(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertprivatekeyextractable(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertpublickeybytes(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertPublicKeyBytes, int* lenPinnedClientCertPublicKeyBytes);
int secureblackbox_webdavserver_getpinnedclientcertqualified(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertqualifiedstatements(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertqualifiers(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertselfsigned(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertserialnumber(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSerialNumber, int* lenPinnedClientCertSerialNumber);
char* secureblackbox_webdavserver_getpinnedclientcertsigalgorithm(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertsource(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertsubject(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertsubjectalternativename(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertsubjectkeyid(void* lpObj, int pinnedclientcertindex, char** lpPinnedClientCertSubjectKeyID, int* lenPinnedClientCertSubjectKeyID);
char* secureblackbox_webdavserver_getpinnedclientcertsubjectrdn(void* lpObj, int pinnedclientcertindex);
int secureblackbox_webdavserver_getpinnedclientcertvalid(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertvalidfrom(void* lpObj, int pinnedclientcertindex);
char* secureblackbox_webdavserver_getpinnedclientcertvalidto(void* lpObj, int pinnedclientcertindex);
int GetPinnedClientCertCount(); QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex); bool GetPinnedClientCertCA(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex); int GetPinnedClientCertCertType(int iPinnedClientCertIndex); QString GetPinnedClientCertCRLDistributionPoints(int iPinnedClientCertIndex); QString GetPinnedClientCertCurve(int iPinnedClientCertIndex); QString GetPinnedClientCertFingerprint(int iPinnedClientCertIndex); QString GetPinnedClientCertFriendlyName(int iPinnedClientCertIndex); qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex); QString GetPinnedClientCertHashAlgorithm(int iPinnedClientCertIndex); QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex); QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex); QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex); int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex); QString GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex); int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex); bool GetPinnedClientCertKeyValid(int iPinnedClientCertIndex); QString GetPinnedClientCertOCSPLocations(int iPinnedClientCertIndex); bool GetPinnedClientCertOCSPNoCheck(int iPinnedClientCertIndex); int GetPinnedClientCertOrigin(int iPinnedClientCertIndex); QString GetPinnedClientCertPolicyIDs(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertPrivateKeyBytes(int iPinnedClientCertIndex); bool GetPinnedClientCertPrivateKeyExists(int iPinnedClientCertIndex); bool GetPinnedClientCertPrivateKeyExtractable(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex); bool GetPinnedClientCertQualified(int iPinnedClientCertIndex); int GetPinnedClientCertQualifiedStatements(int iPinnedClientCertIndex); QString GetPinnedClientCertQualifiers(int iPinnedClientCertIndex); bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex); QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex); int GetPinnedClientCertSource(int iPinnedClientCertIndex); QString GetPinnedClientCertSubject(int iPinnedClientCertIndex); QString GetPinnedClientCertSubjectAlternativeName(int iPinnedClientCertIndex); QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex); QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex); bool GetPinnedClientCertValid(int iPinnedClientCertIndex); QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex); QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);
Remarks
Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.
This property is read-only and not available at design time.
Data Type
Port Property (WebDAVServer Class)
Specifies the port number to listen for connections on.
Syntax
ANSI (Cross Platform) int GetPort();
int SetPort(int iPort); Unicode (Windows) INT GetPort();
INT SetPort(INT iPort);
int secureblackbox_webdavserver_getport(void* lpObj);
int secureblackbox_webdavserver_setport(void* lpObj, int iPort);
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 and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and repored in BoundPort.
Data Type
Integer
PortRangeFrom Property (WebDAVServer Class)
Specifies the lower limit of the listening port range for incoming connections.
Syntax
ANSI (Cross Platform) int GetPortRangeFrom();
int SetPortRangeFrom(int iPortRangeFrom); Unicode (Windows) INT GetPortRangeFrom();
INT SetPortRangeFrom(INT iPortRangeFrom);
int secureblackbox_webdavserver_getportrangefrom(void* lpObj);
int secureblackbox_webdavserver_setportrangefrom(void* lpObj, int iPortRangeFrom);
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), the port will be allocated within the requested range by the operating system, and repored in BoundPort.
Data Type
Integer
PortRangeTo Property (WebDAVServer Class)
Specifies the upper limit of the listening port range for incoming connections.
Syntax
ANSI (Cross Platform) int GetPortRangeTo();
int SetPortRangeTo(int iPortRangeTo); Unicode (Windows) INT GetPortRangeTo();
INT SetPortRangeTo(INT iPortRangeTo);
int secureblackbox_webdavserver_getportrangeto(void* lpObj);
int secureblackbox_webdavserver_setportrangeto(void* lpObj, int iPortRangeTo);
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), the port will be allocated within the requested range by the operating system, and repored in BoundPort.
Data Type
Integer
SocketSettings Property (WebDAVServer Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_webdavserver_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_webdavserver_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_webdavserver_getsocketlocaladdress(void* lpObj);
int secureblackbox_webdavserver_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_webdavserver_getsocketlocalport(void* lpObj);
int secureblackbox_webdavserver_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_webdavserver_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_webdavserver_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_webdavserver_getsockettimeout(void* lpObj);
int secureblackbox_webdavserver_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_webdavserver_getsocketuseipv6(void* lpObj);
int secureblackbox_webdavserver_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Data Type
TLSServerChain Property (WebDAVServer Class)
The server's TLS certificates.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain(); int SetTLSServerChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_webdavserver_gettlsservercertcount(void* lpObj);
int secureblackbox_webdavserver_settlsservercertcount(void* lpObj, int iTLSServerCertCount);
int secureblackbox_webdavserver_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
int64 secureblackbox_webdavserver_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
int secureblackbox_webdavserver_settlsservercerthandle(void* lpObj, int tlsservercertindex, int64 lTLSServerCertHandle);
int GetTLSServerCertCount();
int SetTLSServerCertCount(int iTLSServerCertCount); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
int SetTLSServerCertHandle(int iTLSServerCertIndex, qint64 lTLSServerCertHandle);
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
TLSSettings Property (WebDAVServer Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_webdavserver_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_webdavserver_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_webdavserver_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_webdavserver_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_webdavserver_gettlsciphersuites(void* lpObj);
int secureblackbox_webdavserver_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_webdavserver_gettlsclientauth(void* lpObj);
int secureblackbox_webdavserver_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_webdavserver_gettlseccurves(void* lpObj);
int secureblackbox_webdavserver_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_webdavserver_gettlsextensions(void* lpObj);
int secureblackbox_webdavserver_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_webdavserver_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_webdavserver_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_webdavserver_gettlspresharedidentity(void* lpObj);
int secureblackbox_webdavserver_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_webdavserver_gettlspresharedkey(void* lpObj);
int secureblackbox_webdavserver_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_webdavserver_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_webdavserver_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_webdavserver_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_webdavserver_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_webdavserver_gettlsrevocationcheck(void* lpObj);
int secureblackbox_webdavserver_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_webdavserver_gettlsssloptions(void* lpObj);
int secureblackbox_webdavserver_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_webdavserver_gettlstlsmode(void* lpObj);
int secureblackbox_webdavserver_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_webdavserver_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_webdavserver_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_webdavserver_gettlsusesessionresumption(void* lpObj);
int secureblackbox_webdavserver_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_webdavserver_gettlsversions(void* lpObj);
int secureblackbox_webdavserver_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Data Type
Users Property (WebDAVServer Class)
Provides a list of registered users.
Syntax
SecureBlackboxList<SecureBlackboxUserAccount>* GetUsers(); int SetUsers(SecureBlackboxList<SecureBlackboxUserAccount>* val);
int secureblackbox_webdavserver_getusercount(void* lpObj);
int secureblackbox_webdavserver_setusercount(void* lpObj, int iUserCount);
int secureblackbox_webdavserver_getuserassociateddata(void* lpObj, int userindex, char** lpUserAssociatedData, int* lenUserAssociatedData);
int secureblackbox_webdavserver_setuserassociateddata(void* lpObj, int userindex, const char* lpUserAssociatedData, int lenUserAssociatedData);
char* secureblackbox_webdavserver_getuserbasepath(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserbasepath(void* lpObj, int userindex, const char* lpszUserBasePath);
int secureblackbox_webdavserver_getusercertificate(void* lpObj, int userindex, char** lpUserCertificate, int* lenUserCertificate);
int secureblackbox_webdavserver_setusercertificate(void* lpObj, int userindex, const char* lpUserCertificate, int lenUserCertificate);
char* secureblackbox_webdavserver_getuserdata(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserdata(void* lpObj, int userindex, const char* lpszUserData);
char* secureblackbox_webdavserver_getuseremail(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuseremail(void* lpObj, int userindex, const char* lpszUserEmail);
int64 secureblackbox_webdavserver_getuserhandle(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserhandle(void* lpObj, int userindex, int64 lUserHandle);
char* secureblackbox_webdavserver_getuserhashalgorithm(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserhashalgorithm(void* lpObj, int userindex, const char* lpszUserHashAlgorithm);
int secureblackbox_webdavserver_getuserincomingspeedlimit(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserincomingspeedlimit(void* lpObj, int userindex, int iUserIncomingSpeedLimit);
int secureblackbox_webdavserver_getuserotpalgorithm(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserotpalgorithm(void* lpObj, int userindex, int iUserOtpAlgorithm);
int secureblackbox_webdavserver_getuserotplen(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserotplen(void* lpObj, int userindex, int iUserOTPLen);
int secureblackbox_webdavserver_getuserotpvalue(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserotpvalue(void* lpObj, int userindex, int iUserOtpValue);
int secureblackbox_webdavserver_getuseroutgoingspeedlimit(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuseroutgoingspeedlimit(void* lpObj, int userindex, int iUserOutgoingSpeedLimit);
char* secureblackbox_webdavserver_getuserpassword(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserpassword(void* lpObj, int userindex, const char* lpszUserPassword);
int secureblackbox_webdavserver_getusersharedsecret(void* lpObj, int userindex, char** lpUserSharedSecret, int* lenUserSharedSecret);
int secureblackbox_webdavserver_setusersharedsecret(void* lpObj, int userindex, const char* lpUserSharedSecret, int lenUserSharedSecret);
int secureblackbox_webdavserver_getusersshkey(void* lpObj, int userindex, char** lpUserSSHKey, int* lenUserSSHKey);
int secureblackbox_webdavserver_setusersshkey(void* lpObj, int userindex, const char* lpUserSSHKey, int lenUserSSHKey);
char* secureblackbox_webdavserver_getuserusername(void* lpObj, int userindex);
int secureblackbox_webdavserver_setuserusername(void* lpObj, int userindex, const char* lpszUserUsername);
int GetUserCount();
int SetUserCount(int iUserCount); QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData); QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath); QByteArray GetUserCertificate(int iUserIndex);
int SetUserCertificate(int iUserIndex, QByteArray qbaUserCertificate); QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData); QString GetUserEmail(int iUserIndex);
int SetUserEmail(int iUserIndex, QString qsUserEmail); qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle); QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm); int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit); int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm); int GetUserOTPLen(int iUserIndex);
int SetUserOTPLen(int iUserIndex, int iUserOTPLen); int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue); int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit); QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword); QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret); QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey); QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);
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
WebsiteName Property (WebDAVServer Class)
Specifies the web site name to use in the certificate.
Syntax
ANSI (Cross Platform) char* GetWebsiteName();
int SetWebsiteName(const char* lpszWebsiteName); Unicode (Windows) LPWSTR GetWebsiteName();
INT SetWebsiteName(LPCWSTR lpszWebsiteName);
char* secureblackbox_webdavserver_getwebsitename(void* lpObj);
int secureblackbox_webdavserver_setwebsitename(void* lpObj, const char* lpszWebsiteName);
QString GetWebsiteName();
int SetWebsiteName(QString qsWebsiteName);
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 Class)
Cleans up the server environment by purging expired sessions and cleaning caches.
Syntax
ANSI (Cross Platform) int Cleanup(); Unicode (Windows) INT Cleanup();
int secureblackbox_webdavserver_cleanup(void* lpObj);
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 Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_webdavserver_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (WebDAVServer Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_webdavserver_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case insensitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
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 Class)
Terminates a client connection.
Syntax
ANSI (Cross Platform) int DropClient(int64 lConnectionId, int bForced); Unicode (Windows) INT DropClient(LONG64 lConnectionId, BOOL bForced);
int secureblackbox_webdavserver_dropclient(void* lpObj, int64 lConnectionId, int bForced);
int DropClient(qint64 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 Class)
Obtains a pending connection buffer.
Syntax
ANSI (Cross Platform) char* GetClientBuffer(int64 lConnectionID, int *lpSize = NULL); Unicode (Windows) LPSTR GetClientBuffer(LONG64 lConnectionID, LPINT lpSize = NULL);
char* secureblackbox_webdavserver_getclientbuffer(void* lpObj, int64 lConnectionID, int *lpSize);
QByteArray GetClientBuffer(qint64 lConnectionID);
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 Class)
Returns the contents of the client's HTTP request.
Syntax
ANSI (Cross Platform) char* GetRequestBytes(int64 lConnectionId, const char* lpszRequestFilter, int *lpSize = NULL); Unicode (Windows) LPSTR GetRequestBytes(LONG64 lConnectionId, LPCWSTR lpszRequestFilter, LPINT lpSize = NULL);
char* secureblackbox_webdavserver_getrequestbytes(void* lpObj, int64 lConnectionId, const char* lpszRequestFilter, int *lpSize);
QByteArray GetRequestBytes(qint64 lConnectionId, const QString& qsRequestFilter);
Remarks
Use this method to get the body of the client's HTTP request in your CustomRequest 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 Class)
Returns a request header value.
Syntax
ANSI (Cross Platform) char* GetRequestHeader(int64 lConnectionId, const char* lpszHeaderName); Unicode (Windows) LPWSTR GetRequestHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
char* secureblackbox_webdavserver_getrequestheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName);
QString GetRequestHeader(qint64 lConnectionId, const QString& qsHeaderName);
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 or CustomRequest.
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 Class)
Returns the contents of the client's HTTP request.
Syntax
ANSI (Cross Platform) int GetRequestStream(int64 lConnectionId, const char* lpszRequestFilter, SecureBlackboxStream* sOutputStream); Unicode (Windows) INT GetRequestStream(LONG64 lConnectionId, LPCWSTR lpszRequestFilter, SecureBlackboxStream* sOutputStream);
int secureblackbox_webdavserver_getrequeststream(void* lpObj, int64 lConnectionId, const char* lpszRequestFilter, SecureBlackboxStream* sOutputStream);
int GetRequestStream(qint64 lConnectionId, const QString& qsRequestFilter, 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 Class)
Returns the contents of the client's HTTP request.
Syntax
ANSI (Cross Platform) char* GetRequestString(int64 lConnectionId, const char* lpszRequestFilter); Unicode (Windows) LPWSTR GetRequestString(LONG64 lConnectionId, LPCWSTR lpszRequestFilter);
char* secureblackbox_webdavserver_getrequeststring(void* lpObj, int64 lConnectionId, const char* lpszRequestFilter);
QString GetRequestString(qint64 lConnectionId, const QString& qsRequestFilter);
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 Class)
Returns the username for a connection.
Syntax
ANSI (Cross Platform) char* GetRequestUsername(int64 lConnectionId); Unicode (Windows) LPWSTR GetRequestUsername(LONG64 lConnectionId);
char* secureblackbox_webdavserver_getrequestusername(void* lpObj, int64 lConnectionId);
QString GetRequestUsername(qint64 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 Class)
Returns a response header value.
Syntax
ANSI (Cross Platform) char* GetResponseHeader(int64 lConnectionId, const char* lpszHeaderName); Unicode (Windows) LPWSTR GetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName);
char* secureblackbox_webdavserver_getresponseheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName);
QString GetResponseHeader(qint64 lConnectionId, const QString& qsHeaderName);
Remarks
Use this method to get the value of a response header. A good place to call this method is HeadersPrepared 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 Class)
Enumerates the connected clients.
Syntax
ANSI (Cross Platform) char* ListClients(); Unicode (Windows) LPWSTR ListClients();
char* secureblackbox_webdavserver_listclients(void* lpObj);
QString 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 Class)
Takes a snapshot of the connection's properties.
Syntax
ANSI (Cross Platform) int PinClient(int64 lConnectionId); Unicode (Windows) INT PinClient(LONG64 lConnectionId);
int secureblackbox_webdavserver_pinclient(void* lpObj, int64 lConnectionId);
int PinClient(qint64 lConnectionId);
Remarks
Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain 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 Class)
Processes a generic HTTP request.
Syntax
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);
char* secureblackbox_webdavserver_processgenericrequest(void* lpObj, int64 lConnectionId, const char* lpRequestBytes, int lenRequestBytes, int *lpSize);
QByteArray ProcessGenericRequest(qint64 lConnectionId, QByteArray qbaRequestBytes);
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 Class)
Processes a generic HTTP request from a stream.
Syntax
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);
int secureblackbox_webdavserver_processgenericrequeststream(void* lpObj, int64 lConnectionId, const char* lpszRequestHeaders, SecureBlackboxStream* sRequestData, SecureBlackboxStream* sResponseData);
int ProcessGenericRequestStream(qint64 lConnectionId, const QString& qsRequestHeaders, 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 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 Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_webdavserver_reset(void* lpObj);
int Reset();
Remarks
Reset is a generic method available in every class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetClientBuffer Method (WebDAVServer Class)
Commits a data buffer to the connection.
Syntax
ANSI (Cross Platform) int SetClientBuffer(int64 lConnectionID, const char* lpValue, int lenValue); Unicode (Windows) INT SetClientBuffer(LONG64 lConnectionID, LPCSTR lpValue, INT lenValue);
int secureblackbox_webdavserver_setclientbuffer(void* lpObj, int64 lConnectionID, const char* lpValue, int lenValue);
int SetClientBuffer(qint64 lConnectionID, QByteArray qbaValue);
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 Class)
Commits a file entry to the connection.
Syntax
ANSI (Cross Platform) int SetClientFileEntry(int64 lConnectionID); Unicode (Windows) INT SetClientFileEntry(LONG64 lConnectionID);
int secureblackbox_webdavserver_setclientfileentry(void* lpObj, int64 lConnectionID);
int SetClientFileEntry(qint64 lConnectionID);
Remarks
Use this method to commit a file details entry provided in ClientFileEntry 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.
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 Class)
Sets a byte array to be served as a response.
Syntax
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);
int secureblackbox_webdavserver_setresponsebytes(void* lpObj, int64 lConnectionId, const char* lpBytes, int lenBytes, const char* lpszContentType, const char* lpszResponseFilter);
int SetResponseBytes(qint64 lConnectionId, QByteArray qbaBytes, const QString& qsContentType, const QString& qsResponseFilter);
Remarks
Use this property to provide the response content in a byte array when serving custom requests in your CustomRequest 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 Class)
Sets a file to be served as a response.
Syntax
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);
int secureblackbox_webdavserver_setresponsefile(void* lpObj, int64 lConnectionId, const char* lpszFileName, const char* lpszContentType, const char* lpszResponseFilter);
int SetResponseFile(qint64 lConnectionId, const QString& qsFileName, const QString& qsContentType, const QString& qsResponseFilter);
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 Class)
Sets a response header.
Syntax
ANSI (Cross Platform) int SetResponseHeader(int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue); Unicode (Windows) INT SetResponseHeader(LONG64 lConnectionId, LPCWSTR lpszHeaderName, LPCWSTR lpszValue);
int secureblackbox_webdavserver_setresponseheader(void* lpObj, int64 lConnectionId, const char* lpszHeaderName, const char* lpszValue);
int SetResponseHeader(qint64 lConnectionId, const QString& qsHeaderName, const QString& qsValue);
Remarks
Use this method to set a response header. A good place to call this method is a request-marking event, such as LockObject or CustomRequest.
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 Class)
Sets an HTTP status to be sent with the response.
Syntax
ANSI (Cross Platform) int SetResponseStatus(int64 lConnectionId, int iStatusCode); Unicode (Windows) INT SetResponseStatus(LONG64 lConnectionId, INT iStatusCode);
int secureblackbox_webdavserver_setresponsestatus(void* lpObj, int64 lConnectionId, int iStatusCode);
int SetResponseStatus(qint64 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.
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 Class)
Sets a stream to be served as a response.
Syntax
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);
int secureblackbox_webdavserver_setresponsestream(void* lpObj, int64 lConnectionId, SecureBlackboxStream* sDataStream, int bCloseStream, const char* lpszContentType, const char* lpszResponseFilter);
int SetResponseStream(qint64 lConnectionId, SecureBlackboxStream* sDataStream, bool bCloseStream, const QString& qsContentType, const QString& qsResponseFilter);
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 Class)
Sets a string to be served as a response.
Syntax
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);
int secureblackbox_webdavserver_setresponsestring(void* lpObj, int64 lConnectionId, const char* lpszDataStr, const char* lpszContentType, const char* lpszResponseFilter);
int SetResponseString(qint64 lConnectionId, const QString& qsDataStr, const QString& qsContentType, const QString& qsResponseFilter);
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 Class)
Starts the server.
Syntax
ANSI (Cross Platform) int Start(); Unicode (Windows) INT Start();
int secureblackbox_webdavserver_start(void* lpObj);
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 Class)
Stops the server.
Syntax
ANSI (Cross Platform) int Stop(); Unicode (Windows) INT Stop();
int secureblackbox_webdavserver_stop(void* lpObj);
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 Class)
Reports an incoming connection.
Syntax
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;
#define EID_WEBDAVSERVER_ACCEPT 1 virtual INT SECUREBLACKBOX_CALL FireAccept(LPSTR &lpszRemoteAddress, INT &iRemotePort, BOOL &bAccept);
class WebDAVServerAcceptEventParams { public: const QString &RemoteAddress(); int RemotePort(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Accept(WebDAVServerAcceptEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAccept(WebDAVServerAcceptEventParams *e) {...}
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 event to be notified of every connection that has been set up.
AfterBrowse Event (WebDAVServer Class)
WebDAVServer uses this event to notify the application about the completion of the browsing operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERBROWSE 2 virtual INT SECUREBLACKBOX_CALL FireAfterBrowse(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterBrowseEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterBrowse(WebDAVServerAfterBrowseEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterBrowse(WebDAVServerAfterBrowseEventParams *e) {...}
Remarks
The ConnectionID parameter identifies the client connection, and the Path parameter specifies the browsing path.
This event is typically fired after the BeforeBrowse 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 Class)
This event notifies the application about the completion of the copy operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERCOPYOBJECT 3 virtual INT SECUREBLACKBOX_CALL FireAfterCopyObject(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iOperationStatus);
class WebDAVServerAfterCopyObjectEventParams { public: qint64 ConnectionID(); const QString &OldPath(); const QString &NewPath(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCopyObject(WebDAVServerAfterCopyObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterCopyObject(WebDAVServerAfterCopyObjectEventParams *e) {...}
Remarks
AfterCopyObject is typically preceded by BeforeCopyObject and CopyObject 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 Class)
This event reports the completion of calendar creation request.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERCREATECALENDAR 4 virtual INT SECUREBLACKBOX_CALL FireAfterCreateCalendar(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterCreateCalendarEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCreateCalendar(WebDAVServerAfterCreateCalendarEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterCreateCalendar(WebDAVServerAfterCreateCalendarEventParams *e) {...}
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 Class)
WebDAVServer uses this event to report completion of the collection creation operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERCREATECOLLECTION 5 virtual INT SECUREBLACKBOX_CALL FireAfterCreateCollection(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterCreateCollectionEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCreateCollection(WebDAVServerAfterCreateCollectionEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterCreateCollection(WebDAVServerAfterCreateCollectionEventParams *e) {...}
Remarks
This event is preceded by BeforeCreateCollection and CreateCollection 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 Class)
This event reports the completion of the custom request.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERCUSTOMREQUEST 6 virtual INT SECUREBLACKBOX_CALL FireAfterCustomRequest(LONG64 &lConnectionID, LPSTR &lpszRequestMethod, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterCustomRequestEventParams { public: qint64 ConnectionID(); const QString &RequestMethod(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCustomRequest(WebDAVServerAfterCustomRequestEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterCustomRequest(WebDAVServerAfterCustomRequestEventParams *e) {...}
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 Class)
Reports the completion of the object locking operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERLOCKOBJECT 7 virtual INT SECUREBLACKBOX_CALL FireAfterLockObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterLockObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterLockObject(WebDAVServerAfterLockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterLockObject(WebDAVServerAfterLockObjectEventParams *e) {...}
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 Class)
Reports the completion of the lock refresh operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERREFRESHLOCK 8 virtual INT SECUREBLACKBOX_CALL FireAfterRefreshLock(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterRefreshLockEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterRefreshLock(WebDAVServerAfterRefreshLockEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterRefreshLock(WebDAVServerAfterRefreshLockEventParams *e) {...}
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 Class)
This event notifies the application about the completion of object deletion operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERREMOVEOBJECT 9 virtual INT SECUREBLACKBOX_CALL FireAfterRemoveObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterRemoveObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterRemoveObject(WebDAVServerAfterRemoveObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterRemoveObject(WebDAVServerAfterRemoveObjectEventParams *e) {...}
Remarks
This event follows BeforeRemoveObject and RemoveObject 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 Class)
The class uses this event to notify the application about the completion of the object rename operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERRENAMEOBJECT 10 virtual INT SECUREBLACKBOX_CALL FireAfterRenameObject(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iOperationStatus);
class WebDAVServerAfterRenameObjectEventParams { public: qint64 ConnectionID(); const QString &OldPath(); const QString &NewPath(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterRenameObject(WebDAVServerAfterRenameObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterRenameObject(WebDAVServerAfterRenameObjectEventParams *e) {...}
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 Class)
WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERSETATTRIBUTES 11 virtual INT SECUREBLACKBOX_CALL FireAfterSetAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterSetAttributesEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterSetAttributes(WebDAVServerAfterSetAttributesEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterSetAttributes(WebDAVServerAfterSetAttributesEventParams *e) {...}
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 Class)
Notifies the application about the completion of the object unlocking operation.
Syntax
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;
#define EID_WEBDAVSERVER_AFTERUNLOCKOBJECT 12 virtual INT SECUREBLACKBOX_CALL FireAfterUnlockObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerAfterUnlockObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterUnlockObject(WebDAVServerAfterUnlockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAfterUnlockObject(WebDAVServerAfterUnlockObjectEventParams *e) {...}
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 Class)
Fires when a connected client makes an authentication attempt.
Syntax
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;
#define EID_WEBDAVSERVER_AUTHATTEMPT 13 virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(LONG64 &lConnectionID, LPSTR &lpszHTTPMethod, LPSTR &lpszURI, LPSTR &lpszAuthMethod, LPSTR &lpszUsername, LPSTR &lpszPassword, BOOL &bAllow);
class WebDAVServerAuthAttemptEventParams { public: qint64 ConnectionID(); const QString &HTTPMethod(); const QString &URI(); const QString &AuthMethod(); const QString &Username(); const QString &Password(); bool Allow(); void SetAllow(bool bAllow); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AuthAttempt(WebDAVServerAuthAttemptEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireAuthAttempt(WebDAVServerAuthAttemptEventParams *e) {...}
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.
BeforeBrowse Event (WebDAVServer Class)
Fires when a Browse request is received.
Syntax
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;
#define EID_WEBDAVSERVER_BEFOREBROWSE 14 virtual INT SECUREBLACKBOX_CALL FireBeforeBrowse(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeBrowseEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeBrowse(WebDAVServerBeforeBrowseEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeBrowse(WebDAVServerBeforeBrowseEventParams *e) {...}
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 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, ListSubObjects, and ReadAttribute.
BeforeCopyObject Event (WebDAVServer Class)
Fires when a Copy Object request is received.
Syntax
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;
#define EID_WEBDAVSERVER_BEFORECOPYOBJECT 15 virtual INT SECUREBLACKBOX_CALL FireBeforeCopyObject(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iAction);
class WebDAVServerBeforeCopyObjectEventParams { public: qint64 ConnectionID(); const QString &OldPath(); const QString &NewPath(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCopyObject(WebDAVServerBeforeCopyObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeCopyObject(WebDAVServerBeforeCopyObjectEventParams *e) {...}
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 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 call, allowing you to virtualize the copy operation.
BeforeCreateCalendar Event (WebDAVServer Class)
Fires when a Create Calendar request is received from a client.
Syntax
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;
#define EID_WEBDAVSERVER_BEFORECREATECALENDAR 16 virtual INT SECUREBLACKBOX_CALL FireBeforeCreateCalendar(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeCreateCalendarEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCreateCalendar(WebDAVServerBeforeCreateCalendarEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeCreateCalendar(WebDAVServerBeforeCreateCalendarEventParams *e) {...}
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 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 call, allowing you to virtualize the calendar creation operation.
BeforeCreateCollection Event (WebDAVServer Class)
Fires when a Create Collection request is received from a client.
Syntax
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;
#define EID_WEBDAVSERVER_BEFORECREATECOLLECTION 17 virtual INT SECUREBLACKBOX_CALL FireBeforeCreateCollection(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeCreateCollectionEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCreateCollection(WebDAVServerBeforeCreateCollectionEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeCreateCollection(WebDAVServerBeforeCreateCollectionEventParams *e) {...}
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 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 call.
BeforeCustomRequest Event (WebDAVServer Class)
Notifies the application about an incoming custom request.
Syntax
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;
#define EID_WEBDAVSERVER_BEFORECUSTOMREQUEST 18 virtual INT SECUREBLACKBOX_CALL FireBeforeCustomRequest(LONG64 &lConnectionID, LPSTR &lpszRequestMethod, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeCustomRequestEventParams { public: qint64 ConnectionID(); const QString &RequestMethod(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCustomRequest(WebDAVServerBeforeCustomRequestEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeCustomRequest(WebDAVServerBeforeCustomRequestEventParams *e) {...}
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 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 call, allowing you to respond to the request.
BeforeDownloadObject Event (WebDAVServer Class)
Fires when an object download request is received.
Syntax
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;
#define EID_WEBDAVSERVER_BEFOREDOWNLOADOBJECT 19 virtual INT SECUREBLACKBOX_CALL FireBeforeDownloadObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeDownloadObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeDownloadObject(WebDAVServerBeforeDownloadObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeDownloadObject(WebDAVServerBeforeDownloadObjectEventParams *e) {...}
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 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, ReadObject, and DownloadObjectCompleted calls, allowing you to supply the object data to the client.
BeforeLockObject Event (WebDAVServer Class)
Fires when a lock request is received.
Syntax
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;
#define EID_WEBDAVSERVER_BEFORELOCKOBJECT 20 virtual INT SECUREBLACKBOX_CALL FireBeforeLockObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeLockObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeLockObject(WebDAVServerBeforeLockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeLockObject(WebDAVServerBeforeLockObjectEventParams *e) {...}
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 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 call which expects you to perform the locking as required.
BeforeRefreshLock Event (WebDAVServer Class)
Reports the receipt of lock refresh request.
Syntax
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;
#define EID_WEBDAVSERVER_BEFOREREFRESHLOCK 21 virtual INT SECUREBLACKBOX_CALL FireBeforeRefreshLock(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeRefreshLockEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeRefreshLock(WebDAVServerBeforeRefreshLockEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeRefreshLock(WebDAVServerBeforeRefreshLockEventParams *e) {...}
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 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 call, allowing you to virtualize the operation.
BeforeRemoveObject Event (WebDAVServer Class)
Fires when an object deletion request is received.
Syntax
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;
#define EID_WEBDAVSERVER_BEFOREREMOVEOBJECT 22 virtual INT SECUREBLACKBOX_CALL FireBeforeRemoveObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeRemoveObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeRemoveObject(WebDAVServerBeforeRemoveObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeRemoveObject(WebDAVServerBeforeRemoveObjectEventParams *e) {...}
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 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 call, allowing you to virtualize the deletion operation.
BeforeRenameObject Event (WebDAVServer Class)
Reports object renaming requests.
Syntax
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;
#define EID_WEBDAVSERVER_BEFORERENAMEOBJECT 23 virtual INT SECUREBLACKBOX_CALL FireBeforeRenameObject(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, INT &iAction);
class WebDAVServerBeforeRenameObjectEventParams { public: qint64 ConnectionID(); const QString &OldPath(); const QString &NewPath(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeRenameObject(WebDAVServerBeforeRenameObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeRenameObject(WebDAVServerBeforeRenameObjectEventParams *e) {...}
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 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 call, where your code is expected to perform the renaming operation.
BeforeRequest Event (WebDAVServer Class)
Fires before a DAV request is processed.
Syntax
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;
#define EID_WEBDAVSERVER_BEFOREREQUEST 24 virtual INT SECUREBLACKBOX_CALL FireBeforeRequest(LONG64 &lConnectionID, LPSTR &lpszHTTPMethod, LPSTR &lpszURL, BOOL &bAccept);
class WebDAVServerBeforeRequestEventParams { public: qint64 ConnectionID(); const QString &HTTPMethod(); const QString &URL(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeRequest(WebDAVServerBeforeRequestEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeRequest(WebDAVServerBeforeRequestEventParams *e) {...}
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 Class)
Notifies the application about attribute change request.
Syntax
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;
#define EID_WEBDAVSERVER_BEFORESETATTRIBUTES 25 virtual INT SECUREBLACKBOX_CALL FireBeforeSetAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeSetAttributesEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeSetAttributes(WebDAVServerBeforeSetAttributesEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeSetAttributes(WebDAVServerBeforeSetAttributesEventParams *e) {...}
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 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 and/or ClearAttribute calls, for each attribute to be set or cleared.
BeforeUnlockObject Event (WebDAVServer Class)
Fires when an unlock request is received.
Syntax
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;
#define EID_WEBDAVSERVER_BEFOREUNLOCKOBJECT 26 virtual INT SECUREBLACKBOX_CALL FireBeforeUnlockObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeUnlockObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeUnlockObject(WebDAVServerBeforeUnlockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeUnlockObject(WebDAVServerBeforeUnlockObjectEventParams *e) {...}
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 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 call.
BeforeUploadObject Event (WebDAVServer Class)
Fires when an object upload request is received.
Syntax
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;
#define EID_WEBDAVSERVER_BEFOREUPLOADOBJECT 27 virtual INT SECUREBLACKBOX_CALL FireBeforeUploadObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iAction);
class WebDAVServerBeforeUploadObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int Action(); void SetAction(int iAction); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeUploadObject(WebDAVServerBeforeUploadObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireBeforeUploadObject(WebDAVServerBeforeUploadObjectEventParams *e) {...}
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 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, WriteObject, and UploadObjectCompleted calls, allowing your code to process/store the object data.
ClearAttribute Event (WebDAVServer Class)
Reports an attribute clearance request.
Syntax
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;
#define EID_WEBDAVSERVER_CLEARATTRIBUTE 28 virtual INT SECUREBLACKBOX_CALL FireClearAttribute(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszNS, LPSTR &lpszName, INT &iOperationStatus);
class WebDAVServerClearAttributeEventParams { public: qint64 ConnectionID(); const QString &Path(); const QString &NS(); const QString &Name(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ClearAttribute(WebDAVServerClearAttributeEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireClearAttribute(WebDAVServerClearAttributeEventParams *e) {...}
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 Class)
Reports an accepted connection.
Syntax
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;
#define EID_WEBDAVSERVER_CONNECT 29 virtual INT SECUREBLACKBOX_CALL FireConnect(LONG64 &lConnectionID, LPSTR &lpszRemoteAddress, INT &iRemotePort);
class WebDAVServerConnectEventParams { public: qint64 ConnectionID(); const QString &RemoteAddress(); int RemotePort(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connect(WebDAVServerConnectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireConnect(WebDAVServerConnectEventParams *e) {...}
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.
CopyObject Event (WebDAVServer Class)
Lets the application handle the Copy Object request.
Syntax
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;
#define EID_WEBDAVSERVER_COPYOBJECT 30 virtual INT SECUREBLACKBOX_CALL FireCopyObject(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, BOOL &bOverwrite, INT &iDepth, INT &iOperationStatus);
class WebDAVServerCopyObjectEventParams { public: qint64 ConnectionID(); const QString &OldPath(); const QString &NewPath(); bool Overwrite(); int Depth(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CopyObject(WebDAVServerCopyObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireCopyObject(WebDAVServerCopyObjectEventParams *e) {...}
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 Class)
Lets the application handle a calendar creation request.
Syntax
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;
#define EID_WEBDAVSERVER_CREATECALENDAR 31 virtual INT SECUREBLACKBOX_CALL FireCreateCalendar(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerCreateCalendarEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CreateCalendar(WebDAVServerCreateCalendarEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireCreateCalendar(WebDAVServerCreateCalendarEventParams *e) {...}
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 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 Class)
Lets the application respond to collection creation request.
Syntax
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;
#define EID_WEBDAVSERVER_CREATECOLLECTION 32 virtual INT SECUREBLACKBOX_CALL FireCreateCollection(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerCreateCollectionEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CreateCollection(WebDAVServerCreateCollectionEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireCreateCollection(WebDAVServerCreateCollectionEventParams *e) {...}
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 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 Class)
Use this event to respond to non-standard DAV requests.
Syntax
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;
#define EID_WEBDAVSERVER_CUSTOMREQUEST 33 virtual INT SECUREBLACKBOX_CALL FireCustomRequest(LONG64 &lConnectionID, LPSTR &lpszRequestMethod, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerCustomRequestEventParams { public: qint64 ConnectionID(); const QString &RequestMethod(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CustomRequest(WebDAVServerCustomRequestEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireCustomRequest(WebDAVServerCustomRequestEventParams *e) {...}
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 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 Class)
Supplies a data chunk received from a client.
Syntax
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;
#define EID_WEBDAVSERVER_DATA 34 virtual INT SECUREBLACKBOX_CALL FireData(LONG64 &lConnectionID, LPSTR &lpBuffer, INT &lenBuffer);
class WebDAVServerDataEventParams { public: qint64 ConnectionID(); const QByteArray &Buffer(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Data(WebDAVServerDataEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireData(WebDAVServerDataEventParams *e) {...}
Remarks
This event is fired to supply another piece of data received from a client. This event may fire multiple times.
Disconnect Event (WebDAVServer Class)
Fires to report a disconnected client.
Syntax
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;
#define EID_WEBDAVSERVER_DISCONNECT 35 virtual INT SECUREBLACKBOX_CALL FireDisconnect(LONG64 &lConnectionID);
class WebDAVServerDisconnectEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnect(WebDAVServerDisconnectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireDisconnect(WebDAVServerDisconnectEventParams *e) {...}
Remarks
class fires this event when a connected client disconnects.
DownloadObject Event (WebDAVServer Class)
Allows the application respond to Download Object request.
Syntax
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;
#define EID_WEBDAVSERVER_DOWNLOADOBJECT 36 virtual INT SECUREBLACKBOX_CALL FireDownloadObject(LONG64 &lConnectionID, LPSTR &lpszPath, LONG64 &lRestartAt, INT &iOperationStatus);
class WebDAVServerDownloadObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); qint64 RestartAt(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DownloadObject(WebDAVServerDownloadObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireDownloadObject(WebDAVServerDownloadObjectEventParams *e) {...}
Remarks
Use this event to implement custom handler of the Download operation. This event is followed by a series of ReadObject calls, which are then followed by DownloadObjectCompleted 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 Class)
This event is fired when a download operation completes.
Syntax
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;
#define EID_WEBDAVSERVER_DOWNLOADOBJECTCOMPLETED 37 virtual INT SECUREBLACKBOX_CALL FireDownloadObjectCompleted(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerDownloadObjectCompletedEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DownloadObjectCompleted(WebDAVServerDownloadObjectCompletedEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireDownloadObjectCompleted(WebDAVServerDownloadObjectCompletedEventParams *e) {...}
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 Class)
Information about errors during data delivery.
Syntax
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;
#define EID_WEBDAVSERVER_ERROR 38 virtual INT SECUREBLACKBOX_CALL FireError(LONG64 &lConnectionID, INT &iErrorCode, BOOL &bFatal, BOOL &bRemote, LPSTR &lpszDescription);
class WebDAVServerErrorEventParams { public: qint64 ConnectionID(); int ErrorCode(); bool Fatal(); bool Remote(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(WebDAVServerErrorEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireError(WebDAVServerErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.
ExternalSign Event (WebDAVServer Class)
Handles remote or external signing initiated by the server protocol.
Syntax
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;
#define EID_WEBDAVSERVER_EXTERNALSIGN 39 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LONG64 &lConnectionID, LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
class WebDAVServerExternalSignEventParams { public: qint64 ConnectionID(); const QString &OperationId(); const QString &HashAlgorithm(); const QString &Pars(); const QString &Data(); const QString &SignedData(); void SetSignedData(const QString &qsSignedData); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ExternalSign(WebDAVServerExternalSignEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireExternalSign(WebDAVServerExternalSignEventParams *e) {...}
Remarks
Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.
The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the class via the SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.
The class uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:
signer.OnExternalSign += (s, e) =>
{
var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
var key = (RSACryptoServiceProvider)cert.PrivateKey;
var dataToSign = e.Data.FromBase16String();
var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
e.SignedData = signedData.ToBase16String();
};
FileError Event (WebDAVServer Class)
Reports a file access error to the application.
Syntax
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;
#define EID_WEBDAVSERVER_FILEERROR 40 virtual INT SECUREBLACKBOX_CALL FireFileError(LONG64 &lConnectionID, LPSTR &lpszFileName, INT &iErrorCode);
class WebDAVServerFileErrorEventParams { public: qint64 ConnectionID(); const QString &FileName(); int ErrorCode(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void FileError(WebDAVServerFileErrorEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireFileError(WebDAVServerFileErrorEventParams *e) {...}
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 Class)
Fires when the response headers have been formed and are ready to be sent to the server.
Syntax
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;
#define EID_WEBDAVSERVER_HEADERSPREPARED 41 virtual INT SECUREBLACKBOX_CALL FireHeadersPrepared(LONG64 &lConnectionID);
class WebDAVServerHeadersPreparedEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void HeadersPrepared(WebDAVServerHeadersPreparedEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireHeadersPrepared(WebDAVServerHeadersPreparedEventParams *e) {...}
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 method with an empty header name to get the whole response header.
ListAttributes Event (WebDAVServer Class)
Requests object attributes from the application in fraCustom handling mode.
Syntax
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;
#define EID_WEBDAVSERVER_LISTATTRIBUTES 42 virtual INT SECUREBLACKBOX_CALL FireListAttributes(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszAttributes);
class WebDAVServerListAttributesEventParams { public: qint64 ConnectionID(); const QString &Path(); const QString &Attributes(); void SetAttributes(const QString &qsAttributes); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ListAttributes(WebDAVServerListAttributesEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireListAttributes(WebDAVServerListAttributesEventParams *e) {...}
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 calls.
This event only fires if fraCustom action type was returned from the preceding BeforeBrowse event call.
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.
Syntax
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;
#define EID_WEBDAVSERVER_LISTSUBOBJECTS 43 virtual INT SECUREBLACKBOX_CALL FireListSubObjects(LONG64 &lConnectionID, LPSTR &lpszPath, BOOL &bRecursive, LPSTR &lpszObjects, INT &iOperationStatus);
class WebDAVServerListSubObjectsEventParams { public: qint64 ConnectionID(); const QString &Path(); bool Recursive(); const QString &Objects(); void SetObjects(const QString &qsObjects); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ListSubObjects(WebDAVServerListSubObjectsEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireListSubObjects(WebDAVServerListSubObjectsEventParams *e) {...}
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 Class)
Virtualizes the object locking operation.
Syntax
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;
#define EID_WEBDAVSERVER_LOCKOBJECT 44 virtual INT SECUREBLACKBOX_CALL FireLockObject(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszOwner, BOOL &bExclusive, INT &iDepth, LONG64 &lTimeout, LPSTR &lpszToken);
class WebDAVServerLockObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); const QString &Owner(); bool Exclusive(); int Depth(); qint64 Timeout(); const QString &Token(); void SetToken(const QString &qsToken); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void LockObject(WebDAVServerLockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireLockObject(WebDAVServerLockObjectEventParams *e) {...}
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 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 Class)
This event notifies the application about an underlying control flow event.
Syntax
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;
#define EID_WEBDAVSERVER_NOTIFICATION 45 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class WebDAVServerNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(WebDAVServerNotificationEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireNotification(WebDAVServerNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
QueryQuota Event (WebDAVServer Class)
Reflects a quota enquiry by a client.
Syntax
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;
#define EID_WEBDAVSERVER_QUERYQUOTA 46 virtual INT SECUREBLACKBOX_CALL FireQueryQuota(LONG64 &lConnectionID, LPSTR &lpszUsername, LONG64 &lAvailable, LONG64 &lUsed);
class WebDAVServerQueryQuotaEventParams { public: qint64 ConnectionID(); const QString &Username(); qint64 Available(); void SetAvailable(qint64 lAvailable); qint64 Used(); void SetUsed(qint64 lUsed); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void QueryQuota(WebDAVServerQueryQuotaEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireQueryQuota(WebDAVServerQueryQuotaEventParams *e) {...}
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 Class)
Requests value of an attribute from the application in fraCustom mode.
Syntax
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;
#define EID_WEBDAVSERVER_READATTRIBUTE 47 virtual INT SECUREBLACKBOX_CALL FireReadAttribute(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszNS, LPSTR &lpszName, LPSTR &lpszValue, INT &iOperationStatus);
class WebDAVServerReadAttributeEventParams { public: qint64 ConnectionID(); const QString &Path(); const QString &NS(); const QString &Name(); const QString &Value(); void SetValue(const QString &qsValue); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReadAttribute(WebDAVServerReadAttributeEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireReadAttribute(WebDAVServerReadAttributeEventParams *e) {...}
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 event call.
ostOk | 1 | |
ostNoSuchFile | 2 | |
ostAccessDenied | 3 | |
ostWriteProtect | 4 | |
ostUnsupported | 5 | |
ostInvalidParameter | 6 | |
ostEOF | 7 |
ReadObject Event (WebDAVServer Class)
Requests a piece of object data from the application.
Syntax
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;
#define EID_WEBDAVSERVER_READOBJECT 48 virtual INT SECUREBLACKBOX_CALL FireReadObject(LONG64 &lConnectionID, INT &iSize, INT &iOperationStatus);
class WebDAVServerReadObjectEventParams { public: qint64 ConnectionID(); int Size(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReadObject(WebDAVServerReadObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireReadObject(WebDAVServerReadObjectEventParams *e) {...}
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 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 Class)
Notifies the application about a lock refresh request.
Syntax
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;
#define EID_WEBDAVSERVER_REFRESHLOCK 49 virtual INT SECUREBLACKBOX_CALL FireRefreshLock(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszToken, LONG64 &lTimeout, BOOL &bLockFound);
class WebDAVServerRefreshLockEventParams { public: qint64 ConnectionID(); const QString &Path(); const QString &Token(); qint64 Timeout(); bool LockFound(); void SetLockFound(bool bLockFound); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void RefreshLock(WebDAVServerRefreshLockEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireRefreshLock(WebDAVServerRefreshLockEventParams *e) {...}
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 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 Class)
Notifies the application about object deletion requests.
Syntax
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;
#define EID_WEBDAVSERVER_REMOVEOBJECT 50 virtual INT SECUREBLACKBOX_CALL FireRemoveObject(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerRemoveObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void RemoveObject(WebDAVServerRemoveObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireRemoveObject(WebDAVServerRemoveObjectEventParams *e) {...}
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 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 Class)
Notifies the application about object name change requests.
Syntax
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;
#define EID_WEBDAVSERVER_RENAMEOBJECT 51 virtual INT SECUREBLACKBOX_CALL FireRenameObject(LONG64 &lConnectionID, LPSTR &lpszOldPath, LPSTR &lpszNewPath, BOOL &bOverwrite, INT &iOperationStatus);
class WebDAVServerRenameObjectEventParams { public: qint64 ConnectionID(); const QString &OldPath(); const QString &NewPath(); bool Overwrite(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void RenameObject(WebDAVServerRenameObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireRenameObject(WebDAVServerRenameObjectEventParams *e) {...}
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 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 Class)
Reports an attempt to access a resource.
Syntax
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;
#define EID_WEBDAVSERVER_RESOURCEACCESS 52 virtual INT SECUREBLACKBOX_CALL FireResourceAccess(LONG64 &lConnectionID, LPSTR &lpszHTTPMethod, LPSTR &lpszURI, BOOL &bAllow, LPSTR &lpszRedirectURI);
class WebDAVServerResourceAccessEventParams { public: qint64 ConnectionID(); const QString &HTTPMethod(); const QString &URI(); bool Allow(); void SetAllow(bool bAllow); const QString &RedirectURI(); void SetRedirectURI(const QString &qsRedirectURI); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ResourceAccess(WebDAVServerResourceAccessEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireResourceAccess(WebDAVServerResourceAccessEventParams *e) {...}
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 Class)
Lets the application customize attribute assignment requests.
Syntax
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;
#define EID_WEBDAVSERVER_SETATTRIBUTE 53 virtual INT SECUREBLACKBOX_CALL FireSetAttribute(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszNS, LPSTR &lpszName, LPSTR &lpszValue, INT &iOperationStatus);
class WebDAVServerSetAttributeEventParams { public: qint64 ConnectionID(); const QString &Path(); const QString &NS(); const QString &Name(); const QString &Value(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SetAttribute(WebDAVServerSetAttributeEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireSetAttribute(WebDAVServerSetAttributeEventParams *e) {...}
Remarks
The class uses this event to pass attribute assignment requests to the application. This event may fire multiple times after a BeforeSetAttributes 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 Class)
Fires when a client certificate needs to be validated.
Syntax
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;
#define EID_WEBDAVSERVER_TLSCERTVALIDATE 54 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LONG64 &lConnectionID, BOOL &bAccept);
class WebDAVServerTLSCertValidateEventParams { public: qint64 ConnectionID(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(WebDAVServerTLSCertValidateEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireTLSCertValidate(WebDAVServerTLSCertValidateEventParams *e) {...}
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 Class)
Reports the setup of a TLS session.
Syntax
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;
#define EID_WEBDAVSERVER_TLSESTABLISHED 55 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LONG64 &lConnectionID);
class WebDAVServerTLSEstablishedEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(WebDAVServerTLSEstablishedEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireTLSEstablished(WebDAVServerTLSEstablishedEventParams *e) {...}
Remarks
Subscribe to this event to be notified about the setup of a TLS connection by a connected client.
TLSHandshake Event (WebDAVServer Class)
Fires when a newly established client connection initiates a TLS handshake.
Syntax
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;
#define EID_WEBDAVSERVER_TLSHANDSHAKE 56 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LONG64 &lConnectionID, LPSTR &lpszServerName, BOOL &bAbort);
class WebDAVServerTLSHandshakeEventParams { public: qint64 ConnectionID(); const QString &ServerName(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(WebDAVServerTLSHandshakeEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireTLSHandshake(WebDAVServerTLSHandshakeEventParams *e) {...}
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 Class)
Requests a pre-shared key for TLS-PSK.
Syntax
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;
#define EID_WEBDAVSERVER_TLSPSK 57 virtual INT SECUREBLACKBOX_CALL FireTLSPSK(LONG64 &lConnectionID, LPSTR &lpszIdentity, LPSTR &lpszPSK, LPSTR &lpszCiphersuite);
class WebDAVServerTLSPSKEventParams { public: qint64 ConnectionID(); const QString &Identity(); const QString &PSK(); void SetPSK(const QString &qsPSK); const QString &Ciphersuite(); void SetCiphersuite(const QString &qsCiphersuite); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSPSK(WebDAVServerTLSPSKEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireTLSPSK(WebDAVServerTLSPSKEventParams *e) {...}
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 Class)
Reports closure of a TLS session.
Syntax
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;
#define EID_WEBDAVSERVER_TLSSHUTDOWN 58 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LONG64 &lConnectionID);
class WebDAVServerTLSShutdownEventParams { public: qint64 ConnectionID(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(WebDAVServerTLSShutdownEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireTLSShutdown(WebDAVServerTLSShutdownEventParams *e) {...}
Remarks
The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.
UnlockObject Event (WebDAVServer Class)
Virtualizes the object unlocking operation.
Syntax
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;
#define EID_WEBDAVSERVER_UNLOCKOBJECT 59 virtual INT SECUREBLACKBOX_CALL FireUnlockObject(LONG64 &lConnectionID, LPSTR &lpszPath, LPSTR &lpszToken, BOOL &bLockFound);
class WebDAVServerUnlockObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); const QString &Token(); bool LockFound(); void SetLockFound(bool bLockFound); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UnlockObject(WebDAVServerUnlockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireUnlockObject(WebDAVServerUnlockObjectEventParams *e) {...}
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 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 Class)
Lets the application respond to the Upload Object request.
Syntax
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;
#define EID_WEBDAVSERVER_UPLOADOBJECT 60 virtual INT SECUREBLACKBOX_CALL FireUploadObject(LONG64 &lConnectionID, LPSTR &lpszPath, LONG64 &lRestartAt, BOOL &bAppend, INT &iOperationStatus);
class WebDAVServerUploadObjectEventParams { public: qint64 ConnectionID(); const QString &Path(); qint64 RestartAt(); bool Append(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UploadObject(WebDAVServerUploadObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireUploadObject(WebDAVServerUploadObjectEventParams *e) {...}
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 calls, passing object data in chunks, before a UploadObjectCompleted 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 Class)
This event is fired when a upload operation completes.
Syntax
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;
#define EID_WEBDAVSERVER_UPLOADOBJECTCOMPLETED 61 virtual INT SECUREBLACKBOX_CALL FireUploadObjectCompleted(LONG64 &lConnectionID, LPSTR &lpszPath, INT &iOperationStatus);
class WebDAVServerUploadObjectCompletedEventParams { public: qint64 ConnectionID(); const QString &Path(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void UploadObjectCompleted(WebDAVServerUploadObjectCompletedEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireUploadObjectCompleted(WebDAVServerUploadObjectCompletedEventParams *e) {...}
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 Class)
Hands a piece of object data to the application.
Syntax
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;
#define EID_WEBDAVSERVER_WRITEOBJECT 62 virtual INT SECUREBLACKBOX_CALL FireWriteObject(LONG64 &lConnectionID, INT &iOperationStatus);
class WebDAVServerWriteObjectEventParams { public: qint64 ConnectionID(); int OperationStatus(); void SetOperationStatus(int iOperationStatus); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void WriteObject(WebDAVServerWriteObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function. virtual int FireWriteObject(WebDAVServerWriteObjectEventParams *e) {...}
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 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.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw certificate data in DER format.
CA
int
Default Value: FALSE
Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.
Set this field when generating a new certificate to have its Basic Constraints extension generated automatically.
CAKeyID
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
CRLDistributionPoints
char*
Default Value: ""
Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.
Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.
The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
Curve
char*
Default Value: ""
Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
Fingerprint
char* (read-only)
Default Value: ""
Contains the fingerprint (a hash imprint) of this certificate.
While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.
FriendlyName
char* (read-only)
Default Value: ""
Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use SigAlgorithm to find out the hash algorithm that is part of the certificate signature.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
Issuer
char* (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
KeyAlgorithm
char*
Default Value: "0"
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.
KeyBits
int (read-only)
Default Value: 0
Returns the length of the public key in bits.
This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the PublicKeyBytes or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
char* (read-only)
Default Value: ""
Returns a SHA1 fingerprint of the public key contained in the certificate.
Note that the key fingerprint is different from the certificate fingerprint accessible via the Fingerprint field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
int
Default Value: 0
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
Set this field before generating the certificate to propagate the key usage flags to the new certificate.
KeyValid
int (read-only)
Default Value: FALSE
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
char*
Default Value: ""
Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
Set this field before calling the certificate manager's Generate method to propagate it to the new certificate.
The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.
OCSPNoCheck
int
Default Value: FALSE
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
PolicyIDs
char*
Default Value: ""
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
Set this field when generating a certificate to propagate the policies information to the new certificate.
The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.
PrivateKeyBytes
char* (read-only)
Default Value:
Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.
PrivateKeyExists
int (read-only)
Default Value: FALSE
Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.
This field is independent from PrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.
PrivateKeyExtractable
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
char* (read-only)
Default Value:
Contains the certificate's public key in DER format.
This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.
Qualified
int (read-only)
Default Value: FALSE
Indicates whether the certificate is qualified.
This property is set to True if the certificate is confirmed by a Trusted List to be qualified.
QualifiedStatements
int
Default Value: 0
Returns a simplified qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
int (read-only)
Default Value: FALSE
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
char*
Default Value:
Returns the certificate's serial number.
The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.
SigAlgorithm
char* (read-only)
Default Value: ""
Indicates the algorithm that was used by the CA to sign this certificate.
A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Subject
char* (read-only)
Default Value: ""
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via SubjectRDN.
SubjectAlternativeName
char*
Default Value: ""
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Subject alternative names are used to provide additional names that are impractical to store in the main SubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.
The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.
SubjectKeyID
char*
Default Value:
Contains a unique identifier of the certificate's cryptographic key.
Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.
The SubjectKeyID and CAKeyID fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.
SubjectRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate holder (subject).
Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.
Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.
Valid
int (read-only)
Default Value: FALSE
Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
ValidFrom
char*
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
ValidTo
char*
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
Certificate()
Creates a new object with default field values.
ExternalCrypto Type
Specifies the parameters of external cryptographic calls.
Syntax
SecureBlackboxExternalCrypto (declared in secureblackbox.h)
Remarks
External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.
Fields
AsyncDocumentID
char*
Default Value: ""
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
CustomParams
char*
Default Value: ""
Custom parameters to be passed to the signing service (uninterpreted).
Data
char*
Default Value: ""
Additional data to be included in the async state and mirrored back by the requestor.
ExternalHashCalculation
int
Default Value: FALSE
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.
If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.
HashAlgorithm
char*
Default Value: "SHA256"
Specifies the request's signature hash algorithm.
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
KeyID
char*
Default Value: ""
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use KeySecret to pass the key itself.
The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.
Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.
Example:
signer.ExternalCrypto.KeyID = "MainSigningKey";
signer.ExternalCrypto.KeySecret = "abcdef0123456789";
KeySecret
char*
Default Value: ""
The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.
Read more about configuring authentication in the KeyID topic.
Method
int
Default Value: 0
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
asmdPKCS1 | 0 |
asmdPKCS7 | 1 |
Mode
int
Default Value: 0
Specifies the external cryptography mode.
Available options:
ecmDefault | The default value (0) |
ecmDisabled | Do not use DC or external signing (1) |
ecmGeneric | Generic external signing with the OnExternalSign event (2) |
ecmDCAuth | DCAuth signing (3) |
ecmDCAuthJSON | DCAuth signing in JSON format (4) |
PublicKeyAlgorithm
char*
Default Value: ""
Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
Constructors
ExternalCrypto()
Creates a new ExternalCrypto object with default field values.
SocketSettings Type
A container for the socket settings.
Syntax
SecureBlackboxSocketSettings (declared in secureblackbox.h)
Remarks
This type is a container for socket-layer parameters.
Fields
DNSMode
int
Default Value: 0
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
DNSPort
int
Default Value: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
char*
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default Value: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
char*
Default Value: ""
The local network interface to bind the socket to.
LocalPort
int
Default Value: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default Value: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default Value: 60000
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
UseIPv6
int
Default Value: FALSE
Enables or disables IP protocol version 6.
Constructors
SocketSettings()
Creates a new SocketSettings object.
TLSConnectionInfo Type
Contains information about a network connection.
Syntax
SecureBlackboxTLSConnectionInfo (declared in secureblackbox.h)
Remarks
Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters.
Fields
AEADCipher
int (read-only)
Default Value: FALSE
Indicates whether the encryption algorithm used is an AEAD cipher.
ChainValidationDetails
int (read-only)
Default Value: 0
The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
ChainValidationResult
int (read-only)
Default Value: 0
The outcome of a certificate chain validation routine.
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
Ciphersuite
char* (read-only)
Default Value: ""
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
ClientAuthenticated
int (read-only)
Default Value: FALSE
Specifies whether client authentication was performed during this connection.
ClientAuthRequested
int (read-only)
Default Value: FALSE
Specifies whether client authentication was requested during this connection.
ConnectionEstablished
int (read-only)
Default Value: FALSE
Indicates whether the connection has been established fully.
ConnectionID
char* (read-only)
Default Value:
The unique identifier assigned to this connection.
DigestAlgorithm
char* (read-only)
Default Value: ""
The digest algorithm used in a TLS-enabled connection.
EncryptionAlgorithm
char* (read-only)
Default Value: ""
The symmetric encryption algorithm used in a TLS-enabled connection.
Exportable
int (read-only)
Default Value: FALSE
Indicates whether a TLS connection uses a reduced-strength exportable cipher.
ID
int64 (read-only)
Default Value: -1
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
KeyExchangeAlgorithm
char* (read-only)
Default Value: ""
The key exchange algorithm used in a TLS-enabled connection.
KeyExchangeKeyBits
int (read-only)
Default Value: 0
The length of the key exchange key of a TLS-enabled connection.
NamedECCurve
char* (read-only)
Default Value: ""
The elliptic curve used in this connection.
PFSCipher
int (read-only)
Default Value: FALSE
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
PreSharedIdentity
char*
Default Value: ""
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedIdentityHint
char* (read-only)
Default Value: ""
A hint professed by the server to help the client select the PSK identity to use.
PublicKeyBits
int (read-only)
Default Value: 0
The length of the public key.
RemoteAddress
char* (read-only)
Default Value: ""
The client's IP address.
RemotePort
int (read-only)
Default Value: 0
The remote port of the client connection.
ResumedSession
int (read-only)
Default Value: FALSE
Indicates whether a TLS-enabled connection was spawned from another TLS connection
SecureConnection
int (read-only)
Default Value: FALSE
Indicates whether TLS or SSL is enabled for this connection.
ServerAuthenticated
int (read-only)
Default Value: FALSE
Indicates whether server authentication was performed during a TLS-enabled connection.
SignatureAlgorithm
char* (read-only)
Default Value: ""
The signature algorithm used in a TLS handshake.
SymmetricBlockSize
int (read-only)
Default Value: 0
The block size of the symmetric algorithm used.
SymmetricKeyBits
int (read-only)
Default Value: 0
The key length of the symmetric algorithm used.
TotalBytesReceived
int64 (read-only)
Default Value: 0
The total number of bytes received over this connection.
TotalBytesSent
int64 (read-only)
Default Value: 0
The total number of bytes sent over this connection.
ValidationLog
char* (read-only)
Default Value: ""
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
Version
char* (read-only)
Default Value: ""
Indicates the version of SSL/TLS protocol negotiated during this connection.
Constructors
TLSConnectionInfo()
Creates a new TLSConnectionInfo object.
TLSSettings Type
A container for TLS connection settings.
Syntax
SecureBlackboxTLSSettings (declared in secureblackbox.h)
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
AutoValidateCertificates
int
Default Value: TRUE
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
BaseConfiguration
int
Default Value: 0
Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Ciphersuites
char*
Default Value: ""
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
ClientAuth
int
Default Value: 0
Enables or disables certificate-based client authentication.
Set this property to true to tune up the client authentication type:
ccatNoAuth | 0 | |
ccatRequestCert | 1 | |
ccatRequireCert | 2 |
ECCurves
char*
Default Value: ""
Defines the elliptic curves to enable.
Extensions
char*
Default Value: ""
Provides access to TLS extensions.
ForceResumeIfDestinationChanges
int
Default Value: FALSE
Whether to force TLS session resumption when the destination address changes.
PreSharedIdentity
char*
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedKey
char*
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
PreSharedKeyCiphersuite
char*
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
RenegotiationAttackPreventionMode
int
Default Value: 2
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
RevocationCheck
int
Default Value: 1
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
SSLOptions
int
Default Value: 16
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
TLSMode
int
Default Value: 0
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
UseExtendedMasterSecret
int
Default Value: FALSE
Enables the Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
int
Default Value: FALSE
Enables or disables the TLS session resumption capability.
Versions
int
Default Value: 16
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Constructors
TLSSettings()
Creates a new TLSSettings object.
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.
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.
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
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.
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
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.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
SecureBlackboxStream Type
Syntax
SecureBlackboxStream (declared in secureblackbox.h)
Remarks
The 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.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when a SecureBlackboxStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Config Settings (WebDAVServer Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.WebDAVServer Config Settings
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.
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
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):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
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:
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:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (WebDAVServer 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) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |