WebDAVServer Component

Properties Methods Events Config Settings Errors

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

Syntax

secureblackbox.WebDAVServer

Remarks

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

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


Active	Indicates whether the server is active and is listening to new connections.
AuthRealm	Specifies authentication realm for digest and NTLM authentication.
AuthTypes	Defines allowed HTTP authentication types.
BoundPort	Indicates the bound listening port.
ClientFileEntryATime	Contains the last access time for this object, in UTC.
ClientFileEntryContentType	The object's content type.
ClientFileEntryCTime	Contains this object's creation time, in UTC.
ClientFileEntryDirectory	Specifies whether this object is a directory.
ClientFileEntryDisplayName	Contains the display name of the object.
ClientFileEntryETag	An e-tag of the object.
ClientFileEntryFullURL	A full path to the object.
ClientFileEntryMTime	The last modification time of the object, in UTC.
ClientFileEntryParentURL	Specifies the object's parent URL.
ClientFileEntrySize	The size of the object in bytes.
ClientFileEntrySupportsExclusiveLock	Indicates whether the entry supports exclusive locking.
ClientFileEntrySupportsSharedLock	Indicates whether the entry supports shared lock.
ClientFileEntryURL	A URL of the object.
DocumentRoot	The document root of the server.
ExternalCryptoAsyncDocumentID	Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
ExternalCryptoCustomParams	Custom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoData	Additional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculation	Specifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithm	Specifies the request's signature hash algorithm.
ExternalCryptoKeyID	The ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecret	The pre-shared key used for DC request authentication.
ExternalCryptoMethod	Specifies the asynchronous signing method.
ExternalCryptoMode	Specifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithm	Provide the public key algorithm here if the certificate is not available on the pre-signing stage.
FIPSMode	Reserved.
Host	The host to bind the listening port to.
MetadataFlushTimeout	Specifies metadata flush timeout.
MetadataRoot	The metadata directory root.
PinnedClientAEADCipher	Indicates whether the encryption algorithm used is an AEAD cipher.
PinnedClientChainValidationDetails	The details of a certificate chain validation outcome.
PinnedClientChainValidationResult	The outcome of a certificate chain validation routine.
PinnedClientCiphersuite	The cipher suite employed by this connection.
PinnedClientClientAuthenticated	Specifies whether client authentication was performed during this connection.
PinnedClientClientAuthRequested	Specifies whether client authentication was requested during this connection.
PinnedClientConnectionEstablished	Indicates whether the connection has been established fully.
PinnedClientConnectionID	The unique identifier assigned to this connection.
PinnedClientDigestAlgorithm	The digest algorithm used in a TLS-enabled connection.
PinnedClientEncryptionAlgorithm	The symmetric encryption algorithm used in a TLS-enabled connection.
PinnedClientExportable	Indicates whether a TLS connection uses a reduced-strength exportable cipher.
PinnedClientGroup	The elliptic curve used in this connection.
PinnedClientID	The client connection's unique identifier.
PinnedClientKeyExchangeAlgorithm	The key exchange algorithm used in a TLS-enabled connection.
PinnedClientKeyExchangeKeyBits	The length of the key exchange key of a TLS-enabled connection.
PinnedClientPFSCipher	Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
PinnedClientPreSharedIdentity	Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PinnedClientPreSharedIdentityHint	A hint professed by the server to help the client select the PSK identity to use.
PinnedClientPublicKeyBits	The length of the public key.
PinnedClientRemoteAddress	The client's IP address.
PinnedClientRemotePort	The remote port of the client connection.
PinnedClientResumedSession	Indicates whether a TLS-enabled connection was spawned from another TLS connection.
PinnedClientSecureConnection	Indicates whether TLS or SSL is enabled for this connection.
PinnedClientServerAuthenticated	Indicates whether server authentication was performed during a TLS-enabled connection.
PinnedClientSignatureAlgorithm	The signature algorithm used in a TLS handshake.
PinnedClientSymmetricBlockSize	The block size of the symmetric algorithm used.
PinnedClientSymmetricKeyBits	The key length of the symmetric algorithm used.
PinnedClientTotalBytesReceived	The total number of bytes received over this connection.
PinnedClientTotalBytesSent	The total number of bytes sent over this connection.
PinnedClientValidationLog	Contains the server certificate's chain validation log.
PinnedClientVersion	Indicates the version of SSL/TLS protocol negotiated during this connection.
PinnedClientCertCount	The number of records in the PinnedClientCert arrays.
PinnedClientCertBytes	Returns the raw certificate data in DER format.
PinnedClientCertCA	Indicates whether the certificate has a CA capability.
PinnedClientCertCAKeyID	A unique identifier (fingerprint) of the CA certificate's cryptographic key.
PinnedClientCertCertType	Returns the type of the entity contained in the Certificate object.
PinnedClientCertCRLDistributionPoints	Contains a list of locations of CRL distribution points used to check this certificate's validity.
PinnedClientCertCurve	Specifies the elliptic curve associated with the certificate's public key.
PinnedClientCertFingerprint	Contains the fingerprint (a hash imprint) of this certificate.
PinnedClientCertFriendlyName	Contains an associated alias (friendly name) of the certificate.
PinnedClientCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
PinnedClientCertHashAlgorithm	Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
PinnedClientCertIssuer	The common name of the certificate issuer (CA), typically a company name.
PinnedClientCertIssuerRDN	A list of Property=Value pairs that uniquely identify the certificate issuer.
PinnedClientCertKeyAlgorithm	Specifies the public key algorithm of this certificate.
PinnedClientCertKeyBits	Returns the length of the public key in bits.
PinnedClientCertKeyFingerprint	Returns a SHA1 fingerprint of the public key contained in the certificate.
PinnedClientCertKeyUsage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
PinnedClientCertKeyValid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
PinnedClientCertOCSPLocations	Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.
PinnedClientCertOCSPNoCheck	Accessor to the value of the certificate's ocsp-no-check extension.
PinnedClientCertOrigin	Returns the location that the certificate was taken or loaded from.
PinnedClientCertPolicyIDs	Contains identifiers (OIDs) of the applicable certificate policies.
PinnedClientCertPrivateKeyBytes	Returns the certificate's private key in DER-encoded format.
PinnedClientCertPrivateKeyExists	Indicates whether the certificate has a usable private key associated with it.
PinnedClientCertPrivateKeyExtractable	Indicates whether the private key is extractable (exportable).
PinnedClientCertPublicKeyBytes	Contains the certificate's public key in DER format.
PinnedClientCertQualified	Indicates whether the certificate is qualified.
PinnedClientCertQualifiedStatements	Returns a simplified qualified status of the certificate.
PinnedClientCertQualifiers	A list of qualifiers.
PinnedClientCertSelfSigned	Indicates whether the certificate is self-signed (root) or signed by an external CA.
PinnedClientCertSerialNumber	Returns the certificate's serial number.
PinnedClientCertSigAlgorithm	Indicates the algorithm that was used by the CA to sign this certificate.
PinnedClientCertSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
PinnedClientCertSubject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
PinnedClientCertSubjectAlternativeName	Returns or sets the value of the Subject Alternative Name extension of the certificate.
PinnedClientCertSubjectKeyID	Contains a unique identifier of the certificate's cryptographic key.
PinnedClientCertSubjectRDN	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
PinnedClientCertValid	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	The time point at which the certificate becomes valid, in UTC.
PinnedClientCertValidTo	The time point at which the certificate expires, in UTC.
Port	Specifies the port number to listen for connections on.
PortRangeFrom	Specifies the lower limit of the listening port range for incoming connections.
PortRangeTo	Specifies the upper limit of the listening port range for incoming connections.
SocketIncomingSpeedLimit	The maximum number of bytes to read from the socket, per second.
SocketLocalAddress	The local network interface to bind the socket to.
SocketLocalPort	The local port number to bind the socket to.
SocketOutgoingSpeedLimit	The maximum number of bytes to write to the socket, per second.
SocketTimeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6	Enables or disables IP protocol version 6.
TLSServerCertCount	The number of records in the TLSServerCert arrays.
TLSServerCertBytes	Returns the raw certificate data in DER format.
TLSServerCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
TLSAutoValidateCertificates	Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfiguration	Selects the base configuration for the TLS settings.
TLSCiphersuites	A list of ciphersuites separated with commas or semicolons.
TLSClientAuth	Enables or disables certificate-based client authentication.
TLSExtensions	Provides access to TLS extensions.
TLSForceResumeIfDestinationChanges	Whether to force TLS session resumption when the destination address changes.
TLSGroups	Specifies a list of key exchange groups to attempt during the TLS key exchange.
TLSPreSharedIdentity	Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKey	Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuite	Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionMode	Selects the renegotiation attack prevention mechanism.
TLSRevocationCheck	Specifies the kind(s) of revocation check to perform.
TLSSSLOptions	Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
TLSMode	Specifies the TLS mode to use.
TLSUseExtendedMasterSecret	Enables the Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumption	Enables or disables the TLS session resumption capability.
TLSVersions	The SSL/TLS versions to enable by default.
UserCount	The number of records in the User arrays.
UserAssociatedData	Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.
UserBasePath	Base path for this user in the server's file system.
UserCertificate	Contains the user's certificate.
UserData	Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.
UserEmail	The user's email address.
UserHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
UserHashAlgorithm	Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.
UserIncomingSpeedLimit	Specifies the incoming speed limit for this user.
UserOtpAlgorithm	The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP).
UserOTPLen	Specifies the length of the user's OTP password.
UserOtpValue	The user's time interval (TOTP) or Counter (HOTP).
UserOutgoingSpeedLimit	Specifies the outgoing speed limit for this user.
UserPassword	The user's authentication password.
UserSharedSecret	Contains the user's secret key, which is essentially a shared secret between the client and server.
UserSSHKey	Contains the user's SSH key.
Username	The registered name (login) of the user.
WebsiteName	Specifies the web site name to use in the certificate.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


Cleanup	Cleans up the server environment by purging expired sessions and cleaning caches.
Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
DropClient	Terminates a client connection.
GetClientBuffer	Obtains a pending connection buffer.
GetRequestBytes	Returns the contents of the client's HTTP request.
GetRequestHeader	Returns a request header value.
GetRequestString	Returns the contents of the client's HTTP request.
GetRequestUsername	Returns the username for a connection.
GetResponseHeader	Returns a response header value.
ListClients	Enumerates the connected clients.
PinClient	Takes a snapshot of the connection's properties.
ProcessGenericRequest	Processes a generic HTTP request.
Reset	Resets the class settings.
SetClientBuffer	Commits a data buffer to the connection.
SetClientFileEntry	Commits a file entry to the connection.
SetResponseBytes	Sets a byte array to be served as a response.
SetResponseFile	Sets a file to be served as a response.
SetResponseHeader	Sets a response header.
SetResponseStatus	Sets an HTTP status to be sent with the response.
SetResponseString	Sets a string to be served as a response.
Start	Starts the server.
Stop	Stops the server.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


Accept	Reports an incoming connection.
AfterBrowse	WebDAVServer uses this event to notify the application about the completion of the browsing operation.
AfterCopyObject	This event notifies the application about the completion of the copy operation.
AfterCreateCalendar	This event reports the completion of calendar creation request.
AfterCreateCollection	WebDAVServer uses this event to report completion of the collection creation operation.
AfterCustomRequest	This event reports the completion of the custom request.
AfterLockObject	Reports the completion of the object locking operation.
AfterRefreshLock	Reports the completion of the lock refresh operation.
AfterRemoveObject	This event notifies the application about the completion of object deletion operation.
AfterRenameObject	The class uses this event to notify the application about the completion of the object rename operation.
AfterSetAttributes	WebDAVServer fires this event to notify the application of the completion of the attribute assignment operation.
AfterUnlockObject	Notifies the application about the completion of the object unlocking operation.
AuthAttempt	Fires when a connected client makes an authentication attempt.
BeforeBrowse	Fires when a Browse request is received.
BeforeCopyObject	Fires when a Copy Object request is received.
BeforeCreateCalendar	Fires when a Create Calendar request is received from a client.
BeforeCreateCollection	Fires when a Create Collection request is received from a client.
BeforeCustomRequest	Notifies the application about an incoming custom request.
BeforeDownloadObject	Fires when an object download request is received.
BeforeLockObject	Fires when a lock request is received.
BeforeRefreshLock	Reports the receipt of lock refresh request.
BeforeRemoveObject	Fires when an object deletion request is received.
BeforeRenameObject	Reports object renaming requests.
BeforeRequest	Fires before a DAV request is processed.
BeforeSetAttributes	Notifies the application about attribute change request.
BeforeUnlockObject	Fires when an unlock request is received.
BeforeUploadObject	Fires when an object upload request is received.
ClearAttribute	Reports an attribute clearance request.
Connect	Reports an accepted connection.
CopyObject	Lets the application handle the Copy Object request.
CreateCalendar	Lets the application handle a calendar creation request.
CreateCollection	Lets the application respond to collection creation request.
CustomRequest	Use this event to respond to non-standard DAV requests.
Data	Supplies a data chunk received from a client.
Disconnect	Fires to report a disconnected client.
DownloadObject	Allows the application respond to Download Object request.
DownloadObjectCompleted	This event is fired when a download operation completes.
Error	Information about errors during data delivery.
ExternalSign	Handles remote or external signing initiated by the server protocol.
FileError	Reports a file access error to the application.
HeadersPrepared	Fires when the response headers have been formed and are ready to be sent to the server.
ListAttributes	Requests object attributes from the application in fraCustom handling mode.
ListSubObjects	Requests a list of sub-objects of an object. The class uses this event to request a list of sub-objects of the object residing at Path . The Recursive parameter specifies whether the sub-objects should be browsed and returned recursively. Return the requested list via the Objects parameter by separating individual entries with CRLF.
LockObject	Virtualizes the object locking operation.
Notification	This event notifies the application about an underlying control flow event.
QueryQuota	Reflects a quota enquiry by a client.
ReadAttribute	Requests value of an attribute from the application in fraCustom mode.
ReadObject	Requests a piece of object data from the application.
RefreshLock	Notifies the application about a lock refresh request.
RemoveObject	Notifies the application about object deletion requests.
RenameObject	Notifies the application about object name change requests.
ResourceAccess	Reports an attempt to access a resource.
SetAttribute	Lets the application customize attribute assignment requests.
TLSCertValidate	Fires when a client certificate needs to be validated.
TLSEstablished	Reports the setup of a TLS session.
TLSHandshake	Fires when a newly established client connection initiates a TLS handshake.
TLSPSK	Requests a pre-shared key for TLS-PSK.
TLSShutdown	Reports closure of a TLS session.
UnlockObject	Virtualizes the object unlocking operation.
UploadObject	Lets the application respond to the Upload Object request.
UploadObjectCompleted	This event is fired when a upload operation completes.
WriteObject	Hands a piece of object data to the application.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.


BoundAddress	Returns the bound address of the listening socket.
BoundPort	The port that was bound by the server.
DualStack	Allows the use of ip4 and ip6 simultaneously.
HandshakeTimeout	The HTTPS handshake timeout.
Host	The host to bind to.
HTTPStatusCode[i]	Provides means to set a custom HTTP status code.
Port	The port to listen on.
PortRangeFrom	The lower bound of allowed port scope to listen on.
PortRangeTo	The higher bound of allowed port scope to listen on.
PreSharedIdentityHint	Gets or sets the PSK identity hint.
SessionTimeout	The HTTP session timeout.
SleepLen	Adjusts the server loop idling time.
TLSCiphersuites	Returns the list of ciphersuites activated in the class for the current session.
TLSExtensions	TBD.
TLSGroups	Returns the list of TLS key exchange groups enabled in the class.
TLSPeerExtensions	TBD.
TLSServerCertIndex	Specifies the index of the server certificate to use.
TLSVersions	Returns the list of TLS versions enabled in the class.
WebsiteName	The website name for the TLS certificate.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
EnableSSHMLKEM	Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes.
EnableTLSMLKEM	Enables support for ML-KEM and hybrid groups in TLS client and server classes.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
StaticDNS	Specifies whether static DNS rules should be used.
StaticIPAddress[domain]	Gets or sets an IP address for the specified domain name.
StaticIPAddresses	Gets or sets all the static DNS rules.
Tag	Allows to store any custom data.
TLSSessionGroup	Specifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetime	Specifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeInterval	Specifies how often the session cache should remove the expired TLS sessions.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]	Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]	Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

Active Property (WebDAVServer Component)

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

Syntax

func (obj *WebDAVServer) Active() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

