WebDAVServer Class
Properties Methods Events Configuration Settings Errors
The WebDAVServer class offers server-side functionality for the WebDAV protocol.
Syntax
secureblackbox.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. |
DocumentRoot | The document root of the server. |
ErrorOrigin | Indicates the endpoint where the error originates from. |
ErrorSeverity | The severity of the error that happened. |
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. |
Host | The host to bind the listening port to. |
MetadataFlushTimeout | Specifies metadata flush timeout. |
MetadataRoot | The metadata directory root. |
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. |
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. |
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. |
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. |
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. |
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. |
UseTLS | Enables or disables the TLS requirement. |
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. |
DropClient | Terminates a client connection. |
ListClients | Enumerates the connected clients. |
PinClient | Takes a snapshot of the connection's properties. |
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. |
AuthAttempt | Fires when a connected client makes an authentication attempt. |
BeforeRequest | Fires before a DAV request is processed. |
CertificateValidate | Fires when a client certificate needs to be validated. |
Connect | Reports an accepted connection. |
Data | Supplies a data chunk received from a client. |
Disconnect | Fires to report a disconnected client. |
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. |
Notification | This event notifies the application about an underlying control flow event. |
QueryQuota | Reflects a quota enquiry by a client. |
TLSEstablished | Reports the setup of a TLS session. |
TLSPSK | Requests a pre-shared key for TLS-PSK. |
TLSShutdown | Reports closure of a TLS session. |
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. |
TLSExtensions | Provides access to TLS extensions. |
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. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |