SOAPClient Component

Properties Methods Events Config Settings Errors

The SOAPClient class sends SOAP messages.

Syntax

secureblackbox.SOAPClient

Remarks

The SOAPClient struct implements client-side functionality of the SOAP version 1.1 and 1.2 protocols over HTTP/HTTPS.

Property List

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


AttachmentBytes	Use this property to pass an attachment to class in the byte array form.
AttachmentFile	Specifies the attachment file to be sent with the request.
AuthTypes	Defines allowed HTTP authentication types.
BlockedCertCount	The number of records in the BlockedCert arrays.
BlockedCertBytes	Returns the raw certificate data in DER format.
BlockedCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ConnInfoAEADCipher	Indicates whether the encryption algorithm used is an AEAD cipher.
ConnInfoChainValidationDetails	The details of a certificate chain validation outcome.
ConnInfoChainValidationResult	The outcome of a certificate chain validation routine.
ConnInfoCiphersuite	The cipher suite employed by this connection.
ConnInfoClientAuthenticated	Specifies whether client authentication was performed during this connection.
ConnInfoClientAuthRequested	Specifies whether client authentication was requested during this connection.
ConnInfoConnectionEstablished	Indicates whether the connection has been established fully.
ConnInfoConnectionID	The unique identifier assigned to this connection.
ConnInfoDigestAlgorithm	The digest algorithm used in a TLS-enabled connection.
ConnInfoEncryptionAlgorithm	The symmetric encryption algorithm used in a TLS-enabled connection.
ConnInfoExportable	Indicates whether a TLS connection uses a reduced-strength exportable cipher.
ConnInfoGroup	The elliptic curve used in this connection.
ConnInfoID	The client connection's unique identifier.
ConnInfoKeyExchangeAlgorithm	The key exchange algorithm used in a TLS-enabled connection.
ConnInfoKeyExchangeKeyBits	The length of the key exchange key of a TLS-enabled connection.
ConnInfoPFSCipher	Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).
ConnInfoPreSharedIdentity	Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
ConnInfoPreSharedIdentityHint	A hint professed by the server to help the client select the PSK identity to use.
ConnInfoPublicKeyBits	The length of the public key.
ConnInfoRemoteAddress	The client's IP address.
ConnInfoRemotePort	The remote port of the client connection.
ConnInfoResumedSession	Indicates whether a TLS-enabled connection was spawned from another TLS connection.
ConnInfoSecureConnection	Indicates whether TLS or SSL is enabled for this connection.
ConnInfoServerAuthenticated	Indicates whether server authentication was performed during a TLS-enabled connection.
ConnInfoSignatureAlgorithm	The signature algorithm used in a TLS handshake.
ConnInfoSymmetricBlockSize	The block size of the symmetric algorithm used.
ConnInfoSymmetricKeyBits	The key length of the symmetric algorithm used.
ConnInfoTotalBytesReceived	The total number of bytes received over this connection.
ConnInfoTotalBytesSent	The total number of bytes sent over this connection.
ConnInfoValidationLog	Contains the server certificate's chain validation log.
ConnInfoVersion	Indicates the version of SSL/TLS protocol negotiated during this connection.
Encoding	Specifies SOAP message encoding.
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.
FaultActor	Specifies the entity that caused the fault.
FaultCode	Specifies the error code.
FaultDetail	Contains application-specific error information.
FaultString	Specifies a human-readable description of the fault.
FIPSMode	Reserved.
InputBytes	Use this property to pass the input to class in byte array form.
InputFile	A path to the file containing the SOAP message to be sent.
KeepAlivePolicy	Defines the keep-alive handling policy.
KnownCertCount	The number of records in the KnownCert arrays.
KnownCertBytes	Returns the raw certificate data in DER format.
KnownCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
KnownCRLCount	The number of records in the KnownCRL arrays.
KnownCRLBytes	Returns the raw CRL data in DER format.
KnownCRLHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
KnownOCSPCount	The number of records in the KnownOCSP arrays.
KnownOCSPBytes	A buffer containing the raw OCSP response data.
KnownOCSPHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
MimeType	Specifies the SOAP message MIME type.
OperationName	Specifies the SOAP operation name.
OperationNamespaceURI	Specifies the SOAP message operation namespace URI.
OperationResponseName	Specifies the operation name of the response message.
OperationResponseNamespaceURI	Specifies the response SOAP message operation namespace URI.
OperationResponseTextContent	Returns the text content of the response message.
OperationResponseXML	Returns the XML content of the response SOAP message.
OutputAttachmentBytes	Use this property to read the attachment received from the service.
OutputAttachmentFile	A path to a file where to save the attachment data.
OutputBytes	Use this property to read the output the class object has produced.
OutputFile	A file where the response will be saved.
ProxyAddress	The IP address of the proxy server.
ProxyAuthentication	The authentication type used by the proxy server.
ProxyPassword	The password to authenticate to the proxy server.
ProxyPort	The port on the proxy server to connect to.
ProxyType	The type of the proxy server.
ProxyRequestHeaders	Contains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBody	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeaders	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6	Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUsername	Specifies the username credential for proxy authentication.
ReasonPhrase	Contains the Reason Phrase element of the server's response.
ReqHeaderCount	The number of records in the ReqHeader arrays.
ReqHeaderCategory	Specifies the string category of the contained value.
ReqHeaderFormat	Specifies the format (encoding) of the value contained in the Value property.
ReqHeaderName	The name element in a (name, value) pair.
ReqHeaderValue	The value element in a (name, value) pair.
ReqParamsAccept	Specifies the Accept header property of the HTTP request.
ReqParamsAcceptCharset	Specifies the Accept-Charset header property of the HTTP request.
ReqParamsAcceptLanguage	Specifies the Accept-Language header property of the HTTP request.
ReqParamsAcceptRangeEnd	This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.
ReqParamsAcceptRangeStart	This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.
ReqParamsAuthorization	Specifies the Authorization header of the HTTP request.
ReqParamsConnection	Specifies the value to pass to the Connection header property of HTTP request.
ReqParamsContentLength	Specifies the size of the entity-body of the HTTP request.
ReqParamsContentRangeEnd	Specifies the upper bound used in the Content-Range header of the HTTP request.
ReqParamsContentRangeFullSize	Specifies the total length of the full entity-body of the HTTP request.
ReqParamsContentRangeStart	Specifies the lower bound used in the Content-Range header of the HTTP request.
ReqParamsContentType	The Content-Type header property of the HTTP request.
ReqParamsCookie	This header is expected to be assigned with cookies previously received from the server and stored by the client.
ReqParamsCustomHeaders	Assign any custom HTTP headers to be passed to the server to this property.
ReqParamsDate	The date and time of the request.
ReqParamsFrom	Contains the From header property of the HTTP request.
ReqParamsHost	This property contains the Host header property of the HTTP request.
ReqParamsHTTPVersion	Specifies the version of HTTP protocol to use: 1.
ReqParamsIfMatch	Contains the If-Match request header property.
ReqParamsIfModifiedSince	Contains the If-Modified-Since request header property.
ReqParamsIfNoneMatch	Contains the If-None-Match request header property.
ReqParamsIfUnmodifiedSince	Contains the If-Unmodified-Since request header property.
ReqParamsPassword	Assign this property with the user's password.
ReqParamsReferer	The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).
ReqParamsUserAgent	The User-Agent property of the HTTP request provides information about the software that initiates the request.
ReqParamsUsername	Assign this property with the user's login name.
RespHeaderCount	The number of records in the RespHeader arrays.
RespHeaderCategory	Specifies the string category of the contained value.
RespHeaderFormat	Specifies the format (encoding) of the value contained in the Value property.
RespHeaderName	The name element in a (name, value) pair.
RespHeaderValue	The value element in a (name, value) pair.
RespParamsContentLength	Indicates the length of the response content in bytes.
RespParamsContentType	Returns the content type of the server response, as included in the response headers.
RespParamsDate	The date and time at which the response was generated, in server time, in UTC.
RespParamsReasonPhrase	Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the status code.
RespParamsStatusCode	The server-generated status code of the request processing status.
SOAPAction	Specifies the SOAP action.
SOAPResponseType	The type of the response.
SOAPVersion	Specifies SOAP version.
SocketDNSMode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPort	Specifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeout	The timeout (in milliseconds) for each DNS query.
SocketDNSServers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeout	The timeout (in milliseconds) for the whole resolution process.
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.
StatusCode	Contains the Status Code element of the server's response.
TLSClientCertCount	The number of records in the TLSClientCert arrays.
TLSClientCertBytes	Returns the raw certificate data in DER format.
TLSClientCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertCount	The number of records in the TLSServerCert arrays.
TLSServerCertBytes	Returns the raw certificate data in DER format.
TLSServerCertFingerprint	Contains the fingerprint (a hash imprint) of this certificate.
TLSServerCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertIssuer	The common name of the certificate issuer (CA), typically a company name.
TLSServerCertIssuerRDN	A list of Property=Value pairs that uniquely identify the certificate issuer.
TLSServerCertKeyAlgorithm	Specifies the public key algorithm of this certificate.
TLSServerCertKeyBits	Returns the length of the public key in bits.
TLSServerCertKeyUsage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
TLSServerCertSelfSigned	Indicates whether the certificate is self-signed (root) or signed by an external CA.
TLSServerCertSerialNumber	Returns the certificate's serial number.
TLSServerCertSigAlgorithm	Indicates the algorithm that was used by the CA to sign this certificate.
TLSServerCertSubject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
TLSServerCertSubjectRDN	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
TLSServerCertValidFrom	The time point at which the certificate becomes valid, in UTC.
TLSServerCertValidTo	The time point at which the certificate expires, in UTC.
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.
TrustedCertCount	The number of records in the TrustedCert arrays.
TrustedCertBytes	Returns the raw certificate data in DER format.
TrustedCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.

Method List

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


Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
Reset	Resets the class settings.
SendMessage	Sends a SOAP message to the server.
SendMessageWithAttachments	Sends a SOAP message with attachment(s) to 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.


BeforeReceiveAttachment	Marks the start of receiving an attachment.
BeforeSendAttachment	Marks the start of sending an attachment.
Cookie	Fired to report a received cookie.
DocumentBegin	Marks the start of the incoming HTML document or file.
DocumentEnd	Marks the successful receipt of the incoming HTML document or file.
Error	Information about errors during data delivery.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
HeadersPrepared	Fires when the request headers have been formed and are about to be sent to the server.
HeadersReceived	Fires when the HTTP response headers have just been received from the server.
Notification	This event notifies the application about an underlying control flow event.
Progress	Fires periodically during the data transfer.
Redirection	Fires when the server suggests a redirect.
TLSCertNeeded	Fires when a remote TLS party requests a client certificate.
TLSCertValidate	This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablished	Fires when a TLS handshake with Host successfully completes.
TLSHandshake	Fires when a new TLS handshake is initiated, before the handshake commences.
TLSPSK	Notifies the application about the PSK key exchange.
TLSShutdown	Reports the graceful closure of a TLS connection.