AuthRealm Property (WebDAVServer Component)

Specifies authentication realm for digest and NTLM authentication.

Syntax

func (obj *WebDAVServer) AuthRealm() (string, error)
func (obj *WebDAVServer) SetAuthRealm(value string) error

Default Value

"SecureBlackbox"

Remarks

Specifies authentication realm for digest and NTLM authentication types.

Data Type

string

AuthTypes Property (WebDAVServer Component)

Defines allowed HTTP authentication types.

Syntax

func (obj *WebDAVServer) AuthTypes() (int32, error)
func (obj *WebDAVServer) SetAuthTypes(value int32) error

Default Value

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

int32

BoundPort Property (WebDAVServer Component)

Indicates the bound listening port.

Syntax

func (obj *WebDAVServer) BoundPort() (int32, error)

Default Value

Remarks

Check this property to find out the port that has been allocated to the server by the system. The bound port always equals Port if it is provided, or is allocated dynamically if configured to fall in the range between PortRangeFrom and PortRangeTo constraints.

This property is read-only.

Data Type

int32

ClientFileEntryATime Property (WebDAVServer Component)

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

Syntax

func (obj *WebDAVServer) ClientFileEntryATime() (string, error)
func (obj *WebDAVServer) SetClientFileEntryATime(value string) error

Default Value

Remarks

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

Data Type

string

ClientFileEntryContentType Property (WebDAVServer Component)

The object's content type.

Syntax

func (obj *WebDAVServer) ClientFileEntryContentType() (string, error)
func (obj *WebDAVServer) SetClientFileEntryContentType(value string) error

Default Value

Remarks

The object's content type.

Data Type

string

ClientFileEntryCTime Property (WebDAVServer Component)

Contains this object's creation time, in UTC.

Syntax

func (obj *WebDAVServer) ClientFileEntryCTime() (string, error)
func (obj *WebDAVServer) SetClientFileEntryCTime(value string) error

Default Value

Remarks

Contains this object's creation time, in UTC.

Data Type

string

ClientFileEntryDirectory Property (WebDAVServer Component)

Specifies whether this object is a directory.

Syntax

func (obj *WebDAVServer) ClientFileEntryDirectory() (bool, error)
func (obj *WebDAVServer) SetClientFileEntryDirectory(value bool) error

Default Value

false

Remarks

Specifies whether this object is a directory.

Data Type

bool

ClientFileEntryDisplayName Property (WebDAVServer Component)

Contains the display name of the object.

Syntax

func (obj *WebDAVServer) ClientFileEntryDisplayName() (string, error)
func (obj *WebDAVServer) SetClientFileEntryDisplayName(value string) error

Default Value

Remarks

Contains the display name of the object.

Data Type

string

ClientFileEntryETag Property (WebDAVServer Component)

An e-tag of the object.

Syntax

func (obj *WebDAVServer) ClientFileEntryETag() (string, error)
func (obj *WebDAVServer) SetClientFileEntryETag(value string) error

Default Value

Remarks

An e-tag of the object.

Data Type

string

ClientFileEntryFullURL Property (WebDAVServer Component)

A full path to the object.

Syntax

func (obj *WebDAVServer) ClientFileEntryFullURL() (string, error)
func (obj *WebDAVServer) SetClientFileEntryFullURL(value string) error

Default Value

Remarks

A full path to the object.

Data Type

string

ClientFileEntryMTime Property (WebDAVServer Component)

The last modification time of the object, in UTC.

Syntax

func (obj *WebDAVServer) ClientFileEntryMTime() (string, error)
func (obj *WebDAVServer) SetClientFileEntryMTime(value string) error

Default Value

Remarks

The last modification time of the object, in UTC.

Data Type

string

ClientFileEntryParentURL Property (WebDAVServer Component)

Specifies the object's parent URL.

Syntax

func (obj *WebDAVServer) ClientFileEntryParentURL() (string, error)
func (obj *WebDAVServer) SetClientFileEntryParentURL(value string) error

Default Value

Remarks

Specifies the object's parent URL.

Data Type

string

ClientFileEntrySize Property (WebDAVServer Component)

The size of the object in bytes.

Syntax

func (obj *WebDAVServer) ClientFileEntrySize() (int64, error)
func (obj *WebDAVServer) SetClientFileEntrySize(value int64) error

Default Value

Remarks

The size of the object in bytes.

Data Type

int64

ClientFileEntrySupportsExclusiveLock Property (WebDAVServer Component)

Indicates whether the entry supports exclusive locking.

Syntax

func (obj *WebDAVServer) ClientFileEntrySupportsExclusiveLock() (bool, error)
func (obj *WebDAVServer) SetClientFileEntrySupportsExclusiveLock(value bool) error

Default Value

false

Remarks

Indicates whether the entry supports exclusive locking.

Data Type

bool

ClientFileEntrySupportsSharedLock Property (WebDAVServer Component)

Indicates whether the entry supports shared lock.

Syntax

func (obj *WebDAVServer) ClientFileEntrySupportsSharedLock() (bool, error)
func (obj *WebDAVServer) SetClientFileEntrySupportsSharedLock(value bool) error

Default Value

false

Remarks

Indicates whether the entry supports shared lock.

Data Type

bool

ClientFileEntryURL Property (WebDAVServer Component)

A URL of the object.

Syntax

func (obj *WebDAVServer) ClientFileEntryURL() (string, error)
func (obj *WebDAVServer) SetClientFileEntryURL(value string) error

Default Value

Remarks

A URL of the object.

Data Type

string

DocumentRoot Property (WebDAVServer Component)

The document root of the server.

Syntax

func (obj *WebDAVServer) DocumentRoot() (string, error)
func (obj *WebDAVServer) SetDocumentRoot(value string) error

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

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

func (obj *WebDAVServer) ExternalCryptoAsyncDocumentID() (string, error)
func (obj *WebDAVServer) SetExternalCryptoAsyncDocumentID(value string) error

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

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

func (obj *WebDAVServer) ExternalCryptoCustomParams() (string, error)
func (obj *WebDAVServer) SetExternalCryptoCustomParams(value string) error

Default Value

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

Data Type

string

ExternalCryptoData Property (WebDAVServer Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

func (obj *WebDAVServer) ExternalCryptoData() (string, error)
func (obj *WebDAVServer) SetExternalCryptoData(value string) error

Default Value

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

Data Type

string

ExternalCryptoExternalHashCalculation Property (WebDAVServer Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

func (obj *WebDAVServer) ExternalCryptoExternalHashCalculation() (bool, error)
func (obj *WebDAVServer) SetExternalCryptoExternalHashCalculation(value bool) error

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

If set to true, the struct 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

bool

ExternalCryptoHashAlgorithm Property (WebDAVServer Component)

Specifies the request's signature hash algorithm.

Syntax

func (obj *WebDAVServer) ExternalCryptoHashAlgorithm() (string, error)
func (obj *WebDAVServer) SetExternalCryptoHashAlgorithm(value string) error

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

The ID of the pre-shared key used for DC request authentication.

Syntax

func (obj *WebDAVServer) ExternalCryptoKeyID() (string, error)
func (obj *WebDAVServer) SetExternalCryptoKeyID(value string) error

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 to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

string

ExternalCryptoKeySecret Property (WebDAVServer Component)

The pre-shared key used for DC request authentication.

Syntax

func (obj *WebDAVServer) ExternalCryptoKeySecret() (string, error)
func (obj *WebDAVServer) SetExternalCryptoKeySecret(value string) error

Default Value

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

string

ExternalCryptoMethod Property (WebDAVServer Component)

Specifies the asynchronous signing method.

Syntax

func (obj *WebDAVServer) ExternalCryptoMethod() (int32, error)
func (obj *WebDAVServer) SetExternalCryptoMethod(value int32) error

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

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

int32

ExternalCryptoMode Property (WebDAVServer Component)

Specifies the external cryptography mode.

Syntax

func (obj *WebDAVServer) ExternalCryptoMode() (int32, error)
func (obj *WebDAVServer) SetExternalCryptoMode(value int32) error

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

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

Data Type

int32

ExternalCryptoPublicKeyAlgorithm Property (WebDAVServer Component)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

func (obj *WebDAVServer) ExternalCryptoPublicKeyAlgorithm() (string, error)
func (obj *WebDAVServer) SetExternalCryptoPublicKeyAlgorithm(value string) error

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

Reserved.

Syntax

func (obj *WebDAVServer) FIPSMode() (bool, error)
func (obj *WebDAVServer) SetFIPSMode(value bool) error

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

Host Property (WebDAVServer Component)

The host to bind the listening port to.

Syntax

func (obj *WebDAVServer) Host() (string, error)
func (obj *WebDAVServer) SetHost(value string) error

Default Value

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

Data Type

string

MetadataFlushTimeout Property (WebDAVServer Component)

Specifies metadata flush timeout.

Syntax

func (obj *WebDAVServer) MetadataFlushTimeout() (int32, error)
func (obj *WebDAVServer) SetMetadataFlushTimeout(value int32) error

Default Value

600

Remarks

Use this property to specify metadata flush timeout in seconds.

Data Type

int32

MetadataRoot Property (WebDAVServer Component)

The metadata directory root.

Syntax

func (obj *WebDAVServer) MetadataRoot() (string, error)
func (obj *WebDAVServer) SetMetadataRoot(value string) error

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

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

func (obj *WebDAVServer) PinnedClientAEADCipher() (bool, error)

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

PinnedClientChainValidationDetails Property (WebDAVServer Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *WebDAVServer) PinnedClientChainValidationDetails() (int32, error)

Default Value

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.

Data Type

int32

PinnedClientChainValidationResult Property (WebDAVServer Component)

The outcome of a certificate chain validation routine.

Syntax

func (obj *WebDAVServer) PinnedClientChainValidationResult() (int32, error)

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

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.

Data Type

int32

PinnedClientCiphersuite Property (WebDAVServer Component)

The cipher suite employed by this connection.

Syntax

func (obj *WebDAVServer) PinnedClientCiphersuite() (string, error)

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.

Data Type

string

PinnedClientClientAuthenticated Property (WebDAVServer Component)

Specifies whether client authentication was performed during this connection.

Syntax

func (obj *WebDAVServer) PinnedClientClientAuthenticated() (bool, error)

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

PinnedClientClientAuthRequested Property (WebDAVServer Component)

Specifies whether client authentication was requested during this connection.

Syntax

func (obj *WebDAVServer) PinnedClientClientAuthRequested() (bool, error)

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

PinnedClientConnectionEstablished Property (WebDAVServer Component)

Indicates whether the connection has been established fully.

Syntax

func (obj *WebDAVServer) PinnedClientConnectionEstablished() (bool, error)

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

PinnedClientConnectionID Property (WebDAVServer Component)

The unique identifier assigned to this connection.

Syntax

func (obj *WebDAVServer) PinnedClientConnectionID() ([]byte, error)

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

[]byte

PinnedClientDigestAlgorithm Property (WebDAVServer Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

func (obj *WebDAVServer) PinnedClientDigestAlgorithm() (string, error)

Default Value

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

string

PinnedClientEncryptionAlgorithm Property (WebDAVServer Component)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

func (obj *WebDAVServer) PinnedClientEncryptionAlgorithm() (string, error)

Default Value

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

string

PinnedClientExportable Property (WebDAVServer Component)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

func (obj *WebDAVServer) PinnedClientExportable() (bool, error)

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only.

Data Type

bool

PinnedClientGroup Property (WebDAVServer Component)

The elliptic curve used in this connection.

Syntax

func (obj *WebDAVServer) PinnedClientGroup() (string, error)

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.

Data Type

string

PinnedClientID Property (WebDAVServer Component)

The client connection's unique identifier.

Syntax

func (obj *WebDAVServer) PinnedClientID() (int64, error)

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.

Data Type

int64

PinnedClientKeyExchangeAlgorithm Property (WebDAVServer Component)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

func (obj *WebDAVServer) PinnedClientKeyExchangeAlgorithm() (string, error)

Default Value

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

string

PinnedClientKeyExchangeKeyBits Property (WebDAVServer Component)

The length of the key exchange key of a TLS-enabled connection.

Syntax

func (obj *WebDAVServer) PinnedClientKeyExchangeKeyBits() (int32, error)

Default Value

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only.

Data Type

int32

PinnedClientPFSCipher Property (WebDAVServer Component)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

func (obj *WebDAVServer) PinnedClientPFSCipher() (bool, error)

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only.

Data Type

bool

PinnedClientPreSharedIdentity Property (WebDAVServer Component)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

func (obj *WebDAVServer) PinnedClientPreSharedIdentity() (string, error)

Default Value

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is read-only.

Data Type

string

PinnedClientPreSharedIdentityHint Property (WebDAVServer Component)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

func (obj *WebDAVServer) PinnedClientPreSharedIdentityHint() (string, error)

Default Value

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only.

Data Type

string

PinnedClientPublicKeyBits Property (WebDAVServer Component)

The length of the public key.

Syntax

func (obj *WebDAVServer) PinnedClientPublicKeyBits() (int32, error)

Default Value

Remarks

The length of the public key.

This property is read-only.

Data Type

int32

PinnedClientRemoteAddress Property (WebDAVServer Component)

The client's IP address.

Syntax

func (obj *WebDAVServer) PinnedClientRemoteAddress() (string, error)

Default Value

Remarks

The client's IP address.

This property is read-only.

Data Type

string

PinnedClientRemotePort Property (WebDAVServer Component)

The remote port of the client connection.

Syntax

func (obj *WebDAVServer) PinnedClientRemotePort() (int32, error)

Default Value

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

int32

PinnedClientResumedSession Property (WebDAVServer Component)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

func (obj *WebDAVServer) PinnedClientResumedSession() (bool, error)

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only.

Data Type

bool

PinnedClientSecureConnection Property (WebDAVServer Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

func (obj *WebDAVServer) PinnedClientSecureConnection() (bool, error)

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

PinnedClientServerAuthenticated Property (WebDAVServer Component)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

func (obj *WebDAVServer) PinnedClientServerAuthenticated() (bool, error)

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only.

Data Type

bool

PinnedClientSignatureAlgorithm Property (WebDAVServer Component)

The signature algorithm used in a TLS handshake.

Syntax

func (obj *WebDAVServer) PinnedClientSignatureAlgorithm() (string, error)

Default Value

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

string

PinnedClientSymmetricBlockSize Property (WebDAVServer Component)

The block size of the symmetric algorithm used.

Syntax

func (obj *WebDAVServer) PinnedClientSymmetricBlockSize() (int32, error)

Default Value

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

int32

PinnedClientSymmetricKeyBits Property (WebDAVServer Component)

The key length of the symmetric algorithm used.

Syntax

func (obj *WebDAVServer) PinnedClientSymmetricKeyBits() (int32, error)

Default Value

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

int32

PinnedClientTotalBytesReceived Property (WebDAVServer Component)

The total number of bytes received over this connection.

Syntax

func (obj *WebDAVServer) PinnedClientTotalBytesReceived() (int64, error)

Default Value

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

int64

PinnedClientTotalBytesSent Property (WebDAVServer Component)

The total number of bytes sent over this connection.

Syntax

func (obj *WebDAVServer) PinnedClientTotalBytesSent() (int64, error)

Default Value

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

int64

PinnedClientValidationLog Property (WebDAVServer Component)

Contains the server certificate's chain validation log.

Syntax

func (obj *WebDAVServer) PinnedClientValidationLog() (string, error)

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.

Data Type

string

PinnedClientVersion Property (WebDAVServer Component)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

func (obj *WebDAVServer) PinnedClientVersion() (string, error)

Default Value

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only.

Data Type

string

PinnedClientCertCount Property (WebDAVServer Component)

The number of records in the PinnedClientCert arrays.

Syntax

func (obj *WebDAVServer) PinnedClientCertCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

PinnedClientCertBytes
PinnedClientCertCA
PinnedClientCertCAKeyID
PinnedClientCertCertType
PinnedClientCertCRLDistributionPoints
PinnedClientCertCurve
PinnedClientCertFingerprint
PinnedClientCertFriendlyName
PinnedClientCertHandle
PinnedClientCertHashAlgorithm
PinnedClientCertIssuer
PinnedClientCertIssuerRDN
PinnedClientCertKeyAlgorithm
PinnedClientCertKeyBits
PinnedClientCertKeyFingerprint
PinnedClientCertKeyUsage
PinnedClientCertKeyValid
PinnedClientCertOCSPLocations
PinnedClientCertOCSPNoCheck
PinnedClientCertOrigin
PinnedClientCertPolicyIDs
PinnedClientCertPrivateKeyBytes
PinnedClientCertPrivateKeyExists
PinnedClientCertPrivateKeyExtractable
PinnedClientCertPublicKeyBytes
PinnedClientCertQualified
PinnedClientCertQualifiedStatements
PinnedClientCertQualifiers
PinnedClientCertSelfSigned
PinnedClientCertSerialNumber
PinnedClientCertSigAlgorithm
PinnedClientCertSource
PinnedClientCertSubject
PinnedClientCertSubjectAlternativeName
PinnedClientCertSubjectKeyID
PinnedClientCertSubjectRDN
PinnedClientCertValid
PinnedClientCertValidFrom
PinnedClientCertValidTo

The array indices start at 0 and end at PinnedClientCertCount - 1.

This property is read-only.

Data Type

int32

PinnedClientCertBytes Property (WebDAVServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *WebDAVServer) PinnedClientCertBytes(PinnedClientCertIndex int32) ([]byte, error)

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

This property is read-only.

Data Type

[]byte

PinnedClientCertCA Property (WebDAVServer Component)

Indicates whether the certificate has a CA capability.

Syntax

func (obj *WebDAVServer) PinnedClientCertCA(PinnedClientCertIndex int32) (bool, error)

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

This property is read-only.

Data Type

bool

PinnedClientCertCAKeyID Property (WebDAVServer Component)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

func (obj *WebDAVServer) PinnedClientCertCAKeyID(PinnedClientCertIndex int32) ([]byte, error)

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 generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the PinnedClientCertSubjectKeyID 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 property.

This property is read-only.

Data Type

[]byte

PinnedClientCertCertType Property (WebDAVServer Component)

Returns the type of the entity contained in the Certificate object.

Syntax

func (obj *WebDAVServer) PinnedClientCertCertType(PinnedClientCertIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

Default Value

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager struct 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 property.

This property is read-only.

Data Type

int32

PinnedClientCertCRLDistributionPoints Property (WebDAVServer Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

func (obj *WebDAVServer) PinnedClientCertCRLDistributionPoints(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertCurve Property (WebDAVServer Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

func (obj *WebDAVServer) PinnedClientCertCurve(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertFingerprint Property (WebDAVServer Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

func (obj *WebDAVServer) PinnedClientCertFingerprint(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertFriendlyName Property (WebDAVServer Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

func (obj *WebDAVServer) PinnedClientCertFriendlyName(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertHandle Property (WebDAVServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *WebDAVServer) PinnedClientCertHandle(PinnedClientCertIndex int32) (int64, error)

Default Value

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

int64

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

Syntax

func (obj *WebDAVServer) PinnedClientCertHashAlgorithm(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertIssuer Property (WebDAVServer Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

func (obj *WebDAVServer) PinnedClientCertIssuer(PinnedClientCertIndex int32) (string, error)

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

string

PinnedClientCertIssuerRDN Property (WebDAVServer Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *WebDAVServer) PinnedClientCertIssuerRDN(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertKeyAlgorithm Property (WebDAVServer Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *WebDAVServer) PinnedClientCertKeyAlgorithm(PinnedClientCertIndex int32) (string, error)

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, PinnedClientCertCurve, and PinnedClientCertPublicKeyBytes 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 property.

This property is read-only.

Data Type

string

PinnedClientCertKeyBits Property (WebDAVServer Component)

Returns the length of the public key in bits.

Syntax

func (obj *WebDAVServer) PinnedClientCertKeyBits(PinnedClientCertIndex int32) (int32, error)

Default Value

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 or PinnedClientCertPrivateKeyBytes 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 property.

This property is read-only.

Data Type

int32

PinnedClientCertKeyFingerprint Property (WebDAVServer Component)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

func (obj *WebDAVServer) PinnedClientCertKeyFingerprint(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertKeyUsage Property (WebDAVServer Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

func (obj *WebDAVServer) PinnedClientCertKeyUsage(PinnedClientCertIndex int32) (int32, error)

Default Value

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

This property is read-only.

Data Type

int32

PinnedClientCertKeyValid Property (WebDAVServer Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

func (obj *WebDAVServer) PinnedClientCertKeyValid(PinnedClientCertIndex int32) (bool, error)

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

bool

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.

Syntax

func (obj *WebDAVServer) PinnedClientCertOCSPLocations(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertOCSPNoCheck Property (WebDAVServer Component)

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

func (obj *WebDAVServer) PinnedClientCertOCSPNoCheck(PinnedClientCertIndex int32) (bool, error)

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

This property is read-only.

Data Type

bool

PinnedClientCertOrigin Property (WebDAVServer Component)

Returns the location that the certificate was taken or loaded from.

Syntax

func (obj *WebDAVServer) PinnedClientCertOrigin(PinnedClientCertIndex int32) (int32, error)

Default Value

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

This property is read-only.

Data Type

int32

PinnedClientCertPolicyIDs Property (WebDAVServer Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

func (obj *WebDAVServer) PinnedClientCertPolicyIDs(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertPrivateKeyBytes Property (WebDAVServer Component)

Returns the certificate's private key in DER-encoded format.

Syntax

func (obj *WebDAVServer) PinnedClientCertPrivateKeyBytes(PinnedClientCertIndex int32) ([]byte, error)

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

This property is read-only.

Data Type

[]byte

PinnedClientCertPrivateKeyExists Property (WebDAVServer Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

func (obj *WebDAVServer) PinnedClientCertPrivateKeyExists(PinnedClientCertIndex int32) (bool, error)

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, 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 property.

This property is read-only.

Data Type

bool

PinnedClientCertPrivateKeyExtractable Property (WebDAVServer Component)

Indicates whether the private key is extractable (exportable).

Syntax

func (obj *WebDAVServer) PinnedClientCertPrivateKeyExtractable(PinnedClientCertIndex int32) (bool, error)

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

This property is read-only.

Data Type

bool

PinnedClientCertPublicKeyBytes Property (WebDAVServer Component)

Contains the certificate's public key in DER format.

Syntax

func (obj *WebDAVServer) PinnedClientCertPublicKeyBytes(PinnedClientCertIndex int32) ([]byte, error)

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

This property is read-only.

Data Type

[]byte

PinnedClientCertQualified Property (WebDAVServer Component)

Indicates whether the certificate is qualified.

Syntax

func (obj *WebDAVServer) PinnedClientCertQualified(PinnedClientCertIndex int32) (bool, error)

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

This property is read-only.

Data Type

bool

PinnedClientCertQualifiedStatements Property (WebDAVServer Component)

Returns a simplified qualified status of the certificate.

Syntax

func (obj *WebDAVServer) PinnedClientCertQualifiedStatements(PinnedClientCertIndex int32) (int32, error)

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

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

This property is read-only.

Data Type

int32

PinnedClientCertQualifiers Property (WebDAVServer Component)

A list of qualifiers.

Syntax

func (obj *WebDAVServer) PinnedClientCertQualifiers(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertSelfSigned Property (WebDAVServer Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

func (obj *WebDAVServer) PinnedClientCertSelfSigned(PinnedClientCertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

bool

PinnedClientCertSerialNumber Property (WebDAVServer Component)

Returns the certificate's serial number.

Syntax

func (obj *WebDAVServer) PinnedClientCertSerialNumber(PinnedClientCertIndex int32) ([]byte, error)

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

This property is read-only.

Data Type

[]byte

PinnedClientCertSigAlgorithm Property (WebDAVServer Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

func (obj *WebDAVServer) PinnedClientCertSigAlgorithm(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertSource Property (WebDAVServer Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *WebDAVServer) PinnedClientCertSource(PinnedClientCertIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

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

This property is read-only.

Data Type

int32

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.

Syntax

func (obj *WebDAVServer) PinnedClientCertSubject(PinnedClientCertIndex int32) (string, error)

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

string

PinnedClientCertSubjectAlternativeName Property (WebDAVServer Component)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

func (obj *WebDAVServer) PinnedClientCertSubjectAlternativeName(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

PinnedClientCertSubjectKeyID Property (WebDAVServer Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

func (obj *WebDAVServer) PinnedClientCertSubjectKeyID(PinnedClientCertIndex int32) ([]byte, error)

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 and PinnedClientCertCAKeyID 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 property.

This property is read-only.

Data Type

[]byte

PinnedClientCertSubjectRDN Property (WebDAVServer Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *WebDAVServer) PinnedClientCertSubjectRDN(PinnedClientCertIndex int32) (string, error)

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

This property is read-only.

Data Type

string

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.

Syntax

func (obj *WebDAVServer) PinnedClientCertValid(PinnedClientCertIndex int32) (bool, error)

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

This property is read-only.

Data Type

bool

PinnedClientCertValidFrom Property (WebDAVServer Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

func (obj *WebDAVServer) PinnedClientCertValidFrom(PinnedClientCertIndex int32) (string, error)

Default Value

Remarks

The time point at which the certificate becomes valid, in UTC.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

string

PinnedClientCertValidTo Property (WebDAVServer Component)

The time point at which the certificate expires, in UTC.

Syntax

func (obj *WebDAVServer) PinnedClientCertValidTo(PinnedClientCertIndex int32) (string, error)

Default Value

Remarks

The time point at which the certificate expires, in UTC.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

string

Port Property (WebDAVServer Component)

Specifies the port number to listen for connections on.

Syntax

func (obj *WebDAVServer) Port() (int32, error)
func (obj *WebDAVServer) SetPort(value int32) error

Default Value

Remarks

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

Alternatively, you may specify the acceptable range of listening ports via PortRangeFrom and PortRangeTo properties. In this case the port will be allocated within the requested range by the operating system, and reported in BoundPort.

Data Type

int32

PortRangeFrom Property (WebDAVServer Component)

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

Syntax

func (obj *WebDAVServer) PortRangeFrom() (int32, error)
func (obj *WebDAVServer) SetPortRangeFrom(value int32) error

Default Value

Remarks

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

Data Type

int32

PortRangeTo Property (WebDAVServer Component)

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

Syntax

func (obj *WebDAVServer) PortRangeTo() (int32, error)
func (obj *WebDAVServer) SetPortRangeTo(value int32) error

Default Value

Remarks

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

Data Type

int32

SocketIncomingSpeedLimit Property (WebDAVServer Component)

The maximum number of bytes to read from the socket, per second.

Syntax

func (obj *WebDAVServer) SocketIncomingSpeedLimit() (int32, error)
func (obj *WebDAVServer) SetSocketIncomingSpeedLimit(value int32) error

Default Value

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

int32

SocketLocalAddress Property (WebDAVServer Component)

The local network interface to bind the socket to.

Syntax

func (obj *WebDAVServer) SocketLocalAddress() (string, error)
func (obj *WebDAVServer) SetSocketLocalAddress(value string) error

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

string

SocketLocalPort Property (WebDAVServer Component)

The local port number to bind the socket to.

Syntax

func (obj *WebDAVServer) SocketLocalPort() (int32, error)
func (obj *WebDAVServer) SetSocketLocalPort(value int32) error

Default Value

Remarks

The local port number to bind the socket to.

Data Type

int32

SocketOutgoingSpeedLimit Property (WebDAVServer Component)

The maximum number of bytes to write to the socket, per second.

Syntax

func (obj *WebDAVServer) SocketOutgoingSpeedLimit() (int32, error)
func (obj *WebDAVServer) SetSocketOutgoingSpeedLimit(value int32) error

Default Value

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

int32

SocketTimeout Property (WebDAVServer Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

func (obj *WebDAVServer) SocketTimeout() (int32, error)
func (obj *WebDAVServer) SetSocketTimeout(value int32) error

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

int32

SocketUseIPv6 Property (WebDAVServer Component)

Enables or disables IP protocol version 6.

Syntax

func (obj *WebDAVServer) SocketUseIPv6() (bool, error)
func (obj *WebDAVServer) SetSocketUseIPv6(value bool) error

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

TLSServerCertCount Property (WebDAVServer Component)

The number of records in the TLSServerCert arrays.

Syntax

func (obj *WebDAVServer) TLSServerCertCount() (int32, error)
func (obj *WebDAVServer) SetTLSServerCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

TLSServerCertBytes
TLSServerCertHandle

The array indices start at 0 and end at TLSServerCertCount - 1.

Data Type

int32

TLSServerCertBytes Property (WebDAVServer Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *WebDAVServer) TLSServerCertBytes(TLSServerCertIndex int32) ([]byte, error)

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

This property is read-only.

Data Type

[]byte

TLSServerCertHandle Property (WebDAVServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *WebDAVServer) TLSServerCertHandle(TLSServerCertIndex int32) (int64, error)
func (obj *WebDAVServer) SetTLSServerCertHandle(TLSServerCertIndex int32, value int64) error

Default Value

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.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

Data Type

int64

TLSAutoValidateCertificates Property (WebDAVServer Component)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

func (obj *WebDAVServer) TLSAutoValidateCertificates() (bool, error)
func (obj *WebDAVServer) SetTLSAutoValidateCertificates(value bool) error

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

bool

TLSBaseConfiguration Property (WebDAVServer Component)

Selects the base configuration for the TLS settings.

Syntax

func (obj *WebDAVServer) TLSBaseConfiguration() (int32, error)
func (obj *WebDAVServer) SetTLSBaseConfiguration(value int32) error

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

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

int32

TLSCiphersuites Property (WebDAVServer Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

func (obj *WebDAVServer) TLSCiphersuites() (string, error)
func (obj *WebDAVServer) SetTLSCiphersuites(value string) error

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

Enables or disables certificate-based client authentication.

Syntax

func (obj *WebDAVServer) TLSClientAuth() (int32, error)
func (obj *WebDAVServer) SetTLSClientAuth(value int32) error

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

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

int32

TLSExtensions Property (WebDAVServer Component)

Provides access to TLS extensions.

Syntax

func (obj *WebDAVServer) TLSExtensions() (string, error)
func (obj *WebDAVServer) SetTLSExtensions(value string) error

Default Value

Remarks

Provides access to TLS extensions.

Data Type

string

TLSForceResumeIfDestinationChanges Property (WebDAVServer Component)

Whether to force TLS session resumption when the destination address changes.

Syntax

func (obj *WebDAVServer) TLSForceResumeIfDestinationChanges() (bool, error)
func (obj *WebDAVServer) SetTLSForceResumeIfDestinationChanges(value bool) error

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

bool

TLSGroups Property (WebDAVServer Component)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

func (obj *WebDAVServer) TLSGroups() (string, error)
func (obj *WebDAVServer) SetTLSGroups(value string) error

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:

// 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 Component)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

func (obj *WebDAVServer) TLSPreSharedIdentity() (string, error)
func (obj *WebDAVServer) SetTLSPreSharedIdentity(value string) error

Default Value

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Data Type

string

TLSPreSharedKey Property (WebDAVServer Component)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

func (obj *WebDAVServer) TLSPreSharedKey() (string, error)
func (obj *WebDAVServer) SetTLSPreSharedKey(value string) error

Default Value

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Data Type

string

TLSPreSharedKeyCiphersuite Property (WebDAVServer Component)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

func (obj *WebDAVServer) TLSPreSharedKeyCiphersuite() (string, error)
func (obj *WebDAVServer) SetTLSPreSharedKeyCiphersuite(value string) error

Default Value

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

string

TLSRenegotiationAttackPreventionMode Property (WebDAVServer Component)

Selects the renegotiation attack prevention mechanism.

Syntax

func (obj *WebDAVServer) TLSRenegotiationAttackPreventionMode() (int32, error)
func (obj *WebDAVServer) SetTLSRenegotiationAttackPreventionMode(value int32) error

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

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

int32

TLSRevocationCheck Property (WebDAVServer Component)

Specifies the kind(s) of revocation check to perform.

Syntax

func (obj *WebDAVServer) TLSRevocationCheck() (int32, error)
func (obj *WebDAVServer) SetTLSRevocationCheck(value int32) error

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

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.

Data Type

int32

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.

Syntax

func (obj *WebDAVServer) TLSSSLOptions() (int32, error)
func (obj *WebDAVServer) SetTLSSSLOptions(value int32) error

Default Value

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

int32

TLSMode Property (WebDAVServer Component)

Specifies the TLS mode to use.

Syntax

func (obj *WebDAVServer) TLSMode() (int32, error)
func (obj *WebDAVServer) SetTLSMode(value int32) error

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

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

int32

TLSUseExtendedMasterSecret Property (WebDAVServer Component)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

func (obj *WebDAVServer) TLSUseExtendedMasterSecret() (bool, error)
func (obj *WebDAVServer) SetTLSUseExtendedMasterSecret(value bool) error

Default Value

true

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

bool

TLSUseSessionResumption Property (WebDAVServer Component)

Enables or disables the TLS session resumption capability.

Syntax

func (obj *WebDAVServer) TLSUseSessionResumption() (bool, error)
func (obj *WebDAVServer) SetTLSUseSessionResumption(value bool) error

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

TLSVersions Property (WebDAVServer Component)

The SSL/TLS versions to enable by default.

Syntax

func (obj *WebDAVServer) TLSVersions() (int32, error)
func (obj *WebDAVServer) SetTLSVersions(value int32) error

Default Value

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

int32

UserCount Property (WebDAVServer Component)

The number of records in the User arrays.

Syntax

func (obj *WebDAVServer) UserCount() (int32, error)
func (obj *WebDAVServer) SetUserCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

UserAssociatedData
UserBasePath
UserCertificate
UserData
UserEmail
UserHandle
UserHashAlgorithm
UserIncomingSpeedLimit
Username
UserOtpAlgorithm
UserOTPLen
UserOtpValue
UserOutgoingSpeedLimit
UserPassword
UserSharedSecret
UserSSHKey

The array indices start at 0 and end at UserCount - 1.

Data Type

int32

UserAssociatedData Property (WebDAVServer Component)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

func (obj *WebDAVServer) UserAssociatedData(UserIndex int32) ([]byte, error)
func (obj *WebDAVServer) SetUserAssociatedData(UserIndex int32, value []byte) error

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

[]byte

UserBasePath Property (WebDAVServer Component)

Base path for this user in the server's file system.

Syntax

func (obj *WebDAVServer) UserBasePath(UserIndex int32) (string, error)
func (obj *WebDAVServer) SetUserBasePath(UserIndex int32, value string) error

Default Value

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserCertificate Property (WebDAVServer Component)

Contains the user's certificate.

Syntax

func (obj *WebDAVServer) UserCertificate(UserIndex int32) ([]byte, error)
func (obj *WebDAVServer) SetUserCertificate(UserIndex int32, value []byte) error

Remarks

Contains the user's certificate.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

[]byte

UserData Property (WebDAVServer Component)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

func (obj *WebDAVServer) UserData(UserIndex int32) (string, error)
func (obj *WebDAVServer) SetUserData(UserIndex int32, value string) error

Default Value

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserEmail Property (WebDAVServer Component)

The user's email address.

Syntax

func (obj *WebDAVServer) UserEmail(UserIndex int32) (string, error)
func (obj *WebDAVServer) SetUserEmail(UserIndex int32, value string) error

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

Data Type

string

UserHandle Property (WebDAVServer Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

func (obj *WebDAVServer) UserHandle(UserIndex int32) (int64, error)
func (obj *WebDAVServer) SetUserHandle(UserIndex int32, value int64) error

Default Value

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.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int64

UserHashAlgorithm Property (WebDAVServer Component)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

func (obj *WebDAVServer) UserHashAlgorithm(UserIndex int32) (string, error)
func (obj *WebDAVServer) SetUserHashAlgorithm(UserIndex int32, value string) error

Default Value

Remarks

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests:


SB_MAC_ALGORITHM_HMAC_SHA1	`SHA1`
SB_MAC_ALGORITHM_HMAC_SHA256	`SHA256`
SB_MAC_ALGORITHM_HMAC_SHA512	`SHA512`

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserIncomingSpeedLimit Property (WebDAVServer Component)

Specifies the incoming speed limit for this user.

Syntax

func (obj *WebDAVServer) UserIncomingSpeedLimit(UserIndex int32) (int32, error)
func (obj *WebDAVServer) SetUserIncomingSpeedLimit(UserIndex int32, value int32) error

Default Value

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

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

Syntax

func (obj *WebDAVServer) UserOtpAlgorithm(UserIndex int32) (int32, error)
func (obj *WebDAVServer) SetUserOtpAlgorithm(UserIndex int32, value int32) error

Possible Values

0   // None
1   // Hmac
2   // Time

Default Value

Remarks

The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value.


oaHmac	`0`
oaTime	`1`

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserOTPLen Property (WebDAVServer Component)

Specifies the length of the user's OTP password.

Syntax

func (obj *WebDAVServer) UserOTPLen(UserIndex int32) (int32, error)
func (obj *WebDAVServer) SetUserOTPLen(UserIndex int32, value int32) error

Default Value

Remarks

Specifies the length of the user's OTP password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserOtpValue Property (WebDAVServer Component)

The user's time interval (TOTP) or Counter (HOTP).

Syntax

func (obj *WebDAVServer) UserOtpValue(UserIndex int32) (int32, error)
func (obj *WebDAVServer) SetUserOtpValue(UserIndex int32, value int32) error

Default Value

Remarks

The user's time interval (TOTP) or Counter (HOTP).

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserOutgoingSpeedLimit Property (WebDAVServer Component)

Specifies the outgoing speed limit for this user.

Syntax

func (obj *WebDAVServer) UserOutgoingSpeedLimit(UserIndex int32) (int32, error)
func (obj *WebDAVServer) SetUserOutgoingSpeedLimit(UserIndex int32, value int32) error

Default Value

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

int32

UserPassword Property (WebDAVServer Component)

The user's authentication password.

Syntax

func (obj *WebDAVServer) UserPassword(UserIndex int32) (string, error)
func (obj *WebDAVServer) SetUserPassword(UserIndex int32, value string) error

Default Value

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

UserSharedSecret Property (WebDAVServer Component)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

func (obj *WebDAVServer) UserSharedSecret(UserIndex int32) ([]byte, error)
func (obj *WebDAVServer) SetUserSharedSecret(UserIndex int32, value []byte) error

Remarks

Contains the user's secret key, which is essentially a shared secret between the client and server.

Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

[]byte

UserSSHKey Property (WebDAVServer Component)

Contains the user's SSH key.

Syntax

func (obj *WebDAVServer) UserSSHKey(UserIndex int32) ([]byte, error)
func (obj *WebDAVServer) SetUserSSHKey(UserIndex int32, value []byte) error

Remarks

Contains the user's SSH key.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

[]byte

Username Property (WebDAVServer Component)

The registered name (login) of the user.

Syntax

func (obj *WebDAVServer) Username(UserIndex int32) (string, error)
func (obj *WebDAVServer) SetUsername(UserIndex int32, value string) error

Default Value

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

string

WebsiteName Property (WebDAVServer Component)

Specifies the web site name to use in the certificate.

Syntax

func (obj *WebDAVServer) WebsiteName() (string, error)
func (obj *WebDAVServer) SetWebsiteName(value string) error

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

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

func (obj *WebDAVServer) Cleanup() error

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

Sets or retrieves a configuration setting.

Syntax

func (obj *WebDAVServer) Config(ConfigurationString string) (string, error)

Remarks

Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (WebDAVServer Component)

Performs an additional action.

Syntax

func (obj *WebDAVServer) DoAction(ActionID string, ActionParams string) (string, error)

Remarks

DoAction is a generic method available in every struct. 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 Component)

Terminates a client connection.

Syntax

func (obj *WebDAVServer) DropClient(ConnectionId int64, Forced bool) error

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

Obtains a pending connection buffer.

Syntax

func (obj *WebDAVServer) GetClientBuffer(ConnectionID int64) ([]byte, error)

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

Returns the contents of the client's HTTP request.

Syntax

func (obj *WebDAVServer) GetRequestBytes(ConnectionId int64, RequestFilter string) ([]byte, error)

Remarks

Use this method to get the body of the client's HTTP request in your CustomRequest event handler. Note that the body of GET and HEAD requests is empty. The method returns the requested content.

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


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

GetRequestHeader Method (WebDAVServer Component)

Returns a request header value.

Syntax

func (obj *WebDAVServer) GetRequestHeader(ConnectionId int64, HeaderName string) (string, error)

Remarks

Use this method to get the value of a request header. A good place to call this method is a request-marking event, such as BeforeLockObject or CustomRequest.

GetRequestString Method (WebDAVServer Component)

Returns the contents of the client's HTTP request.

Syntax

func (obj *WebDAVServer) GetRequestString(ConnectionId int64, RequestFilter string) (string, error)

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

Returns the username for a connection.

Syntax

func (obj *WebDAVServer) GetRequestUsername(ConnectionId int64) (string, error)

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

Returns a response header value.

Syntax

func (obj *WebDAVServer) GetResponseHeader(ConnectionId int64, HeaderName string) (string, error)

Remarks

Use this method to get the value of a response header. A good place to call this method is HeadersPrepared event. Call the method with empty HeaderName to get the whole response header.

ListClients Method (WebDAVServer Component)

Enumerates the connected clients.

Syntax

func (obj *WebDAVServer) ListClients() (string, error)

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

Takes a snapshot of the connection's properties.

Syntax

func (obj *WebDAVServer) PinClient(ConnectionId int64) error

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

Processes a generic HTTP request.

Syntax

func (obj *WebDAVServer) ProcessGenericRequest(ConnectionId int64, RequestBytes []byte) ([]byte, error)

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

Resets the class settings.

Syntax

func (obj *WebDAVServer) Reset() error

Remarks

Reset is a generic method available in every struct.

SetClientBuffer Method (WebDAVServer Component)

Commits a data buffer to the connection.

Syntax

func (obj *WebDAVServer) SetClientBuffer(ConnectionID int64, Value []byte) error

Remarks

Use this method from your ReadFile event handler to commit a chunk of file data to the server component.

SetClientFileEntry Method (WebDAVServer Component)

Commits a file entry to the connection.

Syntax

func (obj *WebDAVServer) SetClientFileEntry(ConnectionID int64) error

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

Sets a byte array to be served as a response.

Syntax

func (obj *WebDAVServer) SetResponseBytes(ConnectionId int64, Bytes []byte, ContentType string, ResponseFilter string) error

Remarks

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


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

SetResponseFile Method (WebDAVServer Component)

Sets a file to be served as a response.

Syntax

func (obj *WebDAVServer) SetResponseFile(ConnectionId int64, FileName string, ContentType string, ResponseFilter string) error

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

Sets a response header.

Syntax

func (obj *WebDAVServer) SetResponseHeader(ConnectionId int64, HeaderName string, Value string) error

Remarks

Use this method to set a response header. A good place to call this method is a request-marking event, such as LockObject or CustomRequest.

SetResponseStatus Method (WebDAVServer Component)

Sets an HTTP status to be sent with the response.

Syntax

func (obj *WebDAVServer) SetResponseStatus(ConnectionId int64, StatusCode int32) error

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.

SetResponseString Method (WebDAVServer Component)

Sets a string to be served as a response.

Syntax

func (obj *WebDAVServer) SetResponseString(ConnectionId int64, DataStr string, ContentType string, ResponseFilter string) error

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

Starts the server.

Syntax

func (obj *WebDAVServer) Start() error

Remarks

Use this method to activate the server and start listening to incoming connections.

Stop Method (WebDAVServer Component)

Stops the server.

Syntax

func (obj *WebDAVServer) Stop() error

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

Accept Event (WebDAVServer Component)

Reports an incoming connection.

Syntax

// WebDAVServerAcceptEventArgs carries the WebDAVServer Accept event's parameters.
type WebDAVServerAcceptEventArgs struct {...}

func (args *WebDAVServerAcceptEventArgs) RemoteAddress() string
func (args *WebDAVServerAcceptEventArgs) RemotePort() int32
func (args *WebDAVServerAcceptEventArgs) Accept() bool
func (args *WebDAVServerAcceptEventArgs) SetAccept(value bool)

// WebDAVServerAcceptEvent defines the signature of the WebDAVServer Accept event's handler function.
type WebDAVServerAcceptEvent func(sender *WebDAVServer, args *WebDAVServerAcceptEventArgs)

func (obj *WebDAVServer) GetOnAcceptHandler() WebDAVServerAcceptEvent
func (obj *WebDAVServer) SetOnAcceptHandler(handlerFunc WebDAVServerAcceptEvent)

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

AfterBrowse Event (WebDAVServer Component)

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

Syntax

// WebDAVServerAfterBrowseEventArgs carries the WebDAVServer AfterBrowse event's parameters.
type WebDAVServerAfterBrowseEventArgs struct {...}

func (args *WebDAVServerAfterBrowseEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterBrowseEventArgs) Path() string
func (args *WebDAVServerAfterBrowseEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterBrowseEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterBrowseEvent defines the signature of the WebDAVServer AfterBrowse event's handler function.
type WebDAVServerAfterBrowseEvent func(sender *WebDAVServer, args *WebDAVServerAfterBrowseEventArgs)

func (obj *WebDAVServer) GetOnAfterBrowseHandler() WebDAVServerAfterBrowseEvent
func (obj *WebDAVServer) SetOnAfterBrowseHandler(handlerFunc WebDAVServerAfterBrowseEvent)

Remarks

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

This event is typically fired after the BeforeBrowse event.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


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

AfterCopyObject Event (WebDAVServer Component)

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

Syntax

// WebDAVServerAfterCopyObjectEventArgs carries the WebDAVServer AfterCopyObject event's parameters.
type WebDAVServerAfterCopyObjectEventArgs struct {...}

func (args *WebDAVServerAfterCopyObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterCopyObjectEventArgs) OldPath() string
func (args *WebDAVServerAfterCopyObjectEventArgs) NewPath() string
func (args *WebDAVServerAfterCopyObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterCopyObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterCopyObjectEvent defines the signature of the WebDAVServer AfterCopyObject event's handler function.
type WebDAVServerAfterCopyObjectEvent func(sender *WebDAVServer, args *WebDAVServerAfterCopyObjectEventArgs)

func (obj *WebDAVServer) GetOnAfterCopyObjectHandler() WebDAVServerAfterCopyObjectEvent
func (obj *WebDAVServer) SetOnAfterCopyObjectHandler(handlerFunc WebDAVServerAfterCopyObjectEvent)

Remarks

AfterCopyObject is typically preceded by BeforeCopyObject and CopyObject events. The OldPath and NewPath parameters contain the origin and destination names of the copied object.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


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

AfterCreateCalendar Event (WebDAVServer Component)

This event reports the completion of calendar creation request.

Syntax

// WebDAVServerAfterCreateCalendarEventArgs carries the WebDAVServer AfterCreateCalendar event's parameters.
type WebDAVServerAfterCreateCalendarEventArgs struct {...}

func (args *WebDAVServerAfterCreateCalendarEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterCreateCalendarEventArgs) Path() string
func (args *WebDAVServerAfterCreateCalendarEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterCreateCalendarEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterCreateCalendarEvent defines the signature of the WebDAVServer AfterCreateCalendar event's handler function.
type WebDAVServerAfterCreateCalendarEvent func(sender *WebDAVServer, args *WebDAVServerAfterCreateCalendarEventArgs)

func (obj *WebDAVServer) GetOnAfterCreateCalendarHandler() WebDAVServerAfterCreateCalendarEvent
func (obj *WebDAVServer) SetOnAfterCreateCalendarHandler(handlerFunc WebDAVServerAfterCreateCalendarEvent)

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

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

Syntax

// WebDAVServerAfterCreateCollectionEventArgs carries the WebDAVServer AfterCreateCollection event's parameters.
type WebDAVServerAfterCreateCollectionEventArgs struct {...}

func (args *WebDAVServerAfterCreateCollectionEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterCreateCollectionEventArgs) Path() string
func (args *WebDAVServerAfterCreateCollectionEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterCreateCollectionEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterCreateCollectionEvent defines the signature of the WebDAVServer AfterCreateCollection event's handler function.
type WebDAVServerAfterCreateCollectionEvent func(sender *WebDAVServer, args *WebDAVServerAfterCreateCollectionEventArgs)

func (obj *WebDAVServer) GetOnAfterCreateCollectionHandler() WebDAVServerAfterCreateCollectionEvent
func (obj *WebDAVServer) SetOnAfterCreateCollectionHandler(handlerFunc WebDAVServerAfterCreateCollectionEvent)

Remarks

This event is preceded by BeforeCreateCollection and CreateCollection events. It lets you alter the operation status passed back to the client.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


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

AfterCustomRequest Event (WebDAVServer Component)

This event reports the completion of the custom request.

Syntax

// WebDAVServerAfterCustomRequestEventArgs carries the WebDAVServer AfterCustomRequest event's parameters.
type WebDAVServerAfterCustomRequestEventArgs struct {...}

func (args *WebDAVServerAfterCustomRequestEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterCustomRequestEventArgs) RequestMethod() string
func (args *WebDAVServerAfterCustomRequestEventArgs) Path() string
func (args *WebDAVServerAfterCustomRequestEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterCustomRequestEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterCustomRequestEvent defines the signature of the WebDAVServer AfterCustomRequest event's handler function.
type WebDAVServerAfterCustomRequestEvent func(sender *WebDAVServer, args *WebDAVServerAfterCustomRequestEventArgs)

func (obj *WebDAVServer) GetOnAfterCustomRequestHandler() WebDAVServerAfterCustomRequestEvent
func (obj *WebDAVServer) SetOnAfterCustomRequestHandler(handlerFunc WebDAVServerAfterCustomRequestEvent)

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

Reports the completion of the object locking operation.

Syntax

// WebDAVServerAfterLockObjectEventArgs carries the WebDAVServer AfterLockObject event's parameters.
type WebDAVServerAfterLockObjectEventArgs struct {...}

func (args *WebDAVServerAfterLockObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterLockObjectEventArgs) Path() string
func (args *WebDAVServerAfterLockObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterLockObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterLockObjectEvent defines the signature of the WebDAVServer AfterLockObject event's handler function.
type WebDAVServerAfterLockObjectEvent func(sender *WebDAVServer, args *WebDAVServerAfterLockObjectEventArgs)

func (obj *WebDAVServer) GetOnAfterLockObjectHandler() WebDAVServerAfterLockObjectEvent
func (obj *WebDAVServer) SetOnAfterLockObjectHandler(handlerFunc WebDAVServerAfterLockObjectEvent)

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

Reports the completion of the lock refresh operation.

Syntax

// WebDAVServerAfterRefreshLockEventArgs carries the WebDAVServer AfterRefreshLock event's parameters.
type WebDAVServerAfterRefreshLockEventArgs struct {...}

func (args *WebDAVServerAfterRefreshLockEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterRefreshLockEventArgs) Path() string
func (args *WebDAVServerAfterRefreshLockEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterRefreshLockEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterRefreshLockEvent defines the signature of the WebDAVServer AfterRefreshLock event's handler function.
type WebDAVServerAfterRefreshLockEvent func(sender *WebDAVServer, args *WebDAVServerAfterRefreshLockEventArgs)

func (obj *WebDAVServer) GetOnAfterRefreshLockHandler() WebDAVServerAfterRefreshLockEvent
func (obj *WebDAVServer) SetOnAfterRefreshLockHandler(handlerFunc WebDAVServerAfterRefreshLockEvent)

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

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

Syntax

// WebDAVServerAfterRemoveObjectEventArgs carries the WebDAVServer AfterRemoveObject event's parameters.
type WebDAVServerAfterRemoveObjectEventArgs struct {...}

func (args *WebDAVServerAfterRemoveObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterRemoveObjectEventArgs) Path() string
func (args *WebDAVServerAfterRemoveObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterRemoveObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterRemoveObjectEvent defines the signature of the WebDAVServer AfterRemoveObject event's handler function.
type WebDAVServerAfterRemoveObjectEvent func(sender *WebDAVServer, args *WebDAVServerAfterRemoveObjectEventArgs)

func (obj *WebDAVServer) GetOnAfterRemoveObjectHandler() WebDAVServerAfterRemoveObjectEvent
func (obj *WebDAVServer) SetOnAfterRemoveObjectHandler(handlerFunc WebDAVServerAfterRemoveObjectEvent)

Remarks

This event follows BeforeRemoveObject and RemoveObject events. It is fired upon completion of the operation and lets you adjust the operation status if required:


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

AfterRenameObject Event (WebDAVServer Component)

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

Syntax

// WebDAVServerAfterRenameObjectEventArgs carries the WebDAVServer AfterRenameObject event's parameters.
type WebDAVServerAfterRenameObjectEventArgs struct {...}

func (args *WebDAVServerAfterRenameObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterRenameObjectEventArgs) OldPath() string
func (args *WebDAVServerAfterRenameObjectEventArgs) NewPath() string
func (args *WebDAVServerAfterRenameObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterRenameObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterRenameObjectEvent defines the signature of the WebDAVServer AfterRenameObject event's handler function.
type WebDAVServerAfterRenameObjectEvent func(sender *WebDAVServer, args *WebDAVServerAfterRenameObjectEventArgs)

func (obj *WebDAVServer) GetOnAfterRenameObjectHandler() WebDAVServerAfterRenameObjectEvent
func (obj *WebDAVServer) SetOnAfterRenameObjectHandler(handlerFunc WebDAVServerAfterRenameObjectEvent)

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

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

Syntax

// WebDAVServerAfterSetAttributesEventArgs carries the WebDAVServer AfterSetAttributes event's parameters.
type WebDAVServerAfterSetAttributesEventArgs struct {...}

func (args *WebDAVServerAfterSetAttributesEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterSetAttributesEventArgs) Path() string
func (args *WebDAVServerAfterSetAttributesEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterSetAttributesEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterSetAttributesEvent defines the signature of the WebDAVServer AfterSetAttributes event's handler function.
type WebDAVServerAfterSetAttributesEvent func(sender *WebDAVServer, args *WebDAVServerAfterSetAttributesEventArgs)

func (obj *WebDAVServer) GetOnAfterSetAttributesHandler() WebDAVServerAfterSetAttributesEvent
func (obj *WebDAVServer) SetOnAfterSetAttributesHandler(handlerFunc WebDAVServerAfterSetAttributesEvent)

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

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

Syntax

// WebDAVServerAfterUnlockObjectEventArgs carries the WebDAVServer AfterUnlockObject event's parameters.
type WebDAVServerAfterUnlockObjectEventArgs struct {...}

func (args *WebDAVServerAfterUnlockObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerAfterUnlockObjectEventArgs) Path() string
func (args *WebDAVServerAfterUnlockObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerAfterUnlockObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerAfterUnlockObjectEvent defines the signature of the WebDAVServer AfterUnlockObject event's handler function.
type WebDAVServerAfterUnlockObjectEvent func(sender *WebDAVServer, args *WebDAVServerAfterUnlockObjectEventArgs)

func (obj *WebDAVServer) GetOnAfterUnlockObjectHandler() WebDAVServerAfterUnlockObjectEvent
func (obj *WebDAVServer) SetOnAfterUnlockObjectHandler(handlerFunc WebDAVServerAfterUnlockObjectEvent)

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

Fires when a connected client makes an authentication attempt.

Syntax

// WebDAVServerAuthAttemptEventArgs carries the WebDAVServer AuthAttempt event's parameters.
type WebDAVServerAuthAttemptEventArgs struct {...}

func (args *WebDAVServerAuthAttemptEventArgs) ConnectionID() int64
func (args *WebDAVServerAuthAttemptEventArgs) HTTPMethod() string
func (args *WebDAVServerAuthAttemptEventArgs) URI() string
func (args *WebDAVServerAuthAttemptEventArgs) AuthMethod() string
func (args *WebDAVServerAuthAttemptEventArgs) Username() string
func (args *WebDAVServerAuthAttemptEventArgs) Password() string
func (args *WebDAVServerAuthAttemptEventArgs) Allow() bool
func (args *WebDAVServerAuthAttemptEventArgs) SetAllow(value bool)

// WebDAVServerAuthAttemptEvent defines the signature of the WebDAVServer AuthAttempt event's handler function.
type WebDAVServerAuthAttemptEvent func(sender *WebDAVServer, args *WebDAVServerAuthAttemptEventArgs)

func (obj *WebDAVServer) GetOnAuthAttemptHandler() WebDAVServerAuthAttemptEvent
func (obj *WebDAVServer) SetOnAuthAttemptHandler(handlerFunc WebDAVServerAuthAttemptEvent)

Remarks

The struct 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 Component)

Fires when a Browse request is received.

Syntax

// WebDAVServerBeforeBrowseEventArgs carries the WebDAVServer BeforeBrowse event's parameters.
type WebDAVServerBeforeBrowseEventArgs struct {...}

func (args *WebDAVServerBeforeBrowseEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeBrowseEventArgs) Path() string
func (args *WebDAVServerBeforeBrowseEventArgs) Action() int32
func (args *WebDAVServerBeforeBrowseEventArgs) SetAction(value int32)

// WebDAVServerBeforeBrowseEvent defines the signature of the WebDAVServer BeforeBrowse event's handler function.
type WebDAVServerBeforeBrowseEvent func(sender *WebDAVServer, args *WebDAVServerBeforeBrowseEventArgs)

func (obj *WebDAVServer) GetOnBeforeBrowseHandler() WebDAVServerBeforeBrowseEvent
func (obj *WebDAVServer) SetOnBeforeBrowseHandler(handlerFunc WebDAVServerBeforeBrowseEvent)

Remarks

The struct uses this event to notify the application that a Browse request has been received from the client. The Path parameter contains the path parameter from the request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a series of events that request the details of the object residing at Path: ListAttributes, ListSubObjects, and ReadAttribute.

BeforeCopyObject Event (WebDAVServer Component)

Fires when a Copy Object request is received.

Syntax

// WebDAVServerBeforeCopyObjectEventArgs carries the WebDAVServer BeforeCopyObject event's parameters.
type WebDAVServerBeforeCopyObjectEventArgs struct {...}

func (args *WebDAVServerBeforeCopyObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeCopyObjectEventArgs) OldPath() string
func (args *WebDAVServerBeforeCopyObjectEventArgs) NewPath() string
func (args *WebDAVServerBeforeCopyObjectEventArgs) Action() int32
func (args *WebDAVServerBeforeCopyObjectEventArgs) SetAction(value int32)

// WebDAVServerBeforeCopyObjectEvent defines the signature of the WebDAVServer BeforeCopyObject event's handler function.
type WebDAVServerBeforeCopyObjectEvent func(sender *WebDAVServer, args *WebDAVServerBeforeCopyObjectEventArgs)

func (obj *WebDAVServer) GetOnBeforeCopyObjectHandler() WebDAVServerBeforeCopyObjectEvent
func (obj *WebDAVServer) SetOnBeforeCopyObjectHandler(handlerFunc WebDAVServerBeforeCopyObjectEvent)

Remarks

The struct fires this event to notify the application that a Copy Object request was received. The OldPath and NewPath parameters specify the source and destination paths for the object to be copied. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a CopyObject call, allowing you to virtualize the copy operation.

BeforeCreateCalendar Event (WebDAVServer Component)

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

Syntax

// WebDAVServerBeforeCreateCalendarEventArgs carries the WebDAVServer BeforeCreateCalendar event's parameters.
type WebDAVServerBeforeCreateCalendarEventArgs struct {...}

func (args *WebDAVServerBeforeCreateCalendarEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeCreateCalendarEventArgs) Path() string
func (args *WebDAVServerBeforeCreateCalendarEventArgs) Action() int32
func (args *WebDAVServerBeforeCreateCalendarEventArgs) SetAction(value int32)

// WebDAVServerBeforeCreateCalendarEvent defines the signature of the WebDAVServer BeforeCreateCalendar event's handler function.
type WebDAVServerBeforeCreateCalendarEvent func(sender *WebDAVServer, args *WebDAVServerBeforeCreateCalendarEventArgs)

func (obj *WebDAVServer) GetOnBeforeCreateCalendarHandler() WebDAVServerBeforeCreateCalendarEvent
func (obj *WebDAVServer) SetOnBeforeCreateCalendarHandler(handlerFunc WebDAVServerBeforeCreateCalendarEvent)

Remarks

The struct fires this event to notify the application about a received Create Calendar request. The Path parameter specifies the location of the new calendar. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a CreateCalendar call, allowing you to virtualize the calendar creation operation.

BeforeCreateCollection Event (WebDAVServer Component)

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

Syntax

// WebDAVServerBeforeCreateCollectionEventArgs carries the WebDAVServer BeforeCreateCollection event's parameters.
type WebDAVServerBeforeCreateCollectionEventArgs struct {...}

func (args *WebDAVServerBeforeCreateCollectionEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeCreateCollectionEventArgs) Path() string
func (args *WebDAVServerBeforeCreateCollectionEventArgs) Action() int32
func (args *WebDAVServerBeforeCreateCollectionEventArgs) SetAction(value int32)

// WebDAVServerBeforeCreateCollectionEvent defines the signature of the WebDAVServer BeforeCreateCollection event's handler function.
type WebDAVServerBeforeCreateCollectionEvent func(sender *WebDAVServer, args *WebDAVServerBeforeCreateCollectionEventArgs)

func (obj *WebDAVServer) GetOnBeforeCreateCollectionHandler() WebDAVServerBeforeCreateCollectionEvent
func (obj *WebDAVServer) SetOnBeforeCreateCollectionHandler(handlerFunc WebDAVServerBeforeCreateCollectionEvent)

Remarks

The struct uses this event to notify the application about an incoming collection creation request. The Path parameter advises on the location of the new collection. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a CreateCollection call.

BeforeCustomRequest Event (WebDAVServer Component)

Notifies the application about an incoming custom request.

Syntax

// WebDAVServerBeforeCustomRequestEventArgs carries the WebDAVServer BeforeCustomRequest event's parameters.
type WebDAVServerBeforeCustomRequestEventArgs struct {...}

func (args *WebDAVServerBeforeCustomRequestEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeCustomRequestEventArgs) RequestMethod() string
func (args *WebDAVServerBeforeCustomRequestEventArgs) Path() string
func (args *WebDAVServerBeforeCustomRequestEventArgs) Action() int32
func (args *WebDAVServerBeforeCustomRequestEventArgs) SetAction(value int32)

// WebDAVServerBeforeCustomRequestEvent defines the signature of the WebDAVServer BeforeCustomRequest event's handler function.
type WebDAVServerBeforeCustomRequestEvent func(sender *WebDAVServer, args *WebDAVServerBeforeCustomRequestEventArgs)

func (obj *WebDAVServer) GetOnBeforeCustomRequestHandler() WebDAVServerBeforeCustomRequestEvent
func (obj *WebDAVServer) SetOnBeforeCustomRequestHandler(handlerFunc WebDAVServerBeforeCustomRequestEvent)

Remarks

The struct uses this event to notify the user code about an incoming custom request (a generic request, unknown to the server, and not covered by the other handlers). The RequestMethod parameter specifies the HTTP request method used (GET, POST, PUT, ...), and Path indicates the requested path. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a CustomRequest call, allowing you to respond to the request.

BeforeDownloadObject Event (WebDAVServer Component)

Fires when an object download request is received.

Syntax

// WebDAVServerBeforeDownloadObjectEventArgs carries the WebDAVServer BeforeDownloadObject event's parameters.
type WebDAVServerBeforeDownloadObjectEventArgs struct {...}

func (args *WebDAVServerBeforeDownloadObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeDownloadObjectEventArgs) Path() string
func (args *WebDAVServerBeforeDownloadObjectEventArgs) Action() int32
func (args *WebDAVServerBeforeDownloadObjectEventArgs) SetAction(value int32)

// WebDAVServerBeforeDownloadObjectEvent defines the signature of the WebDAVServer BeforeDownloadObject event's handler function.
type WebDAVServerBeforeDownloadObjectEvent func(sender *WebDAVServer, args *WebDAVServerBeforeDownloadObjectEventArgs)

func (obj *WebDAVServer) GetOnBeforeDownloadObjectHandler() WebDAVServerBeforeDownloadObjectEvent
func (obj *WebDAVServer) SetOnBeforeDownloadObjectHandler(handlerFunc WebDAVServerBeforeDownloadObjectEvent)

Remarks

The struct fires this event to notify the application about an incoming object download request. The Path parameter contains the path of the requested object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by DownloadObject, ReadObject, and DownloadObjectCompleted calls, allowing you to supply the object data to the client.

BeforeLockObject Event (WebDAVServer Component)

Fires when a lock request is received.

Syntax

// WebDAVServerBeforeLockObjectEventArgs carries the WebDAVServer BeforeLockObject event's parameters.
type WebDAVServerBeforeLockObjectEventArgs struct {...}

func (args *WebDAVServerBeforeLockObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeLockObjectEventArgs) Path() string
func (args *WebDAVServerBeforeLockObjectEventArgs) Action() int32
func (args *WebDAVServerBeforeLockObjectEventArgs) SetAction(value int32)

// WebDAVServerBeforeLockObjectEvent defines the signature of the WebDAVServer BeforeLockObject event's handler function.
type WebDAVServerBeforeLockObjectEvent func(sender *WebDAVServer, args *WebDAVServerBeforeLockObjectEventArgs)

func (obj *WebDAVServer) GetOnBeforeLockObjectHandler() WebDAVServerBeforeLockObjectEvent
func (obj *WebDAVServer) SetOnBeforeLockObjectHandler(handlerFunc WebDAVServerBeforeLockObjectEvent)

Remarks

The struct uses this event to notify the application that an object lock request was received. The Path parameter contains the path to be locked. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a LockObject call which expects you to perform the locking as required.

BeforeRefreshLock Event (WebDAVServer Component)

Reports the receipt of lock refresh request.

Syntax

// WebDAVServerBeforeRefreshLockEventArgs carries the WebDAVServer BeforeRefreshLock event's parameters.
type WebDAVServerBeforeRefreshLockEventArgs struct {...}

func (args *WebDAVServerBeforeRefreshLockEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeRefreshLockEventArgs) Path() string
func (args *WebDAVServerBeforeRefreshLockEventArgs) Action() int32
func (args *WebDAVServerBeforeRefreshLockEventArgs) SetAction(value int32)

// WebDAVServerBeforeRefreshLockEvent defines the signature of the WebDAVServer BeforeRefreshLock event's handler function.
type WebDAVServerBeforeRefreshLockEvent func(sender *WebDAVServer, args *WebDAVServerBeforeRefreshLockEventArgs)

func (obj *WebDAVServer) GetOnBeforeRefreshLockHandler() WebDAVServerBeforeRefreshLockEvent
func (obj *WebDAVServer) SetOnBeforeRefreshLockHandler(handlerFunc WebDAVServerBeforeRefreshLockEvent)

Remarks

Use this event to be notified about refresh requests for existing locks. The Path parameter contains the path on which to refresh the lock. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a RefreshLock call, allowing you to virtualize the operation.

BeforeRemoveObject Event (WebDAVServer Component)

Fires when an object deletion request is received.

Syntax

// WebDAVServerBeforeRemoveObjectEventArgs carries the WebDAVServer BeforeRemoveObject event's parameters.
type WebDAVServerBeforeRemoveObjectEventArgs struct {...}

func (args *WebDAVServerBeforeRemoveObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeRemoveObjectEventArgs) Path() string
func (args *WebDAVServerBeforeRemoveObjectEventArgs) Action() int32
func (args *WebDAVServerBeforeRemoveObjectEventArgs) SetAction(value int32)

// WebDAVServerBeforeRemoveObjectEvent defines the signature of the WebDAVServer BeforeRemoveObject event's handler function.
type WebDAVServerBeforeRemoveObjectEvent func(sender *WebDAVServer, args *WebDAVServerBeforeRemoveObjectEventArgs)

func (obj *WebDAVServer) GetOnBeforeRemoveObjectHandler() WebDAVServerBeforeRemoveObjectEvent
func (obj *WebDAVServer) SetOnBeforeRemoveObjectHandler(handlerFunc WebDAVServerBeforeRemoveObjectEvent)

Remarks

Use this event to track object deletion requests. The Path parameter contains the path of the object to be deleted. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a RemoveObject call, allowing you to virtualize the deletion operation.

BeforeRenameObject Event (WebDAVServer Component)

Reports object renaming requests.

Syntax

// WebDAVServerBeforeRenameObjectEventArgs carries the WebDAVServer BeforeRenameObject event's parameters.
type WebDAVServerBeforeRenameObjectEventArgs struct {...}

func (args *WebDAVServerBeforeRenameObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeRenameObjectEventArgs) OldPath() string
func (args *WebDAVServerBeforeRenameObjectEventArgs) NewPath() string
func (args *WebDAVServerBeforeRenameObjectEventArgs) Action() int32
func (args *WebDAVServerBeforeRenameObjectEventArgs) SetAction(value int32)

// WebDAVServerBeforeRenameObjectEvent defines the signature of the WebDAVServer BeforeRenameObject event's handler function.
type WebDAVServerBeforeRenameObjectEvent func(sender *WebDAVServer, args *WebDAVServerBeforeRenameObjectEventArgs)

func (obj *WebDAVServer) GetOnBeforeRenameObjectHandler() WebDAVServerBeforeRenameObjectEvent
func (obj *WebDAVServer) SetOnBeforeRenameObjectHandler(handlerFunc WebDAVServerBeforeRenameObjectEvent)

Remarks

The server uses this event to notify the application about incoming object rename requests. OldPath and NewPath contain the existing and the new path for the object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a RenameObject call, where your code is expected to perform the renaming operation.

BeforeRequest Event (WebDAVServer Component)

Fires before a DAV request is processed.

Syntax

// WebDAVServerBeforeRequestEventArgs carries the WebDAVServer BeforeRequest event's parameters.
type WebDAVServerBeforeRequestEventArgs struct {...}

func (args *WebDAVServerBeforeRequestEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeRequestEventArgs) HTTPMethod() string
func (args *WebDAVServerBeforeRequestEventArgs) URL() string
func (args *WebDAVServerBeforeRequestEventArgs) Accept() bool
func (args *WebDAVServerBeforeRequestEventArgs) SetAccept(value bool)

// WebDAVServerBeforeRequestEvent defines the signature of the WebDAVServer BeforeRequest event's handler function.
type WebDAVServerBeforeRequestEvent func(sender *WebDAVServer, args *WebDAVServerBeforeRequestEventArgs)

func (obj *WebDAVServer) GetOnBeforeRequestHandler() WebDAVServerBeforeRequestEvent
func (obj *WebDAVServer) SetOnBeforeRequestHandler(handlerFunc WebDAVServerBeforeRequestEvent)

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

Notifies the application about attribute change request.

Syntax

// WebDAVServerBeforeSetAttributesEventArgs carries the WebDAVServer BeforeSetAttributes event's parameters.
type WebDAVServerBeforeSetAttributesEventArgs struct {...}

func (args *WebDAVServerBeforeSetAttributesEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeSetAttributesEventArgs) Path() string
func (args *WebDAVServerBeforeSetAttributesEventArgs) Action() int32
func (args *WebDAVServerBeforeSetAttributesEventArgs) SetAction(value int32)

// WebDAVServerBeforeSetAttributesEvent defines the signature of the WebDAVServer BeforeSetAttributes event's handler function.
type WebDAVServerBeforeSetAttributesEvent func(sender *WebDAVServer, args *WebDAVServerBeforeSetAttributesEventArgs)

func (obj *WebDAVServer) GetOnBeforeSetAttributesHandler() WebDAVServerBeforeSetAttributesEvent
func (obj *WebDAVServer) SetOnBeforeSetAttributesHandler(handlerFunc WebDAVServerBeforeSetAttributesEvent)

Remarks

Use this event to react to object attributes change requests. The Path parameter contains the object path. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a series of SetAttribute and/or ClearAttribute calls, for each attribute to be set or cleared.

BeforeUnlockObject Event (WebDAVServer Component)

Fires when an unlock request is received.

Syntax

// WebDAVServerBeforeUnlockObjectEventArgs carries the WebDAVServer BeforeUnlockObject event's parameters.
type WebDAVServerBeforeUnlockObjectEventArgs struct {...}

func (args *WebDAVServerBeforeUnlockObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeUnlockObjectEventArgs) Path() string
func (args *WebDAVServerBeforeUnlockObjectEventArgs) Action() int32
func (args *WebDAVServerBeforeUnlockObjectEventArgs) SetAction(value int32)

// WebDAVServerBeforeUnlockObjectEvent defines the signature of the WebDAVServer BeforeUnlockObject event's handler function.
type WebDAVServerBeforeUnlockObjectEvent func(sender *WebDAVServer, args *WebDAVServerBeforeUnlockObjectEventArgs)

func (obj *WebDAVServer) GetOnBeforeUnlockObjectHandler() WebDAVServerBeforeUnlockObjectEvent
func (obj *WebDAVServer) SetOnBeforeUnlockObjectHandler(handlerFunc WebDAVServerBeforeUnlockObjectEvent)

Remarks

The struct uses this event to notify the application about the received unlock request. The Path parameter contains the path to be unlocked. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by a UnlockObject call.

BeforeUploadObject Event (WebDAVServer Component)

Fires when an object upload request is received.

Syntax

// WebDAVServerBeforeUploadObjectEventArgs carries the WebDAVServer BeforeUploadObject event's parameters.
type WebDAVServerBeforeUploadObjectEventArgs struct {...}

func (args *WebDAVServerBeforeUploadObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerBeforeUploadObjectEventArgs) Path() string
func (args *WebDAVServerBeforeUploadObjectEventArgs) Action() int32
func (args *WebDAVServerBeforeUploadObjectEventArgs) SetAction(value int32)

// WebDAVServerBeforeUploadObjectEvent defines the signature of the WebDAVServer BeforeUploadObject event's handler function.
type WebDAVServerBeforeUploadObjectEvent func(sender *WebDAVServer, args *WebDAVServerBeforeUploadObjectEventArgs)

func (obj *WebDAVServer) GetOnBeforeUploadObjectHandler() WebDAVServerBeforeUploadObjectEvent
func (obj *WebDAVServer) SetOnBeforeUploadObjectHandler(handlerFunc WebDAVServerBeforeUploadObjectEvent)

Remarks

The struct fires this event to notify the application about an incoming object upload request. The Path parameter contains the path of the requested object. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code.

Choose Action as one of the following values:


fraAuto	`1`	Handle the requested action automatically by the server
fraCustom	`2`	Override the action using the user code logic
fraAbort	`3`	Abort the requested action

If fraCustom Action is chosen, this event will be followed by UploadObject, WriteObject, and UploadObjectCompleted calls, allowing your code to process/store the object data.

ClearAttribute Event (WebDAVServer Component)

Reports an attribute clearance request.

Syntax

// WebDAVServerClearAttributeEventArgs carries the WebDAVServer ClearAttribute event's parameters.
type WebDAVServerClearAttributeEventArgs struct {...}

func (args *WebDAVServerClearAttributeEventArgs) ConnectionID() int64
func (args *WebDAVServerClearAttributeEventArgs) Path() string
func (args *WebDAVServerClearAttributeEventArgs) NS() string
func (args *WebDAVServerClearAttributeEventArgs) Name() string
func (args *WebDAVServerClearAttributeEventArgs) OperationStatus() int32
func (args *WebDAVServerClearAttributeEventArgs) SetOperationStatus(value int32)

// WebDAVServerClearAttributeEvent defines the signature of the WebDAVServer ClearAttribute event's handler function.
type WebDAVServerClearAttributeEvent func(sender *WebDAVServer, args *WebDAVServerClearAttributeEventArgs)

func (obj *WebDAVServer) GetOnClearAttributeHandler() WebDAVServerClearAttributeEvent
func (obj *WebDAVServer) SetOnClearAttributeHandler(handlerFunc WebDAVServerClearAttributeEvent)

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

Reports an accepted connection.

Syntax

// WebDAVServerConnectEventArgs carries the WebDAVServer Connect event's parameters.
type WebDAVServerConnectEventArgs struct {...}

func (args *WebDAVServerConnectEventArgs) ConnectionID() int64
func (args *WebDAVServerConnectEventArgs) RemoteAddress() string
func (args *WebDAVServerConnectEventArgs) RemotePort() int32
// WebDAVServerConnectEvent defines the signature of the WebDAVServer Connect event's handler function.
type WebDAVServerConnectEvent func(sender *WebDAVServer, args *WebDAVServerConnectEventArgs)

func (obj *WebDAVServer) GetOnConnectHandler() WebDAVServerConnectEvent
func (obj *WebDAVServer) SetOnConnectHandler(handlerFunc WebDAVServerConnectEvent)

Remarks

struct fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as GetRequest or AuthAttempt.

CopyObject Event (WebDAVServer Component)

Lets the application handle the Copy Object request.

Syntax

// WebDAVServerCopyObjectEventArgs carries the WebDAVServer CopyObject event's parameters.
type WebDAVServerCopyObjectEventArgs struct {...}

func (args *WebDAVServerCopyObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerCopyObjectEventArgs) OldPath() string
func (args *WebDAVServerCopyObjectEventArgs) NewPath() string
func (args *WebDAVServerCopyObjectEventArgs) Overwrite() bool
func (args *WebDAVServerCopyObjectEventArgs) Depth() int32
func (args *WebDAVServerCopyObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerCopyObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerCopyObjectEvent defines the signature of the WebDAVServer CopyObject event's handler function.
type WebDAVServerCopyObjectEvent func(sender *WebDAVServer, args *WebDAVServerCopyObjectEventArgs)

func (obj *WebDAVServer) GetOnCopyObjectHandler() WebDAVServerCopyObjectEvent
func (obj *WebDAVServer) SetOnCopyObjectHandler(handlerFunc WebDAVServerCopyObjectEvent)

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

Lets the application handle a calendar creation request.

Syntax

// WebDAVServerCreateCalendarEventArgs carries the WebDAVServer CreateCalendar event's parameters.
type WebDAVServerCreateCalendarEventArgs struct {...}

func (args *WebDAVServerCreateCalendarEventArgs) ConnectionID() int64
func (args *WebDAVServerCreateCalendarEventArgs) Path() string
func (args *WebDAVServerCreateCalendarEventArgs) OperationStatus() int32
func (args *WebDAVServerCreateCalendarEventArgs) SetOperationStatus(value int32)

// WebDAVServerCreateCalendarEvent defines the signature of the WebDAVServer CreateCalendar event's handler function.
type WebDAVServerCreateCalendarEvent func(sender *WebDAVServer, args *WebDAVServerCreateCalendarEventArgs)

func (obj *WebDAVServer) GetOnCreateCalendarHandler() WebDAVServerCreateCalendarEvent
func (obj *WebDAVServer) SetOnCreateCalendarHandler(handlerFunc WebDAVServerCreateCalendarEvent)

Remarks

Use this method to respond to a calendar creation request with a custom action. This event fires if fraCustom action was returned from the preceding BeforeCreateCalendar call.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


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

CreateCollection Event (WebDAVServer Component)

Lets the application respond to collection creation request.

Syntax

// WebDAVServerCreateCollectionEventArgs carries the WebDAVServer CreateCollection event's parameters.
type WebDAVServerCreateCollectionEventArgs struct {...}

func (args *WebDAVServerCreateCollectionEventArgs) ConnectionID() int64
func (args *WebDAVServerCreateCollectionEventArgs) Path() string
func (args *WebDAVServerCreateCollectionEventArgs) OperationStatus() int32
func (args *WebDAVServerCreateCollectionEventArgs) SetOperationStatus(value int32)

// WebDAVServerCreateCollectionEvent defines the signature of the WebDAVServer CreateCollection event's handler function.
type WebDAVServerCreateCollectionEvent func(sender *WebDAVServer, args *WebDAVServerCreateCollectionEventArgs)

func (obj *WebDAVServer) GetOnCreateCollectionHandler() WebDAVServerCreateCollectionEvent
func (obj *WebDAVServer) SetOnCreateCollectionHandler(handlerFunc WebDAVServerCreateCollectionEvent)

Remarks

The struct uses this event to let the application respond to collection creation requests. This event fires if fraCustom action was returned from the preceding BeforeCreateCollection call. The handler of this event is expected to create a new collection at Path.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


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

CustomRequest Event (WebDAVServer Component)

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

Syntax

// WebDAVServerCustomRequestEventArgs carries the WebDAVServer CustomRequest event's parameters.
type WebDAVServerCustomRequestEventArgs struct {...}

func (args *WebDAVServerCustomRequestEventArgs) ConnectionID() int64
func (args *WebDAVServerCustomRequestEventArgs) RequestMethod() string
func (args *WebDAVServerCustomRequestEventArgs) Path() string
func (args *WebDAVServerCustomRequestEventArgs) OperationStatus() int32
func (args *WebDAVServerCustomRequestEventArgs) SetOperationStatus(value int32)

// WebDAVServerCustomRequestEvent defines the signature of the WebDAVServer CustomRequest event's handler function.
type WebDAVServerCustomRequestEvent func(sender *WebDAVServer, args *WebDAVServerCustomRequestEventArgs)

func (obj *WebDAVServer) GetOnCustomRequestHandler() WebDAVServerCustomRequestEvent
func (obj *WebDAVServer) SetOnCustomRequestHandler(handlerFunc WebDAVServerCustomRequestEvent)

Remarks

This event allows the application to respond in a virtualized manner to non-standard DAV requests. It will fire if fraCustom action was selected in the earlier BeforeCustomRequest call.

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

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


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

Data Event (WebDAVServer Component)

Supplies a data chunk received from a client.

Syntax

// WebDAVServerDataEventArgs carries the WebDAVServer Data event's parameters.
type WebDAVServerDataEventArgs struct {...}

func (args *WebDAVServerDataEventArgs) ConnectionID() int64
func (args *WebDAVServerDataEventArgs) Buffer() []byte
// WebDAVServerDataEvent defines the signature of the WebDAVServer Data event's handler function.
type WebDAVServerDataEvent func(sender *WebDAVServer, args *WebDAVServerDataEventArgs)

func (obj *WebDAVServer) GetOnDataHandler() WebDAVServerDataEvent
func (obj *WebDAVServer) SetOnDataHandler(handlerFunc WebDAVServerDataEvent)

Remarks

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

Disconnect Event (WebDAVServer Component)

Fires to report a disconnected client.

Syntax

// WebDAVServerDisconnectEventArgs carries the WebDAVServer Disconnect event's parameters.
type WebDAVServerDisconnectEventArgs struct {...}

func (args *WebDAVServerDisconnectEventArgs) ConnectionID() int64
// WebDAVServerDisconnectEvent defines the signature of the WebDAVServer Disconnect event's handler function.
type WebDAVServerDisconnectEvent func(sender *WebDAVServer, args *WebDAVServerDisconnectEventArgs)

func (obj *WebDAVServer) GetOnDisconnectHandler() WebDAVServerDisconnectEvent
func (obj *WebDAVServer) SetOnDisconnectHandler(handlerFunc WebDAVServerDisconnectEvent)

Remarks

struct fires this event when a connected client disconnects.

DownloadObject Event (WebDAVServer Component)

Allows the application respond to Download Object request.

Syntax

// WebDAVServerDownloadObjectEventArgs carries the WebDAVServer DownloadObject event's parameters.
type WebDAVServerDownloadObjectEventArgs struct {...}

func (args *WebDAVServerDownloadObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerDownloadObjectEventArgs) Path() string
func (args *WebDAVServerDownloadObjectEventArgs) RestartAt() int64
func (args *WebDAVServerDownloadObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerDownloadObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerDownloadObjectEvent defines the signature of the WebDAVServer DownloadObject event's handler function.
type WebDAVServerDownloadObjectEvent func(sender *WebDAVServer, args *WebDAVServerDownloadObjectEventArgs)

func (obj *WebDAVServer) GetOnDownloadObjectHandler() WebDAVServerDownloadObjectEvent
func (obj *WebDAVServer) SetOnDownloadObjectHandler(handlerFunc WebDAVServerDownloadObjectEvent)

Remarks

Use this event to implement custom handler of the Download operation. This event is followed by a series of ReadObject calls, which are then followed by DownloadObjectCompleted that signifies completion of the transfer operation.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


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

DownloadObjectCompleted Event (WebDAVServer Component)

This event is fired when a download operation completes.

Syntax

// WebDAVServerDownloadObjectCompletedEventArgs carries the WebDAVServer DownloadObjectCompleted event's parameters.
type WebDAVServerDownloadObjectCompletedEventArgs struct {...}

func (args *WebDAVServerDownloadObjectCompletedEventArgs) ConnectionID() int64
func (args *WebDAVServerDownloadObjectCompletedEventArgs) Path() string
func (args *WebDAVServerDownloadObjectCompletedEventArgs) OperationStatus() int32
func (args *WebDAVServerDownloadObjectCompletedEventArgs) SetOperationStatus(value int32)

// WebDAVServerDownloadObjectCompletedEvent defines the signature of the WebDAVServer DownloadObjectCompleted event's handler function.
type WebDAVServerDownloadObjectCompletedEvent func(sender *WebDAVServer, args *WebDAVServerDownloadObjectCompletedEventArgs)

func (obj *WebDAVServer) GetOnDownloadObjectCompletedHandler() WebDAVServerDownloadObjectCompletedEvent
func (obj *WebDAVServer) SetOnDownloadObjectCompletedHandler(handlerFunc WebDAVServerDownloadObjectCompletedEvent)

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

Information about errors during data delivery.

Syntax

// WebDAVServerErrorEventArgs carries the WebDAVServer Error event's parameters.
type WebDAVServerErrorEventArgs struct {...}

func (args *WebDAVServerErrorEventArgs) ConnectionID() int64
func (args *WebDAVServerErrorEventArgs) ErrorCode() int32
func (args *WebDAVServerErrorEventArgs) Fatal() bool
func (args *WebDAVServerErrorEventArgs) Remote() bool
func (args *WebDAVServerErrorEventArgs) Description() string
// WebDAVServerErrorEvent defines the signature of the WebDAVServer Error event's handler function.
type WebDAVServerErrorEvent func(sender *WebDAVServer, args *WebDAVServerErrorEventArgs)

func (obj *WebDAVServer) GetOnErrorHandler() WebDAVServerErrorEvent
func (obj *WebDAVServer) SetOnErrorHandler(handlerFunc WebDAVServerErrorEvent)

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the HTTPS section.

ExternalSign Event (WebDAVServer Component)

Handles remote or external signing initiated by the server protocol.

Syntax

// WebDAVServerExternalSignEventArgs carries the WebDAVServer ExternalSign event's parameters.
type WebDAVServerExternalSignEventArgs struct {...}

func (args *WebDAVServerExternalSignEventArgs) ConnectionID() int64
func (args *WebDAVServerExternalSignEventArgs) OperationId() string
func (args *WebDAVServerExternalSignEventArgs) HashAlgorithm() string
func (args *WebDAVServerExternalSignEventArgs) Pars() string
func (args *WebDAVServerExternalSignEventArgs) Data() string
func (args *WebDAVServerExternalSignEventArgs) SignedData() string
func (args *WebDAVServerExternalSignEventArgs) SetSignedData(value string)

// WebDAVServerExternalSignEvent defines the signature of the WebDAVServer ExternalSign event's handler function.
type WebDAVServerExternalSignEvent func(sender *WebDAVServer, args *WebDAVServerExternalSignEventArgs)

func (obj *WebDAVServer) GetOnExternalSignHandler() WebDAVServerExternalSignEvent
func (obj *WebDAVServer) SetOnExternalSignHandler(handlerFunc WebDAVServerExternalSignEvent)

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 struct via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The struct uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FileError Event (WebDAVServer Component)

Reports a file access error to the application.

Syntax

// WebDAVServerFileErrorEventArgs carries the WebDAVServer FileError event's parameters.
type WebDAVServerFileErrorEventArgs struct {...}

func (args *WebDAVServerFileErrorEventArgs) ConnectionID() int64
func (args *WebDAVServerFileErrorEventArgs) FileName() string
func (args *WebDAVServerFileErrorEventArgs) ErrorCode() int32
// WebDAVServerFileErrorEvent defines the signature of the WebDAVServer FileError event's handler function.
type WebDAVServerFileErrorEvent func(sender *WebDAVServer, args *WebDAVServerFileErrorEventArgs)

func (obj *WebDAVServer) GetOnFileErrorHandler() WebDAVServerFileErrorEvent
func (obj *WebDAVServer) SetOnFileErrorHandler(handlerFunc WebDAVServerFileErrorEvent)

Remarks

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

HeadersPrepared Event (WebDAVServer Component)

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

Syntax

// WebDAVServerHeadersPreparedEventArgs carries the WebDAVServer HeadersPrepared event's parameters.
type WebDAVServerHeadersPreparedEventArgs struct {...}

func (args *WebDAVServerHeadersPreparedEventArgs) ConnectionID() int64
// WebDAVServerHeadersPreparedEvent defines the signature of the WebDAVServer HeadersPrepared event's handler function.
type WebDAVServerHeadersPreparedEvent func(sender *WebDAVServer, args *WebDAVServerHeadersPreparedEventArgs)

func (obj *WebDAVServer) GetOnHeadersPreparedHandler() WebDAVServerHeadersPreparedEvent
func (obj *WebDAVServer) SetOnHeadersPreparedHandler(handlerFunc WebDAVServerHeadersPreparedEvent)

Remarks

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

Use GetResponseHeader method with an empty header name to get the whole response header.

ListAttributes Event (WebDAVServer Component)

Requests object attributes from the application in fraCustom handling mode.

Syntax

// WebDAVServerListAttributesEventArgs carries the WebDAVServer ListAttributes event's parameters.
type WebDAVServerListAttributesEventArgs struct {...}

func (args *WebDAVServerListAttributesEventArgs) ConnectionID() int64
func (args *WebDAVServerListAttributesEventArgs) Path() string
func (args *WebDAVServerListAttributesEventArgs) Attributes() string
func (args *WebDAVServerListAttributesEventArgs) SetAttributes(value string)

// WebDAVServerListAttributesEvent defines the signature of the WebDAVServer ListAttributes event's handler function.
type WebDAVServerListAttributesEvent func(sender *WebDAVServer, args *WebDAVServerListAttributesEventArgs)

func (obj *WebDAVServer) GetOnListAttributesHandler() WebDAVServerListAttributesEvent
func (obj *WebDAVServer) SetOnListAttributesHandler(handlerFunc WebDAVServerListAttributesEvent)

Remarks

The struct 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 struct may request values for individual attributes via a series of ReadAttribute calls.

This event only fires if fraCustom action type was returned from the preceding BeforeBrowse event call.

ListSubObjects Event (WebDAVServer Component)

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

Syntax

// WebDAVServerListSubObjectsEventArgs carries the WebDAVServer ListSubObjects event's parameters.
type WebDAVServerListSubObjectsEventArgs struct {...}

func (args *WebDAVServerListSubObjectsEventArgs) ConnectionID() int64
func (args *WebDAVServerListSubObjectsEventArgs) Path() string
func (args *WebDAVServerListSubObjectsEventArgs) Recursive() bool
func (args *WebDAVServerListSubObjectsEventArgs) Objects() string
func (args *WebDAVServerListSubObjectsEventArgs) SetObjects(value string)

func (args *WebDAVServerListSubObjectsEventArgs) OperationStatus() int32
func (args *WebDAVServerListSubObjectsEventArgs) SetOperationStatus(value int32)

// WebDAVServerListSubObjectsEvent defines the signature of the WebDAVServer ListSubObjects event's handler function.
type WebDAVServerListSubObjectsEvent func(sender *WebDAVServer, args *WebDAVServerListSubObjectsEventArgs)

func (obj *WebDAVServer) GetOnListSubObjectsHandler() WebDAVServerListSubObjectsEvent
func (obj *WebDAVServer) SetOnListSubObjectsHandler(handlerFunc WebDAVServerListSubObjectsEvent)

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

Virtualizes the object locking operation.

Syntax

// WebDAVServerLockObjectEventArgs carries the WebDAVServer LockObject event's parameters.
type WebDAVServerLockObjectEventArgs struct {...}

func (args *WebDAVServerLockObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerLockObjectEventArgs) Path() string
func (args *WebDAVServerLockObjectEventArgs) Owner() string
func (args *WebDAVServerLockObjectEventArgs) Exclusive() bool
func (args *WebDAVServerLockObjectEventArgs) Depth() int32
func (args *WebDAVServerLockObjectEventArgs) Timeout() int64
func (args *WebDAVServerLockObjectEventArgs) Token() string
func (args *WebDAVServerLockObjectEventArgs) SetToken(value string)

// WebDAVServerLockObjectEvent defines the signature of the WebDAVServer LockObject event's handler function.
type WebDAVServerLockObjectEvent func(sender *WebDAVServer, args *WebDAVServerLockObjectEventArgs)

func (obj *WebDAVServer) GetOnLockObjectHandler() WebDAVServerLockObjectEvent
func (obj *WebDAVServer) SetOnLockObjectHandler(handlerFunc WebDAVServerLockObjectEvent)

Remarks

The struct uses this event to request a lock on the object at Path from the application. This event is only fired if fraCustom action was returned from the preceding BeforeLockObject call.

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

Notification Event (WebDAVServer Component)

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

Syntax

// WebDAVServerNotificationEventArgs carries the WebDAVServer Notification event's parameters.
type WebDAVServerNotificationEventArgs struct {...}

func (args *WebDAVServerNotificationEventArgs) EventID() string
func (args *WebDAVServerNotificationEventArgs) EventParam() string
// WebDAVServerNotificationEvent defines the signature of the WebDAVServer Notification event's handler function.
type WebDAVServerNotificationEvent func(sender *WebDAVServer, args *WebDAVServerNotificationEventArgs)

func (obj *WebDAVServer) GetOnNotificationHandler() WebDAVServerNotificationEvent
func (obj *WebDAVServer) SetOnNotificationHandler(handlerFunc WebDAVServerNotificationEvent)

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.

QueryQuota Event (WebDAVServer Component)

Reflects a quota enquiry by a client.

Syntax

// WebDAVServerQueryQuotaEventArgs carries the WebDAVServer QueryQuota event's parameters.
type WebDAVServerQueryQuotaEventArgs struct {...}

func (args *WebDAVServerQueryQuotaEventArgs) ConnectionID() int64
func (args *WebDAVServerQueryQuotaEventArgs) Username() string
func (args *WebDAVServerQueryQuotaEventArgs) Available() int64
func (args *WebDAVServerQueryQuotaEventArgs) SetAvailable(value int64)

func (args *WebDAVServerQueryQuotaEventArgs) Used() int64
func (args *WebDAVServerQueryQuotaEventArgs) SetUsed(value int64)

// WebDAVServerQueryQuotaEvent defines the signature of the WebDAVServer QueryQuota event's handler function.
type WebDAVServerQueryQuotaEvent func(sender *WebDAVServer, args *WebDAVServerQueryQuotaEventArgs)

func (obj *WebDAVServer) GetOnQueryQuotaHandler() WebDAVServerQueryQuotaEvent
func (obj *WebDAVServer) SetOnQueryQuotaHandler(handlerFunc WebDAVServerQueryQuotaEvent)

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

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

Syntax

// WebDAVServerReadAttributeEventArgs carries the WebDAVServer ReadAttribute event's parameters.
type WebDAVServerReadAttributeEventArgs struct {...}

func (args *WebDAVServerReadAttributeEventArgs) ConnectionID() int64
func (args *WebDAVServerReadAttributeEventArgs) Path() string
func (args *WebDAVServerReadAttributeEventArgs) NS() string
func (args *WebDAVServerReadAttributeEventArgs) Name() string
func (args *WebDAVServerReadAttributeEventArgs) Value() string
func (args *WebDAVServerReadAttributeEventArgs) SetValue(value string)

func (args *WebDAVServerReadAttributeEventArgs) OperationStatus() int32
func (args *WebDAVServerReadAttributeEventArgs) SetOperationStatus(value int32)

// WebDAVServerReadAttributeEvent defines the signature of the WebDAVServer ReadAttribute event's handler function.
type WebDAVServerReadAttributeEvent func(sender *WebDAVServer, args *WebDAVServerReadAttributeEventArgs)

func (obj *WebDAVServer) GetOnReadAttributeHandler() WebDAVServerReadAttributeEvent
func (obj *WebDAVServer) SetOnReadAttributeHandler(handlerFunc WebDAVServerReadAttributeEvent)

Remarks

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

This event only fires if fraCustom action type was returned from the preceding BeforeBrowse event call.


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

ReadObject Event (WebDAVServer Component)

Requests a piece of object data from the application.

Syntax

// WebDAVServerReadObjectEventArgs carries the WebDAVServer ReadObject event's parameters.
type WebDAVServerReadObjectEventArgs struct {...}

func (args *WebDAVServerReadObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerReadObjectEventArgs) Size() int32
func (args *WebDAVServerReadObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerReadObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerReadObjectEvent defines the signature of the WebDAVServer ReadObject event's handler function.
type WebDAVServerReadObjectEvent func(sender *WebDAVServer, args *WebDAVServerReadObjectEventArgs)

func (obj *WebDAVServer) GetOnReadObjectHandler() WebDAVServerReadObjectEvent
func (obj *WebDAVServer) SetOnReadObjectHandler(handlerFunc WebDAVServerReadObjectEvent)

Remarks

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

The handler of this event should read up to Size bytes from the downloaded object, and pass them to the component with a SetClientBuffer call.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:


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

RefreshLock Event (WebDAVServer Component)

Notifies the application about a lock refresh request.

Syntax

// WebDAVServerRefreshLockEventArgs carries the WebDAVServer RefreshLock event's parameters.
type WebDAVServerRefreshLockEventArgs struct {...}

func (args *WebDAVServerRefreshLockEventArgs) ConnectionID() int64
func (args *WebDAVServerRefreshLockEventArgs) Path() string
func (args *WebDAVServerRefreshLockEventArgs) Token() string
func (args *WebDAVServerRefreshLockEventArgs) Timeout() int64
func (args *WebDAVServerRefreshLockEventArgs) LockFound() bool
func (args *WebDAVServerRefreshLockEventArgs) SetLockFound(value bool)

// WebDAVServerRefreshLockEvent defines the signature of the WebDAVServer RefreshLock event's handler function.
type WebDAVServerRefreshLockEvent func(sender *WebDAVServer, args *WebDAVServerRefreshLockEventArgs)

func (obj *WebDAVServer) GetOnRefreshLockHandler() WebDAVServerRefreshLockEvent
func (obj *WebDAVServer) SetOnRefreshLockHandler(handlerFunc WebDAVServerRefreshLockEvent)

Remarks

The struct uses this event to request extension of a lock on the object at Path. This event only fires if fraCustom action was returned from the preceding BeforeRefreshLock call.

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

RemoveObject Event (WebDAVServer Component)

Notifies the application about object deletion requests.

Syntax

// WebDAVServerRemoveObjectEventArgs carries the WebDAVServer RemoveObject event's parameters.
type WebDAVServerRemoveObjectEventArgs struct {...}

func (args *WebDAVServerRemoveObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerRemoveObjectEventArgs) Path() string
func (args *WebDAVServerRemoveObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerRemoveObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerRemoveObjectEvent defines the signature of the WebDAVServer RemoveObject event's handler function.
type WebDAVServerRemoveObjectEvent func(sender *WebDAVServer, args *WebDAVServerRemoveObjectEventArgs)

func (obj *WebDAVServer) GetOnRemoveObjectHandler() WebDAVServerRemoveObjectEvent
func (obj *WebDAVServer) SetOnRemoveObjectHandler(handlerFunc WebDAVServerRemoveObjectEvent)

Remarks

The struct uses this event to notify the application about an incoming deletion request for the object at Path. This event only fires if fraCustom action was returned from the preceding BeforeRemoveObject call.

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


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

RenameObject Event (WebDAVServer Component)

Notifies the application about object name change requests.

Syntax

// WebDAVServerRenameObjectEventArgs carries the WebDAVServer RenameObject event's parameters.
type WebDAVServerRenameObjectEventArgs struct {...}

func (args *WebDAVServerRenameObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerRenameObjectEventArgs) OldPath() string
func (args *WebDAVServerRenameObjectEventArgs) NewPath() string
func (args *WebDAVServerRenameObjectEventArgs) Overwrite() bool
func (args *WebDAVServerRenameObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerRenameObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerRenameObjectEvent defines the signature of the WebDAVServer RenameObject event's handler function.
type WebDAVServerRenameObjectEvent func(sender *WebDAVServer, args *WebDAVServerRenameObjectEventArgs)

func (obj *WebDAVServer) GetOnRenameObjectHandler() WebDAVServerRenameObjectEvent
func (obj *WebDAVServer) SetOnRenameObjectHandler(handlerFunc WebDAVServerRenameObjectEvent)

Remarks

The struct uses this event to notify the application about an incoming rename request for the object at OldPath. The Overwrite parameter advises whether any objects currently existing at NewPath should be overwritten. This event only fires if fraCustom action was returned from the preceding BeforeRenameObject call.

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


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

ResourceAccess Event (WebDAVServer Component)

Reports an attempt to access a resource.

Syntax

// WebDAVServerResourceAccessEventArgs carries the WebDAVServer ResourceAccess event's parameters.
type WebDAVServerResourceAccessEventArgs struct {...}

func (args *WebDAVServerResourceAccessEventArgs) ConnectionID() int64
func (args *WebDAVServerResourceAccessEventArgs) HTTPMethod() string
func (args *WebDAVServerResourceAccessEventArgs) URI() string
func (args *WebDAVServerResourceAccessEventArgs) Allow() bool
func (args *WebDAVServerResourceAccessEventArgs) SetAllow(value bool)

func (args *WebDAVServerResourceAccessEventArgs) RedirectURI() string
func (args *WebDAVServerResourceAccessEventArgs) SetRedirectURI(value string)

// WebDAVServerResourceAccessEvent defines the signature of the WebDAVServer ResourceAccess event's handler function.
type WebDAVServerResourceAccessEvent func(sender *WebDAVServer, args *WebDAVServerResourceAccessEventArgs)

func (obj *WebDAVServer) GetOnResourceAccessHandler() WebDAVServerResourceAccessEvent
func (obj *WebDAVServer) SetOnResourceAccessHandler(handlerFunc WebDAVServerResourceAccessEvent)

Remarks

The struct 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 struct 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 struct will automatically send a "found" status code (302). If Allow is set to false, the value of RedirectURI is ignored.

SetAttribute Event (WebDAVServer Component)

Lets the application customize attribute assignment requests.

Syntax

// WebDAVServerSetAttributeEventArgs carries the WebDAVServer SetAttribute event's parameters.
type WebDAVServerSetAttributeEventArgs struct {...}

func (args *WebDAVServerSetAttributeEventArgs) ConnectionID() int64
func (args *WebDAVServerSetAttributeEventArgs) Path() string
func (args *WebDAVServerSetAttributeEventArgs) NS() string
func (args *WebDAVServerSetAttributeEventArgs) Name() string
func (args *WebDAVServerSetAttributeEventArgs) Value() string
func (args *WebDAVServerSetAttributeEventArgs) OperationStatus() int32
func (args *WebDAVServerSetAttributeEventArgs) SetOperationStatus(value int32)

// WebDAVServerSetAttributeEvent defines the signature of the WebDAVServer SetAttribute event's handler function.
type WebDAVServerSetAttributeEvent func(sender *WebDAVServer, args *WebDAVServerSetAttributeEventArgs)

func (obj *WebDAVServer) GetOnSetAttributeHandler() WebDAVServerSetAttributeEvent
func (obj *WebDAVServer) SetOnSetAttributeHandler(handlerFunc WebDAVServerSetAttributeEvent)

Remarks

The struct uses this event to pass attribute assignment requests to the application. This event may fire multiple times after a BeforeSetAttributes call, one for each attribute, if fraCustom action was chosen.

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


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

TLSCertValidate Event (WebDAVServer Component)

Fires when a client certificate needs to be validated.

Syntax

// WebDAVServerTLSCertValidateEventArgs carries the WebDAVServer TLSCertValidate event's parameters.
type WebDAVServerTLSCertValidateEventArgs struct {...}

func (args *WebDAVServerTLSCertValidateEventArgs) ConnectionID() int64
func (args *WebDAVServerTLSCertValidateEventArgs) Accept() bool
func (args *WebDAVServerTLSCertValidateEventArgs) SetAccept(value bool)

// WebDAVServerTLSCertValidateEvent defines the signature of the WebDAVServer TLSCertValidate event's handler function.
type WebDAVServerTLSCertValidateEvent func(sender *WebDAVServer, args *WebDAVServerTLSCertValidateEventArgs)

func (obj *WebDAVServer) GetOnTLSCertValidateHandler() WebDAVServerTLSCertValidateEvent
func (obj *WebDAVServer) SetOnTLSCertValidateHandler(handlerFunc WebDAVServerTLSCertValidateEvent)

Remarks

struct 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 Component)

Reports the setup of a TLS session.

Syntax

// WebDAVServerTLSEstablishedEventArgs carries the WebDAVServer TLSEstablished event's parameters.
type WebDAVServerTLSEstablishedEventArgs struct {...}

func (args *WebDAVServerTLSEstablishedEventArgs) ConnectionID() int64
// WebDAVServerTLSEstablishedEvent defines the signature of the WebDAVServer TLSEstablished event's handler function.
type WebDAVServerTLSEstablishedEvent func(sender *WebDAVServer, args *WebDAVServerTLSEstablishedEventArgs)

func (obj *WebDAVServer) GetOnTLSEstablishedHandler() WebDAVServerTLSEstablishedEvent
func (obj *WebDAVServer) SetOnTLSEstablishedHandler(handlerFunc WebDAVServerTLSEstablishedEvent)

Remarks

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

TLSHandshake Event (WebDAVServer Component)

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

Syntax

// WebDAVServerTLSHandshakeEventArgs carries the WebDAVServer TLSHandshake event's parameters.
type WebDAVServerTLSHandshakeEventArgs struct {...}

func (args *WebDAVServerTLSHandshakeEventArgs) ConnectionID() int64
func (args *WebDAVServerTLSHandshakeEventArgs) ServerName() string
func (args *WebDAVServerTLSHandshakeEventArgs) Abort() bool
func (args *WebDAVServerTLSHandshakeEventArgs) SetAbort(value bool)

// WebDAVServerTLSHandshakeEvent defines the signature of the WebDAVServer TLSHandshake event's handler function.
type WebDAVServerTLSHandshakeEvent func(sender *WebDAVServer, args *WebDAVServerTLSHandshakeEventArgs)

func (obj *WebDAVServer) GetOnTLSHandshakeHandler() WebDAVServerTLSHandshakeEvent
func (obj *WebDAVServer) SetOnTLSHandshakeHandler(handlerFunc WebDAVServerTLSHandshakeEvent)

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

Requests a pre-shared key for TLS-PSK.

Syntax

// WebDAVServerTLSPSKEventArgs carries the WebDAVServer TLSPSK event's parameters.
type WebDAVServerTLSPSKEventArgs struct {...}

func (args *WebDAVServerTLSPSKEventArgs) ConnectionID() int64
func (args *WebDAVServerTLSPSKEventArgs) Identity() string
func (args *WebDAVServerTLSPSKEventArgs) PSK() string
func (args *WebDAVServerTLSPSKEventArgs) SetPSK(value string)

func (args *WebDAVServerTLSPSKEventArgs) Ciphersuite() string
func (args *WebDAVServerTLSPSKEventArgs) SetCiphersuite(value string)

// WebDAVServerTLSPSKEvent defines the signature of the WebDAVServer TLSPSK event's handler function.
type WebDAVServerTLSPSKEvent func(sender *WebDAVServer, args *WebDAVServerTLSPSKEventArgs)

func (obj *WebDAVServer) GetOnTLSPSKHandler() WebDAVServerTLSPSKEvent
func (obj *WebDAVServer) SetOnTLSPSKHandler(handlerFunc WebDAVServerTLSPSKEvent)

Remarks

The struct 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 Component)

Reports closure of a TLS session.

Syntax

// WebDAVServerTLSShutdownEventArgs carries the WebDAVServer TLSShutdown event's parameters.
type WebDAVServerTLSShutdownEventArgs struct {...}

func (args *WebDAVServerTLSShutdownEventArgs) ConnectionID() int64
// WebDAVServerTLSShutdownEvent defines the signature of the WebDAVServer TLSShutdown event's handler function.
type WebDAVServerTLSShutdownEvent func(sender *WebDAVServer, args *WebDAVServerTLSShutdownEventArgs)

func (obj *WebDAVServer) GetOnTLSShutdownHandler() WebDAVServerTLSShutdownEvent
func (obj *WebDAVServer) SetOnTLSShutdownHandler(handlerFunc WebDAVServerTLSShutdownEvent)

Remarks

The struct fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

UnlockObject Event (WebDAVServer Component)

Virtualizes the object unlocking operation.

Syntax

// WebDAVServerUnlockObjectEventArgs carries the WebDAVServer UnlockObject event's parameters.
type WebDAVServerUnlockObjectEventArgs struct {...}

func (args *WebDAVServerUnlockObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerUnlockObjectEventArgs) Path() string
func (args *WebDAVServerUnlockObjectEventArgs) Token() string
func (args *WebDAVServerUnlockObjectEventArgs) LockFound() bool
func (args *WebDAVServerUnlockObjectEventArgs) SetLockFound(value bool)

// WebDAVServerUnlockObjectEvent defines the signature of the WebDAVServer UnlockObject event's handler function.
type WebDAVServerUnlockObjectEvent func(sender *WebDAVServer, args *WebDAVServerUnlockObjectEventArgs)

func (obj *WebDAVServer) GetOnUnlockObjectHandler() WebDAVServerUnlockObjectEvent
func (obj *WebDAVServer) SetOnUnlockObjectHandler(handlerFunc WebDAVServerUnlockObjectEvent)

Remarks

The struct uses this event to notify the application of the incoming unlock request. This event only fires if fraCustom action was returned from the preceding BeforeUnlockObject call.

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

UploadObject Event (WebDAVServer Component)

Lets the application respond to the Upload Object request.

Syntax

// WebDAVServerUploadObjectEventArgs carries the WebDAVServer UploadObject event's parameters.
type WebDAVServerUploadObjectEventArgs struct {...}

func (args *WebDAVServerUploadObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerUploadObjectEventArgs) Path() string
func (args *WebDAVServerUploadObjectEventArgs) RestartAt() int64
func (args *WebDAVServerUploadObjectEventArgs) Append() bool
func (args *WebDAVServerUploadObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerUploadObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerUploadObjectEvent defines the signature of the WebDAVServer UploadObject event's handler function.
type WebDAVServerUploadObjectEvent func(sender *WebDAVServer, args *WebDAVServerUploadObjectEventArgs)

func (obj *WebDAVServer) GetOnUploadObjectHandler() WebDAVServerUploadObjectEvent
func (obj *WebDAVServer) SetOnUploadObjectHandler(handlerFunc WebDAVServerUploadObjectEvent)

Remarks

Use this event handler to respond to the received Upload Object request by reserving a place for the new object at Path. This event, if OperationStatus allows, will be followed by a series of WriteObject calls, passing object data in chunks, before a UploadObjectCompleted call signals completion of the upload operation.

Check the operation status, and alter it, if needed, through the OperationStatus parameter:


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

UploadObjectCompleted Event (WebDAVServer Component)

This event is fired when a upload operation completes.

Syntax

// WebDAVServerUploadObjectCompletedEventArgs carries the WebDAVServer UploadObjectCompleted event's parameters.
type WebDAVServerUploadObjectCompletedEventArgs struct {...}

func (args *WebDAVServerUploadObjectCompletedEventArgs) ConnectionID() int64
func (args *WebDAVServerUploadObjectCompletedEventArgs) Path() string
func (args *WebDAVServerUploadObjectCompletedEventArgs) OperationStatus() int32
func (args *WebDAVServerUploadObjectCompletedEventArgs) SetOperationStatus(value int32)

// WebDAVServerUploadObjectCompletedEvent defines the signature of the WebDAVServer UploadObjectCompleted event's handler function.
type WebDAVServerUploadObjectCompletedEvent func(sender *WebDAVServer, args *WebDAVServerUploadObjectCompletedEventArgs)

func (obj *WebDAVServer) GetOnUploadObjectCompletedHandler() WebDAVServerUploadObjectCompletedEvent
func (obj *WebDAVServer) SetOnUploadObjectCompletedHandler(handlerFunc WebDAVServerUploadObjectCompletedEvent)

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

Hands a piece of object data to the application.

Syntax

// WebDAVServerWriteObjectEventArgs carries the WebDAVServer WriteObject event's parameters.
type WebDAVServerWriteObjectEventArgs struct {...}

func (args *WebDAVServerWriteObjectEventArgs) ConnectionID() int64
func (args *WebDAVServerWriteObjectEventArgs) OperationStatus() int32
func (args *WebDAVServerWriteObjectEventArgs) SetOperationStatus(value int32)

// WebDAVServerWriteObjectEvent defines the signature of the WebDAVServer WriteObject event's handler function.
type WebDAVServerWriteObjectEvent func(sender *WebDAVServer, args *WebDAVServerWriteObjectEventArgs)

func (obj *WebDAVServer) GetOnWriteObjectHandler() WebDAVServerWriteObjectEvent
func (obj *WebDAVServer) SetOnWriteObjectHandler(handlerFunc WebDAVServerWriteObjectEvent)

Remarks

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

The handler of this event should retrieve the pending data buffer with a GetClientBuffer call, and write it to the end of the object that is being uploaded.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:


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

Config Settings (WebDAVServer Component)

The struct 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 struct, access to these internal properties is provided through the Config 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 struct.

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the struct.

Use this property to get cookies from the internal cookie storage of the struct 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 structs 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 structs.

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): 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: 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 struct. 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 struct) 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 struct is set to "local", the property returns/restores the rules from/to the internal storage of the struct. If StaticDNS of the struct 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 structs.

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: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

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

WebDAVServer Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)