SecureBlackbox 2020 iOS Edition

Questions / Feedback?

XMLVerifier Class

Properties   Methods   Events   Configuration Settings   Errors  

The XMLVerifier class verifies signed XML files.

Syntax

SecureBlackboxXMLVerifier
SecureBlackboxXMLVerifierSwift

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.

- allSignaturesValidThe cumulative validity of all signatures.
- canonicalizationMethodThe XML canonicalization method that was used for signing.
- dataFileA file containing the external data covered by a detached signature.
- encodingSpecifies XML encoding.
- hashAlgorithmThe hash algorithm used for signing.
- inputBytesUse this property to pass the input to class in the byte array form.
- inputFileA signed XML file.
- knownCertCountThe number of records in the KnownCert arrays.
- knownCertBytes:(int)knownCertIndexReturns raw certificate data in DER format.
- knownCertHandle:(int)knownCertIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- referenceCountThe number of records in the Reference arrays.
- referenceAutoGenerateElementId:(int)referenceIndexSpecifies whether the identifier (ID) attribute for a referenced (target) element should be auto-generated during signing.
- referenceCanonicalizationMethod:(int)referenceIndexUse this property to specify the canonicalization method for the transform of the reference.
- referenceCustomElementId:(int)referenceIndexSpecifies a custom identifier (ID) attribute for a referenced (target) element that will be set on signing.
- referenceDigestValue:(int)referenceIndexUse this property to get or set the value of the digest calculated over the referenced data.
- referenceHandle:(int)referenceIndexAllows to get or set a 'handle', a unique identifier of the underlying property object.
- referenceHashAlgorithm:(int)referenceIndexSpecifies the hash algorithm to be used.
- referenceHasURI:(int)referenceIndexSpecifies whether the URI is set (even when it is empty).
- referenceID:(int)referenceIndexA user-defined identifier (ID) attribute of this Reference element.
- referenceInclusiveNamespacesPrefixList:(int)referenceIndexUse this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference.
- referenceReferenceType:(int)referenceIndexThe Reference's type attribute as defined in XMLDSIG specification.
- referenceTargetData:(int)referenceIndexContains the referenced external data when the digest value is not explicitly specified.
- referenceTargetXMLElement:(int)referenceIndexThis property specifies the referenced XML element.
- referenceURI:(int)referenceIndexUse this property to get or set the URL which references the data.
- referenceUseBase64Transform:(int)referenceIndexSpecifies whether Base64 transform is included in transform chain.
- referenceUseEnvelopedSignatureTransform:(int)referenceIndexSpecifies whether enveloped signature transform is included in transform chain.
- referenceUseXPathFilter2Transform:(int)referenceIndexSpecifies whether XPath Filter 2.
- referenceUseXPathTransform:(int)referenceIndexSpecifies whether XPath transform is included in transform chain.
- referenceXPathExpression:(int)referenceIndexUse this property to specify XPath expression for XPath transform of the reference.
- referenceXPathFilter2Expressions:(int)referenceIndexUse this property to specify XPointer expression(s) for XPath Filter 2.
- referenceXPathFilter2Filters:(int)referenceIndexUse this property to specify XPointer filter(s) for XPath Filter 2.
- referenceXPathFilter2PrefixList:(int)referenceIndexUse this property to specify a prefix list for XPath Filter 2.
- referenceXPathPrefixList:(int)referenceIndexUse this property to specify a prefix list for XPath transform of the reference.
- signatureValidationResultContains the signature validation result.
- signingCertBytesReturns raw certificate data in DER format.
- signingCertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
- signingCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
- signingCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
- signingCertCurveSpecifies the elliptic curve of the EC public key.
- signingCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
- signingCertFriendlyNameContains an associated alias (friendly name) of the certificate.
- signingCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
- signingCertHashAlgorithmSpecifies 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 .
- signingCertIssuerThe common name of the certificate issuer (CA), typically a company name.
- signingCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
- signingCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
- signingCertKeyBitsReturns the length of the public key.
- signingCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
- signingCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
- signingCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
- signingCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
- signingCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
- signingCertPublicKeyBytesContains the certificate's public key in DER format.
- signingCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
- signingCertSerialNumberReturns the certificate's serial number.
- signingCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
- signingCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
- signingCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
- signingCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
- signingCertValidFromThe time point at which the certificate becomes valid, in UTC.
- signingCertValidToThe time point at which the certificate expires, in UTC.
- XMLElementSpecifies the XML element containing the signature.
- namespaceCountThe number of records in the Namespace arrays.
- namespacePrefix:(int)namespaceIndexA user-defined prefix value of a namespace.
- namespaceURI:(int)namespaceIndexA 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.

- configSets or retrieves a configuration setting.
- verifyVerifies a signed XML document.
- verifyDetachedVerifies 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.

- onErrorInformation about errors during signature verification.
- onNotificationThis event notifies the application about an underlying control flow event.
- onReferenceValidatedMarks the end of a reference validation.
- onResolveReferenceAsks the application to resolve a reference.
- onSignatureFoundSignifies the start of signature validation.
- onSignatureValidatedReports 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.

DataTypeSpecifies the external data type.
DetachedResourceURISpecifies a detached resource URI.
HMACKeyThe key value for HMAC.
HMACSigningUsedWhether HMAC signing was used.
IDAttributeNameSpecifies the custom name of ID attribute.
IDAttributeNamespaceURISpecifies the custom namespace URI of ID attribute.
InclusiveNamespacesPrefixListSpecifies the InclusiveNamespaces PrefixList.
KeyNameIdentifies the key.
ManifestCountThe 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.
ObjectCountThe 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.
PSSUsedWhether RSASSA-PSS mode was used.
SignatureComplianceSIgnature compliance with XMLDSig/EBICS.
SignatureIDContains the ID for Signature element.
SignaturePropertiesCountThe 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.
SignaturePropertyCountThe 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.
TempPathLocation where the temporary files are stored.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 iOS Edition - Version 20.0 [Build 8166]