XMLVerifier Class

Properties Methods Events Configuration Settings Errors

The XMLVerifier class verifies signed XML files.

Syntax

XMLVerifier

Remarks

Use this control to validate XML-SIG signatures. Note that this component only validates the signatures, but not the signing chains. To validate the signing chains, use XAdESVerifier.

Property List

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


AllSignaturesValid	The cumulative validity of all signatures.
CanonicalizationMethod	The XML canonicalization method that was used for signing.
DataFile	A file containing the external data covered by a detached signature.
Encoding	Specifies XML encoding.
FIPSMode	Reserved.
HashAlgorithm	The hash algorithm used for signing.
InputBytes	Use this property to pass the input to class in the byte array form.
InputFile	A signed XML file.
KnownCertCount	The number of records in the KnownCert arrays.
KnownCertBytes	Returns raw certificate data in DER format.
KnownCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ReferenceCount	The number of records in the Reference arrays.
ReferenceAutoGenerateElementId	Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.
ReferenceCanonicalizationMethod	Use this property to specify the canonicalization method for the transform of the reference.
ReferenceCustomElementId	Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.
ReferenceDigestValue	Use this property to get or set the value of the digest calculated over the referenced data.
ReferenceHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ReferenceHashAlgorithm	Specifies the hash algorithm to be used.
ReferenceHasURI	Specifies whether the URI is set (even when it is empty).
ReferenceID	A user-defined identifier (ID) attribute of this Reference element.
ReferenceInclusiveNamespacesPrefixList	Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.
ReferenceReferenceType	The Reference's type attribute as defined in XMLDSIG specification.
ReferenceTargetData	Contains the referenced external data when the digest value is not explicitly specified.
ReferenceTargetXMLElement	This property specifies the referenced XML element.
ReferenceURI	Use this property to get or set the URL which references the data.
ReferenceUseBase64Transform	Specifies whether Base64 transform is included in transform chain.
ReferenceUseEnvelopedSignatureTransform	Specifies whether enveloped signature transform is included in transform chain.
ReferenceUseXPathFilter2Transform	Specifies whether XPath Filter 2.
ReferenceUseXPathTransform	Specifies whether XPath transform is included in transform chain.
ReferenceXPathExpression	Use this property to specify XPath expression for XPath transform of the reference.
ReferenceXPathFilter2Expressions	Use this property to specify XPointer expression(s) for XPath Filter 2.
ReferenceXPathFilter2Filters	Use this property to specify XPointer filter(s) for XPath Filter 2.
ReferenceXPathFilter2PrefixList	Use this property to specify a prefix list for XPath Filter 2.
ReferenceXPathPrefixList	Use this property to specify a prefix list for XPath transform of the reference.
SignatureBytes	TBD.
SignatureValidationResult	Contains the signature validation result.
SigningCertBytes	Returns raw certificate data in DER format.
SigningCertCA	Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
SigningCertCAKeyID	A unique identifier (fingerprint) of the CA certificate's private key.
SigningCertCRLDistributionPoints	Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
SigningCertCurve	Specifies the elliptic curve of the EC public key.
SigningCertFingerprint	Contains the fingerprint (a hash imprint) of this certificate.
SigningCertFriendlyName	Contains an associated alias (friendly name) of the certificate.
SigningCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
SigningCertHashAlgorithm	Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
SigningCertIssuer	The common name of the certificate issuer (CA), typically a company name.
SigningCertIssuerRDN	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
SigningCertKeyAlgorithm	Specifies the public key algorithm of this certificate.
SigningCertKeyBits	Returns the length of the public key.
SigningCertKeyFingerprint	Returns a fingerprint of the public key contained in the certificate.
SigningCertKeyUsage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
SigningCertKeyValid	Returns True if the certificate's key is cryptographically valid, and False otherwise.
SigningCertOCSPLocations	Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
SigningCertPolicyIDs	Contains identifiers (OIDs) of the applicable certificate policies.
SigningCertPublicKeyBytes	Contains the certificate's public key in DER format.
SigningCertSelfSigned	Indicates whether the certificate is self-signed (root) or signed by an external CA.
SigningCertSerialNumber	Returns the certificate's serial number.
SigningCertSigAlgorithm	Indicates the algorithm that was used by the CA to sign this certificate.
SigningCertSubject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
SigningCertSubjectKeyID	Contains a unique identifier (fingerprint) of the certificate's private key.
SigningCertSubjectRDN	A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
SigningCertValidFrom	The time point at which the certificate becomes valid, in UTC.
SigningCertValidTo	The time point at which the certificate expires, in UTC.
XMLElement	Specifies the XML element containing the signature.
NamespaceCount	The number of records in the Namespace arrays.
NamespacePrefix	A user-defined prefix value of a namespace.
NamespaceURI	A user-defined URI value of a namespace.

Method List

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


Config	Sets or retrieves a configuration setting.
DoAction	Performs an additional action.
Verify	Verifies a signed XML document.
VerifyDetached	Verifies a detached signature over external XML data.

Event List

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


Error	Information about errors during signature verification.
Notification	This event notifies the application about an underlying control flow event.
ReferenceValidated	Marks the end of a reference validation.
ResolveReference	Asks the application to resolve a reference.
SignatureFound	Signifies the start of signature validation.
SignatureValidated	Reports the signature validation result.

Configuration Settings

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


DataType	Specifies the external data type.
DetachedResourceURI	Specifies a detached resource URI.
HMACKey	The key value for HMAC.
HMACSigningUsed	Whether HMAC signing was used.
IDAttributeName	Specifies the custom name of ID attribute.
IDAttributeNamespaceURI	Specifies the custom namespace URI of ID attribute.
InclusiveNamespacesPrefixList	Specifies the InclusiveNamespaces PrefixList.
KeyName	Identifies the key.
ManifestCount	The number of the manifest elements.
ManifestID[Index]	The ID of the manifest element.
ManifestObjectIndex[Index]	The object element index to which the manifest element belongs.
ManifestXML[Index]	The XML content of the manifest element.
ObjectCount	The number of the object elements.
ObjectEncoding[Index]	The Encoding of the object element.
ObjectID[Index]	The ID of the object element.
ObjectMimeType[Index]	The MIME type of the object element.
ObjectXML[Index]	The XML content of the object element.
PSSUsed	Whether RSASSA-PSS mode was used.
SignatureCompliance	SIgnature compliance with XMLDSig/EBICS.
SignatureID	Contains the ID for Signature element.
SignaturePropertiesCount	The number of the signature properties elements.
SignaturePropertiesID[Index]	The ID of the signature properties element.
SignaturePropertiesObjectIndex[Index]	The object element index to which the signature properties element belongs.
SignaturePropertiesXML[Index]	The XML content of the signature properties element.
SignaturePropertyCount	The number of the signature property elements.
SignaturePropertyID[Index]	The ID of the signature properties element.
SignaturePropertyPropertiesIndex[Index]	The signature properties element index to which the signature property element belongs.
SignaturePropertyTarget[Index]	The Target of the signature properties element.
SignaturePropertyXML[Index]	The XML content of the signature property element.
TempPath	Location where the temporary files are stored.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
Tag	Allows to store any custom data.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

AllSignaturesValid Property (XMLVerifier Class)

The cumulative validity of all signatures.

Syntax

bool GetAllSignaturesValid();

Default Value

false

Remarks

Use this property to check if all the signatures found in the message or document are valid.

This property is read-only and not available at design time.

Data Type

Boolean

CanonicalizationMethod Property (XMLVerifier Class)

The XML canonicalization method that was used for signing.

Syntax

int GetCanonicalizationMethod();

Possible Values

CXCM_NONE(0), 
CXCM_CANON(1), 
CXCM_CANON_COMMENT(2), 
CXCM_EXCL_CANON(3), 
CXCM_EXCL_CANON_COMMENT(4), 
CXCM_MIN_CANON(5), 
CXCM_CANON_V_1_1(6), 
CXCM_CANON_COMMENT_V_1_1(7)

Default Value

Remarks

Use this property to get the XML canonicalization method used for SignedInfo element. See XML-Signature Syntax and Processing specification for details.

Supported canonicalization methods:


cxcmNone	`0`
cxcmCanon	`1`
cxcmCanonComment	`2`
cxcmExclCanon	`3`
cxcmExclCanonComment	`4`
cxcmMinCanon	`5`
cxcmCanon_v1_1	`6`
cxcmCanonComment_v1_1	`7`

This property is read-only and not available at design time.

Data Type

Integer

DataFile Property (XMLVerifier Class)

A file containing the external data covered by a detached signature.

Syntax

QString GetDataFile();
int SetDataFile(QString qsDataFile);

Default Value

Remarks

In the case of a detached signature, use this property to provide the external data to the class from a file. Alternatively, provide the data via DataStream.

Data Type

String

Encoding Property (XMLVerifier Class)

Specifies XML encoding.

Syntax

QString GetEncoding();
int SetEncoding(QString qsEncoding);

Default Value

Remarks

Use this property to specify the encoding to apply to the XML documents.

Data Type

String

FIPSMode Property (XMLVerifier Class)

Reserved.

Syntax

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (XMLVerifier Class)

The hash algorithm used for signing.

Syntax

QString GetHashAlgorithm();

Default Value

"Unknown"

Remarks

Use this property to check which hash algorithm was used.

Supported values:


SB_HASH_ALGORITHM_MD5	`MD5`
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_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

This property is read-only and not available at design time.

Data Type

String

InputBytes Property (XMLVerifier Class)

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

Syntax

QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (XMLVerifier Class)

A signed XML file.

Syntax

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

Remarks

Provide a path to the signed XML document in this property.

Data Type

String

KnownCertCount Property (XMLVerifier Class)

The number of records in the KnownCert arrays.

Syntax

int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

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.

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (XMLVerifier Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns 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 and not available at design time.

Data Type

Byte Array

KnownCertHandle Property (XMLVerifier Class)

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

Syntax

qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

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 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 not available at design time.

Data Type

Long64

ReferenceCount Property (XMLVerifier Class)

The number of records in the Reference arrays.

Syntax

int GetReferenceCount();

Default Value

Remarks

This property controls the size of the following arrays:

ReferenceAutoGenerateElementId
ReferenceCanonicalizationMethod
ReferenceCustomElementId
ReferenceDigestValue
ReferenceHandle
ReferenceHashAlgorithm
ReferenceHasURI
ReferenceID
ReferenceInclusiveNamespacesPrefixList
ReferenceReferenceType
ReferenceTargetData
ReferenceTargetXMLElement
ReferenceURI
ReferenceUseBase64Transform
ReferenceUseEnvelopedSignatureTransform
ReferenceUseXPathFilter2Transform
ReferenceUseXPathTransform
ReferenceXPathExpression
ReferenceXPathFilter2Expressions
ReferenceXPathFilter2Filters
ReferenceXPathFilter2PrefixList
ReferenceXPathPrefixList

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

This property is read-only and not available at design time.

Data Type

Integer

ReferenceAutoGenerateElementId Property (XMLVerifier Class)

Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.

Syntax

bool GetReferenceAutoGenerateElementId(int iReferenceIndex);

Default Value

false

Remarks

Specifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing. Used when the referenced element doesn't have an ID and CustomElementId and URI properties are empty.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ReferenceCanonicalizationMethod Property (XMLVerifier Class)

Use this property to specify the canonicalization method for the transform of the reference.

Syntax

int GetReferenceCanonicalizationMethod(int iReferenceIndex);

Possible Values

CXCM_NONE(0), 
CXCM_CANON(1), 
CXCM_CANON_COMMENT(2), 
CXCM_EXCL_CANON(3), 
CXCM_EXCL_CANON_COMMENT(4), 
CXCM_MIN_CANON(5), 
CXCM_CANON_V_1_1(6), 
CXCM_CANON_COMMENT_V_1_1(7)

Default Value

Remarks

Use this property to specify the canonicalization method for the transform of the reference. Use cxcmNone value to not to include canonicalization transform in transform chain. See XML-Signature Syntax and Processing specification for details.


cxcmNone	`0`
cxcmCanon	`1`
cxcmCanonComment	`2`
cxcmExclCanon	`3`
cxcmExclCanonComment	`4`
cxcmMinCanon	`5`
cxcmCanon_v1_1	`6`
cxcmCanonComment_v1_1	`7`

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Integer

ReferenceCustomElementId Property (XMLVerifier Class)

Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.

Syntax

QString GetReferenceCustomElementId(int iReferenceIndex);

Default Value

Remarks

Specifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing. Used when the referenced element doesn't have an ID and URI property is empty.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceDigestValue Property (XMLVerifier Class)

Use this property to get or set the value of the digest calculated over the referenced data.

Syntax

QByteArray GetReferenceDigestValue(int iReferenceIndex);

Remarks

Use this property to get or set the value of the digest calculated over the referenced data.

This property is optional and should be set only if you don't provide the actual data via TargetData or URI. If the data is set, then you don't need to set DigestValue since it will be calculated automatically.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ReferenceHandle Property (XMLVerifier Class)

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

Syntax

qint64 GetReferenceHandle(int iReferenceIndex);

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

This property is read-only and not available at design time.

Data Type

Long64

ReferenceHashAlgorithm Property (XMLVerifier Class)

Specifies the hash algorithm to be used.

Syntax

QString GetReferenceHashAlgorithm(int iReferenceIndex);

Default Value

"SHA256"

Remarks

Specifies the hash algorithm to be used.

Supported values:


SB_HASH_ALGORITHM_MD5	`MD5`
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_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceHasURI Property (XMLVerifier Class)

Specifies whether the URI is set (even when it is empty).

Syntax

bool GetReferenceHasURI(int iReferenceIndex);

Default Value

true

Remarks

Specifies whether the URI is set (even when it is empty).

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ReferenceID Property (XMLVerifier Class)

A user-defined identifier (ID) attribute of this Reference element.

Syntax

QString GetReferenceID(int iReferenceIndex);

Default Value

Remarks

A user-defined identifier (ID) attribute of this Reference element.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceInclusiveNamespacesPrefixList Property (XMLVerifier Class)

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.

Syntax

QString GetReferenceInclusiveNamespacesPrefixList(int iReferenceIndex);

Default Value

Remarks

Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceReferenceType Property (XMLVerifier Class)

The Reference's type attribute as defined in XMLDSIG specification.

Syntax

QString GetReferenceReferenceType(int iReferenceIndex);

Default Value

Remarks

The Reference's type attribute as defined in XMLDSIG specification.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceTargetData Property (XMLVerifier Class)

Contains the referenced external data when the digest value is not explicitly specified.

Syntax

QByteArray GetReferenceTargetData(int iReferenceIndex);

Remarks

Contains the referenced external data when the digest value is not explicitly specified.

This property is optional and should only be set if you reference the external data via URI, and you don't provide the digest value explicitly via DigestValue.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

ReferenceTargetXMLElement Property (XMLVerifier Class)

This property specifies the referenced XML element.

Syntax

QString GetReferenceTargetXMLElement(int iReferenceIndex);

Default Value

Remarks

This property specifies the referenced XML element. Used when the URI property is not set. In this case, the URI value is generated based on the ID of the referenced (target) XML element. If the URI property is set, this property is ignored until the ResolveReference event.

Supported values are:


""	an empty string indicates the Document element.
"#id"	indicates an XML element with specified Id.
XPointer expression	indicates an XML element selected using XPointer expression. Use the XPathNamespaces property to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined in XPathNamespaces property
Node name	indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data".

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceURI Property (XMLVerifier Class)

Use this property to get or set the URL which references the data.

Syntax

QString GetReferenceURI(int iReferenceIndex);

Default Value

Remarks

Use this property to get or set the URL which references the data. If the data is external, the application must set either TargetData or DigestValue. If TargetData is set, the digest is calculated automatically unless it is explicitly set by the application via DigestValue.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceUseBase64Transform Property (XMLVerifier Class)

Specifies whether Base64 transform is included in transform chain.

Syntax

bool GetReferenceUseBase64Transform(int iReferenceIndex);

Default Value

false

Remarks

Specifies whether Base64 transform is included in transform chain.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ReferenceUseEnvelopedSignatureTransform Property (XMLVerifier Class)

Specifies whether enveloped signature transform is included in transform chain.

Syntax

bool GetReferenceUseEnvelopedSignatureTransform(int iReferenceIndex);

Default Value

false

Remarks

Specifies whether enveloped signature transform is included in transform chain.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ReferenceUseXPathFilter2Transform Property (XMLVerifier Class)

Specifies whether XPath Filter 2.

Syntax

bool GetReferenceUseXPathFilter2Transform(int iReferenceIndex);

Default Value

false

Remarks

Specifies whether XPath Filter 2.0 transform is included in transform chain.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ReferenceUseXPathTransform Property (XMLVerifier Class)

Specifies whether XPath transform is included in transform chain.

Syntax

bool GetReferenceUseXPathTransform(int iReferenceIndex);

Default Value

false

Remarks

Specifies whether XPath transform is included in transform chain.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ReferenceXPathExpression Property (XMLVerifier Class)

Use this property to specify XPath expression for XPath transform of the reference.

Syntax

QString GetReferenceXPathExpression(int iReferenceIndex);

Default Value

Remarks

Use this property to specify XPath expression for XPath transform of the reference.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceXPathFilter2Expressions Property (XMLVerifier Class)

Use this property to specify XPointer expression(s) for XPath Filter 2.

Syntax

QString GetReferenceXPathFilter2Expressions(int iReferenceIndex);

Default Value

Remarks

Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference.

TBD

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceXPathFilter2Filters Property (XMLVerifier Class)

Use this property to specify XPointer filter(s) for XPath Filter 2.

Syntax

QString GetReferenceXPathFilter2Filters(int iReferenceIndex);

Default Value

Remarks

Use this property to specify XPointer filter(s) for XPath Filter 2.0 transform of the reference. The prefix list is comma-separated.

Supported values:


"intersect"	Intersect filter computes the intersection of the selected subtrees with the filter node-set.
"subtract"	Subtract filter computes the subtraction of the selected subtrees with the filter node-set.
"union"	Union filter computes the union of the selected subtrees with the filter node-set.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceXPathFilter2PrefixList Property (XMLVerifier Class)

Use this property to specify a prefix list for XPath Filter 2.

Syntax

QString GetReferenceXPathFilter2PrefixList(int iReferenceIndex);

Default Value

Remarks

Use this property to specify a prefix list for XPath Filter 2.0 transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceXPathPrefixList Property (XMLVerifier Class)

Use this property to specify a prefix list for XPath transform of the reference.

Syntax

QString GetReferenceXPathPrefixList(int iReferenceIndex);

Default Value

Remarks

Use this property to specify a prefix list for XPath transform of the reference. The prefix list is space-separated. Namespace URIs that are used are taken from XPathNamespaces property.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

SignatureBytes Property (XMLVerifier Class)

TBD.

Syntax

QByteArray GetSignatureBytes();

Remarks

TBD.

This property is read-only and not available at design time.

Data Type

Byte Array

SignatureValidationResult Property (XMLVerifier Class)

Contains the signature validation result.

Syntax

int GetSignatureValidationResult();

Possible Values

XSV_VALID(0), 
XSV_UNKNOWN(1), 
XSV_CORRUPTED(2), 
XSV_SIGNER_NOT_FOUND(3), 
XSV_FAILURE(4), 
XSV_REFERENCE_CORRUPTED(5)

Default Value

Remarks

Use this property to check the result of the most recent XML signature validation.


xsvValid	`0`
xsvUnknown	`1`
xsvCorrupted	`2`
xsvSignerNotFound	`3`
xsvFailure	`4`
xsvReferenceCorrupted	`5`

This property is read-only and not available at design time.

Data Type

Integer

SigningCertBytes Property (XMLVerifier Class)

Returns raw certificate data in DER format.

Syntax

QByteArray GetSigningCertBytes();

Remarks

Returns raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCA Property (XMLVerifier Class)

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

Syntax

bool GetSigningCertCA();

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertCAKeyID Property (XMLVerifier Class)

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

Syntax

QByteArray GetSigningCertCAKeyID();

Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (XMLVerifier Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

QString GetSigningCertCRLDistributionPoints();

Default Value

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is read-only and not available at design time.

Data Type

String

SigningCertCurve Property (XMLVerifier Class)

Specifies the elliptic curve of the EC public key.

Syntax

QString GetSigningCertCurve();

Default Value

Remarks

Specifies the elliptic curve of the EC public key.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

This property is read-only and not available at design time.

Data Type

String

SigningCertFingerprint Property (XMLVerifier Class)

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

Syntax

QByteArray GetSigningCertFingerprint();

Remarks

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

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertFriendlyName Property (XMLVerifier Class)

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

Syntax

QString GetSigningCertFriendlyName();

Default Value

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertHandle Property (XMLVerifier Class)

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

Syntax

qint64 GetSigningCertHandle();

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.

This property is read-only and not available at design time.

Data Type

Long64

SigningCertHashAlgorithm Property (XMLVerifier Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Syntax

QString GetSigningCertHashAlgorithm();

Default Value

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuer Property (XMLVerifier Class)

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

Syntax

QString GetSigningCertIssuer();

Default Value

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuerRDN Property (XMLVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

QString GetSigningCertIssuerRDN();

Default Value

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyAlgorithm Property (XMLVerifier Class)

Specifies the public key algorithm of this certificate.

Syntax

QString GetSigningCertKeyAlgorithm();

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`

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyBits Property (XMLVerifier Class)

Returns the length of the public key.

Syntax

int GetSigningCertKeyBits();

Default Value

Remarks

Returns the length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyFingerprint Property (XMLVerifier Class)

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

Syntax

QByteArray GetSigningCertKeyFingerprint();

Remarks

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

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertKeyUsage Property (XMLVerifier Class)

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

Syntax

int GetSigningCertKeyUsage();

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

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyValid Property (XMLVerifier Class)

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

Syntax

bool GetSigningCertKeyValid();

Default Value

false

Remarks

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

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertOCSPLocations Property (XMLVerifier Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

QString GetSigningCertOCSPLocations();

Default Value

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is read-only and not available at design time.

Data Type

String

SigningCertPolicyIDs Property (XMLVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

QString GetSigningCertPolicyIDs();

Default Value

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

This property is read-only and not available at design time.

Data Type

String

SigningCertPublicKeyBytes Property (XMLVerifier Class)

Contains the certificate's public key in DER format.

Syntax

QByteArray GetSigningCertPublicKeyBytes();

Remarks

Contains the certificate's public key in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSelfSigned Property (XMLVerifier Class)

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

Syntax

bool GetSigningCertSelfSigned();

Default Value

false

Remarks

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

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertSerialNumber Property (XMLVerifier Class)

Returns the certificate's serial number.

Syntax

QByteArray GetSigningCertSerialNumber();

Remarks

Returns the certificate's serial number.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSigAlgorithm Property (XMLVerifier Class)

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

Syntax

QString GetSigningCertSigAlgorithm();

Default Value

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertSubject Property (XMLVerifier Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

QString GetSigningCertSubject();

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 property is read-only and not available at design time.

Data Type

String

SigningCertSubjectKeyID Property (XMLVerifier Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

QByteArray GetSigningCertSubjectKeyID();

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSubjectRDN Property (XMLVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

QString GetSigningCertSubjectRDN();

Default Value

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

This property is read-only and not available at design time.

Data Type

String

SigningCertValidFrom Property (XMLVerifier Class)

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

Syntax

QString GetSigningCertValidFrom();

Default Value

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertValidTo Property (XMLVerifier Class)

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

Syntax

QString GetSigningCertValidTo();

Default Value

Remarks

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

This property is read-only and not available at design time.

Data Type

String

XMLElement Property (XMLVerifier Class)

Specifies the XML element containing the signature.

Syntax

QString GetXMLElement();
int SetXMLElement(QString qsXMLElement);

Default Value

Remarks

Specifies the XML element that contains the signature to be validated.

Supported values are:


""	an empty string indicates that all signatures will be verified.
"#id"	indicates an XML element with specified Id.
XPointer expression	indicates an XML element selected using XPointer expression. Use XPathNamespaces property to specify Prefixes and NamespaceURIs For example: "/root/data[1]" - indicates the second "data" element under the document element with a name "root" "//ns1:data" - indicates a data element. "ns1" prefix should be defined in XPathNamespaces property
Node name	indicates an XML element selected using its NodeName. For example: "data" - indicates an XML element with node name "data".

Data Type

String

NamespaceCount Property (XMLVerifier Class)

The number of records in the Namespace arrays.

Syntax

int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

Default Value

Remarks

This property controls the size of the following arrays:

NamespacePrefix
NamespaceURI

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

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (XMLVerifier Class)

A user-defined prefix value of a namespace.

Syntax

QString GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, QString qsNamespacePrefix);

Default Value

Remarks

A user-defined prefix value of a namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

NamespaceURI Property (XMLVerifier Class)

A user-defined URI value of a namespace.

Syntax

QString GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, QString qsNamespaceURI);

Default Value

Remarks

A user-defined URI value of a namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

Config Method (XMLVerifier Class)

Sets or retrieves a configuration setting.

Syntax

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (XMLVerifier Class)

Performs an additional action.

Syntax

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling

Verify Method (XMLVerifier Class)

Verifies a signed XML document.

Syntax

int Verify();

Remarks

Call this method to verify the signature embedded in the document. Pass the document via InputStream or InputFile property. Use VerifyDetached to verify the external data in case of a detached signature.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifyDetached Method (XMLVerifier Class)

Verifies a detached signature over external XML data.

Syntax

int VerifyDetached();

Remarks

Call this method to verify a signature over external (detached) data provided via DataStream or DataFile.

Error Handling

Error Event (XMLVerifier Class)

Information about errors during signature verification.

Syntax

class XMLVerifierErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(XMLVerifierErrorEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireError(XMLVerifierErrorEventParams *e) {...}

Remarks

The event is fired in case of exceptional conditions during verification.

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

Notification Event (XMLVerifier Class)

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

Syntax

class XMLVerifierNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(XMLVerifierNotificationEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireNotification(XMLVerifierNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

ReferenceValidated Event (XMLVerifier Class)

Marks the end of a reference validation.

Syntax

class XMLVerifierReferenceValidatedEventParams {
public:
  const QString &ID();

  const QString &URI();

  const QString &RefType();

  int ReferenceIndex();

  bool DigestValid();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ReferenceValidated(XMLVerifierReferenceValidatedEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireReferenceValidated(XMLVerifierReferenceValidatedEventParams *e) {...}

Remarks

The class fires this event to report completion of a reference validation. A reference is a building block of a signature as it binds signature coverage to a particular piece of the document.

ResolveReference Event (XMLVerifier Class)

Asks the application to resolve a reference.

Syntax

class XMLVerifierResolveReferenceEventParams {
public:
  const QString &URI();

  int ReferenceIndex();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ResolveReference(XMLVerifierResolveReferenceEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireResolveReference(XMLVerifierResolveReferenceEventParams *e) {...}

Remarks

This event is fired when the control could not automatically resolve a reference and requires custom treatment.

URI contains a reference to the data.

ReferenceIndex specifies the index of the reference to process.

Based on the reference's URI the event handler should set either TargetXMLElement or TargetData property of the reference.

SignatureFound Event (XMLVerifier Class)

Signifies the start of signature validation.

Syntax

class XMLVerifierSignatureFoundEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  bool ValidateSignature();
  void SetValidateSignature(bool bValidateSignature);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SignatureFound(XMLVerifierSignatureFoundEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireSignatureFound(XMLVerifierSignatureFoundEventParams *e) {...}

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound is set to True if the class has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (XMLVerifier Class)

Reports the signature validation result.

Syntax

class XMLVerifierSignatureValidatedEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  int ValidationResult();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SignatureValidated(XMLVerifierSignatureValidatedEventParams *e);

// Or, subclass XMLVerifier and override this emitter function.
virtual int FireSignatureValidated(XMLVerifierSignatureValidatedEventParams *e) {...}

Remarks

This event is fired when the complete XML signature validation process is finished. IssuerRDN returns the name of the signature issuer, SerialNumber identifies the signing certificate, SubjectKeyID contains the key identifier (SecureBlackbox uses SHA-1 hash algorithm output as key identifiers). Finally, ValidationResult specifies whether signature is valid or not:


xsvValid	`0`
xsvUnknown	`1`
xsvCorrupted	`2`
xsvSignerNotFound	`3`
xsvFailure	`4`
xsvReferenceCorrupted	`5`

Configuration Settings (XMLVerifier Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

XMLVerifier Configuration Settings

DataType: Specifies the external data type.

Use this property to specify the type of the external data (either DataFile, DataStream or DataBytes properties) for class.

The following data types are supported:


"" or "XML"		an XML document (by default).
"data"		a binary data.

DetachedResourceURI: Specifies a detached resource URI.

Specifies a URI of the provided data, usually the data filename if stored along with a detached signature.

HMACKey: The key value for HMAC.

TBD

The component uses base16 (hex) encoding for this configuration value.

HMACSigningUsed: Whether HMAC signing was used.

TBD

IDAttributeName: Specifies the custom name of ID attribute.

This property contains the custom name of identifier (ID) attribute. Used to identify the target XML element when reference URI has "#id_name" value or when ID attribute should be auto-generated for a target XML element.

IDAttributeNamespaceURI: Specifies the custom namespace URI of ID attribute.

This property contains the custom namespace URI of identifier (ID) attribute. Used to identify the target XML element when reference URI has "#id_name" value or when ID attribute should be auto-generated for a target XML element.

InclusiveNamespacesPrefixList: Specifies the InclusiveNamespaces PrefixList.

Use this property to read InclusiveNamespaces PrefixList used for exclusive canonicalization transform of SignedInfo element. See XML-Signature Syntax and Processing specification for details.

KeyName: Identifies the key.

Contains a string value (with significant spaces) which may be used by the signer to communicate a key identifier to the recipient. Typically, KeyName contains an identifier related to the key pair used to sign the message, but it may contain other protocol-related information that indirectly identifies a key pair. Common uses of KeyName include simple string names for keys, a key index, a distinguished name (DN), an email address, etc.

ManifestCount: The number of the manifest elements.

Returns the number of the ds:Manifest elements available.

ManifestID[Index]: The ID of the manifest element.

This property contains the identifier (ID) attribute of the ds:Manifest element. Index value could be omitted for the first manifest.

ManifestObjectIndex[Index]: The object element index to which the manifest element belongs.

This property contains the ds:Object element index to which the ds:Manifest element belongs. Index value could be omitted for the first signature properties.

ManifestXML[Index]: The XML content of the manifest element.

This property contains the XML content of the ds:Manifest element. Index value could be omitted for the first manifest.

ObjectCount: The number of the object elements.

Returns the number of the additional ds:Object elements available.

ObjectEncoding[Index]: The Encoding of the object element.

This property contains the Encoding attribute of the ds:Object element. Index value could be omitted for the first object.

ObjectID[Index]: The ID of the object element.

This property contains the identifier (ID) attribute of the ds:Object element. Index value could be omitted for the first object.

ObjectMimeType[Index]: The MIME type of the object element.

This property contains the MIME type attribute of the ds:Object element. Index value could be omitted for the first object.

ObjectXML[Index]: The XML content of the object element.

This property contains the XML content of the ds:Object element. Index value could be omitted for the first object.

PSSUsed: Whether RSASSA-PSS mode was used.

Although the RSASSA-PSS algorithm provides better security than a classic RSA scheme (PKCS#1-1.5), please take into account that RSASSA-PSS is a relatively new algorithm which may not be understood by older implementations.

SignatureCompliance: SIgnature compliance with XMLDSig/EBICS.

Specifies whether the signature is compliant with W3C's XMLDSig, or with EBICS (Electronic Banking Internet Communication Standard).

Supported values are:


""		The same as "XML-DSig".
XML-DSig		The W3C's XMLDSig-compliant signature (by default).
EBICS		Electronic Banking Internet Communication Standard (EBICS) compliant signature. On signing the version is autodetected based on the document element.
EBICS_H3		Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H3.
EBICS_H4		Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H4.
EBICS_H5		Electronic Banking Internet Communication Standard (EBICS) compliant signature. The version is H5.

SignatureID: Contains the ID for Signature element.

This property contains the identifier (ID) attribute of the ds:Signature element.

SignaturePropertiesCount: The number of the signature properties elements.

Returns the number of the ds:SignatureProperties elements available.

SignaturePropertiesID[Index]: The ID of the signature properties element.

This property contains the identifier (ID) attribute of the ds:SignatureProperties element. Index value could be omitted for the first signature properties.

SignaturePropertiesObjectIndex[Index]: The object element index to which the signature properties element belongs.

This property contains the ds:Object element index to which the ds:SignatureProperties element belongs. Index value could be omitted for the first signature properties.

SignaturePropertiesXML[Index]: The XML content of the signature properties element.

This property contains the XML content of the ds:SignatureProperties element. Index value could be omitted for the first signature properties.

SignaturePropertyCount: The number of the signature property elements.

Returns the number of the ds:SignatureProperty elements available.

SignaturePropertyID[Index]: The ID of the signature properties element.

This property contains the identifier (ID) attribute of the ds:SignatureProperty element. Index value could be omitted for the first signature property.

SignaturePropertyPropertiesIndex[Index]: The signature properties element index to which the signature property element belongs.

This property contains the ds:SignatureProperties element index to which the ds:SignatureProperty element belongs. Index value could be omitted for the first signature property.

SignaturePropertyTarget[Index]: The Target of the signature properties element.

This property contains the Target attribute of the ds:SignatureProperty element. Index value could be omitted for the first signature property.

SignaturePropertyXML[Index]: The XML content of the signature property element.

This property contains the XML content of the ds:SignatureProperty element. Index value could be omitted for the first signature property.

TempPath: Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

Base Configuration Settings

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:


off		No caching (default)
local		Local caching (supported for HTTPClient, RESTClient and SOAPClient only)
global		Global caching

Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


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.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (XMLVerifier Class)

XMLVerifier Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
39845889   Input file does not exist (SB_ERROR_XML_INPUTFILE_NOT_EXISTS)
39845890   Data file does not exist (SB_ERROR_XML_DATAFILE_NOT_EXISTS)
39845891   Unsupported signature method type (SB_ERROR_XML_UNSUPPORTED_SIGNATURE_METHOD_TYPE)
39845892   Unsupported has algorithm (SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM)
39845893   Unsupported key type (SB_ERROR_XML_UNSUPPORTED_KEY_TYPE)
39845894   Invalid key type (SB_ERROR_XML_INVALID_KEY_TYPE)
39845895   Invalid encryption method (SB_ERROR_XML_INVALID_ENCRYPTION_METHOD)
39845896   Not found (SB_ERROR_XML_NOT_FOUND)
39845897   No element ID (SB_ERROR_XML_NO_ELEMENT_ID)


	1048577 Invalid parameter value (`SB_ERROR_INVALID_PARAMETER`)
	1048578 Class is configured incorrectly (`SB_ERROR_INVALID_SETUP`)
	1048579 Operation cannot be executed in the current state (`SB_ERROR_INVALID_STATE`)
	1048580 Attempt to set an invalid value to a property (`SB_ERROR_INVALID_VALUE`)
	1048581 Certificate does not have its private key loaded (`SB_ERROR_NO_PRIVATE_KEY`)
	1048581 Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
	39845889 Input file does not exist (`SB_ERROR_XML_INPUTFILE_NOT_EXISTS`)
	39845890 Data file does not exist (`SB_ERROR_XML_DATAFILE_NOT_EXISTS`)
	39845891 Unsupported signature method type (`SB_ERROR_XML_UNSUPPORTED_SIGNATURE_METHOD_TYPE`)
	39845892 Unsupported has algorithm (`SB_ERROR_XML_UNSUPPORTED_HASH_ALGORITHM`)
	39845893 Unsupported key type (`SB_ERROR_XML_UNSUPPORTED_KEY_TYPE`)
	39845894 Invalid key type (`SB_ERROR_XML_INVALID_KEY_TYPE`)
	39845895 Invalid encryption method (`SB_ERROR_XML_INVALID_ENCRYPTION_METHOD`)
	39845896 Not found (`SB_ERROR_XML_NOT_FOUND`)
	39845897 No element ID (`SB_ERROR_XML_NO_ELEMENT_ID`)

SecureBlackbox 2022 Qt Edition

XMLVerifier Class

Syntax

Remarks

Property List

Method List

Event List

Configuration Settings

AllSignaturesValid Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

CanonicalizationMethod Property (XMLVerifier Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

DataFile Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

Encoding Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

FIPSMode Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

HashAlgorithm Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

InputBytes Property (XMLVerifier Class)

Syntax

Remarks

Data Type

InputFile Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

KnownCertCount Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

KnownCertBytes Property (XMLVerifier Class)

Syntax

Remarks

Data Type

KnownCertHandle Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

ReferenceCount Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

ReferenceAutoGenerateElementId Property (XMLVerifier Class)

Syntax

Default Value

Remarks

Data Type

ReferenceCanonicalizationMethod Property (XMLVerifier Class)

Syntax

Possible Values

Default Value

Remarks

Data Type

ReferenceCustomElementId Property (XMLVerifier Class)

Syntax