Config Settings

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


AttachmentContentDescription	Specifies attachment content description.
AttachmentContentId	Specifies attachment content Id.
AttachmentContentType	Specifies attachment content type.
AttachmentFilename	Specifies attachment filename.
AuthStickToLastURL	TBD.
CachedCRLMaxAge	Specifies the maximum age of a cached CRL.
CachedCRLMaxAgeRatio	Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.
CachedCRLOverlapTime	Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.
CachedOCSPResponseMaxAge	Specifies the maximum age of a cached OCSP response.
CachedOCSPResponseMaxAgeRatio	Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.
CachedOCSPResponseOverlapTime	Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.
Cookies	TBD.
DefClientCookieFmt	TBD.
DeltaCRLPreference	Specifies whether complete or delta CRLs are preferred.
EvaluateSystemTrust	Enables or disables usage of the platform's built-in trust validation facilities.
FaultActor[Index]	Specifies who caused the fault.
FaultCode[Index]	Specifies the error code.
FaultCount	The number of faults.
FaultDetail[Index]	Contains application-specific error information.
FaultString[Index]	Specifies a human-readable description of fault.
FaultXML[Index]	Specifies the XML content of the fault.
ForceNTLMAuth	Activates and enforces NTLM authentication.
IgnoreCookieSecureFlag	TBD.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
IgnoreUnknownTransferEncodings	All incoming responses with unknown transfer encodings are ignored if this property is true.
KeepConnectionOpen	TBD.
MaxRedirections	The maximum number of HTTP redirects.
PersistentAuthHeader	Whether to resend NTLM negotiation on every request.
RelatedStartInfo	Specifies Start-Info parameter.
RelatedType	Specifies media type/subtype.
RequestCompressionGZip	Ask server to enforce GZip compression.
RequestCompressionLevel	Ask server to use the specified compression level.
RevocationCacheAgePolicy	Specifies a preset policy for cached CRL and OCSP response freshness settings.
SendBufferSize	Size of send buffer in bytes.
SkipInputProcessing	Whether to skip input processing.
SkipOutputParsing	Whether to skip output parsing.
SOAPPrefix	Specifies the signature prefix.
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.
SuppressRedirectionContent	Whether to suppress the redirection content.
TempPath	Path for storing temporary files.
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.
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.
TLSVersions	Returns the list of TLS versions enabled in the class.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
Use100Continue	Whether to use 100-continue for POST and PUT commands.
UseCompression	Enables compression capability.
UseEnvStorages	Enables or disables use of the environment storages.
UseKerberosAuth	TBD.
UseMicrosoftCTL	Enables or disables the automatic use of the Microsoft online certificate trust list.
UseSOAPAction	Whether to use SOAP Action.
UseSystemCertificates	Enables or disables the use of the system certificates.
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.

AttachmentBytes Property (SOAPClient Component)

Use this property to pass an attachment to class in the byte array form.

Syntax

func (obj *SOAPClient) AttachmentBytes() ([]byte, error)
func (obj *SOAPClient) SetAttachmentBytes(value []byte) error

Remarks

Assign a byte array containing the data to be processed to this property.

Data Type

[]byte

AttachmentFile Property (SOAPClient Component)

Specifies the attachment file to be sent with the request.

Syntax

func (obj *SOAPClient) AttachmentFile() (string, error)
func (obj *SOAPClient) SetAttachmentFile(value string) error

Default Value

Remarks

Provide a full path to the attachment file to be sent with the SOAP request. Use SendMessageWithAttachments method to send the request.

Subscribe to BeforeSendAttachment to pass more than one attachment.

Data Type

string

AuthTypes Property (SOAPClient Component)

Defines allowed HTTP authentication types.

Syntax

func (obj *SOAPClient) AuthTypes() (int32, error)
func (obj *SOAPClient) 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

BlockedCertCount Property (SOAPClient Component)

The number of records in the BlockedCert arrays.

Syntax

func (obj *SOAPClient) BlockedCertCount() (int32, error)
func (obj *SOAPClient) SetBlockedCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

BlockedCertBytes
BlockedCertHandle

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

Data Type

int32

BlockedCertBytes Property (SOAPClient Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SOAPClient) BlockedCertBytes(BlockedCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

[]byte

BlockedCertHandle Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) BlockedCertHandle(BlockedCertIndex int32) (int64, error)
func (obj *SOAPClient) SetBlockedCertHandle(BlockedCertIndex 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.

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 BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

Data Type

int64

ConnInfoAEADCipher Property (SOAPClient Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

func (obj *SOAPClient) ConnInfoAEADCipher() (bool, error)

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

ConnInfoChainValidationDetails Property (SOAPClient Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *SOAPClient) ConnInfoChainValidationDetails() (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

ConnInfoChainValidationResult Property (SOAPClient Component)

The outcome of a certificate chain validation routine.

Syntax

func (obj *SOAPClient) ConnInfoChainValidationResult() (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

ConnInfoCiphersuite Property (SOAPClient Component)

The cipher suite employed by this connection.

Syntax

func (obj *SOAPClient) ConnInfoCiphersuite() (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

ConnInfoClientAuthenticated Property (SOAPClient Component)

Specifies whether client authentication was performed during this connection.

Syntax

func (obj *SOAPClient) ConnInfoClientAuthenticated() (bool, error)

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

ConnInfoClientAuthRequested Property (SOAPClient Component)

Specifies whether client authentication was requested during this connection.

Syntax

func (obj *SOAPClient) ConnInfoClientAuthRequested() (bool, error)

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

ConnInfoConnectionEstablished Property (SOAPClient Component)

Indicates whether the connection has been established fully.

Syntax

func (obj *SOAPClient) ConnInfoConnectionEstablished() (bool, error)

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

ConnInfoConnectionID Property (SOAPClient Component)

The unique identifier assigned to this connection.

Syntax

func (obj *SOAPClient) ConnInfoConnectionID() ([]byte, error)

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

[]byte

ConnInfoDigestAlgorithm Property (SOAPClient Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

func (obj *SOAPClient) ConnInfoDigestAlgorithm() (string, error)

Default Value

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

string

ConnInfoEncryptionAlgorithm Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoEncryptionAlgorithm() (string, error)

Default Value

Remarks

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

This property is read-only.

Data Type

string

ConnInfoExportable Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoExportable() (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

ConnInfoGroup Property (SOAPClient Component)

The elliptic curve used in this connection.

Syntax

func (obj *SOAPClient) ConnInfoGroup() (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

ConnInfoID Property (SOAPClient Component)

The client connection's unique identifier.

Syntax

func (obj *SOAPClient) ConnInfoID() (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

ConnInfoKeyExchangeAlgorithm Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoKeyExchangeAlgorithm() (string, error)

Default Value

Remarks

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

This property is read-only.

Data Type

string

ConnInfoKeyExchangeKeyBits Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoKeyExchangeKeyBits() (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

ConnInfoPFSCipher Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoPFSCipher() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

ConnInfoPreSharedIdentity Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoPreSharedIdentity() (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

ConnInfoPreSharedIdentityHint Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoPreSharedIdentityHint() (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

ConnInfoPublicKeyBits Property (SOAPClient Component)

The length of the public key.

Syntax

func (obj *SOAPClient) ConnInfoPublicKeyBits() (int32, error)

Default Value

Remarks

The length of the public key.

This property is read-only.

Data Type

int32

ConnInfoRemoteAddress Property (SOAPClient Component)

The client's IP address.

Syntax

func (obj *SOAPClient) ConnInfoRemoteAddress() (string, error)

Default Value

Remarks

The client's IP address.

This property is read-only.

Data Type

string

ConnInfoRemotePort Property (SOAPClient Component)

The remote port of the client connection.

Syntax

func (obj *SOAPClient) ConnInfoRemotePort() (int32, error)

Default Value

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

int32

ConnInfoResumedSession Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoResumedSession() (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

ConnInfoSecureConnection Property (SOAPClient Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

func (obj *SOAPClient) ConnInfoSecureConnection() (bool, error)

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

ConnInfoServerAuthenticated Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoServerAuthenticated() (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

ConnInfoSignatureAlgorithm Property (SOAPClient Component)

The signature algorithm used in a TLS handshake.

Syntax

func (obj *SOAPClient) ConnInfoSignatureAlgorithm() (string, error)

Default Value

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

string

ConnInfoSymmetricBlockSize Property (SOAPClient Component)

The block size of the symmetric algorithm used.

Syntax

func (obj *SOAPClient) ConnInfoSymmetricBlockSize() (int32, error)

Default Value

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

int32

ConnInfoSymmetricKeyBits Property (SOAPClient Component)

The key length of the symmetric algorithm used.

Syntax

func (obj *SOAPClient) ConnInfoSymmetricKeyBits() (int32, error)

Default Value

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

int32

ConnInfoTotalBytesReceived Property (SOAPClient Component)

The total number of bytes received over this connection.

Syntax

func (obj *SOAPClient) ConnInfoTotalBytesReceived() (int64, error)

Default Value

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

int64

ConnInfoTotalBytesSent Property (SOAPClient Component)

The total number of bytes sent over this connection.

Syntax

func (obj *SOAPClient) ConnInfoTotalBytesSent() (int64, error)

Default Value

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

int64

ConnInfoValidationLog Property (SOAPClient Component)

Contains the server certificate's chain validation log.

Syntax

func (obj *SOAPClient) ConnInfoValidationLog() (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

ConnInfoVersion Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ConnInfoVersion() (string, error)

Default Value

Remarks

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

This property is read-only.

Data Type

string

Encoding Property (SOAPClient Component)

Specifies SOAP message encoding.

Syntax

func (obj *SOAPClient) Encoding() (string, error)
func (obj *SOAPClient) SetEncoding(value string) error

Default Value

Remarks

Use this property to specify the encoding to apply to the SOAP message.

Data Type

string

ExternalCryptoAsyncDocumentID Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ExternalCryptoAsyncDocumentID() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

string

ExternalCryptoData Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ExternalCryptoData() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ExternalCryptoExternalHashCalculation() (bool, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

Specifies the request's signature hash algorithm.

Syntax

func (obj *SOAPClient) ExternalCryptoHashAlgorithm() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ExternalCryptoKeyID() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

The pre-shared key used for DC request authentication.

Syntax

func (obj *SOAPClient) ExternalCryptoKeySecret() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

Specifies the asynchronous signing method.

Syntax

func (obj *SOAPClient) ExternalCryptoMethod() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

Specifies the external cryptography mode.

Syntax

func (obj *SOAPClient) ExternalCryptoMode() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) ExternalCryptoPublicKeyAlgorithm() (string, error)
func (obj *SOAPClient) 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

FaultActor Property (SOAPClient Component)

Specifies the entity that caused the fault.

Syntax

func (obj *SOAPClient) FaultActor() (string, error)

Default Value

Remarks

Use this property to get the URI associated with the actor (SOAP node) that caused the fault. In RPC-style messaging, the actor is the URI of the Web service.

This property is read-only.

Data Type

string

FaultCode Property (SOAPClient Component)

Specifies the error code.

Syntax

func (obj *SOAPClient) FaultCode() (string, error)

Default Value

Remarks

Use this property to get the standard code that provides more information about the fault. A set of code values is predefined by the SOAP specification. This set of fault code values can be extended by the application.

This property is read-only.

Data Type

string

FaultDetail Property (SOAPClient Component)

Contains application-specific error information.

Syntax

func (obj *SOAPClient) FaultDetail() (string, error)

Default Value

Remarks

Use this property to get the application-specific information, such as the exception that was thrown. This element can be an XML structure or plain text.

This property is read-only.

Data Type

string

FaultString Property (SOAPClient Component)

Specifies a human-readable description of the fault.

Syntax

func (obj *SOAPClient) FaultString() (string, error)

Default Value

Remarks

Use this property to get the human-readable description of the error that happened.

This property is read-only.

Data Type

string

FIPSMode Property (SOAPClient Component)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

InputBytes Property (SOAPClient Component)

Use this property to pass the input to class in byte array form.

Syntax

func (obj *SOAPClient) InputBytes() ([]byte, error)
func (obj *SOAPClient) SetInputBytes(value []byte) error

Remarks

Assign a byte array containing the data to be processed to this property.

Data Type

[]byte

InputFile Property (SOAPClient Component)

A path to the file containing the SOAP message to be sent.

Syntax

func (obj *SOAPClient) InputFile() (string, error)
func (obj *SOAPClient) SetInputFile(value string) error

Default Value

Remarks

Use this property to provide a full path to the file containing the SOAP message to be sent to the server.

Data Type

string

KeepAlivePolicy Property (SOAPClient Component)

Defines the keep-alive handling policy.

Syntax

func (obj *SOAPClient) KeepAlivePolicy() (int32, error)
func (obj *SOAPClient) SetKeepAlivePolicy(value int32) error

Possible Values

0   // StandardDefined
1   // PreferKeepAlive
2   // RelyOnServer
3   // KeepAlivesDisabled

Default Value

Remarks

Use this property to tune-up the keep-alive mechanism as per the needs of your application.


ckapStandardDefined	`0`	Follow the standard
ckapPreferKeepAlive	`1`	Always request a keep-alive connection
ckapRelyOnServer	`2`	Not include the "Connection" header, allowing the server to choose the keep-alive mode
ckapKeepAlivesDisabled	`3`	Disable keep-alives by including the "Connection: Close" header

Data Type

int32

KnownCertCount Property (SOAPClient Component)

The number of records in the KnownCert arrays.

Syntax

func (obj *SOAPClient) KnownCertCount() (int32, error)
func (obj *SOAPClient) SetKnownCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

KnownCertBytes
KnownCertHandle

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

Data Type

int32

KnownCertBytes Property (SOAPClient Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SOAPClient) KnownCertBytes(KnownCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

[]byte

KnownCertHandle Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) KnownCertHandle(KnownCertIndex int32) (int64, error)
func (obj *SOAPClient) SetKnownCertHandle(KnownCertIndex 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 KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

int64

KnownCRLCount Property (SOAPClient Component)

The number of records in the KnownCRL arrays.

Syntax

func (obj *SOAPClient) KnownCRLCount() (int32, error)
func (obj *SOAPClient) SetKnownCRLCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

KnownCRLBytes
KnownCRLHandle

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

Data Type

int32

KnownCRLBytes Property (SOAPClient Component)

Returns the raw CRL data in DER format.

Syntax

func (obj *SOAPClient) KnownCRLBytes(KnownCRLIndex int32) ([]byte, error)

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only.

Data Type

[]byte

KnownCRLHandle Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) KnownCRLHandle(KnownCRLIndex int32) (int64, error)
func (obj *SOAPClient) SetKnownCRLHandle(KnownCRLIndex 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 KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

Data Type

int64

KnownOCSPCount Property (SOAPClient Component)

The number of records in the KnownOCSP arrays.

Syntax

func (obj *SOAPClient) KnownOCSPCount() (int32, error)
func (obj *SOAPClient) SetKnownOCSPCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

KnownOCSPBytes
KnownOCSPHandle

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

Data Type

int32

KnownOCSPBytes Property (SOAPClient Component)

A buffer containing the raw OCSP response data.

Syntax

func (obj *SOAPClient) KnownOCSPBytes(KnownOCSPIndex int32) ([]byte, error)

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only.

Data Type

[]byte

KnownOCSPHandle Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) KnownOCSPHandle(KnownOCSPIndex int32) (int64, error)
func (obj *SOAPClient) SetKnownOCSPHandle(KnownOCSPIndex 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 KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

Data Type

int64

MimeType Property (SOAPClient Component)

Specifies the SOAP message MIME type.

Syntax

func (obj *SOAPClient) MimeType() (string, error)
func (obj *SOAPClient) SetMimeType(value string) error

Default Value

Remarks

Use this property to specify the MIME type attribute of the SOAP message.

Data Type

string

OperationName Property (SOAPClient Component)

Specifies the SOAP operation name.

Syntax

func (obj *SOAPClient) OperationName() (string, error)
func (obj *SOAPClient) SetOperationName(value string) error

Default Value

Remarks

Use this property to specify the name of the operation that the SOAP message corresponds to.

Set this property if InputFile, InputBytes or InputStream only contains the parameters of the operation in XML format. In this case, a new SOAP message will be created and sent to the service.

If one of the Input properties contains a valid SOAP message or an operation request in XML format, this property can be left empty.

Data Type

string

OperationNamespaceURI Property (SOAPClient Component)

Specifies the SOAP message operation namespace URI.

Syntax

func (obj *SOAPClient) OperationNamespaceURI() (string, error)
func (obj *SOAPClient) SetOperationNamespaceURI(value string) error

Default Value

Remarks

This property specifies the operation namespace URI of the SOAP message.

Data Type

string

OperationResponseName Property (SOAPClient Component)

Specifies the operation name of the response message.

Syntax

func (obj *SOAPClient) OperationResponseName() (string, error)

Default Value

Remarks

Use this property to get the operation name from the response message received from the SOAP service.

This property is read-only.

Data Type

string

OperationResponseNamespaceURI Property (SOAPClient Component)

Specifies the response SOAP message operation namespace URI.

Syntax

func (obj *SOAPClient) OperationResponseNamespaceURI() (string, error)

Default Value

Remarks

Use this property to get the operation namespace URI from the response SOAP message.

This property is read-only.

Data Type

string

OperationResponseTextContent Property (SOAPClient Component)

Returns the text content of the response message.

Syntax

func (obj *SOAPClient) OperationResponseTextContent() (string, error)

Default Value

Remarks

Use this property to get the text content of the operation of the response SOAP message.

This property is read-only.

Data Type

string

OperationResponseXML Property (SOAPClient Component)

Returns the XML content of the response SOAP message.

Syntax

func (obj *SOAPClient) OperationResponseXML() (string, error)

Default Value

Remarks

Use this property to get the XML content of the response message.

This property is read-only.

Data Type

string

OutputAttachmentBytes Property (SOAPClient Component)

Use this property to read the attachment received from the service.

Syntax

func (obj *SOAPClient) OutputAttachmentBytes() ([]byte, error)

Remarks

Check the content of this property after the operation has completed to read the received attachment data.

This property will only be set if OutputAttachmentFile and OutputAttachmentStream properties had not been assigned.

This property is read-only.

Data Type

[]byte

OutputAttachmentFile Property (SOAPClient Component)

A path to a file where to save the attachment data.

Syntax

func (obj *SOAPClient) OutputAttachmentFile() (string, error)
func (obj *SOAPClient) SetOutputAttachmentFile(value string) error

Default Value

Remarks

Provide a full path to the file where the attachment should be saved.

Data Type

string

OutputBytes Property (SOAPClient Component)

Use this property to read the output the class object has produced.

Syntax

func (obj *SOAPClient) OutputBytes() ([]byte, error)

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

This property is read-only.

Data Type

[]byte

OutputFile Property (SOAPClient Component)

A file where the response will be saved.

Syntax

func (obj *SOAPClient) OutputFile() (string, error)
func (obj *SOAPClient) SetOutputFile(value string) error

Default Value

Remarks

Provide a full path to the file where the service response should be saved.

Data Type

string

ProxyAddress Property (SOAPClient Component)

The IP address of the proxy server.

Syntax

func (obj *SOAPClient) ProxyAddress() (string, error)
func (obj *SOAPClient) SetProxyAddress(value string) error

Default Value

Remarks

The IP address of the proxy server.

Data Type

string

ProxyAuthentication Property (SOAPClient Component)

The authentication type used by the proxy server.

Syntax

func (obj *SOAPClient) ProxyAuthentication() (int32, error)
func (obj *SOAPClient) SetProxyAuthentication(value int32) error

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Data Type

int32

ProxyPassword Property (SOAPClient Component)

The password to authenticate to the proxy server.

Syntax

func (obj *SOAPClient) ProxyPassword() (string, error)
func (obj *SOAPClient) SetProxyPassword(value string) error

Default Value

Remarks

The password to authenticate to the proxy server.

Data Type

string

ProxyPort Property (SOAPClient Component)

The port on the proxy server to connect to.

Syntax

func (obj *SOAPClient) ProxyPort() (int32, error)
func (obj *SOAPClient) SetProxyPort(value int32) error

Default Value

Remarks

The port on the proxy server to connect to.

Data Type

int32

ProxyType Property (SOAPClient Component)

The type of the proxy server.

Syntax

func (obj *SOAPClient) ProxyType() (int32, error)
func (obj *SOAPClient) SetProxyType(value int32) error

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

Remarks

The type of the proxy server.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

Data Type

int32

ProxyRequestHeaders Property (SOAPClient Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

func (obj *SOAPClient) ProxyRequestHeaders() (string, error)
func (obj *SOAPClient) SetProxyRequestHeaders(value string) error

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

string

ProxyResponseBody Property (SOAPClient Component)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

func (obj *SOAPClient) ProxyResponseBody() (string, error)
func (obj *SOAPClient) SetProxyResponseBody(value string) error

Default Value

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

string

ProxyResponseHeaders Property (SOAPClient Component)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

func (obj *SOAPClient) ProxyResponseHeaders() (string, error)
func (obj *SOAPClient) SetProxyResponseHeaders(value string) error

Default Value

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

string

ProxyUseIPv6 Property (SOAPClient Component)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

func (obj *SOAPClient) ProxyUseIPv6() (bool, error)
func (obj *SOAPClient) SetProxyUseIPv6(value bool) error

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

bool

ProxyUsername Property (SOAPClient Component)

Specifies the username credential for proxy authentication.

Syntax

func (obj *SOAPClient) ProxyUsername() (string, error)
func (obj *SOAPClient) SetProxyUsername(value string) error

Default Value

Remarks

Specifies the username credential for proxy authentication.

Data Type

string

ReasonPhrase Property (SOAPClient Component)

Contains the Reason Phrase element of the server's response.

Syntax

func (obj *SOAPClient) ReasonPhrase() (string, error)

Default Value

Remarks

Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK).

This property is read-only.

Data Type

string

ReqHeaderCount Property (SOAPClient Component)

The number of records in the ReqHeader arrays.

Syntax

func (obj *SOAPClient) ReqHeaderCount() (int32, error)
func (obj *SOAPClient) SetReqHeaderCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

ReqHeaderCategory
ReqHeaderFormat
ReqHeaderName
ReqHeaderValue

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

Data Type

int32

ReqHeaderCategory Property (SOAPClient Component)

Specifies the string category of the contained value.

Syntax

func (obj *SOAPClient) ReqHeaderCategory(ReqHeaderIndex int32) (string, error)
func (obj *SOAPClient) SetReqHeaderCategory(ReqHeaderIndex int32, value string) error

Default Value

Remarks

Specifies the string category of the contained value.

This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used.

For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

Data Type

string

ReqHeaderFormat Property (SOAPClient Component)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

func (obj *SOAPClient) ReqHeaderFormat(ReqHeaderIndex int32) (int32, error)
func (obj *SOAPClient) SetReqHeaderFormat(ReqHeaderIndex int32, value int32) error

Default Value

Remarks

Specifies the format (encoding) of the value contained in the ReqHeaderValue property.

Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071";

The following formats are currently supported:


svfText	`0`	The property contains text
svfBinary	`1`	The property contains binary data. The Value property contains a hex encoding of it.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

Data Type

int32

ReqHeaderName Property (SOAPClient Component)

The name element in a (name, value) pair.

Syntax

func (obj *SOAPClient) ReqHeaderName(ReqHeaderIndex int32) (string, error)
func (obj *SOAPClient) SetReqHeaderName(ReqHeaderIndex int32, value string) error

Default Value

Remarks

The name element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

Data Type

string

ReqHeaderValue Property (SOAPClient Component)

The value element in a (name, value) pair.

Syntax

func (obj *SOAPClient) ReqHeaderValue(ReqHeaderIndex int32) (string, error)
func (obj *SOAPClient) SetReqHeaderValue(ReqHeaderIndex int32, value string) error

Default Value

Remarks

The value element in a (name, value) pair.

The ReqHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReqHeaderCount property.

Data Type

string

ReqParamsAccept Property (SOAPClient Component)

Specifies the Accept header property of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsAccept() (string, error)
func (obj *SOAPClient) SetReqParamsAccept(value string) error

Default Value

Remarks

Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response.

Data Type

string

ReqParamsAcceptCharset Property (SOAPClient Component)

Specifies the Accept-Charset header property of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsAcceptCharset() (string, error)
func (obj *SOAPClient) SetReqParamsAcceptCharset(value string) error

Default Value

Remarks

Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand.

Data Type

string

ReqParamsAcceptLanguage Property (SOAPClient Component)

Specifies the Accept-Language header property of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsAcceptLanguage() (string, error)
func (obj *SOAPClient) SetReqParamsAcceptLanguage(value string) error

Default Value

Remarks

Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand.

Data Type

string

ReqParamsAcceptRangeEnd Property (SOAPClient Component)

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsAcceptRangeEnd() (int64, error)
func (obj *SOAPClient) SetReqParamsAcceptRangeEnd(value int64) error

Default Value

Remarks

This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request.

Data Type

int64

ReqParamsAcceptRangeStart Property (SOAPClient Component)

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsAcceptRangeStart() (int64, error)
func (obj *SOAPClient) SetReqParamsAcceptRangeStart(value int64) error

Default Value

Remarks

This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request.

Data Type

int64

ReqParamsAuthorization Property (SOAPClient Component)

Specifies the Authorization header of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsAuthorization() (string, error)
func (obj *SOAPClient) SetReqParamsAuthorization(value string) error

Default Value

Remarks

Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server.

Data Type

string

ReqParamsConnection Property (SOAPClient Component)

Specifies the value to pass to the Connection header property of HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsConnection() (string, error)
func (obj *SOAPClient) SetReqParamsConnection(value string) error

Default Value

Remarks

Specifies the value to pass to the Connection header field of HTTP request.

Data Type

string

ReqParamsContentLength Property (SOAPClient Component)

Specifies the size of the entity-body of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsContentLength() (int64, error)
func (obj *SOAPClient) SetReqParamsContentLength(value int64) error

Default Value

Remarks

Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the struct calculate it automatically.

Data Type

int64

ReqParamsContentRangeEnd Property (SOAPClient Component)

Specifies the upper bound used in the Content-Range header of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsContentRangeEnd() (int64, error)
func (obj *SOAPClient) SetReqParamsContentRangeEnd(value int64) error

Default Value

Remarks

Specifies the upper bound used in the Content-Range header of the HTTP request.

Data Type

int64

ReqParamsContentRangeFullSize Property (SOAPClient Component)

Specifies the total length of the full entity-body of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsContentRangeFullSize() (int64, error)
func (obj *SOAPClient) SetReqParamsContentRangeFullSize(value int64) error

Default Value

Remarks

Specifies the total length of the full entity-body of the HTTP request.

Data Type

int64

ReqParamsContentRangeStart Property (SOAPClient Component)

Specifies the lower bound used in the Content-Range header of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsContentRangeStart() (int64, error)
func (obj *SOAPClient) SetReqParamsContentRangeStart(value int64) error

Default Value

Remarks

Specifies the lower bound used in the Content-Range header of the HTTP request.

Data Type

int64

ReqParamsContentType Property (SOAPClient Component)

The Content-Type header property of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsContentType() (string, error)
func (obj *SOAPClient) SetReqParamsContentType(value string) error

Default Value

Remarks

The Content-Type header field of the HTTP request.

Data Type

string

ReqParamsCookie Property (SOAPClient Component)

This header is expected to be assigned with cookies previously received from the server and stored by the client.

Syntax

func (obj *SOAPClient) ReqParamsCookie() (string, error)
func (obj *SOAPClient) SetReqParamsCookie(value string) error

Default Value

Remarks

This header is expected to be assigned with cookies previously received from the server and stored by the client.

Data Type

string

ReqParamsCustomHeaders Property (SOAPClient Component)

Assign any custom HTTP headers to be passed to the server to this property.

Syntax

func (obj *SOAPClient) ReqParamsCustomHeaders() (string, error)
func (obj *SOAPClient) SetReqParamsCustomHeaders(value string) error

Default Value

Remarks

Assign any custom HTTP headers to be passed to the server to this property.

Data Type

string

ReqParamsDate Property (SOAPClient Component)

The date and time of the request.

Syntax

func (obj *SOAPClient) ReqParamsDate() (string, error)
func (obj *SOAPClient) SetReqParamsDate(value string) error

Default Value

Remarks

The date and time of the request.

Data Type

string

ReqParamsFrom Property (SOAPClient Component)

Contains the From header property of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsFrom() (string, error)
func (obj *SOAPClient) SetReqParamsFrom(value string) error

Default Value

Remarks

Contains the From header field of the HTTP request. It specifies the e-mail address for the human user who controls the requesting user agent.

Data Type

string

ReqParamsHost Property (SOAPClient Component)

This property contains the Host header property of the HTTP request.

Syntax

func (obj *SOAPClient) ReqParamsHost() (string, error)
func (obj *SOAPClient) SetReqParamsHost(value string) error

Default Value

Remarks

This property contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested.

Data Type

string

ReqParamsHTTPVersion Property (SOAPClient Component)

Specifies the version of HTTP protocol to use: 1.

Syntax

func (obj *SOAPClient) ReqParamsHTTPVersion() (int32, error)
func (obj *SOAPClient) SetReqParamsHTTPVersion(value int32) error

Possible Values

0   // HTTP10
1   // HTTP11

Default Value

Remarks

Specifies the version of HTTP protocol to use: 1.0 or 1.1.


chvHTTP10	HTTP/1.0 (`0`)
chvHTTP11	HTTP/1.1 (`1`)

Data Type

int32

ReqParamsIfMatch Property (SOAPClient Component)

Contains the If-Match request header property.

Syntax

func (obj *SOAPClient) ReqParamsIfMatch() (string, error)
func (obj *SOAPClient) SetReqParamsIfMatch(value string) error

Default Value

Remarks

Contains the If-Match request header field. This property makes the requested method conditional: when If-Match field is set, only the entities matching the included entity tags will be returned by the server.

Data Type

string

ReqParamsIfModifiedSince Property (SOAPClient Component)

Contains the If-Modified-Since request header property.

Syntax

func (obj *SOAPClient) ReqParamsIfModifiedSince() (string, error)
func (obj *SOAPClient) SetReqParamsIfModifiedSince(value string) error

Default Value

Remarks

Contains the If-Modified-Since request header field. This property makes the requested method conditional: when If-Modified-Since field is set, only the modified entities will be returned by the server.

Data Type

string

ReqParamsIfNoneMatch Property (SOAPClient Component)

Contains the If-None-Match request header property.

Syntax

func (obj *SOAPClient) ReqParamsIfNoneMatch() (string, error)
func (obj *SOAPClient) SetReqParamsIfNoneMatch(value string) error

Default Value

Remarks

Contains the If-None-Match request header field. This property makes the requested method conditional: when If-None-Match field is set, only the entities which doesn't match the included entity tags will be returned by the server.

Data Type

string

ReqParamsIfUnmodifiedSince Property (SOAPClient Component)

Contains the If-Unmodified-Since request header property.

Syntax

func (obj *SOAPClient) ReqParamsIfUnmodifiedSince() (string, error)
func (obj *SOAPClient) SetReqParamsIfUnmodifiedSince(value string) error

Default Value

Remarks

Contains the If-Unmodified-Since request header field. This property makes the requested method conditional: when If-Unmodified-Since field is set, only the unmodified entities will be returned by the server.

Data Type

string

ReqParamsPassword Property (SOAPClient Component)

Assign this property with the user's password.

Syntax

func (obj *SOAPClient) ReqParamsPassword() (string, error)
func (obj *SOAPClient) SetReqParamsPassword(value string) error

Default Value

Remarks

Assign this property with the user's password.

Data Type

string

ReqParamsReferer Property (SOAPClient Component)

The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

Syntax

func (obj *SOAPClient) ReqParamsReferer() (string, error)
func (obj *SOAPClient) SetReqParamsReferer(value string) error

Default Value

Remarks

The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer).

Data Type

string

ReqParamsUserAgent Property (SOAPClient Component)

The User-Agent property of the HTTP request provides information about the software that initiates the request.

Syntax

func (obj *SOAPClient) ReqParamsUserAgent() (string, error)
func (obj *SOAPClient) SetReqParamsUserAgent(value string) error

Default Value

Remarks

The User-Agent field of the HTTP request provides information about the software that initiates the request.

Data Type

string

ReqParamsUsername Property (SOAPClient Component)

Assign this property with the user's login name.

Syntax

func (obj *SOAPClient) ReqParamsUsername() (string, error)
func (obj *SOAPClient) SetReqParamsUsername(value string) error

Default Value

Remarks

Assign this property with the user's login name.

Data Type

string

RespHeaderCount Property (SOAPClient Component)

The number of records in the RespHeader arrays.

Syntax

func (obj *SOAPClient) RespHeaderCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

RespHeaderCategory
RespHeaderFormat
RespHeaderName
RespHeaderValue

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

This property is read-only.

Data Type

int32

RespHeaderCategory Property (SOAPClient Component)

Specifies the string category of the contained value.

Syntax

func (obj *SOAPClient) RespHeaderCategory(RespHeaderIndex int32) (string, error)

Default Value

Remarks

Specifies the string category of the contained value.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only.

Data Type

string

RespHeaderFormat Property (SOAPClient Component)

Specifies the format (encoding) of the value contained in the Value property.

Syntax

func (obj *SOAPClient) RespHeaderFormat(RespHeaderIndex int32) (int32, error)

Default Value

Remarks

Specifies the format (encoding) of the value contained in the RespHeaderValue property.

The following formats are currently supported:


svfText	`0`	The property contains text
svfBinary	`1`	The property contains binary data. The Value property contains a hex encoding of it.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only.

Data Type

int32

RespHeaderName Property (SOAPClient Component)

The name element in a (name, value) pair.

Syntax

func (obj *SOAPClient) RespHeaderName(RespHeaderIndex int32) (string, error)

Default Value

Remarks

The name element in a (name, value) pair.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only.

Data Type

string

RespHeaderValue Property (SOAPClient Component)

The value element in a (name, value) pair.

Syntax

func (obj *SOAPClient) RespHeaderValue(RespHeaderIndex int32) (string, error)

Default Value

Remarks

The value element in a (name, value) pair.

The RespHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RespHeaderCount property.

This property is read-only.

Data Type

string

RespParamsContentLength Property (SOAPClient Component)

Indicates the length of the response content in bytes.

Syntax

func (obj *SOAPClient) RespParamsContentLength() (int64, error)

Default Value

Remarks

Indicates the length of the response content in bytes.

This property is read-only.

Data Type

int64

RespParamsContentType Property (SOAPClient Component)

Returns the content type of the server response, as included in the response headers.

Syntax

func (obj *SOAPClient) RespParamsContentType() (string, error)

Default Value

Remarks

Returns the content type of the server response, as included in the response headers.

This property is read-only.

Data Type

string

RespParamsDate Property (SOAPClient Component)

The date and time at which the response was generated, in server time, in UTC.

Syntax

func (obj *SOAPClient) RespParamsDate() (string, error)

Default Value

Remarks

The date and time at which the response was generated, in server time, in UTC.

This property is read-only.

Data Type

string

RespParamsReasonPhrase Property (SOAPClient Component)

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the status code.

Syntax

func (obj *SOAPClient) RespParamsReasonPhrase() (string, error)

Default Value

Remarks

Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the status code.

This property is read-only.

Data Type

string

RespParamsStatusCode Property (SOAPClient Component)

The server-generated status code of the request processing status.

Syntax

func (obj *SOAPClient) RespParamsStatusCode() (int32, error)

Default Value

Remarks

The server-generated status code of the request processing status.

The code is a 3-digit integer where the first digit defines the class of the response:


`1`	Informational
`2`	Success
`3`	Redirection
`4`	Client Error
`5`	Server Error

Common examples are 200 (page served successfully), 404 (page not found), 302 (redirect), and 500 (internal server error).

This property is read-only.

Data Type

int32

SOAPAction Property (SOAPClient Component)

Specifies the SOAP action.

Syntax

func (obj *SOAPClient) SOAPAction() (string, error)
func (obj *SOAPClient) SetSOAPAction(value string) error

Default Value

Remarks

Use this property to specify the value for the SOAPAction/action HTTP request header field. This field is normally used to indicate the intent of the SOAP request.

Data Type

string

SOAPResponseType Property (SOAPClient Component)

The type of the response.

Syntax

func (obj *SOAPClient) SOAPResponseType() (int32, error)

Possible Values

0   // Unknown
1   // Binary
2   // XMLDocument
3   // SOAPMessage

Default Value

Remarks

Use this property to learn about the type (format) of the response provided by the SOAP service.


srtUnknown	`0`	It was not possible to identify the response type. Either connection error has occurred or the service returned an unexpected HTTP status code.
srtBinary	`1`	The SOAP service has returned binary data.
srtXMLDocument	`2`	The SOAP service has returned an XML document.
srtSOAPMessage	`3`	The SOAP service has returned a SOAP message.

This property is read-only.

Data Type

int32

SOAPVersion Property (SOAPClient Component)

Specifies SOAP version.

Syntax

func (obj *SOAPClient) SOAPVersion() (int32, error)
func (obj *SOAPClient) SetSOAPVersion(value int32) error

Possible Values

0   // Auto
1   // 11
2   // 12

Default Value

Remarks

This property specifies the version of the SOAP protocol. This SOAP version will be used to create a SOAP message (if needed) and to communicate with the service.


spvAuto	`0`	The SOAP version is detected from the SOAP message provided. If the input does not constitute a SOAP message, version 1.2 will be used.
spv11	`1`	SOAP version 1.1
spv12	`2`	SOAP version 1.2

Data Type

int32

SocketDNSMode Property (SOAPClient Component)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Syntax

func (obj *SOAPClient) SocketDNSMode() (int32, error)
func (obj *SOAPClient) SetSocketDNSMode(value int32) error

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

Default Value

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

Data Type

int32

SocketDNSPort Property (SOAPClient Component)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

func (obj *SOAPClient) SocketDNSPort() (int32, error)
func (obj *SOAPClient) SetSocketDNSPort(value int32) error

Default Value

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

int32

SocketDNSQueryTimeout Property (SOAPClient Component)

The timeout (in milliseconds) for each DNS query.

Syntax

func (obj *SOAPClient) SocketDNSQueryTimeout() (int32, error)
func (obj *SOAPClient) SetSocketDNSQueryTimeout(value int32) error

Default Value

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

int32

SocketDNSServers Property (SOAPClient Component)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

func (obj *SOAPClient) SocketDNSServers() (string, error)
func (obj *SOAPClient) SetSocketDNSServers(value string) error

Default Value

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

string

SocketDNSTotalTimeout Property (SOAPClient Component)

The timeout (in milliseconds) for the whole resolution process.

Syntax

func (obj *SOAPClient) SocketDNSTotalTimeout() (int32, error)
func (obj *SOAPClient) SetSocketDNSTotalTimeout(value int32) error

Default Value

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

int32

SocketIncomingSpeedLimit Property (SOAPClient Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

int32

SocketLocalAddress Property (SOAPClient Component)

The local network interface to bind the socket to.

Syntax

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

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

string

SocketLocalPort Property (SOAPClient Component)

The local port number to bind the socket to.

Syntax

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

Default Value

Remarks

The local port number to bind the socket to.

Data Type

int32

SocketOutgoingSpeedLimit Property (SOAPClient Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

int32

SocketTimeout Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) SocketTimeout() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

Enables or disables IP protocol version 6.

Syntax

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

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

StatusCode Property (SOAPClient Component)

Contains the Status Code element of the server's response.

Syntax

func (obj *SOAPClient) StatusCode() (int32, error)

Default Value

Remarks

Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK).

This property is read-only.

Data Type

int32

TLSClientCertCount Property (SOAPClient Component)

The number of records in the TLSClientCert arrays.

Syntax

func (obj *SOAPClient) TLSClientCertCount() (int32, error)
func (obj *SOAPClient) SetTLSClientCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

TLSClientCertBytes
TLSClientCertHandle

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

Data Type

int32

TLSClientCertBytes Property (SOAPClient Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SOAPClient) TLSClientCertBytes(TLSClientCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is read-only.

Data Type

[]byte

TLSClientCertHandle Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSClientCertHandle(TLSClientCertIndex int32) (int64, error)
func (obj *SOAPClient) SetTLSClientCertHandle(TLSClientCertIndex 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 TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

Data Type

int64

TLSServerCertCount Property (SOAPClient Component)

The number of records in the TLSServerCert arrays.

Syntax

func (obj *SOAPClient) TLSServerCertCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

TLSServerCertBytes
TLSServerCertFingerprint
TLSServerCertHandle
TLSServerCertIssuer
TLSServerCertIssuerRDN
TLSServerCertKeyAlgorithm
TLSServerCertKeyBits
TLSServerCertKeyUsage
TLSServerCertSelfSigned
TLSServerCertSerialNumber
TLSServerCertSigAlgorithm
TLSServerCertSubject
TLSServerCertSubjectRDN
TLSServerCertValidFrom
TLSServerCertValidTo

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

This property is read-only.

Data Type

int32

TLSServerCertBytes Property (SOAPClient Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SOAPClient) 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

TLSServerCertFingerprint Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertFingerprint(TLSServerCertIndex 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 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

string

TLSServerCertHandle Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertHandle(TLSServerCertIndex 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.

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

int64

TLSServerCertIssuer Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertIssuer(TLSServerCertIndex 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 TLSIssuerRDN.

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

string

TLSServerCertIssuerRDN Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertIssuerRDN(TLSServerCertIndex 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 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

string

TLSServerCertKeyAlgorithm Property (SOAPClient Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *SOAPClient) TLSServerCertKeyAlgorithm(TLSServerCertIndex 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 TLSKeyBits, TLSCurve, and TLSPublicKeyBytes properties to get more details about the key the certificate contains.

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

string

TLSServerCertKeyBits Property (SOAPClient Component)

Returns the length of the public key in bits.

Syntax

func (obj *SOAPClient) TLSServerCertKeyBits(TLSServerCertIndex 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 TLSPublicKeyBytes or TLSPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

int32

TLSServerCertKeyUsage Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertKeyUsage(TLSServerCertIndex 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 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

int32

TLSServerCertSelfSigned Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertSelfSigned(TLSServerCertIndex int32) (bool, error)

Default Value

false

Remarks

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

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

bool

TLSServerCertSerialNumber Property (SOAPClient Component)

Returns the certificate's serial number.

Syntax

func (obj *SOAPClient) TLSServerCertSerialNumber(TLSServerCertIndex 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 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

TLSServerCertSigAlgorithm Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertSigAlgorithm(TLSServerCertIndex 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 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

string

TLSServerCertSubject Property (SOAPClient 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 *SOAPClient) TLSServerCertSubject(TLSServerCertIndex 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 TLSSubjectRDN.

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

string

TLSServerCertSubjectRDN Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertSubjectRDN(TLSServerCertIndex 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 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

string

TLSServerCertValidFrom Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertValidFrom(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

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

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

string

TLSServerCertValidTo Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSServerCertValidTo(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

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

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

string

TLSAutoValidateCertificates Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSAutoValidateCertificates() (bool, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

Selects the base configuration for the TLS settings.

Syntax

func (obj *SOAPClient) TLSBaseConfiguration() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

func (obj *SOAPClient) TLSCiphersuites() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

Enables or disables certificate-based client authentication.

Syntax

func (obj *SOAPClient) TLSClientAuth() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

Provides access to TLS extensions.

Syntax

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

Default Value

Remarks

Provides access to TLS extensions.

Data Type

string

TLSForceResumeIfDestinationChanges Property (SOAPClient Component)

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

Syntax

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

Default Value

false

Remarks

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

Data Type

bool

TLSGroups Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSGroups() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSPreSharedIdentity() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSPreSharedKey() (string, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

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

Default Value

Remarks

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

Data Type

string

TLSRenegotiationAttackPreventionMode Property (SOAPClient Component)

Selects the renegotiation attack prevention mechanism.

Syntax

func (obj *SOAPClient) TLSRenegotiationAttackPreventionMode() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TLSRevocationCheck() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient 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 *SOAPClient) TLSSSLOptions() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

Specifies the TLS mode to use.

Syntax

func (obj *SOAPClient) TLSMode() (int32, error)
func (obj *SOAPClient) 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 (SOAPClient Component)

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

Syntax

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

Default Value

true

Remarks

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

Data Type

bool

TLSUseSessionResumption Property (SOAPClient Component)

Enables or disables the TLS session resumption capability.

Syntax

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

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

TLSVersions Property (SOAPClient Component)

The SSL/TLS versions to enable by default.

Syntax

func (obj *SOAPClient) TLSVersions() (int32, error)
func (obj *SOAPClient) 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

TrustedCertCount Property (SOAPClient Component)

The number of records in the TrustedCert arrays.

Syntax

func (obj *SOAPClient) TrustedCertCount() (int32, error)
func (obj *SOAPClient) SetTrustedCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

TrustedCertBytes
TrustedCertHandle

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

Data Type

int32

TrustedCertBytes Property (SOAPClient Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *SOAPClient) TrustedCertBytes(TrustedCertIndex int32) ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

[]byte

TrustedCertHandle Property (SOAPClient Component)

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

Syntax

func (obj *SOAPClient) TrustedCertHandle(TrustedCertIndex int32) (int64, error)
func (obj *SOAPClient) SetTrustedCertHandle(TrustedCertIndex 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 TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

int64

Config Method (SOAPClient Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *SOAPClient) 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 (SOAPClient Component)

Performs an additional action.

Syntax

func (obj *SOAPClient) 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.

Reset Method (SOAPClient Component)

Resets the class settings.

Syntax

func (obj *SOAPClient) Reset() error

Remarks

Reset is a generic method available in every struct.

SendMessage Method (SOAPClient Component)

Sends a SOAP message to the server.

Syntax

func (obj *SOAPClient) SendMessage(Url string) error

Remarks

The SendMessage() does the following:

Loads the data from InputBytes, InputFile or InputStream properties.
If the data contains a SOAP message, no pre-send processing is performed.

If the data contains XML content, then basing on OperationName, OperationNamespaceURI and SOAPVersion properties new SOAP envelope will be created. The XML content will be used either as either the operation itself or the operation parameters, depending on OperationName value.
Sends the SOAP message to the service Url.
Use SOAPAction, Encoding and MimeType properties to set SOAP HTTP request parameters.
If the request is successful, the received content is saved in either OutputBytes, OutputFile or OutputStream.
If the response contains attachment(s) then BeforeReceiveAttachment event will be fired for each attachment, following which the attachment will be saved to either OutputAttachmentBytes, OutputAttachmentFile or OutputAttachmentStream.

Use SOAPResponseType to get the type of the received content. If the received content is recognized as a SOAP message, then OperationResponseName, OperationResponseNamespaceURI OperationResponseTextContent and OperationResponseXML properties will be populated.
If an error happens during the request, an exception is thrown.
Use SOAPResponseType to identify the received content. The type set to Unknown means that either a connection error has occurred or the service has returned an unexpected HTTP status code. In this case, the error details are published in StatusCode and ReasonPhrase properties.

If SOAPResponseType set to a different value indicates that the service has returned HTTP status code in the range 500 - 599, indicating a service error.

If the type of received content is SOAP message, then FaultActor, FaultCode, FaultDetail and FaultString properties will contain error details returned by the service.

If the request has succeeded then the received content will also be available in either OutputBytes, OutputFile or OutputStream properties.

SendMessageWithAttachments Method (SOAPClient Component)

Sends a SOAP message with attachment(s) to the server.

Syntax

func (obj *SOAPClient) SendMessageWithAttachments(Url string, PrimaryMessageId string) error

Remarks

This method follows the general pattern used by SendMessage method. It also lets you pass a selection of attachments to the service.

Assign the attachment content to AttachmentBytes, AttachmentFile, or AttachmentStream property. Subscribe to BeforeSendAttachment to pass more than one attachment.

BeforeReceiveAttachment Event (SOAPClient Component)

Marks the start of receiving an attachment.

Syntax

// SOAPClientBeforeReceiveAttachmentEventArgs carries the SOAPClient BeforeReceiveAttachment event's parameters.
type SOAPClientBeforeReceiveAttachmentEventArgs struct {...}

// SOAPClientBeforeReceiveAttachmentEvent defines the signature of the SOAPClient BeforeReceiveAttachment event's handler function.
type SOAPClientBeforeReceiveAttachmentEvent func(sender *SOAPClient, args *SOAPClientBeforeReceiveAttachmentEventArgs)

func (obj *SOAPClient) GetOnBeforeReceiveAttachmentHandler() SOAPClientBeforeReceiveAttachmentEvent
func (obj *SOAPClient) SetOnBeforeReceiveAttachmentHandler(handlerFunc SOAPClientBeforeReceiveAttachmentEvent)

Remarks

This event fires for every new attachment being received from the service.

Tune up OutputAttachmentBytes, OutputAttachmentFile or OutputAttachmentStream properties inside the event handler to indicate where the attachment content should be saved.

BeforeSendAttachment Event (SOAPClient Component)

Marks the start of sending an attachment.

Syntax

// SOAPClientBeforeSendAttachmentEventArgs carries the SOAPClient BeforeSendAttachment event's parameters.
type SOAPClientBeforeSendAttachmentEventArgs struct {...}

func (args *SOAPClientBeforeSendAttachmentEventArgs) LastAttachment() bool
func (args *SOAPClientBeforeSendAttachmentEventArgs) SetLastAttachment(value bool)

// SOAPClientBeforeSendAttachmentEvent defines the signature of the SOAPClient BeforeSendAttachment event's handler function.
type SOAPClientBeforeSendAttachmentEvent func(sender *SOAPClient, args *SOAPClientBeforeSendAttachmentEventArgs)

func (obj *SOAPClient) GetOnBeforeSendAttachmentHandler() SOAPClientBeforeSendAttachmentEvent
func (obj *SOAPClient) SetOnBeforeSendAttachmentHandler(handlerFunc SOAPClientBeforeSendAttachmentEvent)

Remarks

Use either AttachmentBytes, AttachmentFile or AttachmentStream properties to pass attachment to the struct.

Set LastAttachment parameter to False to indicate that you have more than one attachment to pass.

Cookie Event (SOAPClient Component)

Fired to report a received cookie.

Syntax

// SOAPClientCookieEventArgs carries the SOAPClient Cookie event's parameters.
type SOAPClientCookieEventArgs struct {...}

func (args *SOAPClientCookieEventArgs) CookieText() string
// SOAPClientCookieEvent defines the signature of the SOAPClient Cookie event's handler function.
type SOAPClientCookieEvent func(sender *SOAPClient, args *SOAPClientCookieEventArgs)

func (obj *SOAPClient) GetOnCookieHandler() SOAPClientCookieEvent
func (obj *SOAPClient) SetOnCookieHandler(handlerFunc SOAPClientCookieEvent)

Remarks

The CookieText parameter contains the text of the cookie.

DocumentBegin Event (SOAPClient Component)

Marks the start of the incoming HTML document or file.

Syntax

// SOAPClientDocumentBeginEventArgs carries the SOAPClient DocumentBegin event's parameters.
type SOAPClientDocumentBeginEventArgs struct {...}

// SOAPClientDocumentBeginEvent defines the signature of the SOAPClient DocumentBegin event's handler function.
type SOAPClientDocumentBeginEvent func(sender *SOAPClient, args *SOAPClientDocumentBeginEventArgs)

func (obj *SOAPClient) GetOnDocumentBeginHandler() SOAPClientDocumentBeginEvent
func (obj *SOAPClient) SetOnDocumentBeginHandler(handlerFunc SOAPClientDocumentBeginEvent)

Remarks

This event is followed by one or more Progress calls. When the document has been received in full, the DocumentEnd event is fired.

DocumentEnd Event (SOAPClient Component)

Marks the successful receipt of the incoming HTML document or file.

Syntax

// SOAPClientDocumentEndEventArgs carries the SOAPClient DocumentEnd event's parameters.
type SOAPClientDocumentEndEventArgs struct {...}

// SOAPClientDocumentEndEvent defines the signature of the SOAPClient DocumentEnd event's handler function.
type SOAPClientDocumentEndEvent func(sender *SOAPClient, args *SOAPClientDocumentEndEventArgs)

func (obj *SOAPClient) GetOnDocumentEndHandler() SOAPClientDocumentEndEvent
func (obj *SOAPClient) SetOnDocumentEndHandler(handlerFunc SOAPClientDocumentEndEvent)

Remarks

This event fires when the document has been received in full.

Error Event (SOAPClient Component)

Information about errors during data delivery.

Syntax

// SOAPClientErrorEventArgs carries the SOAPClient Error event's parameters.
type SOAPClientErrorEventArgs struct {...}

func (args *SOAPClientErrorEventArgs) ErrorCode() int32
func (args *SOAPClientErrorEventArgs) Description() string
// SOAPClientErrorEvent defines the signature of the SOAPClient Error event's handler function.
type SOAPClientErrorEvent func(sender *SOAPClient, args *SOAPClientErrorEventArgs)

func (obj *SOAPClient) GetOnErrorHandler() SOAPClientErrorEvent
func (obj *SOAPClient) SetOnErrorHandler(handlerFunc SOAPClientErrorEvent)

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

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

// SOAPClientExternalSignEventArgs carries the SOAPClient ExternalSign event's parameters.
type SOAPClientExternalSignEventArgs struct {...}

func (args *SOAPClientExternalSignEventArgs) OperationId() string
func (args *SOAPClientExternalSignEventArgs) HashAlgorithm() string
func (args *SOAPClientExternalSignEventArgs) Pars() string
func (args *SOAPClientExternalSignEventArgs) Data() string
func (args *SOAPClientExternalSignEventArgs) SignedData() string
func (args *SOAPClientExternalSignEventArgs) SetSignedData(value string)

// SOAPClientExternalSignEvent defines the signature of the SOAPClient ExternalSign event's handler function.
type SOAPClientExternalSignEvent func(sender *SOAPClient, args *SOAPClientExternalSignEventArgs)

func (obj *SOAPClient) GetOnExternalSignHandler() SOAPClientExternalSignEvent
func (obj *SOAPClient) SetOnExternalSignHandler(handlerFunc SOAPClientExternalSignEvent)

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(); };

HeadersPrepared Event (SOAPClient Component)

Fires when the request headers have been formed and are about to be sent to the server.

Syntax

// SOAPClientHeadersPreparedEventArgs carries the SOAPClient HeadersPrepared event's parameters.
type SOAPClientHeadersPreparedEventArgs struct {...}

// SOAPClientHeadersPreparedEvent defines the signature of the SOAPClient HeadersPrepared event's handler function.
type SOAPClientHeadersPreparedEvent func(sender *SOAPClient, args *SOAPClientHeadersPreparedEventArgs)

func (obj *SOAPClient) GetOnHeadersPreparedHandler() SOAPClientHeadersPreparedEvent
func (obj *SOAPClient) SetOnHeadersPreparedHandler(handlerFunc SOAPClientHeadersPreparedEvent)

Remarks

The prepared headers are available in RequestHeaders property. This event provides you the last chance to review/alter them.

HeadersReceived Event (SOAPClient Component)

Fires when the HTTP response headers have just been received from the server.

Syntax

// SOAPClientHeadersReceivedEventArgs carries the SOAPClient HeadersReceived event's parameters.
type SOAPClientHeadersReceivedEventArgs struct {...}

// SOAPClientHeadersReceivedEvent defines the signature of the SOAPClient HeadersReceived event's handler function.
type SOAPClientHeadersReceivedEvent func(sender *SOAPClient, args *SOAPClientHeadersReceivedEventArgs)

func (obj *SOAPClient) GetOnHeadersReceivedHandler() SOAPClientHeadersReceivedEvent
func (obj *SOAPClient) SetOnHeadersReceivedHandler(handlerFunc SOAPClientHeadersReceivedEvent)

Remarks

The received headers are available via the ResponseHeaders property.

Notification Event (SOAPClient Component)

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

Syntax

// SOAPClientNotificationEventArgs carries the SOAPClient Notification event's parameters.
type SOAPClientNotificationEventArgs struct {...}

func (args *SOAPClientNotificationEventArgs) EventID() string
func (args *SOAPClientNotificationEventArgs) EventParam() string
// SOAPClientNotificationEvent defines the signature of the SOAPClient Notification event's handler function.
type SOAPClientNotificationEvent func(sender *SOAPClient, args *SOAPClientNotificationEventArgs)

func (obj *SOAPClient) GetOnNotificationHandler() SOAPClientNotificationEvent
func (obj *SOAPClient) SetOnNotificationHandler(handlerFunc SOAPClientNotificationEvent)

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.

This struct can fire this event with the following EventID values:


TLSExtensions.CertificateStatus	TBD
TLSExtensions.PreSharedIdentityHint	TBD

Progress Event (SOAPClient Component)

Fires periodically during the data transfer.

Syntax

// SOAPClientProgressEventArgs carries the SOAPClient Progress event's parameters.
type SOAPClientProgressEventArgs struct {...}

func (args *SOAPClientProgressEventArgs) Total() int64
func (args *SOAPClientProgressEventArgs) Current() int64
func (args *SOAPClientProgressEventArgs) Cancel() bool
func (args *SOAPClientProgressEventArgs) SetCancel(value bool)

// SOAPClientProgressEvent defines the signature of the SOAPClient Progress event's handler function.
type SOAPClientProgressEvent func(sender *SOAPClient, args *SOAPClientProgressEventArgs)

func (obj *SOAPClient) GetOnProgressHandler() SOAPClientProgressEvent
func (obj *SOAPClient) SetOnProgressHandler(handlerFunc SOAPClientProgressEvent)

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

Redirection Event (SOAPClient Component)

Fires when the server suggests a redirect.

Syntax

// SOAPClientRedirectionEventArgs carries the SOAPClient Redirection event's parameters.
type SOAPClientRedirectionEventArgs struct {...}

func (args *SOAPClientRedirectionEventArgs) OldURL() string
func (args *SOAPClientRedirectionEventArgs) NewURL() string
func (args *SOAPClientRedirectionEventArgs) SetNewURL(value string)

func (args *SOAPClientRedirectionEventArgs) AllowRedirection() bool
func (args *SOAPClientRedirectionEventArgs) SetAllowRedirection(value bool)

// SOAPClientRedirectionEvent defines the signature of the SOAPClient Redirection event's handler function.
type SOAPClientRedirectionEvent func(sender *SOAPClient, args *SOAPClientRedirectionEventArgs)

func (obj *SOAPClient) GetOnRedirectionHandler() SOAPClientRedirectionEvent
func (obj *SOAPClient) SetOnRedirectionHandler(handlerFunc SOAPClientRedirectionEvent)

Remarks

This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). OldURL indicates the 'from' page, and NewURL indicates the 'to' one. The destination page can be altered by the application if needed. Use AllowRedirection to block undesirable redirects.

Generally, this is a notification event: the component handles redirections automatically. Use the MaxRedirections config property to limit the number of redirection hops.

TLSCertNeeded Event (SOAPClient Component)

Fires when a remote TLS party requests a client certificate.

Syntax

// SOAPClientTLSCertNeededEventArgs carries the SOAPClient TLSCertNeeded event's parameters.
type SOAPClientTLSCertNeededEventArgs struct {...}

func (args *SOAPClientTLSCertNeededEventArgs) Host() string
func (args *SOAPClientTLSCertNeededEventArgs) CANames() string
// SOAPClientTLSCertNeededEvent defines the signature of the SOAPClient TLSCertNeeded event's handler function.
type SOAPClientTLSCertNeededEvent func(sender *SOAPClient, args *SOAPClientTLSCertNeededEventArgs)

func (obj *SOAPClient) GetOnTLSCertNeededHandler() SOAPClientTLSCertNeededEvent
func (obj *SOAPClient) SetOnTLSCertNeededHandler(handlerFunc SOAPClientTLSCertNeededEvent)

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (SOAPClient Component)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

// SOAPClientTLSCertValidateEventArgs carries the SOAPClient TLSCertValidate event's parameters.
type SOAPClientTLSCertValidateEventArgs struct {...}

func (args *SOAPClientTLSCertValidateEventArgs) ServerHost() string
func (args *SOAPClientTLSCertValidateEventArgs) ServerIP() string
func (args *SOAPClientTLSCertValidateEventArgs) Accept() bool
func (args *SOAPClientTLSCertValidateEventArgs) SetAccept(value bool)

// SOAPClientTLSCertValidateEvent defines the signature of the SOAPClient TLSCertValidate event's handler function.
type SOAPClientTLSCertValidateEvent func(sender *SOAPClient, args *SOAPClientTLSCertValidateEventArgs)

func (obj *SOAPClient) GetOnTLSCertValidateHandler() SOAPClientTLSCertValidateEvent
func (obj *SOAPClient) SetOnTLSCertValidateHandler(handlerFunc SOAPClientTLSCertValidateEvent)

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, structs may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the struct, and can be adjusted if needed.

TLSEstablished Event (SOAPClient Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

// SOAPClientTLSEstablishedEventArgs carries the SOAPClient TLSEstablished event's parameters.
type SOAPClientTLSEstablishedEventArgs struct {...}

func (args *SOAPClientTLSEstablishedEventArgs) Host() string
func (args *SOAPClientTLSEstablishedEventArgs) Version() string
func (args *SOAPClientTLSEstablishedEventArgs) Ciphersuite() string
func (args *SOAPClientTLSEstablishedEventArgs) ConnectionId() []byte
func (args *SOAPClientTLSEstablishedEventArgs) Abort() bool
func (args *SOAPClientTLSEstablishedEventArgs) SetAbort(value bool)

// SOAPClientTLSEstablishedEvent defines the signature of the SOAPClient TLSEstablished event's handler function.
type SOAPClientTLSEstablishedEvent func(sender *SOAPClient, args *SOAPClientTLSEstablishedEventArgs)

func (obj *SOAPClient) GetOnTLSEstablishedHandler() SOAPClientTLSEstablishedEvent
func (obj *SOAPClient) SetOnTLSEstablishedHandler(handlerFunc SOAPClientTLSEstablishedEvent)

Remarks

The struct uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (SOAPClient Component)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

// SOAPClientTLSHandshakeEventArgs carries the SOAPClient TLSHandshake event's parameters.
type SOAPClientTLSHandshakeEventArgs struct {...}

func (args *SOAPClientTLSHandshakeEventArgs) Host() string
func (args *SOAPClientTLSHandshakeEventArgs) Abort() bool
func (args *SOAPClientTLSHandshakeEventArgs) SetAbort(value bool)

// SOAPClientTLSHandshakeEvent defines the signature of the SOAPClient TLSHandshake event's handler function.
type SOAPClientTLSHandshakeEvent func(sender *SOAPClient, args *SOAPClientTLSHandshakeEventArgs)

func (obj *SOAPClient) GetOnTLSHandshakeHandler() SOAPClientTLSHandshakeEvent
func (obj *SOAPClient) SetOnTLSHandshakeHandler(handlerFunc SOAPClientTLSHandshakeEvent)

Remarks

The struct uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (SOAPClient Component)

Notifies the application about the PSK key exchange.

Syntax

// SOAPClientTLSPSKEventArgs carries the SOAPClient TLSPSK event's parameters.
type SOAPClientTLSPSKEventArgs struct {...}

func (args *SOAPClientTLSPSKEventArgs) Host() string
func (args *SOAPClientTLSPSKEventArgs) Hint() string
// SOAPClientTLSPSKEvent defines the signature of the SOAPClient TLSPSK event's handler function.
type SOAPClientTLSPSKEvent func(sender *SOAPClient, args *SOAPClientTLSPSKEventArgs)

func (obj *SOAPClient) GetOnTLSPSKHandler() SOAPClientTLSPSKEvent
func (obj *SOAPClient) SetOnTLSPSKHandler(handlerFunc SOAPClientTLSPSKEvent)

Remarks

The struct fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (SOAPClient Component)

Reports the graceful closure of a TLS connection.

Syntax

// SOAPClientTLSShutdownEventArgs carries the SOAPClient TLSShutdown event's parameters.
type SOAPClientTLSShutdownEventArgs struct {...}

func (args *SOAPClientTLSShutdownEventArgs) Host() string
// SOAPClientTLSShutdownEvent defines the signature of the SOAPClient TLSShutdown event's handler function.
type SOAPClientTLSShutdownEvent func(sender *SOAPClient, args *SOAPClientTLSShutdownEventArgs)

func (obj *SOAPClient) GetOnTLSShutdownHandler() SOAPClientTLSShutdownEvent
func (obj *SOAPClient) SetOnTLSShutdownHandler(handlerFunc SOAPClientTLSShutdownEvent)

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (SOAPClient 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.

HTTPClient Config Settings

AttachmentContentDescription: Specifies attachment content description.

Specifies content description for the attachment.

AttachmentContentId: Specifies attachment content Id.

Specifies content Id for the attachment.

AttachmentContentType: Specifies attachment content type.

Specifies content type for the attachment.

AttachmentFilename: Specifies attachment filename.

Specifies filename for the attachment.

AuthStickToLastURL: TBD.

TBD

CachedCRLMaxAge: Specifies the maximum age of a cached CRL.

Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.

The default value is 0, which disables the absolute CRL age check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedCRLMaxAgeRatio: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.

Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.

The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedCRLOverlapTime: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.

Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

The default value is 0, which disables the CRL overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from CachedCRLMaxAge and CachedCRLMaxAgeRatio. If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.

CachedOCSPResponseMaxAge: Specifies the maximum age of a cached OCSP response.

Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedOCSPResponseMaxAgeRatio: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.

Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use CachedOCSPResponseMaxAge to limit their age. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedOCSPResponseOverlapTime: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.

Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from CachedOCSPResponseMaxAge and CachedOCSPResponseMaxAgeRatio. If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.

Cookies: TBD.

TBD

DefClientCookieFmt: TBD.

TBD

DeltaCRLPreference: Specifies whether complete or delta CRLs are preferred.

Use this setting to specify which CRL type should be preferred during TLS certificate revocation checks.

The default value is dcrlpPreferDelta (0).

Supported values:

dcrlpPreferDelta (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
dcrlpPreferComplete (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.

EvaluateSystemTrust: Enables or disables usage of the platform's built-in trust validation facilities.

Enable this property to delegate the chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

FaultActor[Index]: Specifies who caused the fault.

Use this property to get the URI associated with the actor (SOAP node) that caused the fault. In RPC-style messaging, the actor is the URI of the Web service.

FaultCode[Index]: Specifies the error code.

FaultCount: The number of faults.

Returns the number of the faults obtained.

FaultDetail[Index]: Contains application-specific error information.

Use this property to get the application-specific information, such as the exception that was thrown. This element can be an XML structure or plain text.

FaultString[Index]: Specifies a human-readable description of fault.

Use this property to get the human-readable description of the error.

FaultXML[Index]: Specifies the XML content of the fault.

Use this property to get the XML content of the fault.

ForceNTLMAuth: Activates and enforces NTLM authentication.

Set this property to True to force NTLM (Windows Integrated) authentication.

IgnoreCookieSecureFlag: TBD.

TBD

IgnoreSystemTrust: Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the struct should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the struct should trust the certificates residing in the Trusted Root Certification Authorities store.

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.

IgnoreUnknownTransferEncodings: All incoming responses with unknown transfer encodings are ignored if this property is true.

All incoming responses with unknown transfer encodings are ignored if this property is true.

KeepConnectionOpen: TBD.

TBD

MaxRedirections: The maximum number of HTTP redirects.

Specifies the maximum number of HTTP redirects. Value 0 prevents any redirections, and -1 allows unlimited redirections.

PersistentAuthHeader: Whether to resend NTLM negotiation on every request.

Specifies whether to resend NTLM negotiation on every request.

RelatedStartInfo: Specifies Start-Info parameter.

Specifies additional information required for unpacking or processing of the content. It is optional Start-Info parameter of the Multipart/Related media type.

RelatedType: Specifies media type/subtype.

Specifies media type/subtype of message's content. Use this property to override default media type. It is Type parameter of the Multipart/Related media type.

RequestCompressionGZip: Ask server to enforce GZip compression.

Ask the server to use GZip compression instead of Deflate. This setting only makes sense when UseCompression is set to true. Most modern servers support both Deflate and GZip, so primary use case for this setting is the need to communicate to an older server.

RequestCompressionLevel: Ask server to use the specified compression level.

Ask server to use the specified compression level.

RevocationCacheAgePolicy: Specifies a preset policy for cached CRL and OCSP response freshness settings.

Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled.

Supported values are case-insensitive:


Disabled	Sets CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache.
Default	Applies the component default freshness settings. For this component, Default is equivalent to Disabled.
Short	Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes.
Long	Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour.
N	Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50.
crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap>	Sets the CRL and OCSP response freshness values explicitly.

Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.

SendBufferSize: Size of send buffer in bytes.

The size of blocks used to send data to the server.

SkipInputProcessing: Whether to skip input processing.

Set this property to True to enforce the struct to send input data as-is.

SkipOutputParsing: Whether to skip output parsing.

Set this property to True to enforce the struct to not to parse the output. In this case, SOAPResponseType property value will be either srtUnknown or srtBinary, and OperationResponse* and Fault* properties will not be set.

SOAPPrefix: Specifies the signature prefix.

Specifies the prefix for the SOAPMessage elements.

Default value is "". In this case no prefix will be used.

Special values:


"#default" or ""	indicates that the prefix will be omitted.
"#auto"	indicates that the prefix will be auto-detected based on the parent nodes.

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.

SuppressRedirectionContent: Whether to suppress the redirection content.

If this property is set to True, the redirection content will be silently suppressed by the struct. Otherwise the message containing a redirection code will be processed as usual, the Redirection event will be fired, and the data will be written to OutputString or OutputBytes.

TempPath: Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except PDFSigner, where this limitation does not apply.

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

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

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.

TolerateMinorChainIssues: Whether to tolerate minor chain issues.

This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are:

CA, revocation source, TLS key usage requirements are not mandated
Violation of OCSP issuer requirements are ignored
The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates)
Basic constraints and name constraints of CA certificates are ignored
Some weaker algorithms are tolerated

Use100Continue: Whether to use 100-continue for POST and PUT commands.

Set this property to True to use the 100-continue approach for POST and PUT commands. In this approach, prior to sending the request body, the client sends a request message asking the server whether it is willing to accept the request body. The request body is sent only if the server accepts it.

UseCompression: Enables compression capability.

Use this property to tell the server that it can compress the response data if it wants to. Deflate mechanism is requested by default; use RequestCompressionGZip to change that to GZip.

UseEnvStorages: Enables or disables use of the environment storages.

Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.

UseKerberosAuth: TBD.

TBD

UseMicrosoftCTL: Enables or disables the automatic use of the Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseSOAPAction: Whether to use SOAP Action.

Set this property to False to disable adding SOAPAction/action header field.

UseSystemCertificates: Enables or disables the use of the system certificates.

Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.

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.

StaticIPAddresses: Gets or sets all the static DNS rules.

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.

TLSSessionLifetime: Specifies lifetime in seconds of the cached TLS session.

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

SOAPClient 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`)
19922945	Unsupported keep-alive policy (`SB_ERROR_HTTP_UNSUPPORTED_KEEPALIVEPOLICY`)
19922946	Wrong request filter string format (`SB_ERROR_HTTP_WRONG_REQUEST_FILTER_FORMAT`)
19922947	Failed to subscribe to server-sent events service (`SB_ERROR_HTTP_FAILED_TO_SUBSCRIBE`)
33554433	The input file does not exist (`SB_ERROR_SOAP_INPUTFILE_NOT_EXISTS`)
33554434	Invalid key type (`SB_ERROR_SOAP_INVALID_KEY_TYPE`)
33554435	No signature found to complete the asynchronous signing (`SB_ERROR_SOAP_SIGNATURE_NOT_FOUND`)
33554436	Unsupported signature type (`SB_ERROR_SOAP_UNSUPPORTED_SIGNATURE_TYPE`)
33554437	Unexpected HTTP status code (`SB_ERROR_SOAP_UNEXPECTED_HTTP_STATUS_CODE`)
33554438	SOAP service failed (`SB_ERROR_SOAP_SERVICE_FAILED`)