# WebDAVServer Component The WebDAVServer component offers server-side functionality for the WebDAV protocol. ## Syntax ```text TsbxWebDAVServer ``` ## Remarks Both plain (HTTP) and secure (HTTPS) connection types are supported. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Active](#active-property-webdavserver-component) | Indicates whether the server is active and is listening to new connections. | | [AuthRealm](#authrealm-property-webdavserver-component) | Specifies authentication realm for digest and NTLM authentication. | | [AuthTypes](#authtypes-property-webdavserver-component) | Defines allowed HTTP authentication types. | | [BoundPort](#boundport-property-webdavserver-component) | Indicates the bound listening port. | | [ClientFileEntryATime](#clientfileentryatime-property-webdavserver-component) | Contains the last access time for this object, in UTC. | | [ClientFileEntryContentType](#clientfileentrycontenttype-property-webdavserver-component) | The object's content type. | | [ClientFileEntryCTime](#clientfileentryctime-property-webdavserver-component) | Contains this object's creation time, in UTC. | | [ClientFileEntryDirectory](#clientfileentrydirectory-property-webdavserver-component) | Specifies whether this object is a directory. | | [ClientFileEntryDisplayName](#clientfileentrydisplayname-property-webdavserver-component) | Contains the display name of the object. | | [ClientFileEntryETag](#clientfileentryetag-property-webdavserver-component) | An e-tag of the object. | | [ClientFileEntryFullURL](#clientfileentryfullurl-property-webdavserver-component) | A full path to the object. | | [ClientFileEntryMTime](#clientfileentrymtime-property-webdavserver-component) | The last modification time of the object, in UTC. | | [ClientFileEntryParentURL](#clientfileentryparenturl-property-webdavserver-component) | Specifies the object's parent URL. | | [ClientFileEntrySize](#clientfileentrysize-property-webdavserver-component) | The size of the object in bytes. | | [ClientFileEntrySupportsExclusiveLock](#clientfileentrysupportsexclusivelock-property-webdavserver-component) | Indicates whether the entry supports exclusive locking. | | [ClientFileEntrySupportsSharedLock](#clientfileentrysupportssharedlock-property-webdavserver-component) | Indicates whether the entry supports shared lock. | | [ClientFileEntryURL](#clientfileentryurl-property-webdavserver-component) | A URL of the object. | | [DocumentRoot](#documentroot-property-webdavserver-component) | The document root of the server. | | [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-webdavserver-component) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [ExternalCryptoCustomParams](#externalcryptocustomparams-property-webdavserver-component) | Custom parameters to be passed to the signing service (uninterpreted). | | [ExternalCryptoData](#externalcryptodata-property-webdavserver-component) | Additional data to be included in the async state and mirrored back by the requestor. | | [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-webdavserver-component) | Specifies whether the message hash is to be calculated at the external endpoint. | | [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-webdavserver-component) | Specifies the request's signature hash algorithm. | | [ExternalCryptoKeyID](#externalcryptokeyid-property-webdavserver-component) | The ID of the pre-shared key used for DC request authentication. | | [ExternalCryptoKeySecret](#externalcryptokeysecret-property-webdavserver-component) | The pre-shared key used for DC request authentication. | | [ExternalCryptoMethod](#externalcryptomethod-property-webdavserver-component) | Specifies the asynchronous signing method. | | [ExternalCryptoMode](#externalcryptomode-property-webdavserver-component) | Specifies the external cryptography mode. | | [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-webdavserver-component) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [FIPSMode](#fipsmode-property-webdavserver-component) | Reserved. | | [Host](#host-property-webdavserver-component) | The host to bind the listening port to. | | [MetadataFlushTimeout](#metadataflushtimeout-property-webdavserver-component) | Specifies metadata flush timeout. | | [MetadataRoot](#metadataroot-property-webdavserver-component) | The metadata directory root. | | [PinnedClientAEADCipher](#pinnedclientaeadcipher-property-webdavserver-component) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [PinnedClientChainValidationDetails](#pinnedclientchainvalidationdetails-property-webdavserver-component) | The details of a certificate chain validation outcome. | | [PinnedClientChainValidationResult](#pinnedclientchainvalidationresult-property-webdavserver-component) | The outcome of a certificate chain validation routine. | | [PinnedClientCiphersuite](#pinnedclientciphersuite-property-webdavserver-component) | The cipher suite employed by this connection. | | [PinnedClientClientAuthenticated](#pinnedclientclientauthenticated-property-webdavserver-component) | Specifies whether client authentication was performed during this connection. | | [PinnedClientClientAuthRequested](#pinnedclientclientauthrequested-property-webdavserver-component) | Specifies whether client authentication was requested during this connection. | | [PinnedClientConnectionEstablished](#pinnedclientconnectionestablished-property-webdavserver-component) | Indicates whether the connection has been established fully. | | [PinnedClientConnectionID](#pinnedclientconnectionid-property-webdavserver-component) | The unique identifier assigned to this connection. | | [PinnedClientDigestAlgorithm](#pinnedclientdigestalgorithm-property-webdavserver-component) | The digest algorithm used in a TLS-enabled connection. | | [PinnedClientEncryptionAlgorithm](#pinnedclientencryptionalgorithm-property-webdavserver-component) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [PinnedClientExportable](#pinnedclientexportable-property-webdavserver-component) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [PinnedClientGroup](#pinnedclientgroup-property-webdavserver-component) | The elliptic curve used in this connection. | | [PinnedClientID](#pinnedclientid-property-webdavserver-component) | The client connection's unique identifier. | | [PinnedClientKeyExchangeAlgorithm](#pinnedclientkeyexchangealgorithm-property-webdavserver-component) | The key exchange algorithm used in a TLS-enabled connection. | | [PinnedClientKeyExchangeKeyBits](#pinnedclientkeyexchangekeybits-property-webdavserver-component) | The length of the key exchange key of a TLS-enabled connection. | | [PinnedClientPFSCipher](#pinnedclientpfscipher-property-webdavserver-component) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [PinnedClientPreSharedIdentity](#pinnedclientpresharedidentity-property-webdavserver-component) | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [PinnedClientPreSharedIdentityHint](#pinnedclientpresharedidentityhint-property-webdavserver-component) | A hint professed by the server to help the client select the PSK identity to use. | | [PinnedClientPublicKeyBits](#pinnedclientpublickeybits-property-webdavserver-component) | The length of the public key. | | [PinnedClientRemoteAddress](#pinnedclientremoteaddress-property-webdavserver-component) | The client's IP address. | | [PinnedClientRemotePort](#pinnedclientremoteport-property-webdavserver-component) | The remote port of the client connection. | | [PinnedClientResumedSession](#pinnedclientresumedsession-property-webdavserver-component) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [PinnedClientSecureConnection](#pinnedclientsecureconnection-property-webdavserver-component) | Indicates whether TLS or SSL is enabled for this connection. | | [PinnedClientServerAuthenticated](#pinnedclientserverauthenticated-property-webdavserver-component) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [PinnedClientSignatureAlgorithm](#pinnedclientsignaturealgorithm-property-webdavserver-component) | The signature algorithm used in a TLS handshake. | | [PinnedClientSymmetricBlockSize](#pinnedclientsymmetricblocksize-property-webdavserver-component) | The block size of the symmetric algorithm used. | | [PinnedClientSymmetricKeyBits](#pinnedclientsymmetrickeybits-property-webdavserver-component) | The key length of the symmetric algorithm used. | | [PinnedClientTotalBytesReceived](#pinnedclienttotalbytesreceived-property-webdavserver-component) | The total number of bytes received over this connection. | | [PinnedClientTotalBytesSent](#pinnedclienttotalbytessent-property-webdavserver-component) | The total number of bytes sent over this connection. | | [PinnedClientValidationLog](#pinnedclientvalidationlog-property-webdavserver-component) | Contains the server certificate's chain validation log. | | [PinnedClientVersion](#pinnedclientversion-property-webdavserver-component) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) | The number of records in the PinnedClientCert arrays. | | [PinnedClientCertBytes](#pinnedclientcertbytes-property-webdavserver-component) | Returns the raw certificate data in DER format. | | [PinnedClientCertCA](#pinnedclientcertca-property-webdavserver-component) | Indicates whether the certificate has a CA capability. | | [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-webdavserver-component) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [PinnedClientCertCertType](#pinnedclientcertcerttype-property-webdavserver-component) | Returns the type of the entity contained in the Certificate object. | | [PinnedClientCertCRLDistributionPoints](#pinnedclientcertcrldistributionpoints-property-webdavserver-component) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [PinnedClientCertCurve](#pinnedclientcertcurve-property-webdavserver-component) | Specifies the elliptic curve associated with the certificate's public key. | | [PinnedClientCertFingerprint](#pinnedclientcertfingerprint-property-webdavserver-component) | Contains the fingerprint (a hash imprint) of this certificate. | | [PinnedClientCertFriendlyName](#pinnedclientcertfriendlyname-property-webdavserver-component) | Contains an associated alias (friendly name) of the certificate. | | [PinnedClientCertHandle](#pinnedclientcerthandle-property-webdavserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [PinnedClientCertHashAlgorithm](#pinnedclientcerthashalgorithm-property-webdavserver-component) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [PinnedClientCertIssuer](#pinnedclientcertissuer-property-webdavserver-component) | The common name of the certificate issuer (CA), typically a company name. | | [PinnedClientCertIssuerRDN](#pinnedclientcertissuerrdn-property-webdavserver-component) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [PinnedClientCertKeyAlgorithm](#pinnedclientcertkeyalgorithm-property-webdavserver-component) | Specifies the public key algorithm of this certificate. | | [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-webdavserver-component) | Returns the length of the public key in bits. | | [PinnedClientCertKeyFingerprint](#pinnedclientcertkeyfingerprint-property-webdavserver-component) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [PinnedClientCertKeyUsage](#pinnedclientcertkeyusage-property-webdavserver-component) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [PinnedClientCertKeyValid](#pinnedclientcertkeyvalid-property-webdavserver-component) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [PinnedClientCertOCSPLocations](#pinnedclientcertocsplocations-property-webdavserver-component) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [PinnedClientCertOCSPNoCheck](#pinnedclientcertocspnocheck-property-webdavserver-component) | Accessor to the value of the certificate's ocsp-no-check extension. | | [PinnedClientCertOrigin](#pinnedclientcertorigin-property-webdavserver-component) | Returns the location that the certificate was taken or loaded from. | | [PinnedClientCertPolicyIDs](#pinnedclientcertpolicyids-property-webdavserver-component) | Contains identifiers (OIDs) of the applicable certificate policies. | | [PinnedClientCertPrivateKeyBytes](#pinnedclientcertprivatekeybytes-property-webdavserver-component) | Returns the certificate's private key in DER-encoded format. | | [PinnedClientCertPrivateKeyExists](#pinnedclientcertprivatekeyexists-property-webdavserver-component) | Indicates whether the certificate has a usable private key associated with it. | | [PinnedClientCertPrivateKeyExtractable](#pinnedclientcertprivatekeyextractable-property-webdavserver-component) | Indicates whether the private key is extractable (exportable). | | [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-webdavserver-component) | Contains the certificate's public key in DER format. | | [PinnedClientCertQualified](#pinnedclientcertqualified-property-webdavserver-component) | Indicates whether the certificate is qualified. | | [PinnedClientCertQualifiedStatements](#pinnedclientcertqualifiedstatements-property-webdavserver-component) | Returns a simplified qualified status of the certificate. | | [PinnedClientCertQualifiers](#pinnedclientcertqualifiers-property-webdavserver-component) | A list of qualifiers. | | [PinnedClientCertSelfSigned](#pinnedclientcertselfsigned-property-webdavserver-component) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [PinnedClientCertSerialNumber](#pinnedclientcertserialnumber-property-webdavserver-component) | Returns the certificate's serial number. | | [PinnedClientCertSigAlgorithm](#pinnedclientcertsigalgorithm-property-webdavserver-component) | Indicates the algorithm that was used by the CA to sign this certificate. | | [PinnedClientCertSource](#pinnedclientcertsource-property-webdavserver-component) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [PinnedClientCertSubject](#pinnedclientcertsubject-property-webdavserver-component) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [PinnedClientCertSubjectAlternativeName](#pinnedclientcertsubjectalternativename-property-webdavserver-component) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-webdavserver-component) | Contains a unique identifier of the certificate's cryptographic key. | | [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-webdavserver-component) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [PinnedClientCertValid](#pinnedclientcertvalid-property-webdavserver-component) | Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. | | [PinnedClientCertValidFrom](#pinnedclientcertvalidfrom-property-webdavserver-component) | The time point at which the certificate becomes valid, in UTC. | | [PinnedClientCertValidTo](#pinnedclientcertvalidto-property-webdavserver-component) | The time point at which the certificate expires, in UTC. | | [Port](#port-property-webdavserver-component) | Specifies the port number to listen for connections on. | | [PortRangeFrom](#portrangefrom-property-webdavserver-component) | Specifies the lower limit of the listening port range for incoming connections. | | [PortRangeTo](#portrangeto-property-webdavserver-component) | Specifies the upper limit of the listening port range for incoming connections. | | [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-webdavserver-component) | The maximum number of bytes to read from the socket, per second. | | [SocketLocalAddress](#socketlocaladdress-property-webdavserver-component) | The local network interface to bind the socket to. | | [SocketLocalPort](#socketlocalport-property-webdavserver-component) | The local port number to bind the socket to. | | [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-webdavserver-component) | The maximum number of bytes to write to the socket, per second. | | [SocketTimeout](#sockettimeout-property-webdavserver-component) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [SocketUseIPv6](#socketuseipv6-property-webdavserver-component) | Enables or disables IP protocol version 6. | | [TLSServerCertCount](#tlsservercertcount-property-webdavserver-component) | The number of records in the TLSServerCert arrays. | | [TLSServerCertBytes](#tlsservercertbytes-property-webdavserver-component) | Returns the raw certificate data in DER format. | | [TLSServerCertHandle](#tlsservercerthandle-property-webdavserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TLSAutoValidateCertificates](#tlsautovalidatecertificates-property-webdavserver-component) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [TLSBaseConfiguration](#tlsbaseconfiguration-property-webdavserver-component) | Selects the base configuration for the TLS settings. | | [TLSCiphersuites](#tlsciphersuites-property-webdavserver-component) | A list of ciphersuites separated with commas or semicolons. | | [TLSClientAuth](#tlsclientauth-property-webdavserver-component) | Enables or disables certificate-based client authentication. | | [TLSExtensions](#tlsextensions-property-webdavserver-component) | Provides access to TLS extensions. | | [TLSForceResumeIfDestinationChanges](#tlsforceresumeifdestinationchanges-property-webdavserver-component) | Whether to force TLS session resumption when the destination address changes. | | [TLSGroups](#tlsgroups-property-webdavserver-component) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [TLSPreSharedIdentity](#tlspresharedidentity-property-webdavserver-component) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [TLSPreSharedKey](#tlspresharedkey-property-webdavserver-component) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [TLSPreSharedKeyCiphersuite](#tlspresharedkeyciphersuite-property-webdavserver-component) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [TLSRenegotiationAttackPreventionMode](#tlsrenegotiationattackpreventionmode-property-webdavserver-component) | Selects the renegotiation attack prevention mechanism. | | [TLSRevocationCheck](#tlsrevocationcheck-property-webdavserver-component) | Specifies the kind(s) of revocation check to perform. | | [TLSSSLOptions](#tlsssloptions-property-webdavserver-component) | 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. | | [TLSMode](#tlsmode-property-webdavserver-component) | Specifies the TLS mode to use. | | [TLSUseExtendedMasterSecret](#tlsuseextendedmastersecret-property-webdavserver-component) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [TLSUseSessionResumption](#tlsusesessionresumption-property-webdavserver-component) | Enables or disables the TLS session resumption capability. | | [TLSVersions](#tlsversions-property-webdavserver-component) | The SSL/TLS versions to enable by default. | | [UserCount](#usercount-property-webdavserver-component) | The number of records in the User arrays. | | [UserAssociatedData](#userassociateddata-property-webdavserver-component) | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. | | [UserBasePath](#userbasepath-property-webdavserver-component) | Base path for this user in the server's file system. | | [UserCertificate](#usercertificate-property-webdavserver-component) | Contains the user's certificate. | | [UserData](#userdata-property-webdavserver-component) | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. | | [UserEmail](#useremail-property-webdavserver-component) | The user's email address. | | [UserHandle](#userhandle-property-webdavserver-component) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [UserHashAlgorithm](#userhashalgorithm-property-webdavserver-component) | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. | | [UserIncomingSpeedLimit](#userincomingspeedlimit-property-webdavserver-component) | Specifies the incoming speed limit for this user. | | [UserOtpAlgorithm](#userotpalgorithm-property-webdavserver-component) | The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). | | [UserOTPLen](#userotplen-property-webdavserver-component) | Specifies the length of the user's OTP password. | | [UserOtpValue](#userotpvalue-property-webdavserver-component) | The user's time interval (TOTP) or Counter (HOTP). | | [UserOutgoingSpeedLimit](#useroutgoingspeedlimit-property-webdavserver-component) | Specifies the outgoing speed limit for this user. | | [UserPassword](#userpassword-property-webdavserver-component) | The user's authentication password. | | [UserSharedSecret](#usersharedsecret-property-webdavserver-component) | Contains the user's secret key, which is essentially a shared secret between the client and server. | | [UserSSHKey](#usersshkey-property-webdavserver-component) | Contains the user's SSH key. | | [Username](#username-property-webdavserver-component) | The registered name (login) of the user. | | [WebsiteName](#websitename-property-webdavserver-component) | Specifies the web site name to use in the certificate. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Cleanup](#cleanup-method-webdavserver-component) | Cleans up the server environment by purging expired sessions and cleaning caches. | | [Config](#config-method-webdavserver-component) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-webdavserver-component) | Performs an additional action. | | [DropClient](#dropclient-method-webdavserver-component) | Terminates a client connection. | | [GetClientBuffer](#getclientbuffer-method-webdavserver-component) | Obtains a pending connection buffer. | | [GetRequestBytes](#getrequestbytes-method-webdavserver-component) | Returns the contents of the client's HTTP request. | | [GetRequestHeader](#getrequestheader-method-webdavserver-component) | Returns a request header value. | | [GetRequestString](#getrequeststring-method-webdavserver-component) | Returns the contents of the client's HTTP request. | | [GetRequestUsername](#getrequestusername-method-webdavserver-component) | Returns the username for a connection. | | [GetResponseHeader](#getresponseheader-method-webdavserver-component) | Returns a response header value. | | [ListClients](#listclients-method-webdavserver-component) | Enumerates the connected clients. | | [PinClient](#pinclient-method-webdavserver-component) | Takes a snapshot of the connection's properties. | | [ProcessGenericRequest](#processgenericrequest-method-webdavserver-component) | Processes a generic HTTP request. | | [Reset](#reset-method-webdavserver-component) | Resets the component settings. | | [SetClientBuffer](#setclientbuffer-method-webdavserver-component) | Commits a data buffer to the connection. | | [SetClientFileEntry](#setclientfileentry-method-webdavserver-component) | Commits a file entry to the connection. | | [SetResponseBytes](#setresponsebytes-method-webdavserver-component) | Sets a byte array to be served as a response. | | [SetResponseFile](#setresponsefile-method-webdavserver-component) | Sets a file to be served as a response. | | [SetResponseHeader](#setresponseheader-method-webdavserver-component) | Sets a response header. | | [SetResponseStatus](#setresponsestatus-method-webdavserver-component) | Sets an HTTP status to be sent with the response. | | [SetResponseString](#setresponsestring-method-webdavserver-component) | Sets a string to be served as a response. | | [Start](#start-method-webdavserver-component) | Starts the server. | | [Stop](#stop-method-webdavserver-component) | Stops the server. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Accept](#accept-event-webdavserver-component) | Reports an incoming connection. | | [AfterBrowse](#afterbrowse-event-webdavserver-component) | WebDAVServer uses this event to notify the application about the completion of the browsing operation. | | [AfterCopyObject](#aftercopyobject-event-webdavserver-component) | This event notifies the application about the completion of the copy operation. | | [AfterCreateCalendar](#aftercreatecalendar-event-webdavserver-component) | This event reports the completion of calendar creation request. | | [AfterCreateCollection](#aftercreatecollection-event-webdavserver-component) | WebDAVServer uses this event to report completion of the collection creation operation. | | [AfterCustomRequest](#aftercustomrequest-event-webdavserver-component) | This event reports the completion of the custom request. | | [AfterLockObject](#afterlockobject-event-webdavserver-component) | Reports the completion of the object locking operation. | | [AfterRefreshLock](#afterrefreshlock-event-webdavserver-component) | Reports the completion of the lock refresh operation. | | [AfterRemoveObject](#afterremoveobject-event-webdavserver-component) | This event notifies the application about the completion of object deletion operation. | | [AfterRenameObject](#afterrenameobject-event-webdavserver-component) | The component uses this event to notify the application about the completion of the object rename operation. | | [AfterSetAttributes](#aftersetattributes-event-webdavserver-component) | WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation. | | [AfterUnlockObject](#afterunlockobject-event-webdavserver-component) | Notifies the application about the completion of the object unlocking operation. | | [AuthAttempt](#authattempt-event-webdavserver-component) | Fires when a connected client makes an authentication attempt. | | [BeforeBrowse](#beforebrowse-event-webdavserver-component) | Fires when a Browse request is received. | | [BeforeCopyObject](#beforecopyobject-event-webdavserver-component) | Fires when a Copy Object request is received. | | [BeforeCreateCalendar](#beforecreatecalendar-event-webdavserver-component) | Fires when a Create Calendar request is received from a client. | | [BeforeCreateCollection](#beforecreatecollection-event-webdavserver-component) | Fires when a Create Collection request is received from a client. | | [BeforeCustomRequest](#beforecustomrequest-event-webdavserver-component) | Notifies the application about an incoming custom request. | | [BeforeDownloadObject](#beforedownloadobject-event-webdavserver-component) | Fires when an object download request is received. | | [BeforeLockObject](#beforelockobject-event-webdavserver-component) | Fires when a lock request is received. | | [BeforeRefreshLock](#beforerefreshlock-event-webdavserver-component) | Reports the receipt of lock refresh request. | | [BeforeRemoveObject](#beforeremoveobject-event-webdavserver-component) | Fires when an object deletion request is received. | | [BeforeRenameObject](#beforerenameobject-event-webdavserver-component) | Reports object renaming requests. | | [BeforeRequest](#beforerequest-event-webdavserver-component) | Fires before a DAV request is processed. | | [BeforeSetAttributes](#beforesetattributes-event-webdavserver-component) | Notifies the application about attribute change request. | | [BeforeUnlockObject](#beforeunlockobject-event-webdavserver-component) | Fires when an unlock request is received. | | [BeforeUploadObject](#beforeuploadobject-event-webdavserver-component) | Fires when an object upload request is received. | | [ClearAttribute](#clearattribute-event-webdavserver-component) | Reports an attribute clearance request. | | [Connect](#connect-event-webdavserver-component) | Reports an accepted connection. | | [CopyObject](#copyobject-event-webdavserver-component) | Lets the application handle the Copy Object request. | | [CreateCalendar](#createcalendar-event-webdavserver-component) | Lets the application handle a calendar creation request. | | [CreateCollection](#createcollection-event-webdavserver-component) | Lets the application respond to collection creation request. | | [CustomRequest](#customrequest-event-webdavserver-component) | Use this event to respond to non-standard DAV requests. | | [Data](#data-event-webdavserver-component) | Supplies a data chunk received from a client. | | [Disconnect](#disconnect-event-webdavserver-component) | Fires to report a disconnected client. | | [DownloadObject](#downloadobject-event-webdavserver-component) | Allows the application respond to Download Object request. | | [DownloadObjectCompleted](#downloadobjectcompleted-event-webdavserver-component) | This event is fired when a download operation completes. | | [Error](#error-event-webdavserver-component) | Information about errors during data delivery. | | [ExternalSign](#externalsign-event-webdavserver-component) | Handles remote or external signing initiated by the server protocol. | | [FileError](#fileerror-event-webdavserver-component) | Reports a file access error to the application. | | [HeadersPrepared](#headersprepared-event-webdavserver-component) | Fires when the response headers have been formed and are ready to be sent to the server. | | [ListAttributes](#listattributes-event-webdavserver-component) | Requests object attributes from the application in fraCustom handling mode. | | [ListSubObjects](#listsubobjects-event-webdavserver-component) | Requests a list of sub-objects of an object. The component uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF. | | [LockObject](#lockobject-event-webdavserver-component) | Virtualizes the object locking operation. | | [Notification](#notification-event-webdavserver-component) | This event notifies the application about an underlying control flow event. | | [QueryQuota](#queryquota-event-webdavserver-component) | Reflects a quota enquiry by a client. | | [ReadAttribute](#readattribute-event-webdavserver-component) | Requests value of an attribute from the application in fraCustom mode. | | [ReadObject](#readobject-event-webdavserver-component) | Requests a piece of object data from the application. | | [RefreshLock](#refreshlock-event-webdavserver-component) | Notifies the application about a lock refresh request. | | [RemoveObject](#removeobject-event-webdavserver-component) | Notifies the application about object deletion requests. | | [RenameObject](#renameobject-event-webdavserver-component) | Notifies the application about object name change requests. | | [ResourceAccess](#resourceaccess-event-webdavserver-component) | Reports an attempt to access a resource. | | [SetAttribute](#setattribute-event-webdavserver-component) | Lets the application customize attribute assignment requests. | | [TLSCertValidate](#tlscertvalidate-event-webdavserver-component) | Fires when a client certificate needs to be validated. | | [TLSEstablished](#tlsestablished-event-webdavserver-component) | Reports the setup of a TLS session. | | [TLSHandshake](#tlshandshake-event-webdavserver-component) | Fires when a newly established client connection initiates a TLS handshake. | | [TLSPSK](#tlspsk-event-webdavserver-component) | Requests a pre-shared key for TLS-PSK. | | [TLSShutdown](#tlsshutdown-event-webdavserver-component) | Reports closure of a TLS session. | | [UnlockObject](#unlockobject-event-webdavserver-component) | Virtualizes the object unlocking operation. | | [UploadObject](#uploadobject-event-webdavserver-component) | Lets the application respond to the Upload Object request. | | [UploadObjectCompleted](#uploadobjectcompleted-event-webdavserver-component) | This event is fired when a upload operation completes. | | [WriteObject](#writeobject-event-webdavserver-component) | Hands a piece of object data to the application. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BoundAddress](#BoundAddress) | Returns the bound address of the listening socket. | | [BoundPort](#BoundPort) | The port that was bound by the server. | | [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. | | [HandshakeTimeout](#HandshakeTimeout) | The HTTPS handshake timeout. | | [Host](#Host) | The host to bind to. | | [HTTPStatusCode\[i\]](#HTTPStatusCode[i]) | Provides means to set a custom HTTP status code. | | [Port](#Port) | The port to listen on. | | [PortRangeFrom](#PortRangeFrom) | The lower bound of allowed port scope to listen on. | | [PortRangeTo](#PortRangeTo) | The higher bound of allowed port scope to listen on. | | [PreSharedIdentityHint](#PreSharedIdentityHint) | Gets or sets the PSK identity hint. | | [SessionTimeout](#SessionTimeout) | The HTTP session timeout. | | [SleepLen](#SleepLen) | Adjusts the server loop idling time. | | [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the component for the current session. | | [TLSExtensions](#TLSExtensions) | TBD. | | [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the component. | | [TLSPeerExtensions](#TLSPeerExtensions) | TBD. | | [TLSServerCertIndex](#TLSServerCertIndex) | Specifies the index of the server certificate to use. | | [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the component. | | [WebsiteName](#WebsiteName) | The website name for the TLS certificate. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the component. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server components. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client components created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client components should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # Active Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the server is active and is listening to new connections. ## Syntax *C++ Builder Syntax* ```text __property bool Active = { read=FActive }; ``` ## Default Value false ## Remarks This read-only property returns True if the server is listening to incoming connections. This property is read-only and not available at design time. ## Data Type Boolean # AuthRealm Property ([WebDAVServer](#webdavserver-component) Component) Specifies authentication realm for digest and NTLM authentication. ## Syntax *C++ Builder Syntax* ```text __property String AuthRealm = { read=FAuthRealm, write=FSetAuthRealm }; ``` ## Default Value "SecureBlackbox" ## Remarks Specifies authentication realm for digest and NTLM authentication types. ## Data Type String # AuthTypes Property ([WebDAVServer](#webdavserver-component) Component) Defines allowed HTTP authentication types. ## Syntax *C++ Builder Syntax* ```text __property int AuthTypes = { read=FAuthTypes, write=FSetAuthTypes }; ``` ## Default Value 0 ## Remarks Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags: | | | | | --- | --- | --- | | haBasic | 0x01 | Basic authentication | | haDigest | 0x02 | Digest authentication (RFC 2617) | | haNTLM | 0x04 | Windows NTLM authentication | | haKerberos | 0x08 | Kerberos (Negotiate) authentication | | haOAuth2 | 0x10 | OAuth2 authentication | ## Data Type Integer # BoundPort Property ([WebDAVServer](#webdavserver-component) Component) Indicates the bound listening port. ## Syntax *C++ Builder Syntax* ```text __property int BoundPort = { read=FBoundPort }; ``` ## Default Value 0 ## Remarks Check this property to find out the port that has been allocated to the server by the system. The bound port always equals [Port](#port-property-webdavserver-component) if it is provided, or is allocated dynamically if configured to fall in the range between [PortRangeFrom](#portrangefrom-property-webdavserver-component) and [PortRangeTo](#portrangeto-property-webdavserver-component) constraints. This property is read-only and not available at design time. ## Data Type Integer # ClientFileEntryATime Property ([WebDAVServer](#webdavserver-component) Component) Contains the last access time for this object, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryATime = { read=FClientFileEntryATime, write=FSetClientFileEntryATime }; ``` ## 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](#webdavserver-component) Component) The object's content type. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryContentType = { read=FClientFileEntryContentType, write=FSetClientFileEntryContentType }; ``` ## Default Value "" ## Remarks The object's content type. This property is not available at design time. ## Data Type String # ClientFileEntryCTime Property ([WebDAVServer](#webdavserver-component) Component) Contains this object's creation time, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryCTime = { read=FClientFileEntryCTime, write=FSetClientFileEntryCTime }; ``` ## 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](#webdavserver-component) Component) Specifies whether this object is a directory. ## Syntax *C++ Builder Syntax* ```text __property bool ClientFileEntryDirectory = { read=FClientFileEntryDirectory, write=FSetClientFileEntryDirectory }; ``` ## 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](#webdavserver-component) Component) Contains the display name of the object. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryDisplayName = { read=FClientFileEntryDisplayName, write=FSetClientFileEntryDisplayName }; ``` ## Default Value "" ## Remarks Contains the display name of the object. This property is not available at design time. ## Data Type String # ClientFileEntryETag Property ([WebDAVServer](#webdavserver-component) Component) An e-tag of the object. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryETag = { read=FClientFileEntryETag, write=FSetClientFileEntryETag }; ``` ## Default Value "" ## Remarks An e-tag of the object. This property is not available at design time. ## Data Type String # ClientFileEntryFullURL Property ([WebDAVServer](#webdavserver-component) Component) A full path to the object. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryFullURL = { read=FClientFileEntryFullURL, write=FSetClientFileEntryFullURL }; ``` ## Default Value "" ## Remarks A full path to the object. This property is not available at design time. ## Data Type String # ClientFileEntryMTime Property ([WebDAVServer](#webdavserver-component) Component) The last modification time of the object, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryMTime = { read=FClientFileEntryMTime, write=FSetClientFileEntryMTime }; ``` ## 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](#webdavserver-component) Component) Specifies the object's parent URL. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryParentURL = { read=FClientFileEntryParentURL, write=FSetClientFileEntryParentURL }; ``` ## Default Value "" ## Remarks Specifies the object's parent URL. This property is not available at design time. ## Data Type String # ClientFileEntrySize Property ([WebDAVServer](#webdavserver-component) Component) The size of the object in bytes. ## Syntax *C++ Builder Syntax* ```text __property __int64 ClientFileEntrySize = { read=FClientFileEntrySize, write=FSetClientFileEntrySize }; ``` ## 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](#webdavserver-component) Component) Indicates whether the entry supports exclusive locking. ## Syntax *C++ Builder Syntax* ```text __property bool ClientFileEntrySupportsExclusiveLock = { read=FClientFileEntrySupportsExclusiveLock, write=FSetClientFileEntrySupportsExclusiveLock }; ``` ## 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](#webdavserver-component) Component) Indicates whether the entry supports shared lock. ## Syntax *C++ Builder Syntax* ```text __property bool ClientFileEntrySupportsSharedLock = { read=FClientFileEntrySupportsSharedLock, write=FSetClientFileEntrySupportsSharedLock }; ``` ## 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](#webdavserver-component) Component) A URL of the object. ## Syntax *C++ Builder Syntax* ```text __property String ClientFileEntryURL = { read=FClientFileEntryURL, write=FSetClientFileEntryURL }; ``` ## Default Value "" ## Remarks A URL of the object. This property is not available at design time. ## Data Type String # DocumentRoot Property ([WebDAVServer](#webdavserver-component) Component) The document root of the server. ## Syntax *C++ Builder Syntax* ```text __property String DocumentRoot = { read=FDocumentRoot, write=FSetDocumentRoot }; ``` ## 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 # ExternalCryptoAsyncDocumentID Property ([WebDAVServer](#webdavserver-component) Component) Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID }; ``` ## Default Value "" ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. ## Data Type String # ExternalCryptoCustomParams Property ([WebDAVServer](#webdavserver-component) Component) Custom parameters to be passed to the signing service (uninterpreted). ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams }; ``` ## 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](#webdavserver-component) Component) Additional data to be included in the async state and mirrored back by the requestor. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData }; ``` ## 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](#webdavserver-component) Component) Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax *C++ Builder Syntax* ```text __property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation }; ``` ## 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 the DCAuth component. If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. ## Data Type Boolean # ExternalCryptoHashAlgorithm Property ([WebDAVServer](#webdavserver-component) Component) Specifies the request's signature hash algorithm. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm }; ``` ## 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](#webdavserver-component) Component) The ID of the pre-shared key used for DC request authentication. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID }; ``` ## 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 an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [ExternalCryptoKeySecret](#externalcryptokeysecret-property-webdavserver-component) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` ## Data Type String # ExternalCryptoKeySecret Property ([WebDAVServer](#webdavserver-component) Component) The pre-shared key used for DC request authentication. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret }; ``` ## 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](#externalcryptokeyid-property-webdavserver-component) topic. ## Data Type String # ExternalCryptoMethod Property ([WebDAVServer](#webdavserver-component) Component) Specifies the asynchronous signing method. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod }; enum TsbxWebDAVServerExternalCryptoMethods { asmdPKCS1=0, asmdPKCS7=1 }; ``` ## Default Value asmdPKCS1 ## 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](#webdavserver-component) Component) Specifies the external cryptography mode. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode }; enum TsbxWebDAVServerExternalCryptoModes { ecmDefault=0, ecmDisabled=1, ecmGeneric=2, ecmDCAuth=3, ecmDCAuthJSON=4 }; ``` ## Default Value ecmDefault ## 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 the 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](#webdavserver-component) Component) Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax *C++ Builder Syntax* ```text __property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Data Type String # FIPSMode Property ([WebDAVServer](#webdavserver-component) Component) Reserved. ## Syntax *C++ Builder Syntax* ```text __property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode }; ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # Host Property ([WebDAVServer](#webdavserver-component) Component) The host to bind the listening port to. ## Syntax *C++ Builder Syntax* ```text __property String Host = { read=FHost, write=FSetHost }; ``` ## Default Value "" ## Remarks Use this property to specify the IP address on which to listen to incoming connections. ## Data Type String # MetadataFlushTimeout Property ([WebDAVServer](#webdavserver-component) Component) Specifies metadata flush timeout. ## Syntax *C++ Builder Syntax* ```text __property int MetadataFlushTimeout = { read=FMetadataFlushTimeout, write=FSetMetadataFlushTimeout }; ``` ## Default Value 600 ## Remarks Use this property to specify metadata flush timeout in seconds. ## Data Type Integer # MetadataRoot Property ([WebDAVServer](#webdavserver-component) Component) The metadata directory root. ## Syntax *C++ Builder Syntax* ```text __property String MetadataRoot = { read=FMetadataRoot, write=FSetMetadataRoot }; ``` ## Default Value "" ## Remarks The metadata directory is a dedicated location for storing properties of the files served by the WebDAVServer. ## Data Type String # PinnedClientAEADCipher Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the encryption algorithm used is an AEAD cipher. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientAEADCipher = { read=FPinnedClientAEADCipher }; ``` ## Default Value false ## Remarks Indicates whether the encryption algorithm used is an AEAD cipher. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientChainValidationDetails Property ([WebDAVServer](#webdavserver-component) Component) The details of a certificate chain validation outcome. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientChainValidationDetails = { read=FPinnedClientChainValidationDetails }; ``` ## Default Value 0 ## Remarks The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is read-only and not available at design time. ## Data Type Integer # PinnedClientChainValidationResult Property ([WebDAVServer](#webdavserver-component) Component) The outcome of a certificate chain validation routine. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerPinnedClientChainValidationResults PinnedClientChainValidationResult = { read=FPinnedClientChainValidationResult }; enum TsbxWebDAVServerPinnedClientChainValidationResults { cvtValid=0, cvtValidButUntrusted=1, cvtInvalid=2, cvtCantBeEstablished=3 }; ``` ## Default Value cvtValid ## 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](#webdavserver-component) Component) The cipher suite employed by this connection. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCiphersuite = { read=FPinnedClientCiphersuite }; ``` ## 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](#webdavserver-component) Component) Specifies whether client authentication was performed during this connection. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientClientAuthenticated = { read=FPinnedClientClientAuthenticated }; ``` ## 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 # PinnedClientClientAuthRequested Property ([WebDAVServer](#webdavserver-component) Component) Specifies whether client authentication was requested during this connection. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientClientAuthRequested = { read=FPinnedClientClientAuthRequested }; ``` ## Default Value false ## Remarks Specifies whether client authentication was requested during this connection. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientConnectionEstablished Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the connection has been established fully. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientConnectionEstablished = { read=FPinnedClientConnectionEstablished }; ``` ## Default Value false ## Remarks Indicates whether the connection has been established fully. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientConnectionID Property ([WebDAVServer](#webdavserver-component) Component) The unique identifier assigned to this connection. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientConnectionID = { read=FPinnedClientConnectionID }; ``` ## Remarks The unique identifier assigned to this connection. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientDigestAlgorithm Property ([WebDAVServer](#webdavserver-component) Component) The digest algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientDigestAlgorithm = { read=FPinnedClientDigestAlgorithm }; ``` ## 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](#webdavserver-component) Component) The symmetric encryption algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientEncryptionAlgorithm = { read=FPinnedClientEncryptionAlgorithm }; ``` ## 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 # PinnedClientExportable Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether a TLS connection uses a reduced-strength exportable cipher. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientExportable = { read=FPinnedClientExportable }; ``` ## Default Value false ## Remarks Indicates whether a TLS connection uses a reduced-strength exportable cipher. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientGroup Property ([WebDAVServer](#webdavserver-component) Component) The elliptic curve used in this connection. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientGroup = { read=FPinnedClientGroup }; ``` ## Default Value "" ## Remarks The elliptic curve used in this connection. This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions. This property is read-only and not available at design time. ## Data Type String # PinnedClientID Property ([WebDAVServer](#webdavserver-component) Component) The client connection's unique identifier. ## Syntax *C++ Builder Syntax* ```text __property __int64 PinnedClientID = { read=FPinnedClientID }; ``` ## 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](#webdavserver-component) Component) The key exchange algorithm used in a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientKeyExchangeAlgorithm = { read=FPinnedClientKeyExchangeAlgorithm }; ``` ## 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](#webdavserver-component) Component) The length of the key exchange key of a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientKeyExchangeKeyBits = { read=FPinnedClientKeyExchangeKeyBits }; ``` ## 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 # PinnedClientPFSCipher Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientPFSCipher = { read=FPinnedClientPFSCipher }; ``` ## 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 # PinnedClientPreSharedIdentity Property ([WebDAVServer](#webdavserver-component) Component) Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientPreSharedIdentity = { read=FPinnedClientPreSharedIdentity }; ``` ## 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 # PinnedClientPreSharedIdentityHint Property ([WebDAVServer](#webdavserver-component) Component) A hint professed by the server to help the client select the PSK identity to use. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientPreSharedIdentityHint = { read=FPinnedClientPreSharedIdentityHint }; ``` ## Default Value "" ## Remarks A hint professed by the server to help the client select the PSK identity to use. This property is read-only and not available at design time. ## Data Type String # PinnedClientPublicKeyBits Property ([WebDAVServer](#webdavserver-component) Component) The length of the public key. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientPublicKeyBits = { read=FPinnedClientPublicKeyBits }; ``` ## Default Value 0 ## Remarks The length of the public key. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientRemoteAddress Property ([WebDAVServer](#webdavserver-component) Component) The client's IP address. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientRemoteAddress = { read=FPinnedClientRemoteAddress }; ``` ## Default Value "" ## Remarks The client's IP address. This property is read-only and not available at design time. ## Data Type String # PinnedClientRemotePort Property ([WebDAVServer](#webdavserver-component) Component) The remote port of the client connection. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientRemotePort = { read=FPinnedClientRemotePort }; ``` ## 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 # PinnedClientResumedSession Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether a TLS-enabled connection was spawned from another TLS connection. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientResumedSession = { read=FPinnedClientResumedSession }; ``` ## 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](#webdavserver-component) Component) Indicates whether TLS or SSL is enabled for this connection. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientSecureConnection = { read=FPinnedClientSecureConnection }; ``` ## 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 # PinnedClientServerAuthenticated Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether server authentication was performed during a TLS-enabled connection. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientServerAuthenticated = { read=FPinnedClientServerAuthenticated }; ``` ## Default Value false ## Remarks Indicates whether server authentication was performed during a TLS-enabled connection. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientSignatureAlgorithm Property ([WebDAVServer](#webdavserver-component) Component) The signature algorithm used in a TLS handshake. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientSignatureAlgorithm = { read=FPinnedClientSignatureAlgorithm }; ``` ## 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](#webdavserver-component) Component) The block size of the symmetric algorithm used. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientSymmetricBlockSize = { read=FPinnedClientSymmetricBlockSize }; ``` ## 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](#webdavserver-component) Component) The key length of the symmetric algorithm used. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientSymmetricKeyBits = { read=FPinnedClientSymmetricKeyBits }; ``` ## 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](#webdavserver-component) Component) The total number of bytes received over this connection. ## Syntax *C++ Builder Syntax* ```text __property __int64 PinnedClientTotalBytesReceived = { read=FPinnedClientTotalBytesReceived }; ``` ## 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](#webdavserver-component) Component) The total number of bytes sent over this connection. ## Syntax *C++ Builder Syntax* ```text __property __int64 PinnedClientTotalBytesSent = { read=FPinnedClientTotalBytesSent }; ``` ## 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](#webdavserver-component) Component) Contains the server certificate's chain validation log. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientValidationLog = { read=FPinnedClientValidationLog }; ``` ## 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](#webdavserver-component) Component) Indicates the version of SSL/TLS protocol negotiated during this connection. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientVersion = { read=FPinnedClientVersion }; ``` ## 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](#webdavserver-component) Component) The number of records in the PinnedClientCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientCertCount = { read=FPinnedClientCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [PinnedClientCertBytes](#pinnedclientcertbytes-property-webdavserver-component) - [PinnedClientCertCA](#pinnedclientcertca-property-webdavserver-component) - [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-webdavserver-component) - [PinnedClientCertCertType](#pinnedclientcertcerttype-property-webdavserver-component) - [PinnedClientCertCRLDistributionPoints](#pinnedclientcertcrldistributionpoints-property-webdavserver-component) - [PinnedClientCertCurve](#pinnedclientcertcurve-property-webdavserver-component) - [PinnedClientCertFingerprint](#pinnedclientcertfingerprint-property-webdavserver-component) - [PinnedClientCertFriendlyName](#pinnedclientcertfriendlyname-property-webdavserver-component) - [PinnedClientCertHandle](#pinnedclientcerthandle-property-webdavserver-component) - [PinnedClientCertHashAlgorithm](#pinnedclientcerthashalgorithm-property-webdavserver-component) - [PinnedClientCertIssuer](#pinnedclientcertissuer-property-webdavserver-component) - [PinnedClientCertIssuerRDN](#pinnedclientcertissuerrdn-property-webdavserver-component) - [PinnedClientCertKeyAlgorithm](#pinnedclientcertkeyalgorithm-property-webdavserver-component) - [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-webdavserver-component) - [PinnedClientCertKeyFingerprint](#pinnedclientcertkeyfingerprint-property-webdavserver-component) - [PinnedClientCertKeyUsage](#pinnedclientcertkeyusage-property-webdavserver-component) - [PinnedClientCertKeyValid](#pinnedclientcertkeyvalid-property-webdavserver-component) - [PinnedClientCertOCSPLocations](#pinnedclientcertocsplocations-property-webdavserver-component) - [PinnedClientCertOCSPNoCheck](#pinnedclientcertocspnocheck-property-webdavserver-component) - [PinnedClientCertOrigin](#pinnedclientcertorigin-property-webdavserver-component) - [PinnedClientCertPolicyIDs](#pinnedclientcertpolicyids-property-webdavserver-component) - [PinnedClientCertPrivateKeyBytes](#pinnedclientcertprivatekeybytes-property-webdavserver-component) - [PinnedClientCertPrivateKeyExists](#pinnedclientcertprivatekeyexists-property-webdavserver-component) - [PinnedClientCertPrivateKeyExtractable](#pinnedclientcertprivatekeyextractable-property-webdavserver-component) - [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-webdavserver-component) - [PinnedClientCertQualified](#pinnedclientcertqualified-property-webdavserver-component) - [PinnedClientCertQualifiedStatements](#pinnedclientcertqualifiedstatements-property-webdavserver-component) - [PinnedClientCertQualifiers](#pinnedclientcertqualifiers-property-webdavserver-component) - [PinnedClientCertSelfSigned](#pinnedclientcertselfsigned-property-webdavserver-component) - [PinnedClientCertSerialNumber](#pinnedclientcertserialnumber-property-webdavserver-component) - [PinnedClientCertSigAlgorithm](#pinnedclientcertsigalgorithm-property-webdavserver-component) - [PinnedClientCertSource](#pinnedclientcertsource-property-webdavserver-component) - [PinnedClientCertSubject](#pinnedclientcertsubject-property-webdavserver-component) - [PinnedClientCertSubjectAlternativeName](#pinnedclientcertsubjectalternativename-property-webdavserver-component) - [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-webdavserver-component) - [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-webdavserver-component) - [PinnedClientCertValid](#pinnedclientcertvalid-property-webdavserver-component) - [PinnedClientCertValidFrom](#pinnedclientcertvalidfrom-property-webdavserver-component) - [PinnedClientCertValidTo](#pinnedclientcertvalidto-property-webdavserver-component) The array indices start at *0* and end at *PinnedClientCertCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertBytes Property ([WebDAVServer](#webdavserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertBytes }; ``` ## Remarks Returns the 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](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertCA Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the certificate has a CA capability. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientCertCA[int PinnedClientCertIndex] = { read=FPinnedClientCertCA }; ``` ## Default Value false ## Remarks Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this property when generating a new certificate to have its Basic Constraints extension generated automatically. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertCAKeyID Property ([WebDAVServer](#webdavserver-component) Component) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertCAKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertCAKeyID }; ``` ## Remarks A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-webdavserver-component) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertCertType Property ([WebDAVServer](#webdavserver-component) Component) Returns the type of the entity contained in the Certificate object. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerPinnedClientCertCertTypes PinnedClientCertCertType[int PinnedClientCertIndex] = { read=FPinnedClientCertCertType }; enum TsbxWebDAVServerPinnedClientCertCertTypes { ctUnknown=0, ctX509Certificate=1, ctX509CertificateRequest=2 }; ``` ## Default Value ctUnknown ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_Certificate) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](#CertificateManager) component to load or create new certificate and certificate requests objects. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertCRLDistributionPoints Property ([WebDAVServer](#webdavserver-component) Component) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertCRLDistributionPoints[int PinnedClientCertIndex] = { read=FPinnedClientCertCRLDistributionPoints }; ``` ## Default Value "" ## Remarks Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertCurve Property ([WebDAVServer](#webdavserver-component) Component) Specifies the elliptic curve associated with the certificate's public key. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertCurve[int PinnedClientCertIndex] = { read=FPinnedClientCertCurve }; ``` ## Default Value "" ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertFingerprint Property ([WebDAVServer](#webdavserver-component) Component) Contains the fingerprint (a hash imprint) of this certificate. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertFingerprint }; ``` ## Default Value "" ## Remarks Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertFriendlyName Property ([WebDAVServer](#webdavserver-component) Component) Contains an associated alias (friendly name) of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertFriendlyName[int PinnedClientCertIndex] = { read=FPinnedClientCertFriendlyName }; ``` ## Default Value "" ## Remarks Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertHandle Property ([WebDAVServer](#webdavserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 PinnedClientCertHandle[int PinnedClientCertIndex] = { read=FPinnedClientCertHandle }; ``` ## 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. ```text 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](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Long64 # PinnedClientCertHashAlgorithm Property ([WebDAVServer](#webdavserver-component) Component) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertHashAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertHashAlgorithm }; ``` ## Default Value "" ## Remarks Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [PinnedClientCertSigAlgorithm](#pinnedclientcertsigalgorithm-property-webdavserver-component) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertIssuer Property ([WebDAVServer](#webdavserver-component) Component) The common name of the certificate issuer (CA), typically a company name. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertIssuer[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuer }; ``` ## Default Value "" ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [PinnedClientCertIssuerRDN](#pinnedclientcertissuerrdn-property-webdavserver-component). The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertIssuerRDN Property ([WebDAVServer](#webdavserver-component) Component) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertIssuerRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertIssuerRDN }; ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyAlgorithm Property ([WebDAVServer](#webdavserver-component) Component) Specifies the public key algorithm of this certificate. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertKeyAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyAlgorithm }; ``` ## 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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [PinnedClientCertKeyBits](#pinnedclientcertkeybits-property-webdavserver-component), [PinnedClientCertCurve](#pinnedclientcertcurve-property-webdavserver-component), and [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-webdavserver-component) properties to get more details about the key the certificate contains. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyBits Property ([WebDAVServer](#webdavserver-component) Component) Returns the length of the public key in bits. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientCertKeyBits[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyBits }; ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [PinnedClientCertPublicKeyBytes](#pinnedclientcertpublickeybytes-property-webdavserver-component) or [PinnedClientCertPrivateKeyBytes](#pinnedclientcertprivatekeybytes-property-webdavserver-component) property would typically contain auxiliary values, and therefore be longer. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertKeyFingerprint Property ([WebDAVServer](#webdavserver-component) Component) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertKeyFingerprint[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyFingerprint }; ``` ## Default Value "" ## Remarks Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [PinnedClientCertFingerprint](#pinnedclientcertfingerprint-property-webdavserver-component) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertKeyUsage Property ([WebDAVServer](#webdavserver-component) Component) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientCertKeyUsage[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyUsage }; ``` ## 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 | Set this property before generating the certificate to propagate the key usage flags to the new certificate. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertKeyValid Property ([WebDAVServer](#webdavserver-component) Component) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientCertKeyValid[int PinnedClientCertIndex] = { read=FPinnedClientCertKeyValid }; ``` ## 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](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertOCSPLocations Property ([WebDAVServer](#webdavserver-component) Component) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertOCSPLocations[int PinnedClientCertIndex] = { read=FPinnedClientCertOCSPLocations }; ``` ## Default Value "" ## Remarks Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this property before calling the certificate manager's [Generate](#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertOCSPNoCheck Property ([WebDAVServer](#webdavserver-component) Component) Accessor to the value of the certificate's ocsp-no-check extension. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientCertOCSPNoCheck[int PinnedClientCertIndex] = { read=FPinnedClientCertOCSPNoCheck }; ``` ## Default Value false ## Remarks Accessor to the value of the certificate's ocsp-no-check extension. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertOrigin Property ([WebDAVServer](#webdavserver-component) Component) Returns the location that the certificate was taken or loaded from. ## Syntax *C++ Builder Syntax* ```text __property int PinnedClientCertOrigin[int PinnedClientCertIndex] = { read=FPinnedClientCertOrigin }; ``` ## Default Value 0 ## Remarks Returns the location that the certificate was taken or loaded from. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertPolicyIDs Property ([WebDAVServer](#webdavserver-component) Component) Contains identifiers (OIDs) of the applicable certificate policies. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertPolicyIDs[int PinnedClientCertIndex] = { read=FPinnedClientCertPolicyIDs }; ``` ## 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. Set this property when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertPrivateKeyBytes Property ([WebDAVServer](#webdavserver-component) Component) Returns the certificate's private key in DER-encoded format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertPrivateKeyBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertPrivateKeyBytes }; ``` ## Remarks Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertPrivateKeyExists Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the certificate has a usable private key associated with it. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientCertPrivateKeyExists[int PinnedClientCertIndex] = { read=FPinnedClientCertPrivateKeyExists }; ``` ## Default Value false ## Remarks Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This property is independent from [PinnedClientCertPrivateKeyBytes](#pinnedclientcertprivatekeybytes-property-webdavserver-component), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertPrivateKeyExtractable Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the private key is extractable (exportable). ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientCertPrivateKeyExtractable[int PinnedClientCertIndex] = { read=FPinnedClientCertPrivateKeyExtractable }; ``` ## Default Value false ## Remarks Indicates whether the private key is extractable (exportable). The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertPublicKeyBytes Property ([WebDAVServer](#webdavserver-component) Component) Contains the certificate's public key in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertPublicKeyBytes[int PinnedClientCertIndex] = { read=FPinnedClientCertPublicKeyBytes }; ``` ## Remarks Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertQualified Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the certificate is qualified. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientCertQualified[int PinnedClientCertIndex] = { read=FPinnedClientCertQualified }; ``` ## Default Value false ## Remarks Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertQualifiedStatements Property ([WebDAVServer](#webdavserver-component) Component) Returns a simplified qualified status of the certificate. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerPinnedClientCertQualifiedStatements PinnedClientCertQualifiedStatements[int PinnedClientCertIndex] = { read=FPinnedClientCertQualifiedStatements }; enum TsbxWebDAVServerPinnedClientCertQualifiedStatements { qstNonQualified=0, qstQualifiedHardware=1, qstQualifiedSoftware=2 }; ``` ## Default Value qstNonQualified ## Remarks Returns a simplified qualified status 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](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertQualifiers Property ([WebDAVServer](#webdavserver-component) Component) A list of qualifiers. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertQualifiers[int PinnedClientCertIndex] = { read=FPinnedClientCertQualifiers }; ``` ## Default Value "" ## Remarks A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertSelfSigned Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientCertSelfSigned[int PinnedClientCertIndex] = { read=FPinnedClientCertSelfSigned }; ``` ## 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](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertSerialNumber Property ([WebDAVServer](#webdavserver-component) Component) Returns the certificate's serial number. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertSerialNumber[int PinnedClientCertIndex] = { read=FPinnedClientCertSerialNumber }; ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertSigAlgorithm Property ([WebDAVServer](#webdavserver-component) Component) Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertSigAlgorithm[int PinnedClientCertIndex] = { read=FPinnedClientCertSigAlgorithm }; ``` ## Default Value "" ## Remarks Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertSource Property ([WebDAVServer](#webdavserver-component) Component) Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerPinnedClientCertSources PinnedClientCertSource[int PinnedClientCertIndex] = { read=FPinnedClientCertSource }; enum TsbxWebDAVServerPinnedClientCertSources { pksUnknown=0, pksSignature=1, pksDocument=2, pksUser=3, pksLocal=4, pksOnline=5 }; ``` ## Default Value pksUnknown ## Remarks Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Integer # PinnedClientCertSubject Property ([WebDAVServer](#webdavserver-component) Component) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertSubject[int PinnedClientCertIndex] = { read=FPinnedClientCertSubject }; ``` ## 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. This is part of a larger set of credentials available via [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-webdavserver-component). The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertSubjectAlternativeName Property ([WebDAVServer](#webdavserver-component) Component) Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertSubjectAlternativeName[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectAlternativeName }; ``` ## Default Value "" ## Remarks Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main [PinnedClientCertSubjectRDN](#pinnedclientcertsubjectrdn-property-webdavserver-component) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertSubjectKeyID Property ([WebDAVServer](#webdavserver-component) Component) Contains a unique identifier of the certificate's cryptographic key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray PinnedClientCertSubjectKeyID[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectKeyID }; ``` ## Remarks Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [PinnedClientCertSubjectKeyID](#pinnedclientcertsubjectkeyid-property-webdavserver-component) and [PinnedClientCertCAKeyID](#pinnedclientcertcakeyid-property-webdavserver-component) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # PinnedClientCertSubjectRDN Property ([WebDAVServer](#webdavserver-component) Component) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertSubjectRDN[int PinnedClientCertIndex] = { read=FPinnedClientCertSubjectRDN }; ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertValid Property ([WebDAVServer](#webdavserver-component) Component) Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. ## Syntax *C++ Builder Syntax* ```text __property bool PinnedClientCertValid[int PinnedClientCertIndex] = { read=FPinnedClientCertValid }; ``` ## Default Value false ## Remarks Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. The *PinnedClientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [PinnedClientCertCount](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Boolean # PinnedClientCertValidFrom Property ([WebDAVServer](#webdavserver-component) Component) The time point at which the certificate becomes valid, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertValidFrom[int PinnedClientCertIndex] = { read=FPinnedClientCertValidFrom }; ``` ## 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](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # PinnedClientCertValidTo Property ([WebDAVServer](#webdavserver-component) Component) The time point at which the certificate expires, in UTC. ## Syntax *C++ Builder Syntax* ```text __property String PinnedClientCertValidTo[int PinnedClientCertIndex] = { read=FPinnedClientCertValidTo }; ``` ## 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](#pinnedclientcertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type String # Port Property ([WebDAVServer](#webdavserver-component) Component) Specifies the port number to listen for connections on. ## Syntax *C++ Builder Syntax* ```text __property int Port = { read=FPort, write=FSetPort }; ``` ## Default Value 80 ## Remarks Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server. Alternatively, you may specify the acceptable range of listening ports via [PortRangeFrom](#portrangefrom-property-webdavserver-component) and [PortRangeTo](#portrangeto-property-webdavserver-component) properties. In this case the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-webdavserver-component). ## Data Type Integer # PortRangeFrom Property ([WebDAVServer](#webdavserver-component) Component) Specifies the lower limit of the listening port range for incoming connections. ## Syntax *C++ Builder Syntax* ```text __property int PortRangeFrom = { read=FPortRangeFrom, write=FSetPortRangeFrom }; ``` ## Default Value 0 ## Remarks Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via [Port](#port-property-webdavserver-component)), the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-webdavserver-component). ## Data Type Integer # PortRangeTo Property ([WebDAVServer](#webdavserver-component) Component) Specifies the upper limit of the listening port range for incoming connections. ## Syntax *C++ Builder Syntax* ```text __property int PortRangeTo = { read=FPortRangeTo, write=FSetPortRangeTo }; ``` ## Default Value 0 ## Remarks Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via [Port](#port-property-webdavserver-component)), the port will be allocated within the requested range by the operating system, and reported in [BoundPort](#boundport-property-webdavserver-component). ## Data Type Integer # SocketIncomingSpeedLimit Property ([WebDAVServer](#webdavserver-component) Component) The maximum number of bytes to read from the socket, per second. ## Syntax *C++ Builder Syntax* ```text __property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit }; ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. ## Data Type Integer # SocketLocalAddress Property ([WebDAVServer](#webdavserver-component) Component) The local network interface to bind the socket to. ## Syntax *C++ Builder Syntax* ```text __property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress }; ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. ## Data Type String # SocketLocalPort Property ([WebDAVServer](#webdavserver-component) Component) The local port number to bind the socket to. ## Syntax *C++ Builder Syntax* ```text __property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort }; ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. ## Data Type Integer # SocketOutgoingSpeedLimit Property ([WebDAVServer](#webdavserver-component) Component) The maximum number of bytes to write to the socket, per second. ## Syntax *C++ Builder Syntax* ```text __property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit }; ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. ## Data Type Integer # SocketTimeout Property ([WebDAVServer](#webdavserver-component) Component) The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax *C++ Builder Syntax* ```text __property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout }; ``` ## 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](#webdavserver-component) Component) Enables or disables IP protocol version 6. ## Syntax *C++ Builder Syntax* ```text __property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 }; ``` ## Default Value false ## Remarks Enables or disables IP protocol version 6. ## Data Type Boolean # TLSServerCertCount Property ([WebDAVServer](#webdavserver-component) Component) The number of records in the TLSServerCert arrays. ## Syntax *C++ Builder Syntax* ```text __property int TLSServerCertCount = { read=FTLSServerCertCount, write=FSetTLSServerCertCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [TLSServerCertBytes](#tlsservercertbytes-property-webdavserver-component) - [TLSServerCertHandle](#tlsservercerthandle-property-webdavserver-component) The array indices start at *0* and end at *TLSServerCertCount - 1*. This property is not available at design time. ## Data Type Integer # TLSServerCertBytes Property ([WebDAVServer](#webdavserver-component) Component) Returns the raw certificate data in DER format. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes }; ``` ## Remarks Returns the raw certificate data in DER format. The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-webdavserver-component) property. This property is read-only and not available at design time. ## Data Type Byte Array # TLSServerCertHandle Property ([WebDAVServer](#webdavserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle, write=FSetTLSServerCertHandle }; ``` ## 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *TLSServerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Long64 # TLSAutoValidateCertificates Property ([WebDAVServer](#webdavserver-component) Component) Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax *C++ Builder Syntax* ```text __property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates }; ``` ## Default Value true ## Remarks Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Data Type Boolean # TLSBaseConfiguration Property ([WebDAVServer](#webdavserver-component) Component) Selects the base configuration for the TLS settings. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration }; enum TsbxWebDAVServerTLSBaseConfigurations { stpcDefault=0, stpcCompatible=1, stpcComprehensiveInsecure=2, stpcHighlySecure=3 }; ``` ## Default Value stpcDefault ## Remarks Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | ## Data Type Integer # TLSCiphersuites Property ([WebDAVServer](#webdavserver-component) Component) A list of ciphersuites separated with commas or semicolons. ## Syntax *C++ Builder Syntax* ```text __property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites }; ``` ## 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, allowing all ciphersuites to be blanketly enabled or disabled at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [TLSBaseConfiguration](#tlsbaseconfiguration-property-webdavserver-component). 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 # TLSClientAuth Property ([WebDAVServer](#webdavserver-component) Component) Enables or disables certificate-based client authentication. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth }; enum TsbxWebDAVServerTLSClientAuths { ccatNoAuth=0, ccatRequestCert=1, ccatRequireCert=2 }; ``` ## Default Value ccatNoAuth ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | ## Data Type Integer # TLSExtensions Property ([WebDAVServer](#webdavserver-component) Component) Provides access to TLS extensions. ## Syntax *C++ Builder Syntax* ```text __property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions }; ``` ## Default Value "" ## Remarks Provides access to TLS extensions. ## Data Type String # TLSForceResumeIfDestinationChanges Property ([WebDAVServer](#webdavserver-component) Component) Whether to force TLS session resumption when the destination address changes. ## Syntax *C++ Builder Syntax* ```text __property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges }; ``` ## Default Value false ## Remarks Whether to force TLS session resumption when the destination address changes. ## Data Type Boolean # TLSGroups Property ([WebDAVServer](#webdavserver-component) Component) Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax *C++ Builder Syntax* ```text __property String TLSGroups = { read=FTLSGroups, write=FSetTLSGroups }; ``` ## Default Value "" ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. ## Data Type String # TLSPreSharedIdentity Property ([WebDAVServer](#webdavserver-component) Component) Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax *C++ Builder Syntax* ```text __property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity }; ``` ## 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](#webdavserver-component) Component) Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax *C++ Builder Syntax* ```text __property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey }; ``` ## Default Value "" ## Remarks Contains the pre-shared key 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](#webdavserver-component) Component) Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax *C++ Builder Syntax* ```text __property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite }; ``` ## Default Value "" ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Data Type String # TLSRenegotiationAttackPreventionMode Property ([WebDAVServer](#webdavserver-component) Component) Selects the renegotiation attack prevention mechanism. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode }; enum TsbxWebDAVServerTLSRenegotiationAttackPreventionModes { crapmCompatible=0, crapmStrict=1, crapmAuto=2 }; ``` ## Default Value crapmAuto ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | ## Data Type Integer # TLSRevocationCheck Property ([WebDAVServer](#webdavserver-component) Component) Specifies the kind(s) of revocation check to perform. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck }; enum TsbxWebDAVServerTLSRevocationChecks { crcNone=0, crcAuto=1, crcAllCRL=2, crcAllOCSP=3, crcAllCRLAndOCSP=4, crcAnyCRL=5, crcAnyOCSP=6, crcAnyCRLOrOCSP=7, crcAnyOCSPOrCRL=8 }; ``` ## Default Value crcAuto ## 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 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. This property is not available at design time. ## Data Type Integer # TLSSSLOptions Property ([WebDAVServer](#webdavserver-component) Component) 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 *C++ Builder Syntax* ```text __property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions }; ``` ## 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 the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. | | cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known | | cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only | | cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. | | cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled | | cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms | | cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks | | cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually | ## Data Type Integer # TLSMode Property ([WebDAVServer](#webdavserver-component) Component) Specifies the TLS mode to use. ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerTLSModes TLSMode = { read=FTLSMode, write=FSetTLSMode }; enum TsbxWebDAVServerTLSModes { smDefault=0, smNoTLS=1, smExplicitTLS=2, smImplicitTLS=3, smMixedTLS=4 }; ``` ## Default Value smDefault ## 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, but allow plain data. | ## Data Type Integer # TLSUseExtendedMasterSecret Property ([WebDAVServer](#webdavserver-component) Component) Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax *C++ Builder Syntax* ```text __property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret }; ``` ## Default Value true ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Data Type Boolean # TLSUseSessionResumption Property ([WebDAVServer](#webdavserver-component) Component) Enables or disables the TLS session resumption capability. ## Syntax *C++ Builder Syntax* ```text __property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption }; ``` ## Default Value false ## Remarks Enables or disables the TLS session resumption capability. ## Data Type Boolean # TLSVersions Property ([WebDAVServer](#webdavserver-component) Component) The SSL/TLS versions to enable by default. ## Syntax *C++ Builder Syntax* ```text __property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions }; ``` ## Default Value 48 ## Remarks The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | ## Data Type Integer # UserCount Property ([WebDAVServer](#webdavserver-component) Component) The number of records in the User arrays. ## Syntax *C++ Builder Syntax* ```text __property int UserCount = { read=FUserCount, write=FSetUserCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [UserAssociatedData](#userassociateddata-property-webdavserver-component) - [UserBasePath](#userbasepath-property-webdavserver-component) - [UserCertificate](#usercertificate-property-webdavserver-component) - [UserData](#userdata-property-webdavserver-component) - [UserEmail](#useremail-property-webdavserver-component) - [UserHandle](#userhandle-property-webdavserver-component) - [UserHashAlgorithm](#userhashalgorithm-property-webdavserver-component) - [UserIncomingSpeedLimit](#userincomingspeedlimit-property-webdavserver-component) - [Username](#username-property-webdavserver-component) - [UserOtpAlgorithm](#userotpalgorithm-property-webdavserver-component) - [UserOTPLen](#userotplen-property-webdavserver-component) - [UserOtpValue](#userotpvalue-property-webdavserver-component) - [UserOutgoingSpeedLimit](#useroutgoingspeedlimit-property-webdavserver-component) - [UserPassword](#userpassword-property-webdavserver-component) - [UserSharedSecret](#usersharedsecret-property-webdavserver-component) - [UserSSHKey](#usersshkey-property-webdavserver-component) The array indices start at *0* and end at *UserCount - 1*. This property is not available at design time. ## Data Type Integer # UserAssociatedData Property ([WebDAVServer](#webdavserver-component) Component) Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray UserAssociatedData[int UserIndex] = { read=FUserAssociatedData, write=FSetUserAssociatedData }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Byte Array # UserBasePath Property ([WebDAVServer](#webdavserver-component) Component) Base path for this user in the server's file system. ## Syntax *C++ Builder Syntax* ```text __property String UserBasePath[int UserIndex] = { read=FUserBasePath, write=FSetUserBasePath }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type String # UserCertificate Property ([WebDAVServer](#webdavserver-component) Component) Contains the user's certificate. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray UserCertificate[int UserIndex] = { read=FUserCertificate, write=FSetUserCertificate }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Byte Array # UserData Property ([WebDAVServer](#webdavserver-component) Component) Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. ## Syntax *C++ Builder Syntax* ```text __property String UserData[int UserIndex] = { read=FUserData, write=FSetUserData }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type String # UserEmail Property ([WebDAVServer](#webdavserver-component) Component) The user's email address. ## Syntax *C++ Builder Syntax* ```text __property String UserEmail[int UserIndex] = { read=FUserEmail, write=FSetUserEmail }; ``` ## Default Value "" ## Remarks The user's email address. The *UserIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [UserCount](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type String # UserHandle Property ([WebDAVServer](#webdavserver-component) Component) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax *C++ Builder Syntax* ```text __property __int64 UserHandle[int UserIndex] = { read=FUserHandle, write=FSetUserHandle }; ``` ## 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. ```text 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Long64 # UserHashAlgorithm Property ([WebDAVServer](#webdavserver-component) Component) Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. ## Syntax *C++ Builder Syntax* ```text __property String UserHashAlgorithm[int UserIndex] = { read=FUserHashAlgorithm, write=FSetUserHashAlgorithm }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type String # UserIncomingSpeedLimit Property ([WebDAVServer](#webdavserver-component) Component) Specifies the incoming speed limit for this user. ## Syntax *C++ Builder Syntax* ```text __property int UserIncomingSpeedLimit[int UserIndex] = { read=FUserIncomingSpeedLimit, write=FSetUserIncomingSpeedLimit }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Integer # UserOtpAlgorithm Property ([WebDAVServer](#webdavserver-component) Component) The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). ## Syntax *C++ Builder Syntax* ```text __property TsbxWebDAVServerUserOtpAlgorithms UserOtpAlgorithm[int UserIndex] = { read=FUserOtpAlgorithm, write=FSetUserOtpAlgorithm }; enum TsbxWebDAVServerUserOtpAlgorithms { oaNone=0, oaHmac=1, oaTime=2 }; ``` ## Default Value oaNone ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Integer # UserOTPLen Property ([WebDAVServer](#webdavserver-component) Component) Specifies the length of the user's OTP password. ## Syntax *C++ Builder Syntax* ```text __property int UserOTPLen[int UserIndex] = { read=FUserOTPLen, write=FSetUserOTPLen }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Integer # UserOtpValue Property ([WebDAVServer](#webdavserver-component) Component) The user's time interval (TOTP) or Counter (HOTP). ## Syntax *C++ Builder Syntax* ```text __property int UserOtpValue[int UserIndex] = { read=FUserOtpValue, write=FSetUserOtpValue }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Integer # UserOutgoingSpeedLimit Property ([WebDAVServer](#webdavserver-component) Component) Specifies the outgoing speed limit for this user. ## Syntax *C++ Builder Syntax* ```text __property int UserOutgoingSpeedLimit[int UserIndex] = { read=FUserOutgoingSpeedLimit, write=FSetUserOutgoingSpeedLimit }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Integer # UserPassword Property ([WebDAVServer](#webdavserver-component) Component) The user's authentication password. ## Syntax *C++ Builder Syntax* ```text __property String UserPassword[int UserIndex] = { read=FUserPassword, write=FSetUserPassword }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type String # UserSharedSecret Property ([WebDAVServer](#webdavserver-component) Component) Contains the user's secret key, which is essentially a shared secret between the client and server. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray UserSharedSecret[int UserIndex] = { read=FUserSharedSecret, write=FSetUserSharedSecret }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Byte Array # UserSSHKey Property ([WebDAVServer](#webdavserver-component) Component) Contains the user's SSH key. ## Syntax *C++ Builder Syntax* ```text __property DynamicArray UserSSHKey[int UserIndex] = { read=FUserSSHKey, write=FSetUserSSHKey }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type Byte Array # Username Property ([WebDAVServer](#webdavserver-component) Component) The registered name (login) of the user. ## Syntax *C++ Builder Syntax* ```text __property String Username[int UserIndex] = { read=FUsername, write=FSetUsername }; ``` ## 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](#usercount-property-webdavserver-component) property. This property is not available at design time. ## Data Type String # WebsiteName Property ([WebDAVServer](#webdavserver-component) Component) Specifies the web site name to use in the certificate. ## Syntax *C++ Builder Syntax* ```text __property String WebsiteName = { read=FWebsiteName, write=FSetWebsiteName }; ``` ## Default Value "SecureBlackbox" ## Remarks If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'. ## Data Type String # Cleanup Method ([WebDAVServer](#webdavserver-component) Component) Cleans up the server environment by purging expired sessions and cleaning caches. ## Syntax *C++ Builder Syntax* ```text void __fastcall Cleanup(); ``` ## Remarks Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches. # Config Method ([WebDAVServer](#webdavserver-component) Component) Sets or retrieves a configuration setting. ## Syntax *C++ Builder Syntax* ```text String __fastcall Config(String ConfigurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-webdavserver-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-webdavserver-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([WebDAVServer](#webdavserver-component) Component) Performs an additional action. ## Syntax *C++ Builder Syntax* ```text String __fastcall DoAction(String ActionID, String ActionParams); ``` ## Remarks DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # DropClient Method ([WebDAVServer](#webdavserver-component) Component) Terminates a client connection. ## Syntax *C++ Builder Syntax* ```text void __fastcall DropClient(__int64 ConnectionId, bool Forced); ``` ## Remarks Call this method to shut down a connected client. *Forced* indicates whether the connection should be closed in a graceful manner. # GetClientBuffer Method ([WebDAVServer](#webdavserver-component) Component) Obtains a pending connection buffer. ## Syntax *C++ Builder Syntax* ```text DynamicArray __fastcall GetClientBuffer(__int64 ConnectionID); ``` ## 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. # GetRequestBytes Method ([WebDAVServer](#webdavserver-component) Component) Returns the contents of the client's HTTP request. ## Syntax *C++ Builder Syntax* ```text DynamicArray __fastcall GetRequestBytes(__int64 ConnectionId, String RequestFilter); ``` ## Remarks Use this method to get the body of the client's HTTP request in your [CustomRequest](#customrequest-event-webdavserver-component) event handler. Note that the body of GET and HEAD requests is empty. The method returns the requested content. The *RequestFilter* parameter allows you to select the element(s) that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported: | | | | --- | --- | | params | Request query parameters only. | | params[Index] | A specific request parameter, by index. | | params['Name'] | A specific request parameter, by name. | | parts[Index] | The body of a particular part of a multipart message. | # GetRequestHeader Method ([WebDAVServer](#webdavserver-component) Component) Returns a request header value. ## Syntax *C++ Builder Syntax* ```text String __fastcall GetRequestHeader(__int64 ConnectionId, String HeaderName); ``` ## Remarks Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as [BeforeLockObject](#beforelockobject-event-webdavserver-component) or [CustomRequest](#customrequest-event-webdavserver-component). # GetRequestString Method ([WebDAVServer](#webdavserver-component) Component) Returns the contents of the client's HTTP request. ## Syntax *C++ Builder Syntax* ```text String __fastcall GetRequestString(__int64 ConnectionId, String RequestFilter); ``` ## Remarks Use this method to get the body of the client's HTTP request to a string. Note that the body of GET and HEAD requests is empty. The *RequestFilter* parameter allows you to select the element(s) of the requests that you would like to get. An empty request filter makes the whole body to be returned. The following request filters are currently supported: | | | | --- | --- | | params | Request query parameters only. | | params[Index] | A specific request parameter, by index. | | params['Name'] | A specific request parameter, by name. | | parts[Index] | The body of a particular part of a multipart message. | # GetRequestUsername Method ([WebDAVServer](#webdavserver-component) Component) Returns the username for a connection. ## Syntax *C++ Builder Syntax* ```text String __fastcall GetRequestUsername(__int64 ConnectionId); ``` ## Remarks Use this method to obtain a username for an active connection. The method will return an empty string if no authentication has been performed on the connection. # GetResponseHeader Method ([WebDAVServer](#webdavserver-component) Component) Returns a response header value. ## Syntax *C++ Builder Syntax* ```text String __fastcall GetResponseHeader(__int64 ConnectionId, String HeaderName); ``` ## Remarks Use this method to get the value of a response header. A good place to call this method is [HeadersPrepared](#headersprepared-event-webdavserver-component) event. Call the method with empty *HeaderName* to get the whole response header. # ListClients Method ([WebDAVServer](#webdavserver-component) Component) Enumerates the connected clients. ## Syntax *C++ Builder Syntax* ```text String __fastcall 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. # PinClient Method ([WebDAVServer](#webdavserver-component) Component) Takes a snapshot of the connection's properties. ## Syntax *C++ Builder Syntax* ```text void __fastcall PinClient(__int64 ConnectionId); ``` ## Remarks Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties. # ProcessGenericRequest Method ([WebDAVServer](#webdavserver-component) Component) Processes a generic HTTP request. ## Syntax *C++ Builder Syntax* ```text DynamicArray __fastcall ProcessGenericRequest(__int64 ConnectionId, DynamicArray RequestBytes); ``` ## Remarks This method processes a generic HTTP request and produces a response. Use it to generate HTTP responses for requests obtained externally, out of the default HTTP channel. This method respects all current settings of the server object, and invokes the corresponding events to consult about the request and response details with the application. *ConnectionId* allows to identify the request in the events. The method returns the complete HTTP response including HTTP headers. # Reset Method ([WebDAVServer](#webdavserver-component) Component) Resets the component settings. ## Syntax *C++ Builder Syntax* ```text void __fastcall Reset(); ``` ## Remarks Reset is a generic method available in every component. # SetClientBuffer Method ([WebDAVServer](#webdavserver-component) Component) Commits a data buffer to the connection. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetClientBuffer(__int64 ConnectionID, DynamicArray Value); ``` ## Remarks Use this method from your ReadFile event handler to commit a chunk of file data to the server component. # SetClientFileEntry Method ([WebDAVServer](#webdavserver-component) Component) Commits a file entry to the connection. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetClientFileEntry(__int64 ConnectionID); ``` ## 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. # SetResponseBytes Method ([WebDAVServer](#webdavserver-component) Component) Sets a byte array to be served as a response. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetResponseBytes(__int64 ConnectionId, DynamicArray Bytes, String ContentType, String ResponseFilter); ``` ## Remarks Use this property to provide the response content in a byte array when serving custom requests in your [CustomRequest](#customrequest-event-webdavserver-component) handler. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*: | | | | --- | --- | | parts[Index] | The body of a particular part of a multipart response. | # SetResponseFile Method ([WebDAVServer](#webdavserver-component) Component) Sets a file to be served as a response. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetResponseFile(__int64 ConnectionId, String FileName, String ContentType, String ResponseFilter); ``` ## Remarks Use this property to provide the response content in a file. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*: | | | | --- | --- | | parts[Index] | The body of a particular part of a multipart response. | # SetResponseHeader Method ([WebDAVServer](#webdavserver-component) Component) Sets a response header. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetResponseHeader(__int64 ConnectionId, String HeaderName, String Value); ``` ## Remarks Use this method to set a response header. A good place to call this method is a request-marking event, such as [LockObject](#lockobject-event-webdavserver-component) or [CustomRequest](#customrequest-event-webdavserver-component). # SetResponseStatus Method ([WebDAVServer](#webdavserver-component) Component) Sets an HTTP status to be sent with the response. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetResponseStatus(__int64 ConnectionId, int StatusCode); ``` ## Remarks Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as [CustomRequest](#customrequest-event-webdavserver-component). # SetResponseString Method ([WebDAVServer](#webdavserver-component) Component) Sets a string to be served as a response. ## Syntax *C++ Builder Syntax* ```text void __fastcall SetResponseString(__int64 ConnectionId, String DataStr, String ContentType, String ResponseFilter); ``` ## Remarks Use this property to provide the response content in a string. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. The only response filter currently supported is *parts*: | | | | --- | --- | | parts[Index] | The body of a particular part of a multipart response. | # Start Method ([WebDAVServer](#webdavserver-component) Component) Starts the server. ## Syntax *C++ Builder Syntax* ```text void __fastcall Start(); ``` ## Remarks Use this method to activate the server and start listening to incoming connections. # Stop Method ([WebDAVServer](#webdavserver-component) Component) Stops the server. ## Syntax *C++ Builder Syntax* ```text void __fastcall Stop(); ``` ## Remarks Call this method to stop listening to incoming connections and deactivate the server. # Accept Event ([WebDAVServer](#webdavserver-component) Component) Reports an incoming connection. ## Syntax *C++ Builder Syntax* ```text typedef struct { String RemoteAddress; int RemotePort; bool Accept; } TsbxWebDAVServerAcceptEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAcceptEvent)(System::TObject* Sender, TsbxWebDAVServerAcceptEventParams *e); __property TsbxWebDAVServerAcceptEvent OnAccept = { read=FOnAccept, write=FOnAccept }; ``` ## Remarks This event is fired when a new connection from *RemoteAddress*:*RemotePort* is ready to be accepted. Use the *Accept* parameter to accept or decline it. Subscribe to [Connect](#connect-event-webdavserver-component) event to be notified of every connection that has been set up. # AfterBrowse Event ([WebDAVServer](#webdavserver-component) Component) WebDAVServer uses this event to notify the application about the completion of the browsing operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerAfterBrowseEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterBrowseEvent)(System::TObject* Sender, TsbxWebDAVServerAfterBrowseEventParams *e); __property TsbxWebDAVServerAfterBrowseEvent OnAfterBrowse = { read=FOnAfterBrowse, write=FOnAfterBrowse }; ``` ## Remarks The *ConnectionID* parameter identifies the client connection, and the *Path* parameter specifies the browsing path. This event is typically fired after the [BeforeBrowse](#beforebrowse-event-webdavserver-component) event. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterCopyObject Event ([WebDAVServer](#webdavserver-component) Component) This event notifies the application about the completion of the copy operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String OldPath; String NewPath; int OperationStatus; } TsbxWebDAVServerAfterCopyObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterCopyObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterCopyObjectEventParams *e); __property TsbxWebDAVServerAfterCopyObjectEvent OnAfterCopyObject = { read=FOnAfterCopyObject, write=FOnAfterCopyObject }; ``` ## Remarks AfterCopyObject is typically preceded by [BeforeCopyObject](#beforecopyobject-event-webdavserver-component) and [CopyObject](#copyobject-event-webdavserver-component) events. The *OldPath* and *NewPath* parameters contain the origin and destination names of the copied object. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterCreateCalendar Event ([WebDAVServer](#webdavserver-component) Component) This event reports the completion of calendar creation request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerAfterCreateCalendarEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterCreateCalendarEvent)(System::TObject* Sender, TsbxWebDAVServerAfterCreateCalendarEventParams *e); __property TsbxWebDAVServerAfterCreateCalendarEvent OnAfterCreateCalendar = { read=FOnAfterCreateCalendar, write=FOnAfterCreateCalendar }; ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterCreateCollection Event ([WebDAVServer](#webdavserver-component) Component) WebDAVServer uses this event to report completion of the collection creation operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerAfterCreateCollectionEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterCreateCollectionEvent)(System::TObject* Sender, TsbxWebDAVServerAfterCreateCollectionEventParams *e); __property TsbxWebDAVServerAfterCreateCollectionEvent OnAfterCreateCollection = { read=FOnAfterCreateCollection, write=FOnAfterCreateCollection }; ``` ## Remarks This event is preceded by [BeforeCreateCollection](#beforecreatecollection-event-webdavserver-component) and [CreateCollection](#createcollection-event-webdavserver-component) events. It lets you alter the operation status passed back to the client. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterCustomRequest Event ([WebDAVServer](#webdavserver-component) Component) This event reports the completion of the custom request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String RequestMethod; String Path; int OperationStatus; } TsbxWebDAVServerAfterCustomRequestEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterCustomRequestEvent)(System::TObject* Sender, TsbxWebDAVServerAfterCustomRequestEventParams *e); __property TsbxWebDAVServerAfterCustomRequestEvent OnAfterCustomRequest = { read=FOnAfterCustomRequest, write=FOnAfterCustomRequest }; ``` ## Remarks Use this event to track the completion of an earlier reported custom request and adjust the operation status through the *OperationStatus* parameter as required. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterLockObject Event ([WebDAVServer](#webdavserver-component) Component) Reports the completion of the object locking operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerAfterLockObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterLockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterLockObjectEventParams *e); __property TsbxWebDAVServerAfterLockObjectEvent OnAfterLockObject = { read=FOnAfterLockObject, write=FOnAfterLockObject }; ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterRefreshLock Event ([WebDAVServer](#webdavserver-component) Component) Reports the completion of the lock refresh operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerAfterRefreshLockEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterRefreshLockEvent)(System::TObject* Sender, TsbxWebDAVServerAfterRefreshLockEventParams *e); __property TsbxWebDAVServerAfterRefreshLockEvent OnAfterRefreshLock = { read=FOnAfterRefreshLock, write=FOnAfterRefreshLock }; ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterRemoveObject Event ([WebDAVServer](#webdavserver-component) Component) This event notifies the application about the completion of object deletion operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerAfterRemoveObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterRemoveObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterRemoveObjectEventParams *e); __property TsbxWebDAVServerAfterRemoveObjectEvent OnAfterRemoveObject = { read=FOnAfterRemoveObject, write=FOnAfterRemoveObject }; ``` ## Remarks This event follows [BeforeRemoveObject](#beforeremoveobject-event-webdavserver-component) and [RemoveObject](#removeobject-event-webdavserver-component) events. It is fired upon completion of the operation and lets you adjust the operation status if required: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterRenameObject Event ([WebDAVServer](#webdavserver-component) Component) The component uses this event to notify the application about the completion of the object rename operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String OldPath; String NewPath; int OperationStatus; } TsbxWebDAVServerAfterRenameObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterRenameObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterRenameObjectEventParams *e); __property TsbxWebDAVServerAfterRenameObjectEvent OnAfterRenameObject = { read=FOnAfterRenameObject, write=FOnAfterRenameObject }; ``` ## Remarks The *OldPath* and *NewPath* provide the old and new path of the renamed object respectively. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterSetAttributes Event ([WebDAVServer](#webdavserver-component) Component) WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerAfterSetAttributesEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterSetAttributesEvent)(System::TObject* Sender, TsbxWebDAVServerAfterSetAttributesEventParams *e); __property TsbxWebDAVServerAfterSetAttributesEvent OnAfterSetAttributes = { read=FOnAfterSetAttributes, write=FOnAfterSetAttributes }; ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AfterUnlockObject Event ([WebDAVServer](#webdavserver-component) Component) Notifies the application about the completion of the object unlocking operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerAfterUnlockObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAfterUnlockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerAfterUnlockObjectEventParams *e); __property TsbxWebDAVServerAfterUnlockObjectEvent OnAfterUnlockObject = { read=FOnAfterUnlockObject, write=FOnAfterUnlockObject }; ``` ## Remarks Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # AuthAttempt Event ([WebDAVServer](#webdavserver-component) Component) Fires when a connected client makes an authentication attempt. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String HTTPMethod; String URI; String AuthMethod; String Username; String Password; bool Allow; } TsbxWebDAVServerAuthAttemptEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerAuthAttemptEvent)(System::TObject* Sender, TsbxWebDAVServerAuthAttemptEventParams *e); __property TsbxWebDAVServerAuthAttemptEvent OnAuthAttempt = { read=FOnAuthAttempt, write=FOnAuthAttempt }; ``` ## Remarks The component fires this event whenever a client attempts to authenticate itself. Use the *Allow* parameter to let the client through. *ConnectionID* contains the unique session identifier for that client, *HTTPMethod* specifies the HTTP method (GET, POST, etc.) used to access the *URI* resource, *AuthMethod* specifies the authentication method, and *Username* and *Password* contain the professed credentials. **Note:** In case of OAuth 2.0 authentication, *Password* contains an access token to be validated. # BeforeBrowse Event ([WebDAVServer](#webdavserver-component) Component) Fires when a Browse request is received. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeBrowseEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeBrowseEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeBrowseEventParams *e); __property TsbxWebDAVServerBeforeBrowseEvent OnBeforeBrowse = { read=FOnBeforeBrowse, write=FOnBeforeBrowse }; ``` ## Remarks The component uses this event to notify the application that a Browse request has been received from the client. The *Path* parameter contains the path parameter from the request. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a series of events that request the details of the object residing at *Path*: [ListAttributes](#listattributes-event-webdavserver-component), [ListSubObjects](#listsubobjects-event-webdavserver-component), and [ReadAttribute](#readattribute-event-webdavserver-component). # BeforeCopyObject Event ([WebDAVServer](#webdavserver-component) Component) Fires when a Copy Object request is received. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String OldPath; String NewPath; int Action; } TsbxWebDAVServerBeforeCopyObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeCopyObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeCopyObjectEventParams *e); __property TsbxWebDAVServerBeforeCopyObjectEvent OnBeforeCopyObject = { read=FOnBeforeCopyObject, write=FOnBeforeCopyObject }; ``` ## Remarks The component fires this event to notify the application that a Copy Object request was received. The *OldPath* and *NewPath* parameters specify the source and destination paths for the object to be copied. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [CopyObject](#copyobject-event-webdavserver-component) call, allowing you to virtualize the copy operation. # BeforeCreateCalendar Event ([WebDAVServer](#webdavserver-component) Component) Fires when a Create Calendar request is received from a client. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeCreateCalendarEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeCreateCalendarEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeCreateCalendarEventParams *e); __property TsbxWebDAVServerBeforeCreateCalendarEvent OnBeforeCreateCalendar = { read=FOnBeforeCreateCalendar, write=FOnBeforeCreateCalendar }; ``` ## Remarks The component fires this event to notify the application about a received Create Calendar request. The *Path* parameter specifies the location of the new calendar. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [CreateCalendar](#createcalendar-event-webdavserver-component) call, allowing you to virtualize the calendar creation operation. # BeforeCreateCollection Event ([WebDAVServer](#webdavserver-component) Component) Fires when a Create Collection request is received from a client. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeCreateCollectionEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeCreateCollectionEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeCreateCollectionEventParams *e); __property TsbxWebDAVServerBeforeCreateCollectionEvent OnBeforeCreateCollection = { read=FOnBeforeCreateCollection, write=FOnBeforeCreateCollection }; ``` ## Remarks The component uses this event to notify the application about an incoming collection creation request. The *Path* parameter advises on the location of the new collection. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [CreateCollection](#createcollection-event-webdavserver-component) call. # BeforeCustomRequest Event ([WebDAVServer](#webdavserver-component) Component) Notifies the application about an incoming custom request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String RequestMethod; String Path; int Action; } TsbxWebDAVServerBeforeCustomRequestEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeCustomRequestEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeCustomRequestEventParams *e); __property TsbxWebDAVServerBeforeCustomRequestEvent OnBeforeCustomRequest = { read=FOnBeforeCustomRequest, write=FOnBeforeCustomRequest }; ``` ## Remarks The component uses this event to notify the user code about an incoming custom request (a generic request, unknown to the server, and not covered by the other handlers). The *RequestMethod* parameter specifies the HTTP request method used (GET, POST, PUT, ...), and *Path* indicates the requested path. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [CustomRequest](#customrequest-event-webdavserver-component) call, allowing you to respond to the request. # BeforeDownloadObject Event ([WebDAVServer](#webdavserver-component) Component) Fires when an object download request is received. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeDownloadObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeDownloadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeDownloadObjectEventParams *e); __property TsbxWebDAVServerBeforeDownloadObjectEvent OnBeforeDownloadObject = { read=FOnBeforeDownloadObject, write=FOnBeforeDownloadObject }; ``` ## Remarks The component fires this event to notify the application about an incoming object download request. The *Path* parameter contains the path of the requested object. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by [DownloadObject](#downloadobject-event-webdavserver-component), [ReadObject](#readobject-event-webdavserver-component), and [DownloadObjectCompleted](#downloadobjectcompleted-event-webdavserver-component) calls, allowing you to supply the object data to the client. # BeforeLockObject Event ([WebDAVServer](#webdavserver-component) Component) Fires when a lock request is received. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeLockObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeLockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeLockObjectEventParams *e); __property TsbxWebDAVServerBeforeLockObjectEvent OnBeforeLockObject = { read=FOnBeforeLockObject, write=FOnBeforeLockObject }; ``` ## Remarks The component uses this event to notify the application that an object lock request was received. The *Path* parameter contains the path to be locked. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [LockObject](#lockobject-event-webdavserver-component) call which expects you to perform the locking as required. # BeforeRefreshLock Event ([WebDAVServer](#webdavserver-component) Component) Reports the receipt of lock refresh request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeRefreshLockEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeRefreshLockEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeRefreshLockEventParams *e); __property TsbxWebDAVServerBeforeRefreshLockEvent OnBeforeRefreshLock = { read=FOnBeforeRefreshLock, write=FOnBeforeRefreshLock }; ``` ## Remarks Use this event to be notified about refresh requests for existing locks. The *Path* parameter contains the path on which to refresh the lock. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [RefreshLock](#refreshlock-event-webdavserver-component) call, allowing you to virtualize the operation. # BeforeRemoveObject Event ([WebDAVServer](#webdavserver-component) Component) Fires when an object deletion request is received. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeRemoveObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeRemoveObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeRemoveObjectEventParams *e); __property TsbxWebDAVServerBeforeRemoveObjectEvent OnBeforeRemoveObject = { read=FOnBeforeRemoveObject, write=FOnBeforeRemoveObject }; ``` ## Remarks Use this event to track object deletion requests. The *Path* parameter contains the path of the object to be deleted. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [RemoveObject](#removeobject-event-webdavserver-component) call, allowing you to virtualize the deletion operation. # BeforeRenameObject Event ([WebDAVServer](#webdavserver-component) Component) Reports object renaming requests. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String OldPath; String NewPath; int Action; } TsbxWebDAVServerBeforeRenameObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeRenameObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeRenameObjectEventParams *e); __property TsbxWebDAVServerBeforeRenameObjectEvent OnBeforeRenameObject = { read=FOnBeforeRenameObject, write=FOnBeforeRenameObject }; ``` ## Remarks The server uses this event to notify the application about incoming object rename requests. *OldPath* and *NewPath* contain the existing and the new path for the object. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [RenameObject](#renameobject-event-webdavserver-component) call, where your code is expected to perform the renaming operation. # BeforeRequest Event ([WebDAVServer](#webdavserver-component) Component) Fires before a DAV request is processed. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String HTTPMethod; String URL; bool Accept; } TsbxWebDAVServerBeforeRequestEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeRequestEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeRequestEventParams *e); __property TsbxWebDAVServerBeforeRequestEvent OnBeforeRequest = { read=FOnBeforeRequest, write=FOnBeforeRequest }; ``` ## Remarks This event fires before an incoming request is processed. *ConnectionID* indicates the client's unique connection ID; *HTTPMethod* specifies the HTTP method being used to submit the request, and *URL* signifies the object's URL. Use *Accept* parameter to accept or reject the request. # BeforeSetAttributes Event ([WebDAVServer](#webdavserver-component) Component) Notifies the application about attribute change request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeSetAttributesEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeSetAttributesEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeSetAttributesEventParams *e); __property TsbxWebDAVServerBeforeSetAttributesEvent OnBeforeSetAttributes = { read=FOnBeforeSetAttributes, write=FOnBeforeSetAttributes }; ``` ## Remarks Use this event to react to object attributes change requests. The *Path* parameter contains the object path. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a series of [SetAttribute](#setattribute-event-webdavserver-component) and/or [ClearAttribute](#clearattribute-event-webdavserver-component) calls, for each attribute to be set or cleared. # BeforeUnlockObject Event ([WebDAVServer](#webdavserver-component) Component) Fires when an unlock request is received. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeUnlockObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeUnlockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeUnlockObjectEventParams *e); __property TsbxWebDAVServerBeforeUnlockObjectEvent OnBeforeUnlockObject = { read=FOnBeforeUnlockObject, write=FOnBeforeUnlockObject }; ``` ## Remarks The component uses this event to notify the application about the received unlock request. The *Path* parameter contains the path to be unlocked. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by a [UnlockObject](#unlockobject-event-webdavserver-component) call. # BeforeUploadObject Event ([WebDAVServer](#webdavserver-component) Component) Fires when an object upload request is received. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int Action; } TsbxWebDAVServerBeforeUploadObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerBeforeUploadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerBeforeUploadObjectEventParams *e); __property TsbxWebDAVServerBeforeUploadObjectEvent OnBeforeUploadObject = { read=FOnBeforeUploadObject, write=FOnBeforeUploadObject }; ``` ## Remarks The component fires this event to notify the application about an incoming object upload request. The *Path* parameter contains the path of the requested object. *ConnectionID* identifies the connected client. Set *Action* to [fraAuto](constants.md#const_fraAuto) to let the server handle the request automatically, or to fraCustom to handle the request in your code. Choose *Action* as one of the following values: | | | | | --- | --- | --- | | fraAuto | 1 | Handle the requested action automatically by the server | | fraCustom | 2 | Override the action using the user code logic | | fraAbort | 3 | Abort the requested action | If *fraCustom* Action is chosen, this event will be followed by [UploadObject](#uploadobject-event-webdavserver-component), [WriteObject](#writeobject-event-webdavserver-component), and [UploadObjectCompleted](#uploadobjectcompleted-event-webdavserver-component) calls, allowing your code to process/store the object data. # ClearAttribute Event ([WebDAVServer](#webdavserver-component) Component) Reports an attribute clearance request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; String NS; String Name; int OperationStatus; } TsbxWebDAVServerClearAttributeEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerClearAttributeEvent)(System::TObject* Sender, TsbxWebDAVServerClearAttributeEventParams *e); __property TsbxWebDAVServerClearAttributeEvent OnClearAttribute = { read=FOnClearAttribute, write=FOnClearAttribute }; ``` ## Remarks This event fires to notify the application about an attribute clearance (removal) request. Use this handler to respond to this request by making the necessary changes to the locally stored resource attributes. The *ConnectionID* specifies the unique client ID, *Path* contains the resource path, and the *NS:Name* pair specifies the attribute to be cleared. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # Connect Event ([WebDAVServer](#webdavserver-component) Component) Reports an accepted connection. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String RemoteAddress; int RemotePort; } TsbxWebDAVServerConnectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerConnectEvent)(System::TObject* Sender, TsbxWebDAVServerConnectEventParams *e); __property TsbxWebDAVServerConnectEvent OnConnect = { read=FOnConnect, write=FOnConnect }; ``` ## Remarks component fires this event to report that a new connection has been established. *ConnectionId* indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as GetRequest or [AuthAttempt](#authattempt-event-webdavserver-component). # CopyObject Event ([WebDAVServer](#webdavserver-component) Component) Lets the application handle the Copy Object request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String OldPath; String NewPath; bool Overwrite; int Depth; int OperationStatus; } TsbxWebDAVServerCopyObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerCopyObjectEvent)(System::TObject* Sender, TsbxWebDAVServerCopyObjectEventParams *e); __property TsbxWebDAVServerCopyObjectEvent OnCopyObject = { read=FOnCopyObject, write=FOnCopyObject }; ``` ## Remarks Use this event handler to respond to the received Copy Object request by creating a copy of *OldPath* resource at *NewPath*. *ConnectionID* specifies the unique client connection identifier, *Overwrite* indicates whether any existing resource(s) should be overwritten, and *Depth* specifies the depth of the resource tree to be copied. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # CreateCalendar Event ([WebDAVServer](#webdavserver-component) Component) Lets the application handle a calendar creation request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerCreateCalendarEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerCreateCalendarEvent)(System::TObject* Sender, TsbxWebDAVServerCreateCalendarEventParams *e); __property TsbxWebDAVServerCreateCalendarEvent OnCreateCalendar = { read=FOnCreateCalendar, write=FOnCreateCalendar }; ``` ## Remarks Use this method to respond to a calendar creation request with a custom action. This event fires if *fraCustom* action was returned from the preceding [BeforeCreateCalendar](#beforecreatecalendar-event-webdavserver-component) call. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # CreateCollection Event ([WebDAVServer](#webdavserver-component) Component) Lets the application respond to collection creation request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerCreateCollectionEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerCreateCollectionEvent)(System::TObject* Sender, TsbxWebDAVServerCreateCollectionEventParams *e); __property TsbxWebDAVServerCreateCollectionEvent OnCreateCollection = { read=FOnCreateCollection, write=FOnCreateCollection }; ``` ## Remarks The component uses this event to let the application respond to collection creation requests. This event fires if *fraCustom* action was returned from the preceding [BeforeCreateCollection](#beforecreatecollection-event-webdavserver-component) call. The handler of this event is expected to create a new collection at *Path*. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # CustomRequest Event ([WebDAVServer](#webdavserver-component) Component) Use this event to respond to non-standard DAV requests. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String RequestMethod; String Path; int OperationStatus; } TsbxWebDAVServerCustomRequestEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerCustomRequestEvent)(System::TObject* Sender, TsbxWebDAVServerCustomRequestEventParams *e); __property TsbxWebDAVServerCustomRequestEvent OnCustomRequest = { read=FOnCustomRequest, write=FOnCustomRequest }; ``` ## Remarks This event allows the application to respond in a virtualized manner to non-standard DAV requests. It will fire if *fraCustom* action was selected in the earlier [BeforeCustomRequest](#beforecustomrequest-event-webdavserver-component) call. The *RequestMethod* specifies the HTTP method used for this request (GET, PUT, POST etc.), and the *Path* contains the requested path. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # Data Event ([WebDAVServer](#webdavserver-component) Component) Supplies a data chunk received from a client. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; DynamicArray Buffer; } TsbxWebDAVServerDataEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerDataEvent)(System::TObject* Sender, TsbxWebDAVServerDataEventParams *e); __property TsbxWebDAVServerDataEvent OnData = { read=FOnData, write=FOnData }; ``` ## Remarks This event is fired to supply another piece of data received from a client. This event may fire multiple times. # Disconnect Event ([WebDAVServer](#webdavserver-component) Component) Fires to report a disconnected client. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; } TsbxWebDAVServerDisconnectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerDisconnectEvent)(System::TObject* Sender, TsbxWebDAVServerDisconnectEventParams *e); __property TsbxWebDAVServerDisconnectEvent OnDisconnect = { read=FOnDisconnect, write=FOnDisconnect }; ``` ## Remarks component fires this event when a connected client disconnects. # DownloadObject Event ([WebDAVServer](#webdavserver-component) Component) Allows the application respond to Download Object request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; __int64 RestartAt; int OperationStatus; } TsbxWebDAVServerDownloadObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerDownloadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerDownloadObjectEventParams *e); __property TsbxWebDAVServerDownloadObjectEvent OnDownloadObject = { read=FOnDownloadObject, write=FOnDownloadObject }; ``` ## Remarks Use this event to implement custom handler of the Download operation. This event is followed by a series of [ReadObject](#readobject-event-webdavserver-component) calls, which are then followed by [DownloadObjectCompleted](#downloadobjectcompleted-event-webdavserver-component) that signifies completion of the transfer operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # DownloadObjectCompleted Event ([WebDAVServer](#webdavserver-component) Component) This event is fired when a download operation completes. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerDownloadObjectCompletedEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerDownloadObjectCompletedEvent)(System::TObject* Sender, TsbxWebDAVServerDownloadObjectCompletedEventParams *e); __property TsbxWebDAVServerDownloadObjectCompletedEvent OnDownloadObjectCompleted = { read=FOnDownloadObjectCompleted, write=FOnDownloadObjectCompleted }; ``` ## Remarks This event is fired when a download operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeDownloadFile event, and with Action parameter set to fraCustom. The *ConnectionID* parameter specifies the session to which the event belongs, and *OperationStatus* reports the outcome of the transfer operation. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # Error Event ([WebDAVServer](#webdavserver-component) Component) Information about errors during data delivery. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; int ErrorCode; bool Fatal; bool Remote; String Description; } TsbxWebDAVServerErrorEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerErrorEvent)(System::TObject* Sender, TsbxWebDAVServerErrorEventParams *e); __property TsbxWebDAVServerErrorEvent OnError = { read=FOnError, write=FOnError }; ``` ## Remarks The event is fired in case of exceptional conditions during message processing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [HTTPS](#trappable-errors-webdavserver-component) section. # ExternalSign Event ([WebDAVServer](#webdavserver-component) Component) Handles remote or external signing initiated by the server protocol. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String OperationId; String HashAlgorithm; String Pars; String Data; String SignedData; } TsbxWebDAVServerExternalSignEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerExternalSignEvent)(System::TObject* Sender, TsbxWebDAVServerExternalSignEventParams *e); __property TsbxWebDAVServerExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign }; ``` ## 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 the *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* contains algorithm-dependent parameters. The component uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # FileError Event ([WebDAVServer](#webdavserver-component) Component) Reports a file access error to the application. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String FileName; int ErrorCode; } TsbxWebDAVServerFileErrorEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerFileErrorEvent)(System::TObject* Sender, TsbxWebDAVServerFileErrorEventParams *e); __property TsbxWebDAVServerFileErrorEvent OnFileError = { read=FOnFileError, write=FOnFileError }; ``` ## Remarks component uses this event to report a file access errors. *FileName* and *ErrorCode* contain the file path and the error code respectively. # HeadersPrepared Event ([WebDAVServer](#webdavserver-component) Component) Fires when the response headers have been formed and are ready to be sent to the server. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; } TsbxWebDAVServerHeadersPreparedEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerHeadersPreparedEvent)(System::TObject* Sender, TsbxWebDAVServerHeadersPreparedEventParams *e); __property TsbxWebDAVServerHeadersPreparedEvent OnHeadersPrepared = { read=FOnHeadersPrepared, write=FOnHeadersPrepared }; ``` ## Remarks The component fires this event when the response headers are ready to be sent to the server. *ConnectionID* indicates the connection that processed the request. Use [GetResponseHeader](#getresponseheader-method-webdavserver-component) method with an empty header name to get the whole response header. # ListAttributes Event ([WebDAVServer](#webdavserver-component) Component) Requests object attributes from the application in fraCustom handling mode. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; String Attributes; } TsbxWebDAVServerListAttributesEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerListAttributesEvent)(System::TObject* Sender, TsbxWebDAVServerListAttributesEventParams *e); __property TsbxWebDAVServerListAttributesEvent OnListAttributes = { read=FOnListAttributes, write=FOnListAttributes }; ``` ## Remarks The component uses this event to request a set of attributes supported/kept for the object at *Path*. Return the list via the *Attributes* parameter as a string of CRLF-separated attribute names. After firing this event, the component may request values for individual attributes via a series of [ReadAttribute](#readattribute-event-webdavserver-component) calls. This event only fires if *fraCustom* action type was returned from the preceding [BeforeBrowse](#beforebrowse-event-webdavserver-component) event call. # ListSubObjects Event ([WebDAVServer](#webdavserver-component) Component) Requests a list of sub-objects of an object. The component uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; bool Recursive; String Objects; int OperationStatus; } TsbxWebDAVServerListSubObjectsEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerListSubObjectsEvent)(System::TObject* Sender, TsbxWebDAVServerListSubObjectsEventParams *e); __property TsbxWebDAVServerListSubObjectsEvent OnListSubObjects = { read=FOnListSubObjects, write=FOnListSubObjects }; ``` ## Remarks Set the status of the operation through the *OperationStatus* parameter as required: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # LockObject Event ([WebDAVServer](#webdavserver-component) Component) Virtualizes the object locking operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; String Owner; bool Exclusive; int Depth; __int64 Timeout; String Token; } TsbxWebDAVServerLockObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerLockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerLockObjectEventParams *e); __property TsbxWebDAVServerLockObjectEvent OnLockObject = { read=FOnLockObject, write=FOnLockObject }; ``` ## Remarks The component uses this event to request a lock on the object at *Path* from the application. This event is only fired if *fraCustom* action was returned from the preceding [BeforeLockObject](#beforelockobject-event-webdavserver-component) call. The *Owner*, *Exclusive*, *Depth*, and *Timeout* parameters specify the respective parameters of the requested lock. In response to this event, generate a lock token and return it via the *Token* parameter. # Notification Event ([WebDAVServer](#webdavserver-component) Component) This event notifies the application about an underlying control flow event. ## Syntax *C++ Builder Syntax* ```text typedef struct { String EventID; String EventParam; } TsbxWebDAVServerNotificationEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerNotificationEvent)(System::TObject* Sender, TsbxWebDAVServerNotificationEventParams *e); __property TsbxWebDAVServerNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification }; ``` ## Remarks The component 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 the *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](#webdavserver-component) Component) Reflects a quota enquiry by a client. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Username; __int64 Available; __int64 Used; } TsbxWebDAVServerQueryQuotaEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerQueryQuotaEvent)(System::TObject* Sender, TsbxWebDAVServerQueryQuotaEventParams *e); __property TsbxWebDAVServerQueryQuotaEvent OnQueryQuota = { read=FOnQueryQuota, write=FOnQueryQuota }; ``` ## Remarks This event fires in response to a client's enquire about their quota status. Subscribe to this event to react to such enquiries in a customized manner. Use *Available* and *Used* properties to report the respective amounts back to the client. # ReadAttribute Event ([WebDAVServer](#webdavserver-component) Component) Requests value of an attribute from the application in fraCustom mode. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; String NS; String Name; String Value; int OperationStatus; } TsbxWebDAVServerReadAttributeEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerReadAttributeEvent)(System::TObject* Sender, TsbxWebDAVServerReadAttributeEventParams *e); __property TsbxWebDAVServerReadAttributeEvent OnReadAttribute = { read=FOnReadAttribute, write=FOnReadAttribute }; ``` ## Remarks The component fires this event to request value of the *NS:Name* attribute of the object residing at *Path*. In the event handler, pass the attribute value via the *Value* parameter and set *OperationStatus* as required. This event only fires if *fraCustom* action type was returned from the preceding [BeforeBrowse](#beforebrowse-event-webdavserver-component) event call. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # ReadObject Event ([WebDAVServer](#webdavserver-component) Component) Requests a piece of object data from the application. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; int Size; int OperationStatus; } TsbxWebDAVServerReadObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerReadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerReadObjectEventParams *e); __property TsbxWebDAVServerReadObjectEvent OnReadObject = { read=FOnReadObject, write=FOnReadObject }; ``` ## Remarks The component fires this event repeatedly during an overridden download operation to request object data from the application. The handler of this event should read up to *Size* bytes from the downloaded object, and pass them to the component with a [SetClientBuffer](#setclientbuffer-method-webdavserver-component) call. Use the *OperationStatus* parameter to return the operation result back to the server. Set *OperationStatus* to one of the following values: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # RefreshLock Event ([WebDAVServer](#webdavserver-component) Component) Notifies the application about a lock refresh request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; String Token; __int64 Timeout; bool LockFound; } TsbxWebDAVServerRefreshLockEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerRefreshLockEvent)(System::TObject* Sender, TsbxWebDAVServerRefreshLockEventParams *e); __property TsbxWebDAVServerRefreshLockEvent OnRefreshLock = { read=FOnRefreshLock, write=FOnRefreshLock }; ``` ## Remarks The component uses this event to request extension of a lock on the object at *Path*. This event only fires if *fraCustom* action was returned from the preceding [BeforeRefreshLock](#beforerefreshlock-event-webdavserver-component) call. In response to this event, check the validity of the provided *Token* for the object at *Path*, and extend the lock by *Timeout* milliseconds if the values match. Set the *LockFound* result as required. # RemoveObject Event ([WebDAVServer](#webdavserver-component) Component) Notifies the application about object deletion requests. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerRemoveObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerRemoveObjectEvent)(System::TObject* Sender, TsbxWebDAVServerRemoveObjectEventParams *e); __property TsbxWebDAVServerRemoveObjectEvent OnRemoveObject = { read=FOnRemoveObject, write=FOnRemoveObject }; ``` ## Remarks The component uses this event to notify the application about an incoming deletion request for the object at *Path*. This event only fires if *fraCustom* action was returned from the preceding [BeforeRemoveObject](#beforeremoveobject-event-webdavserver-component) call. The handler of this event should remove the object, if appropriate, and set the *OperationStatus* parameter to signify the actual operation result. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # RenameObject Event ([WebDAVServer](#webdavserver-component) Component) Notifies the application about object name change requests. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String OldPath; String NewPath; bool Overwrite; int OperationStatus; } TsbxWebDAVServerRenameObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerRenameObjectEvent)(System::TObject* Sender, TsbxWebDAVServerRenameObjectEventParams *e); __property TsbxWebDAVServerRenameObjectEvent OnRenameObject = { read=FOnRenameObject, write=FOnRenameObject }; ``` ## Remarks The component uses this event to notify the application about an incoming rename request for the object at *OldPath*. The *Overwrite* parameter advises whether any objects currently existing at *NewPath* should be overwritten. This event only fires if *fraCustom* action was returned from the preceding [BeforeRenameObject](#beforerenameobject-event-webdavserver-component) call. The handler of this event should rename the object to *NewPath* (if appropriate) and set the *OperationStatus* parameter to signify the actual operation result. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # ResourceAccess Event ([WebDAVServer](#webdavserver-component) Component) Reports an attempt to access a resource. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String HTTPMethod; String URI; bool Allow; String RedirectURI; } TsbxWebDAVServerResourceAccessEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerResourceAccessEvent)(System::TObject* Sender, TsbxWebDAVServerResourceAccessEventParams *e); __property TsbxWebDAVServerResourceAccessEvent OnResourceAccess = { read=FOnResourceAccess, write=FOnResourceAccess }; ``` ## Remarks The component 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 component 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 component will automatically send a "found" status code (302). If *Allow* is set to false, the value of *RedirectURI* is ignored. # SetAttribute Event ([WebDAVServer](#webdavserver-component) Component) Lets the application customize attribute assignment requests. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; String NS; String Name; String Value; int OperationStatus; } TsbxWebDAVServerSetAttributeEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerSetAttributeEvent)(System::TObject* Sender, TsbxWebDAVServerSetAttributeEventParams *e); __property TsbxWebDAVServerSetAttributeEvent OnSetAttribute = { read=FOnSetAttribute, write=FOnSetAttribute }; ``` ## Remarks The component uses this event to pass attribute assignment requests to the application. This event may fire multiple times after a [BeforeSetAttributes](#beforesetattributes-event-webdavserver-component) call, one for each attribute, if *fraCustom* action was chosen. In the handler of this event, assign *Value* to the attribute *NS:Name* of the object at *Path*. Set *OperationStatus* in accordance with the outcome of the operation. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # TLSCertValidate Event ([WebDAVServer](#webdavserver-component) Component) Fires when a client certificate needs to be validated. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; bool Accept; } TsbxWebDAVServerTLSCertValidateEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerTLSCertValidateEvent)(System::TObject* Sender, TsbxWebDAVServerTLSCertValidateEventParams *e); __property TsbxWebDAVServerTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate }; ``` ## Remarks component fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the *Accept* parameter. # TLSEstablished Event ([WebDAVServer](#webdavserver-component) Component) Reports the setup of a TLS session. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; } TsbxWebDAVServerTLSEstablishedEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerTLSEstablishedEvent)(System::TObject* Sender, TsbxWebDAVServerTLSEstablishedEventParams *e); __property TsbxWebDAVServerTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished }; ``` ## Remarks Subscribe to this event to be notified about the setup of a TLS connection by a connected client. # TLSHandshake Event ([WebDAVServer](#webdavserver-component) Component) Fires when a newly established client connection initiates a TLS handshake. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String ServerName; bool Abort; } TsbxWebDAVServerTLSHandshakeEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerTLSHandshakeEvent)(System::TObject* Sender, TsbxWebDAVServerTLSHandshakeEventParams *e); __property TsbxWebDAVServerTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake }; ``` ## Remarks Use this event to get notified about the initiation of the TLS handshake by the remote client. The *ServerName* parameter specifies the requested host from the client hello message. # TLSPSK Event ([WebDAVServer](#webdavserver-component) Component) Requests a pre-shared key for TLS-PSK. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Identity; String PSK; String Ciphersuite; } TsbxWebDAVServerTLSPSKEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerTLSPSKEvent)(System::TObject* Sender, TsbxWebDAVServerTLSPSKEventParams *e); __property TsbxWebDAVServerTLSPSKEvent OnTLSPSK = { read=FOnTLSPSK, write=FOnTLSPSK }; ``` ## Remarks The component fires this event to report that a client has requested a TLS-PSK negotiation. *ConnectionId* indicates the unique connection ID that requested the PSK handshake. Use *Identity* to look up for the corresponding pre-shared key in the server's database, then assign the key to the *PSK* parameter. If TLS 1.3 PSK is used, you will also need to assign the *Ciphersuite* parameter with the cipher suite associated with that identity and their key. # TLSShutdown Event ([WebDAVServer](#webdavserver-component) Component) Reports closure of a TLS session. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; } TsbxWebDAVServerTLSShutdownEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerTLSShutdownEvent)(System::TObject* Sender, TsbxWebDAVServerTLSShutdownEventParams *e); __property TsbxWebDAVServerTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown }; ``` ## Remarks The component fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a [Disconnect](#disconnect-event-webdavserver-component), which marks the closure of the underlying TCP session. # UnlockObject Event ([WebDAVServer](#webdavserver-component) Component) Virtualizes the object unlocking operation. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; String Token; bool LockFound; } TsbxWebDAVServerUnlockObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerUnlockObjectEvent)(System::TObject* Sender, TsbxWebDAVServerUnlockObjectEventParams *e); __property TsbxWebDAVServerUnlockObjectEvent OnUnlockObject = { read=FOnUnlockObject, write=FOnUnlockObject }; ``` ## Remarks The component uses this event to notify the application of the incoming unlock request. This event only fires if *fraCustom* action was returned from the preceding [BeforeUnlockObject](#beforeunlockobject-event-webdavserver-component) call. In response to this event, check the validity of the provided *Token* for the object at *Path*, and cancel the lock if the values match. Set the *LockFound* result as required. # UploadObject Event ([WebDAVServer](#webdavserver-component) Component) Lets the application respond to the Upload Object request. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; __int64 RestartAt; bool Append; int OperationStatus; } TsbxWebDAVServerUploadObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerUploadObjectEvent)(System::TObject* Sender, TsbxWebDAVServerUploadObjectEventParams *e); __property TsbxWebDAVServerUploadObjectEvent OnUploadObject = { read=FOnUploadObject, write=FOnUploadObject }; ``` ## Remarks Use this event handler to respond to the received Upload Object request by reserving a place for the new object at *Path*. This event, if *OperationStatus* allows, will be followed by a series of [WriteObject](#writeobject-event-webdavserver-component) calls, passing object data in chunks, before a [UploadObjectCompleted](#uploadobjectcompleted-event-webdavserver-component) call signals completion of the upload operation. Check the operation status, and alter it, if needed, through the *OperationStatus* parameter: | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # UploadObjectCompleted Event ([WebDAVServer](#webdavserver-component) Component) This event is fired when a upload operation completes. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; String Path; int OperationStatus; } TsbxWebDAVServerUploadObjectCompletedEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerUploadObjectCompletedEvent)(System::TObject* Sender, TsbxWebDAVServerUploadObjectCompletedEventParams *e); __property TsbxWebDAVServerUploadObjectCompletedEvent OnUploadObjectCompleted = { read=FOnUploadObjectCompleted, write=FOnUploadObjectCompleted }; ``` ## Remarks This event is fired when a upload operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeUploadFile event, and with Action parameter set to fraCustom. The *ConnectionID* parameter specifies the session to which the event belongs, and *OperationStatus* reports the outcome of the transfer operation. | | | | | --- | --- | --- | | ostOk | 1 | | | ostNoSuchFile | 2 | | | ostAccessDenied | 3 | | | ostWriteProtect | 4 | | | ostUnsupported | 5 | | | ostInvalidParameter | 6 | | | ostEOF | 7 | | # WriteObject Event ([WebDAVServer](#webdavserver-component) Component) Hands a piece of object data to the application. ## Syntax *C++ Builder Syntax* ```text typedef struct { __int64 ConnectionID; int OperationStatus; } TsbxWebDAVServerWriteObjectEventParams; typedef void __fastcall (__closure *TsbxWebDAVServerWriteObjectEvent)(System::TObject* Sender, TsbxWebDAVServerWriteObjectEventParams *e); __property TsbxWebDAVServerWriteObjectEvent OnWriteObject = { read=FOnWriteObject, write=FOnWriteObject }; ``` ## Remarks The component fires this event repeatedly during an overridden upload operation to pass object data to the application. The handler of this event should retrieve the pending data buffer with a [GetClientBuffer](#getclientbuffer-method-webdavserver-component) 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 | | # Config Settings ([WebDAVServer](#webdavserver-component) Component) The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-webdavserver-component) method. ### WebDAVServer Config Settings **BoundAddress**: Returns the bound address of the listening socket.Use this property to obtain the bound address of the listening socket. **BoundPort**: The port that was bound by the server.Returns the port number that was bound by the server. **DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. **HandshakeTimeout**: The HTTPS handshake timeout.The HTTPS handshake timeout in milliseconds. **Host**: The host to bind to.Specifies a specific interface the server should listen on. **HTTPStatusCode[i]**: Provides means to set a custom HTTP status code.Use this indexed property to set a custom HTTP status code for a specific client. **Port**: The port to listen on.This config setting mimics the Port property. Please use that instead. **PortRangeFrom**: The lower bound of allowed port scope to listen on.Specifies the lowest port number the server may use if dynamic allocation is used. **PortRangeTo**: The higher bound of allowed port scope to listen on.Specifies the highest port number the server may use if dynamic allocation is used. **PreSharedIdentityHint**: Gets or sets the PSK identity hint.Use this property to get or set the PSK identity hint to be used during PSK-based TLS handshake. **SessionTimeout**: The HTTP session timeout.The HTTP session timeout in milliseconds. **SleepLen**: Adjusts the server loop idling time.Use this property to adjust the server connection loop idling time between consecutive connection read calls. Increasing this setting may help combat excessive CPU usage in performance-restricted or busy environments. Setting it to zero removes the idling altogether, which maximizes the throughput but may cause excessive CPU load. **TLSCiphersuites**: Returns the list of ciphersuites activated in the component for the current session.Check this property to enumerate the list of TLS ciphersuites enabled in the component. A good place to do that is OnTLSHandshake event handler. **TLSExtensions**: TBD.TBD **TLSGroups**: Returns the list of TLS key exchange groups enabled in the component.Check this property to enumerate the list of TLS key exchange groups enabled in the component. **TLSPeerExtensions**: TBD.TBD **TLSServerCertIndex**: Specifies the index of the server certificate to use.This setting allows your code to specify the exact certificate/chain to use for the TLS handshake that has just commenced, if your server is configured with more than one chain. This property should typically be adjusted from within the OnTLSHandshake event handler. Note: the server component normally picks up the most appropriate certificate automatically. This setting is a wiretap for scenarios where unusual or cherry-picked certificate selection logic may be necessary. **TLSVersions**: Returns the list of TLS versions enabled in the component.Check this property to obtain the list of TLS versions enabled in the component, as an integer bitmask. **WebsiteName**: The website name for the TLS certificate.Assign this property with a name to put in a self-generated TLS certificate. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the component. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the component.Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the components. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([WebDAVServer](#webdavserver-component) Component) ### WebDAVServer Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |