WebDAVServer Class
Properties Methods Events Configuration 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. |
| AuthBasic | Enables or disables basic authentication. |
| AuthDigest | Enables or disables digest authentication. |
| AuthDigestExpire | Specifies digest expiration time for digest authentication. |
| AuthRealm | Specifies authentication realm for digest and NTLM authentication. |
| BoundPort | Indicates the bound listening port. |
| ClientAuth | Enables or disables certificate-based client authentication. |
| ClientFileEntryATime | Contains the last access time for this object, in UTC. |
| ClientFileEntryContentType | The object's content type. |
| ClientFileEntryCTime | Contains this object's creation time, in UTC. |
| ClientFileEntryDirectory | Specifies whether this object is a directory. |
| ClientFileEntryDisplayName | Contains the display name of the object. |
| ClientFileEntryETag | An e-tag of the object. |
| ClientFileEntryFullURL | A full path to the object. |
| ClientFileEntryMTime | The last modification time of the object, in UTC. |
| ClientFileEntryParentURL | Specifies the object's parent URL. |
| ClientFileEntrySize | The size of the object in bytes. |
| ClientFileEntrySupportsExclusiveLock | Indicates whether the entry supports exclusive locking. |
| ClientFileEntrySupportsSharedLock | Indicates whether the entry supports shared lock. |
| ClientFileEntryURL | A URL of the object. |
| DocumentRoot | The document root of the server. |
| ErrorOrigin | Indicates the endpoint where the error originates from. |
| ErrorSeverity | The severity of the error that happened. |
| ExternalCryptoAsyncDocumentID | Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. |
| ExternalCryptoCustomParams | Custom parameters to be passed to the signing service (uninterpreted). |
| ExternalCryptoData | Additional data to be included in the async state and mirrored back by the requestor. |
| ExternalCryptoExternalHashCalculation | Specifies whether the message hash is to be calculated at the external endpoint. |
| ExternalCryptoHashAlgorithm | Specifies the request's signature hash algorithm. |
| ExternalCryptoKeyID | The ID of the pre-shared key used for DC request authentication. |
| ExternalCryptoKeySecret | The pre-shared key used for DC request authentication. |
| ExternalCryptoMethod | Specifies the asynchronous signing method. |
| ExternalCryptoMode | Specifies the external cryptography mode. |
| ExternalCryptoPublicKeyAlgorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
| FIPSMode | Reserved. |
| Host | The host to bind the listening port to. |
| MetadataFlushTimeout | Specifies metadata flush timeout. |
| MetadataRoot | The document root of the server. |
| PinnedClientAddress | The client's IP address. |
| PinnedClientChainValidationDetails | The details of a certificate chain validation outcome. |
| PinnedClientChainValidationResult | The outcome of a certificate chain validation routine. |
| PinnedClientCiphersuite | The cipher suite employed by this connection. |
| PinnedClientClientAuthenticated | Specifies whether client authentication was performed during this connection. |
| PinnedClientDigestAlgorithm | The digest algorithm used in a TLS-enabled connection. |
| PinnedClientEncryptionAlgorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
| PinnedClientID | The client connection's unique identifier. |
| PinnedClientKeyExchangeAlgorithm | The key exchange algorithm used in a TLS-enabled connection. |
| PinnedClientKeyExchangeKeyBits | The length of the key exchange key of a TLS-enabled connection. |
| PinnedClientNamedECCurve | The elliptic curve used in this connection. |
| PinnedClientPFSCipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
| PinnedClientPort | The remote port of the client connection. |
| PinnedClientPreSharedIdentity | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| PinnedClientPublicKeyBits | The length of the public key. |
| PinnedClientResumedSession | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
| PinnedClientSecureConnection | Indicates whether TLS or SSL is enabled for this connection. |
| PinnedClientSignatureAlgorithm | The signature algorithm used in a TLS handshake. |
| PinnedClientSymmetricBlockSize | The block size of the symmetric algorithm used. |
| PinnedClientSymmetricKeyBits | The key length of the symmetric algorithm used. |
| PinnedClientTotalBytesReceived | The total number of bytes received over this connection. |
| PinnedClientTotalBytesSent | The total number of bytes sent over this connection. |
| PinnedClientValidationLog | Contains the server certificate's chain validation log. |
| PinnedClientVersion | Indicates the version of SSL/TLS protocol negotiated during this connection. |
| PinnedClientCertCount | The number of records in the PinnedClientCert arrays. |
| PinnedClientCertBytes | Returns raw certificate data in DER format. |
| PinnedClientCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
| PinnedClientCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
| PinnedClientCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
| PinnedClientCertCurve | Specifies the elliptic curve of the EC public key. |
| PinnedClientCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
| PinnedClientCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
| PinnedClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| PinnedClientCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 . |
| PinnedClientCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
| PinnedClientCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
| PinnedClientCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
| PinnedClientCertKeyBits | Returns the length of the public key. |
| PinnedClientCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
| PinnedClientCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| PinnedClientCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
| PinnedClientCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
| PinnedClientCertOCSPNoCheck | TBD. |
| PinnedClientCertOrigin | Returns the origin of this certificate. |
| PinnedClientCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
| PinnedClientCertPrivateKeyBytes | Contains the certificate's private key. |
| PinnedClientCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
| PinnedClientCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
| PinnedClientCertPublicKeyBytes | Contains the certificate's public key in DER format. |
| PinnedClientCertQualifiedStatements | TBD. |
| PinnedClientCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| PinnedClientCertSerialNumber | Returns the certificate's serial number. |
| PinnedClientCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
| PinnedClientCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| PinnedClientCertSubjectAlternativeName | TBD. |
| PinnedClientCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
| PinnedClientCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
| PinnedClientCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
| PinnedClientCertValidTo | The time point at which the certificate expires, in UTC. |
| 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. |
| ServerCertCount | The number of records in the ServerCert arrays. |
| ServerCertBytes | Returns raw certificate data in DER format. |
| ServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
| SocketLocalAddress | The local network interface to bind the socket to. |
| SocketLocalPort | The local port number to bind the socket to. |
| SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
| SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| SocketUseIPv6 | Enables or disables IP protocol version 6. |
| TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
| TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
| TLSECCurves | Defines the elliptic curves to enable. |
| TLSExtensions | Provides access to TLS extensions. |
| TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
| TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
| TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
| TLSSSLOptions | 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. |
| TLSTLSMode | Specifies the TLS mode to use. |
| TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
| TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
| TLSVersions | Th SSL/TLS versions to enable by default. |
| UserCount | The number of records in the User arrays. |
| UserAssociatedData | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. |
| UserBasePath | Base path for this user in the server's file system. |
| UserCert | Contains the user's certificate. |
| UserData | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. |
| UserHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| UserHashAlgorithm | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. |
| UserIncomingSpeedLimit | Specifies the incoming speed limit for this user. |
| UserOtpAlgorithm | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). |
| UserOtpValue | The user's time interval (TOTP) or Counter (HOTP). |
| UserOutgoingSpeedLimit | Specifies the outgoing speed limit for this user. |
| UserPassword | The user's authentication password. |
| UserPasswordLen | Specifies the length of the user's OTP password. |
| UserSharedSecret | Contains the user's secret key, which is essentially a shared secret between the client and server. |
| UserSSHKey | Contains the user's SSH key. |
| UserUsername | The registered name (login) of the user. |
| 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.
| Config | Sets or retrieves a configuration setting. |
| DoAction | Performs an additional action. |
| DropClient | Terminates a client connection. |
| GetClientBuffer | Obtains a pending connection buffer. |
| ListClients | Enumerates the connected clients. |
| PinClient | Takes a snapshot of the connection's properties. |
| SetClientBuffer | Commits a data buffer to the connection. |
| SetClientFileEntry | Commits a file entry to the connection. |
| 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 | TBD. |
| AfterCopyObject | TBD. |
| AfterCreateCalendar | TBD. |
| AfterCreateCollection | TBD. |
| AfterCustomRequest | TBD. |
| AfterLockObject | TBD. |
| AfterRefreshLockObject | TBD. |
| AfterRemoveObject | TBD. |
| AfterRenameObject | TBD. |
| AfterSetAttributes | TBD. |
| AfterUnlockObject | TBD. |
| AuthAttempt | Fires when a connected client makes an authentication attempt. |
| BeforeBrowse | TBD. |
| BeforeCopyObject | TBD. |
| BeforeCreateCalendar | TBD. |
| BeforeCreateCollection | TBD. |
| BeforeCustomRequest | TBD. |
| BeforeDownloadObject | TBD. |
| BeforeLockObject | TBD. |
| BeforeRefreshLockObject | TBD. |
| BeforeRemoveObject | TBD. |
| BeforeRenameObject | TBD. |
| BeforeRequest | Fires before a DAV request is processed. |
| BeforeSetAttributes | TBD. |
| BeforeUnlockObject | TBD. |
| BeforeUploadObject | TBD. |
| CertificateValidate | Fires when a client certificate needs to be validated. |
| ClearAttribute | TBD. |
| Connect | Reports an accepted connection. |
| CopyObject | TBD. |
| CreateCalendar | TBD. |
| CreateCollection | TBD. |
| CustomRequest | TBD. |
| Data | Supplies a data chunk received from a client. |
| Disconnect | Fires to report a disconnected client. |
| DownloadObject | TBD. |
| 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. |
| ListAttributes | TBD. |
| ListSubObjects | TBD. |
| LockObject | TBD. |
| Notification | This event notifies the application about an underlying control flow event. |
| QueryQuota | Reflects a quota enquiry by a client. |
| ReadAttribute | TBD. |
| ReadObject | Requests a piece of object data from the application. |
| RefreshLockObject | TBD. |
| RemoveObject | TBD. |
| RenameObject | TBD. |
| ResourceAccess | Reports an attempt to access a resource. |
| SetAttribute | TBD. |
| TLSEstablished | Reports the setup of a TLS session. |
| TLSHandshake | TBD. |
| TLSPSK | Requests a pre-shared key for TLS-PSK. |
| TLSShutdown | Reports closure of a TLS session. |
| UnlockObject | TBD. |
| UploadObject | TBD. |
| UploadObjectCompleted | This event is fired when a upload operation completes. |
| WriteObject | Hands a piece of object data to the application. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| ClientAuth | Enables or disables certificate-based client authentication. |
| DualStack | Allows the use of ip4 and ip6 simultaneously. |
| Host | The host to bind to. |
| ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
| WebsiteName | The website name for the TLS certificate. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| Tag | Allows to store any custom data. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |
Active Property (WebDAVServer Class)
Indicates whether the server is active and is listening to new connections.
Syntax
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
AuthBasic Property (WebDAVServer Class)
Enables or disables basic authentication.
Syntax
bool GetAuthBasic();
int SetAuthBasic(bool bAuthBasic);
Default Value
false
Remarks
Use this property to enable or disable basic user authentication in the HTTP server.
Data Type
Boolean
AuthDigest Property (WebDAVServer Class)
Enables or disables digest authentication.
Syntax
bool GetAuthDigest();
int SetAuthDigest(bool bAuthDigest);
Default Value
false
Remarks
Use this property to enable or disable digest-based user authentication in the HTTP server.
Data Type
Boolean
AuthDigestExpire Property (WebDAVServer Class)
Specifies digest expiration time for digest authentication.
Syntax
int GetAuthDigestExpire();
int SetAuthDigestExpire(int iAuthDigestExpire);
Default Value
20
Remarks
Use this property to specify the digest expiration time for digest authentication, in seconds.
Data Type
Integer
AuthRealm Property (WebDAVServer Class)
Specifies authentication realm for digest and NTLM authentication.
Syntax
QString GetAuthRealm();
int SetAuthRealm(QString qsAuthRealm);
Default Value
"SecureBlackbox"
Remarks
Specifies authentication realm for digest and NTLM authentication types.
Data Type
String
BoundPort Property (WebDAVServer Class)
Indicates the bound listening port.
Syntax
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
ClientAuth Property (WebDAVServer Class)
Enables or disables certificate-based client authentication.
Syntax
int GetClientAuth();
int SetClientAuth(int iClientAuth);
Possible Values
CCAT_NO_AUTH(0),
CCAT_REQUEST_CERT(1),
CCAT_REQUIRE_CERT(2)
Default Value
0
Remarks
Set this property to true to tune up the client authentication type: ccatNoAuth = 0; ccatRequestCert = 1; ccatRequireCert = 2;
Data Type
Integer
ClientFileEntryATime Property (WebDAVServer Class)
Contains the last access time for this object, in UTC.
Syntax
QString GetClientFileEntryATime();
int SetClientFileEntryATime(QString qsClientFileEntryATime);
Default Value
""
Remarks
Contains the last access time for this object, in UTC.
This property is not available at design time.
Data Type
String
ClientFileEntryContentType Property (WebDAVServer Class)
The object's content type.
Syntax
QString GetClientFileEntryContentType();
int SetClientFileEntryContentType(QString qsClientFileEntryContentType);
Default Value
""
Remarks
The object's content type.
This property is not available at design time.
Data Type
String
ClientFileEntryCTime Property (WebDAVServer Class)
Contains this object's creation time, in UTC.
Syntax
QString GetClientFileEntryCTime();
int SetClientFileEntryCTime(QString qsClientFileEntryCTime);
Default Value
""
Remarks
Contains this object's creation time, in UTC.
This property is not available at design time.
Data Type
String
ClientFileEntryDirectory Property (WebDAVServer Class)
Specifies whether this object is a directory.
Syntax
bool GetClientFileEntryDirectory();
int SetClientFileEntryDirectory(bool bClientFileEntryDirectory);
Default Value
false
Remarks
Specifies whether this object is a directory.
This property is not available at design time.
Data Type
Boolean
ClientFileEntryDisplayName Property (WebDAVServer Class)
Contains the display name of the object.
Syntax
QString GetClientFileEntryDisplayName();
int SetClientFileEntryDisplayName(QString qsClientFileEntryDisplayName);
Default Value
""
Remarks
Contains the display name of the object.
This property is not available at design time.
Data Type
String
ClientFileEntryETag Property (WebDAVServer Class)
An e-tag of the object.
Syntax
QString GetClientFileEntryETag();
int SetClientFileEntryETag(QString qsClientFileEntryETag);
Default Value
""
Remarks
An e-tag of the object.
This property is not available at design time.
Data Type
String
ClientFileEntryFullURL Property (WebDAVServer Class)
A full path to the object.
Syntax
QString GetClientFileEntryFullURL();
int SetClientFileEntryFullURL(QString qsClientFileEntryFullURL);
Default Value
""
Remarks
A full path to the object.
This property is not available at design time.
Data Type
String
ClientFileEntryMTime Property (WebDAVServer Class)
The last modification time of the object, in UTC.
Syntax
QString GetClientFileEntryMTime();
int SetClientFileEntryMTime(QString qsClientFileEntryMTime);
Default Value
""
Remarks
The last modification time of the object, in UTC.
This property is not available at design time.
Data Type
String
ClientFileEntryParentURL Property (WebDAVServer Class)
Specifies the object's parent URL.
Syntax
QString GetClientFileEntryParentURL();
int SetClientFileEntryParentURL(QString qsClientFileEntryParentURL);
Default Value
""
Remarks
Specifies the object's parent URL.
This property is not available at design time.
Data Type
String
ClientFileEntrySize Property (WebDAVServer Class)
The size of the object in bytes.
Syntax
qint64 GetClientFileEntrySize();
int SetClientFileEntrySize(qint64 lClientFileEntrySize);
Default Value
0
Remarks
The size of the object in bytes.
This property is not available at design time.
Data Type
Long64
ClientFileEntrySupportsExclusiveLock Property (WebDAVServer Class)
Indicates whether the entry supports exclusive locking.
Syntax
bool GetClientFileEntrySupportsExclusiveLock();
int SetClientFileEntrySupportsExclusiveLock(bool bClientFileEntrySupportsExclusiveLock);
Default Value
false
Remarks
Indicates whether the entry supports exclusive locking.
This property is not available at design time.
Data Type
Boolean
ClientFileEntrySupportsSharedLock Property (WebDAVServer Class)
Indicates whether the entry supports shared lock.
Syntax
bool GetClientFileEntrySupportsSharedLock();
int SetClientFileEntrySupportsSharedLock(bool bClientFileEntrySupportsSharedLock);
Default Value
false
Remarks
Indicates whether the entry supports shared lock.
This property is not available at design time.
Data Type
Boolean
ClientFileEntryURL Property (WebDAVServer Class)
A URL of the object.
Syntax
QString GetClientFileEntryURL();
int SetClientFileEntryURL(QString qsClientFileEntryURL);
Default Value
""
Remarks
A URL of the object.
This property is not available at design time.
Data Type
String
DocumentRoot Property (WebDAVServer Class)
The document root of the server.
Syntax
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
ErrorOrigin Property (WebDAVServer Class)
Indicates the endpoint where the error originates from.
Syntax
int GetErrorOrigin();
int SetErrorOrigin(int iErrorOrigin);
Possible Values
EO_LOCAL(0),
EO_REMOTE(1)
Default Value
0
Remarks
Use this property to establish whether the reported error originates from a local or remote endpoint.
| eoLocal | 0 | |
| eoRemote | 1 |
This property is not available at design time.
Data Type
Integer
ErrorSeverity Property (WebDAVServer Class)
The severity of the error that happened.
Syntax
int GetErrorSeverity();
int SetErrorSeverity(int iErrorSeverity);
Possible Values
ES_INFO(0),
ES_WARNING(1),
ES_FATAL(2)
Default Value
1
Remarks
Use this property to establish whether the error is fatal.
| esWarning | 1 | |
| esFatal | 2 |
This property is not available at design time.
Data Type
Integer
ExternalCryptoAsyncDocumentID Property (WebDAVServer Class)
Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.
Syntax
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);
Default Value
""
Remarks
Specifies the document ID for SignAsyncEnd() call
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.
Data Type
String
ExternalCryptoCustomParams Property (WebDAVServer Class)
Custom parameters to be passed to the signing service (uninterpreted).
Syntax
QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);
Default Value
""
Remarks
Custom parameters to be passed to the signing service (uninterpreted).
This property is not available at design time.
Data Type
String
ExternalCryptoData Property (WebDAVServer Class)
Additional data to be included in the async state and mirrored back by the requestor.
Syntax
QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);
Default Value
""
Remarks
Additional data to be included in the async state and mirrored back by the requestor
This property is not available at design time.
Data Type
String
ExternalCryptoExternalHashCalculation Property (WebDAVServer Class)
Specifies whether the message hash is to be calculated at the external endpoint.
Syntax
bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);
Default Value
false
Remarks
Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.
Data Type
Boolean
ExternalCryptoHashAlgorithm Property (WebDAVServer Class)
Specifies the request's signature hash algorithm.
Syntax
QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);
Default Value
"SHA256"
Remarks
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 |
Data Type
String
ExternalCryptoKeyID Property (WebDAVServer Class)
The ID of the pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);
Default Value
""
Remarks
The ID of the pre-shared key used for DC request authentication.
Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides extra protection layer for the protocol and diminishes the risk of private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret 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";
Data Type
String
ExternalCryptoKeySecret Property (WebDAVServer Class)
The pre-shared key used for DC request authentication.
Syntax
QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);
Default Value
""
Remarks
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 ExternalCryptoKeyID topic.
Data Type
String
ExternalCryptoMethod Property (WebDAVServer Class)
Specifies the asynchronous signing method.
Syntax
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);
Possible Values
ASMD_PKCS1(0),
ASMD_PKCS7(1)
Default Value
0
Remarks
Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.
Available options:
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |
Data Type
Integer
ExternalCryptoMode Property (WebDAVServer Class)
Specifies the external cryptography mode.
Syntax
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);
Possible Values
ECM_DEFAULT(0),
ECM_DISABLED(1),
ECM_GENERIC(2),
ECM_DCAUTH(3),
ECM_DCAUTH_JSON(4)
Default Value
0
Remarks
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 OnExternalSign event (2) |
| ecmDCAuth | DCAuth signing (3) |
| ecmDCAuthJSON | DCAuth signing in JSON format (4) |
This property is not available at design time.
Data Type
Integer
ExternalCryptoPublicKeyAlgorithm Property (WebDAVServer Class)
Provide public key algorithm here if the certificate is not available on the pre-signing stage.
Syntax
QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);
Default Value
""
Remarks
Provide 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 |
Data Type
String
FIPSMode Property (WebDAVServer Class)
Reserved.
Syntax
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
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
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 document root of the server.
Syntax
QString GetMetadataRoot();
int SetMetadataRoot(QString qsMetadataRoot);
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
PinnedClientAddress Property (WebDAVServer Class)
The client's IP address.
Syntax
QString GetPinnedClientAddress();
Default Value
""
Remarks
The client's IP address.
This property is read-only and not available at design time.
Data Type
String
PinnedClientChainValidationDetails Property (WebDAVServer Class)
The details of a certificate chain validation outcome.
Syntax
int GetPinnedClientChainValidationDetails();
Default Value
0
Remarks
The details of a certificate chain validation outcome. They may often suggest what reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
| 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 |
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientChainValidationResult Property (WebDAVServer Class)
The outcome of a certificate chain validation routine.
Syntax
int GetPinnedClientChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
Default Value
0
Remarks
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.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCiphersuite Property (WebDAVServer Class)
The cipher suite employed by this connection.
Syntax
QString GetPinnedClientCiphersuite();
Default Value
""
Remarks
The cipher suite employed by this connection.
For TLS connections, this property returns the ciphersuite that was/is employed by the connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientClientAuthenticated Property (WebDAVServer Class)
Specifies whether client authentication was performed during this connection.
Syntax
bool GetPinnedClientClientAuthenticated();
Default Value
false
Remarks
Specifies whether client authentication was performed during this connection.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientDigestAlgorithm Property (WebDAVServer Class)
The digest algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientDigestAlgorithm();
Default Value
""
Remarks
The digest algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientEncryptionAlgorithm Property (WebDAVServer Class)
The symmetric encryption algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientEncryptionAlgorithm();
Default Value
""
Remarks
The symmetric encryption algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientID Property (WebDAVServer Class)
The client connection's unique identifier.
Syntax
qint64 GetPinnedClientID();
Default Value
-1
Remarks
The client connection's unique identifier. This value is used throughout to refer to a particular client connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientKeyExchangeAlgorithm Property (WebDAVServer Class)
The key exchange algorithm used in a TLS-enabled connection.
Syntax
QString GetPinnedClientKeyExchangeAlgorithm();
Default Value
""
Remarks
The key exchange algorithm used in a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientKeyExchangeKeyBits Property (WebDAVServer Class)
The length of the key exchange key of a TLS-enabled connection.
Syntax
int GetPinnedClientKeyExchangeKeyBits();
Default Value
0
Remarks
The length of the key exchange key of a TLS-enabled connection.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientNamedECCurve Property (WebDAVServer Class)
The elliptic curve used in this connection.
Syntax
QString GetPinnedClientNamedECCurve();
Default Value
""
Remarks
The elliptic curve used in this connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientPFSCipher Property (WebDAVServer Class)
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
Syntax
bool GetPinnedClientPFSCipher();
Default Value
false
Remarks
Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientPort Property (WebDAVServer Class)
The remote port of the client connection.
Syntax
int GetPinnedClientPort();
Default Value
0
Remarks
The remote port of the client connection.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientPreSharedIdentity Property (WebDAVServer Class)
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetPinnedClientPreSharedIdentity();
Default Value
""
Remarks
Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is read-only and not available at design time.
Data Type
String
PinnedClientPublicKeyBits Property (WebDAVServer Class)
The length of the public key.
Syntax
int GetPinnedClientPublicKeyBits();
Default Value
0
Remarks
The length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientResumedSession Property (WebDAVServer Class)
Indicates whether a TLS-enabled connection was spawned from another TLS connection.
Syntax
bool GetPinnedClientResumedSession();
Default Value
false
Remarks
Indicates whether a TLS-enabled connection was spawned from another TLS connection
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientSecureConnection Property (WebDAVServer Class)
Indicates whether TLS or SSL is enabled for this connection.
Syntax
bool GetPinnedClientSecureConnection();
Default Value
false
Remarks
Indicates whether TLS or SSL is enabled for this connection.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientSignatureAlgorithm Property (WebDAVServer Class)
The signature algorithm used in a TLS handshake.
Syntax
QString GetPinnedClientSignatureAlgorithm();
Default Value
""
Remarks
The signature algorithm used in a TLS handshake.
This property is read-only and not available at design time.
Data Type
String
PinnedClientSymmetricBlockSize Property (WebDAVServer Class)
The block size of the symmetric algorithm used.
Syntax
int GetPinnedClientSymmetricBlockSize();
Default Value
0
Remarks
The block size of the symmetric algorithm used.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientSymmetricKeyBits Property (WebDAVServer Class)
The key length of the symmetric algorithm used.
Syntax
int GetPinnedClientSymmetricKeyBits();
Default Value
0
Remarks
The key length of the symmetric algorithm used.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientTotalBytesReceived Property (WebDAVServer Class)
The total number of bytes received over this connection.
Syntax
qint64 GetPinnedClientTotalBytesReceived();
Default Value
0
Remarks
The total number of bytes received over this connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientTotalBytesSent Property (WebDAVServer Class)
The total number of bytes sent over this connection.
Syntax
qint64 GetPinnedClientTotalBytesSent();
Default Value
0
Remarks
The total number of bytes sent over this connection.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientValidationLog Property (WebDAVServer Class)
Contains the server certificate's chain validation log.
Syntax
QString GetPinnedClientValidationLog();
Default Value
""
Remarks
Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.
This property is read-only and not available at design time.
Data Type
String
PinnedClientVersion Property (WebDAVServer Class)
Indicates the version of SSL/TLS protocol negotiated during this connection.
Syntax
QString GetPinnedClientVersion();
Default Value
""
Remarks
Indicates the version of SSL/TLS protocol negotiated during this connection.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertCount Property (WebDAVServer Class)
The number of records in the PinnedClientCert arrays.
Syntax
int GetPinnedClientCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PinnedClientCertBytes
- PinnedClientCertCA
- PinnedClientCertCAKeyID
- PinnedClientCertCRLDistributionPoints
- PinnedClientCertCurve
- PinnedClientCertFingerprint
- PinnedClientCertFriendlyName
- PinnedClientCertHandle
- PinnedClientCertHashAlgorithm
- PinnedClientCertIssuer
- PinnedClientCertIssuerRDN
- PinnedClientCertKeyAlgorithm
- PinnedClientCertKeyBits
- PinnedClientCertKeyFingerprint
- PinnedClientCertKeyUsage
- PinnedClientCertKeyValid
- PinnedClientCertOCSPLocations
- PinnedClientCertOCSPNoCheck
- PinnedClientCertOrigin
- PinnedClientCertPolicyIDs
- PinnedClientCertPrivateKeyBytes
- PinnedClientCertPrivateKeyExists
- PinnedClientCertPrivateKeyExtractable
- PinnedClientCertPublicKeyBytes
- PinnedClientCertQualifiedStatements
- PinnedClientCertSelfSigned
- PinnedClientCertSerialNumber
- PinnedClientCertSigAlgorithm
- PinnedClientCertSubject
- PinnedClientCertSubjectAlternativeName
- PinnedClientCertSubjectKeyID
- PinnedClientCertSubjectRDN
- PinnedClientCertValidFrom
- PinnedClientCertValidTo
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertBytes Property (WebDAVServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetPinnedClientCertBytes(int iPinnedClientCertIndex);
Remarks
Returns raw certificate data in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertCA Property (WebDAVServer Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
bool GetPinnedClientCertCA(int iPinnedClientCertIndex);
Default Value
false
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientCertCAKeyID Property (WebDAVServer Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
QByteArray GetPinnedClientCertCAKeyID(int iPinnedClientCertIndex);
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertCRLDistributionPoints Property (WebDAVServer Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
QString GetPinnedClientCertCRLDistributionPoints(int iPinnedClientCertIndex);
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertCurve Property (WebDAVServer Class)
Specifies the elliptic curve of the EC public key.
Syntax
QString GetPinnedClientCertCurve(int iPinnedClientCertIndex);
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
| 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 |
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertFingerprint Property (WebDAVServer Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
QByteArray GetPinnedClientCertFingerprint(int iPinnedClientCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertFriendlyName Property (WebDAVServer Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
QString GetPinnedClientCertFriendlyName(int iPinnedClientCertIndex);
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertHandle Property (WebDAVServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetPinnedClientCertHandle(int iPinnedClientCertIndex);
Default Value
0
Remarks
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());
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
PinnedClientCertHashAlgorithm Property (WebDAVServer Class)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
Syntax
QString GetPinnedClientCertHashAlgorithm(int iPinnedClientCertIndex);
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
| 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 |
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertIssuer Property (WebDAVServer Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
QString GetPinnedClientCertIssuer(int iPinnedClientCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertIssuerRDN Property (WebDAVServer Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
QString GetPinnedClientCertIssuerRDN(int iPinnedClientCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertKeyAlgorithm Property (WebDAVServer Class)
Specifies the public key algorithm of this certificate.
Syntax
QString GetPinnedClientCertKeyAlgorithm(int iPinnedClientCertIndex);
Default Value
"0"
Remarks
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 |
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertKeyBits Property (WebDAVServer Class)
Returns the length of the public key.
Syntax
int GetPinnedClientCertKeyBits(int iPinnedClientCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertKeyFingerprint Property (WebDAVServer Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
QByteArray GetPinnedClientCertKeyFingerprint(int iPinnedClientCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertKeyUsage Property (WebDAVServer Class)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
int GetPinnedClientCertKeyUsage(int iPinnedClientCertIndex);
Default Value
0
Remarks
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 |
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertKeyValid Property (WebDAVServer Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
bool GetPinnedClientCertKeyValid(int iPinnedClientCertIndex);
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientCertOCSPLocations Property (WebDAVServer Class)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
QString GetPinnedClientCertOCSPLocations(int iPinnedClientCertIndex);
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertOCSPNoCheck Property (WebDAVServer Class)
TBD.
Syntax
bool GetPinnedClientCertOCSPNoCheck(int iPinnedClientCertIndex);
Default Value
false
Remarks
TBD.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientCertOrigin Property (WebDAVServer Class)
Returns the origin of this certificate.
Syntax
int GetPinnedClientCertOrigin(int iPinnedClientCertIndex);
Default Value
0
Remarks
Returns the origin of this certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertPolicyIDs Property (WebDAVServer Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
QString GetPinnedClientCertPolicyIDs(int iPinnedClientCertIndex);
Default Value
""
Remarks
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.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertPrivateKeyBytes Property (WebDAVServer Class)
Contains the certificate's private key.
Syntax
QByteArray GetPinnedClientCertPrivateKeyBytes(int iPinnedClientCertIndex);
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertPrivateKeyExists Property (WebDAVServer Class)
Indicates whether the certificate has an associated private key.
Syntax
bool GetPinnedClientCertPrivateKeyExists(int iPinnedClientCertIndex);
Default Value
false
Remarks
Indicates whether the certificate has an associated private key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientCertPrivateKeyExtractable Property (WebDAVServer Class)
Indicates whether the private key is extractable.
Syntax
bool GetPinnedClientCertPrivateKeyExtractable(int iPinnedClientCertIndex);
Default Value
false
Remarks
Indicates whether the private key is extractable
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientCertPublicKeyBytes Property (WebDAVServer Class)
Contains the certificate's public key in DER format.
Syntax
QByteArray GetPinnedClientCertPublicKeyBytes(int iPinnedClientCertIndex);
Remarks
Contains the certificate's public key in DER format.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertQualifiedStatements Property (WebDAVServer Class)
TBD.
Syntax
int GetPinnedClientCertQualifiedStatements(int iPinnedClientCertIndex);
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
Default Value
0
Remarks
TBD
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
PinnedClientCertSelfSigned Property (WebDAVServer Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
bool GetPinnedClientCertSelfSigned(int iPinnedClientCertIndex);
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
PinnedClientCertSerialNumber Property (WebDAVServer Class)
Returns the certificate's serial number.
Syntax
QByteArray GetPinnedClientCertSerialNumber(int iPinnedClientCertIndex);
Remarks
Returns the certificate's serial number.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertSigAlgorithm Property (WebDAVServer Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
QString GetPinnedClientCertSigAlgorithm(int iPinnedClientCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertSubject Property (WebDAVServer Class)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
QString GetPinnedClientCertSubject(int iPinnedClientCertIndex);
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertSubjectAlternativeName Property (WebDAVServer Class)
TBD.
Syntax
QString GetPinnedClientCertSubjectAlternativeName(int iPinnedClientCertIndex);
Default Value
""
Remarks
TBD.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertSubjectKeyID Property (WebDAVServer Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
QByteArray GetPinnedClientCertSubjectKeyID(int iPinnedClientCertIndex);
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
PinnedClientCertSubjectRDN Property (WebDAVServer Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
QString GetPinnedClientCertSubjectRDN(int iPinnedClientCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertValidFrom Property (WebDAVServer Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
QString GetPinnedClientCertValidFrom(int iPinnedClientCertIndex);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
PinnedClientCertValidTo Property (WebDAVServer Class)
The time point at which the certificate expires, in UTC.
Syntax
QString GetPinnedClientCertValidTo(int iPinnedClientCertIndex);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.
This property is read-only and not available at design time.
Data Type
String
Port Property (WebDAVServer Class)
Specifies the port number to listen for connections on.
Syntax
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
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
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
ServerCertCount Property (WebDAVServer Class)
The number of records in the ServerCert arrays.
Syntax
int GetServerCertCount();
int SetServerCertCount(int iServerCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ServerCertCount - 1.This property is not available at design time.
Data Type
Integer
ServerCertBytes Property (WebDAVServer Class)
Returns raw certificate data in DER format.
Syntax
QByteArray GetServerCertBytes(int iServerCertIndex);
Remarks
Returns raw certificate data in DER format.
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerCertHandle Property (WebDAVServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetServerCertHandle(int iServerCertIndex);
int SetServerCertHandle(int iServerCertIndex, qint64 lServerCertHandle);
Default Value
0
Remarks
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());
The ServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerCertCount property.
This property is not available at design time.
Data Type
Long64
SocketIncomingSpeedLimit Property (WebDAVServer Class)
The maximum number of bytes to read from the socket, per second.
Syntax
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (WebDAVServer Class)
The local network interface to bind the socket to.
Syntax
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (WebDAVServer Class)
The local port number to bind the socket to.
Syntax
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (WebDAVServer Class)
The maximum number of bytes to write to the socket, per second.
Syntax
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (WebDAVServer Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);
Default Value
60000
Remarks
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).
Data Type
Integer
SocketUseIPv6 Property (WebDAVServer Class)
Enables or disables IP protocol version 6.
Syntax
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
TLSAutoValidateCertificates Property (WebDAVServer Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (WebDAVServer Class)
Selects the base configuration for the TLS settings.
Syntax
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
| stpcDefault | 0 | |
| stpcCompatible | 1 | |
| stpcComprehensiveInsecure | 2 | |
| stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (WebDAVServer Class)
A list of ciphersuites separated with commas or semicolons.
Syntax
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- 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
Data Type
String
TLSECCurves Property (WebDAVServer Class)
Defines the elliptic curves to enable.
Syntax
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (WebDAVServer Class)
Provides access to TLS extensions.
Syntax
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (WebDAVServer Class)
Whether to force TLS session resumption when the destination address changes.
Syntax
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (WebDAVServer Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity);
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (WebDAVServer Class)
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey);
Default Value
""
Remarks
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
This property is not available at design time.
Data Type
String
TLSPreSharedKeyCiphersuite Property (WebDAVServer Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite);
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (WebDAVServer Class)
Selects renegotiation attack prevention mechanism.
Syntax
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);
Possible Values
CRAPM_COMPATIBLE(0),
CRAPM_STRICT(1),
CRAPM_AUTO(2)
Default Value
0
Remarks
Selects 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. |
Data Type
Integer
TLSRevocationCheck Property (WebDAVServer Class)
Specifies the kind(s) of revocation check to perform.
Syntax
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
Default Value
1
Remarks
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) | Check all provided CRL endpoints for all chain certificates. |
| crcAllOCSP (3) | Check all provided OCSP endpoints for all chain certificates. |
| crcAllCRLAndOCSP (4) | Check all CRL and OCSP endpoints for all chain certificates. |
| crcAnyCRL (5) | At least one CRL check for every certificate in the chain must succeed. |
| crcAnyOCSP (6) | At least one OCSP check for every certificate in the chain must succeed. |
| crcAnyCRLOrOCSP (7) | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL (8) | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (WebDAVServer Class)
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.
Syntax
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);
Default Value
16
Remarks
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 use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) 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 handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (WebDAVServer Class)
Specifies the TLS mode to use.
Syntax
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);
Possible Values
SM_DEFAULT(0),
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
Default Value
0
Remarks
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, allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (WebDAVServer Class)
Enables Extended Master Secret Extension, as defined in RFC 7627.
Syntax
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);
Default Value
false
Remarks
Enables Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (WebDAVServer Class)
Enables or disables TLS session resumption capability.
Syntax
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);
Default Value
false
Remarks
Enables or disables TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (WebDAVServer Class)
Th SSL/TLS versions to enable by default.
Syntax
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Default Value
16
Remarks
Th 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 |
Data Type
Integer
UserCount Property (WebDAVServer Class)
The number of records in the User arrays.
Syntax
int GetUserCount();
int SetUserCount(int iUserCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- UserAssociatedData
- UserBasePath
- UserCert
- UserData
- UserHandle
- UserHashAlgorithm
- UserIncomingSpeedLimit
- UserOtpAlgorithm
- UserOtpValue
- UserOutgoingSpeedLimit
- UserPassword
- UserPasswordLen
- UserSharedSecret
- UserSSHKey
- UserUsername
This property is not available at design time.
Data Type
Integer
UserAssociatedData Property (WebDAVServer Class)
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
Syntax
QByteArray GetUserAssociatedData(int iUserIndex);
int SetUserAssociatedData(int iUserIndex, QByteArray qbaUserAssociatedData);
Remarks
Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserBasePath Property (WebDAVServer Class)
Base path for this user in the server's file system.
Syntax
QString GetUserBasePath(int iUserIndex);
int SetUserBasePath(int iUserIndex, QString qsUserBasePath);
Default Value
""
Remarks
Base path for this user in the server's file system.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserCert Property (WebDAVServer Class)
Contains the user's certificate.
Syntax
QByteArray GetUserCert(int iUserIndex);
int SetUserCert(int iUserIndex, QByteArray qbaUserCert);
Remarks
Contains the user's certificate.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserData Property (WebDAVServer Class)
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
Syntax
QString GetUserData(int iUserIndex);
int SetUserData(int iUserIndex, QString qsUserData);
Default Value
""
Remarks
Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserHandle Property (WebDAVServer Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
qint64 GetUserHandle(int iUserIndex);
int SetUserHandle(int iUserIndex, qint64 lUserHandle);
Default Value
0
Remarks
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());
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Long64
UserHashAlgorithm Property (WebDAVServer Class)
Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
Syntax
QString GetUserHashAlgorithm(int iUserIndex);
int SetUserHashAlgorithm(int iUserIndex, QString qsUserHashAlgorithm);
Default Value
""
Remarks
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 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserIncomingSpeedLimit Property (WebDAVServer Class)
Specifies the incoming speed limit for this user.
Syntax
int GetUserIncomingSpeedLimit(int iUserIndex);
int SetUserIncomingSpeedLimit(int iUserIndex, int iUserIncomingSpeedLimit);
Default Value
0
Remarks
Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOtpAlgorithm Property (WebDAVServer Class)
The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
Syntax
int GetUserOtpAlgorithm(int iUserIndex);
int SetUserOtpAlgorithm(int iUserIndex, int iUserOtpAlgorithm);
Possible Values
OA_NONE(0),
OA_HMAC(1),
OA_TIME(2)
Default Value
0
Remarks
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 |
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOtpValue Property (WebDAVServer Class)
The user's time interval (TOTP) or Counter (HOTP).
Syntax
int GetUserOtpValue(int iUserIndex);
int SetUserOtpValue(int iUserIndex, int iUserOtpValue);
Default Value
0
Remarks
The user's time interval (TOTP) or Counter (HOTP).
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserOutgoingSpeedLimit Property (WebDAVServer Class)
Specifies the outgoing speed limit for this user.
Syntax
int GetUserOutgoingSpeedLimit(int iUserIndex);
int SetUserOutgoingSpeedLimit(int iUserIndex, int iUserOutgoingSpeedLimit);
Default Value
0
Remarks
Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserPassword Property (WebDAVServer Class)
The user's authentication password.
Syntax
QString GetUserPassword(int iUserIndex);
int SetUserPassword(int iUserIndex, QString qsUserPassword);
Default Value
""
Remarks
The user's authentication password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
UserPasswordLen Property (WebDAVServer Class)
Specifies the length of the user's OTP password.
Syntax
int GetUserPasswordLen(int iUserIndex);
int SetUserPasswordLen(int iUserIndex, int iUserPasswordLen);
Default Value
0
Remarks
Specifies the length of the user's OTP password.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Integer
UserSharedSecret Property (WebDAVServer Class)
Contains the user's secret key, which is essentially a shared secret between the client and server.
Syntax
QByteArray GetUserSharedSecret(int iUserIndex);
int SetUserSharedSecret(int iUserIndex, QByteArray qbaUserSharedSecret);
Remarks
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.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserSSHKey Property (WebDAVServer Class)
Contains the user's SSH key.
Syntax
QByteArray GetUserSSHKey(int iUserIndex);
int SetUserSSHKey(int iUserIndex, QByteArray qbaUserSSHKey);
Remarks
Contains the user's SSH key.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
Byte Array
UserUsername Property (WebDAVServer Class)
The registered name (login) of the user.
Syntax
QString GetUserUsername(int iUserIndex);
int SetUserUsername(int iUserIndex, QString qsUserUsername);
Default Value
""
Remarks
The registered name (login) of the user.
The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.
This property is not available at design time.
Data Type
String
WebsiteName Property (WebDAVServer Class)
Specifies the web site name to use in the certificate.
Syntax
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
Config Method (WebDAVServer Class)
Sets or retrieves a configuration setting.
Syntax
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
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
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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling
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
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
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
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
This method returns a Byte Array 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
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
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
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
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
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
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
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
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
int Start();
Remarks
Use this method to activate the server and start listening to incoming connections.
Error Handling
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
int Stop();
Remarks
Call this method to stop listening to incoming connections and deactivate the server.
Error Handling
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
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)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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 |
AfterLockObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
AfterRefreshLockObject Event (WebDAVServer Class)
TBD.
Syntax
class WebDAVServerAfterRefreshLockObjectEventParams {
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 AfterRefreshLockObject(WebDAVServerAfterRefreshLockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function.
virtual int FireAfterRefreshLockObject(WebDAVServerAfterRefreshLockObjectEventParams *e) {...}
Remarks
TBD. 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)
TBD.
Syntax
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
TBD. 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 |
AfterRenameObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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
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)
TBD.
Syntax
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
TBD. 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 |
BeforeCopyObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeCreateCalendar Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeCreateCollection Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeCustomRequest Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeDownloadObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeLockObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeRefreshLockObject Event (WebDAVServer Class)
TBD.
Syntax
class WebDAVServerBeforeRefreshLockObjectEventParams {
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 BeforeRefreshLockObject(WebDAVServerBeforeRefreshLockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function.
virtual int FireBeforeRefreshLockObject(WebDAVServerBeforeRefreshLockObjectEventParams *e) {...}
Remarks
TBD. 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 |
BeforeRemoveObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeRenameObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeRequest Event (WebDAVServer Class)
Fires before a DAV request is processed.
Syntax
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)
TBD.
Syntax
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
TBD. 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 |
BeforeUnlockObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
BeforeUploadObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
CertificateValidate Event (WebDAVServer Class)
Fires when a client certificate needs to be validated.
Syntax
class WebDAVServerCertificateValidateEventParams {
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 CertificateValidate(WebDAVServerCertificateValidateEventParams *e);
// Or, subclass WebDAVServer and override this emitter function.
virtual int FireCertificateValidate(WebDAVServerCertificateValidateEventParams *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.
ClearAttribute Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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
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)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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)
TBD.
Syntax
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
TBD. 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
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
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)
TBD.
Syntax
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
TBD. 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
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
class WebDAVServerErrorEventParams {
public:
qint64 ConnectionID();
int ErrorCode();
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
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 component via SignedData parameter.
OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.
The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.
A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16
FileError Event (WebDAVServer Class)
Reports a file access error to the application.
Syntax
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.
ListAttributes Event (WebDAVServer Class)
TBD.
Syntax
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
TBD.
ListSubObjects Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
LockObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD.
Notification Event (WebDAVServer Class)
This event notifies the application about an underlying control flow event.
Syntax
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 component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
QueryQuota Event (WebDAVServer Class)
Reflects a quota enquiry by a client.
Syntax
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)
TBD.
Syntax
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
TBD. 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 |
ReadObject Event (WebDAVServer Class)
Requests a piece of object data from the application.
Syntax
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 |
RefreshLockObject Event (WebDAVServer Class)
TBD.
Syntax
class WebDAVServerRefreshLockObjectEventParams {
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 RefreshLockObject(WebDAVServerRefreshLockObjectEventParams *e);
// Or, subclass WebDAVServer and override this emitter function.
virtual int FireRefreshLockObject(WebDAVServerRefreshLockObjectEventParams *e) {...}
Remarks
TBD.
RemoveObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
RenameObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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 |
ResourceAccess Event (WebDAVServer Class)
Reports an attempt to access a resource.
Syntax
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)
TBD.
Syntax
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
TBD. 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 |
TLSEstablished Event (WebDAVServer Class)
Reports the setup of a TLS session.
Syntax
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)
TBD.
Syntax
class WebDAVServerTLSHandshakeEventParams {
public:
qint64 ConnectionID();
const QString &ServerName();
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
TBD
TLSPSK Event (WebDAVServer Class)
Requests a pre-shared key for TLS-PSK.
Syntax
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 ciphersuite associated with that identity and their key.
TLSShutdown Event (WebDAVServer Class)
Reports closure of a TLS session.
Syntax
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)
TBD.
Syntax
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
TBD.
UploadObject Event (WebDAVServer Class)
TBD.
Syntax
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
TBD. 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
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
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 |
Configuration 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 Configuration Settings | ||||||||||||||||||||||||||||||
ClientAuth:
Enables or disables certificate-based client authentication.Set this property to one of the below values to tune up the client authentication logic:
If this property is set to 1 or 2, the component will request certificates from the connecting clients. Depending on the setting, the clients that fail to provide their certificate in response will be allowed or disallowed to proceed with the connection. The server signals about a received certificate by firing its CertificateValidate event. Use PinClient method in the event handler to pin the client details, and access the provided certificate chain via the PinnedClientChain property. Note that this event is fired from the connecting clients threads, so please make sure you avoid bottlenecks in the event handler and put appropriate thread safety measures in place. Unlike the client-side components, the server component does not perform automated certificate validation against the local security policy. You must perform appropriate certificate validation steps in your CertificateValidate event handler. |
||||||||||||||||||||||||||||||
| DualStack: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. | ||||||||||||||||||||||||||||||
| Host: The host to bind to.Specifies a specific interface the server should listen on. | ||||||||||||||||||||||||||||||
| ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. | ||||||||||||||||||||||||||||||
| WebsiteName: The website name for the TLS certificate.Assign this property with a name to put in a self-generated TLS certificate. | ||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||
| CheckKeyIntegrityBeforeUse:
Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit,
but prevents a selection of attacks on RSA keys where keys with unknown origins are used.
You can switch this property off to improve performance if your project only uses known, good private keys. |
||||||||||||||||||||||||||||||
| CookieCaching:
Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class.
Supported values are:
|
||||||||||||||||||||||||||||||
| Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. | ||||||||||||||||||||||||||||||
| DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | ||||||||||||||||||||||||||||||
| EnableClientSideSSLFFDHE:
Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower
algorithm if compared to EC DHE; enabling it may result in slower connections.
This setting only applies to sessions negotiated with TLS version 1.3. |
||||||||||||||||||||||||||||||
| GlobalCookies: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global". | ||||||||||||||||||||||||||||||
| HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. | ||||||||||||||||||||||||||||||
| LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogDetails:
Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogFile: Specifies the debug log filename.Use this property to provide a path to the log file. | ||||||||||||||||||||||||||||||
| LogFilters:
Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
|
||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
||||||||||||||||||||||||||||||
| LogMaxEventCount:
Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects,
depending on the rotation setting and/or the flush mode.
The default value of this setting is 100. |
||||||||||||||||||||||||||||||
LogRotationMode:
Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined:
|
||||||||||||||||||||||||||||||
| MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. | ||||||||||||||||||||||||||||||
| OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. | ||||||||||||||||||||||||||||||
| Tag: Allows to store any custom data.Use this config property to store any custom data. | ||||||||||||||||||||||||||||||
| UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | ||||||||||||||||||||||||||||||
| UseSystemOAEPAndPSS:
Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable.
If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations
using its own OAEP/PSS implementation.
This setting only applies to certificates originating from a Windows system store. |
||||||||||||||||||||||||||||||
| UseSystemRandom: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. |
Trappable Errors (WebDAVServer Class)
WebDAVServer Errors
| 1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
| 1048578 Class is configured incorrectly (SB_ERROR_INVALID_SETUP) | |
| 1048579 Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE) | |
| 1048580 Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE) | |
| 1048581 Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY) | |
| 1048581 Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |