XMLVerifier Component
Properties Methods Events Config Settings Errors
The XMLVerifier component verifies signed XML files
Syntax
nsoftware.SecureBlackbox.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 component with short descriptions. Click on the links for further details.
AllSignaturesValid | The cumulative validity of all signatures. |
AutoValidateSignatures | Specifies whether component should validate any present signatures when the document is opened. |
Certificates | A collection of certificates included in the electronic signature. |
DataBytes | Use this property to pass the external data to component in the byte array form. |
DataFile | A file containing the external data covered by a detached signature. |
DataStream | Standalone data covered by the signature. |
DataType | Specifies the external data type. |
DataURI | Specifies a detached data resource URI. |
Encoding | Specifies XML encoding. |
FIPSMode | Reserved. |
InputBytes | Use this property to pass the input to component in the byte array form. |
InputFile | A signed XML file. |
InputStream | A stream containing the signed XML document. |
KnownCertificates | Additional certificates for chain validation. |
OutputBytes | Use this property to read the output the component object has produced. |
OutputFile | The file where the modified signed document will be saved. |
OutputStream | A stream where to save the modified signed document. |
References | References covered by the signature. |
Signatures | All signatures found in the XML document. |
XPathNamespaces | Specifies namespaces for the XPath expression. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Close | Closes an opened document. |
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
GetInnerXML | Get the inner XML content of the selected XML element. |
GetOuterXML | Get the outer XML content of the selected XML element. |
GetTextContent | Get the text content of the selected XML element. |
Open | Opens a document for verifying or removing signatures. |
Revalidate | Revalidates a signature in accordance with current settings. |
SetInnerXML | Set the inner XML content of the selected XML element. |
SetTextContent | Set the text content of the selected XML element. |
Unsign | Deletes a signature from the document. |
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 component with short descriptions. Click on the links for further details.
DocumentLoaded | This event is fired when the document has been loaded into memory. |
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. |
Config Settings
The following is a list of config settings for the component 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. |
ObjectSignaturePropertiesCount | The number of the signature properties elements. |
ObjectSignaturePropertiesID[Index] | The ID of the signature properties element. |
ObjectSignaturePropertiesObjectIndex[Index] | The object element index to which the signature properties element belongs. |
ObjectSignaturePropertiesXML[Index] | The XML content of the signature properties element. |
ObjectSignaturePropertyCount | The number of the signature property elements. |
ObjectSignaturePropertyID[Index] | The ID of the signature properties element. |
ObjectSignaturePropertyPropertiesIndex[Index] | The signature properties element index to which the signature property element belongs. |
ObjectSignaturePropertyTarget[Index] | The Target of the signature properties element. |
ObjectSignaturePropertyXML[Index] | The XML content of the signature property 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. |
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 component (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. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
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 Component)
The cumulative validity of all signatures.
Syntax
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.
AutoValidateSignatures Property (XMLVerifier Component)
Specifies whether component should validate any present signatures when the document is opened.
Syntax
Default Value
True
Remarks
This setting is switched on by default. You can choose to set this property to false in order to validate the signatures manually on a later stage using the Revalidate method.
Certificates Property (XMLVerifier Component)
A collection of certificates included in the electronic signature.
Syntax
public CertificateList Certificates { get; }
Public ReadOnly Property Certificates As CertificateList
Remarks
Use this property to access all certificates included into the signature(s) by its creator.
This property is read-only and not available at design time.
DataBytes Property (XMLVerifier Component)
Use this property to pass the external data to component in the byte array form.
Syntax
Remarks
Assign a byte array containing the external data to be processed to this property.
This property is not available at design time.
DataFile Property (XMLVerifier Component)
A file containing the external data covered by a detached signature.
Syntax
Default Value
""
Remarks
In the case of a detached signature, use this property to provide the external data to the component from a file. Alternatively, provide the data via DataStream.
DataStream Property (XMLVerifier Component)
Standalone data covered by the signature.
Syntax
public System.IO.Stream DataStream { get; set; }
Public Property DataStream As System.IO.Stream
Default Value
null
Remarks
When validating a detached signature, use this stream property to provide the external (detached) data.
This property is not available at design time.
DataType Property (XMLVerifier Component)
Specifies the external data type.
Syntax
public XmlverifierDataTypes DataType { get; set; }
enum XmlverifierDataTypes { cxdtXML, cxdtBinary, cxdtBase64 }
Public Property DataType As XmlverifierDataTypes
Enum XmlverifierDataTypes cxdtXML cxdtBinary cxdtBase64 End Enum
Default Value
0
Remarks
Use this property to specify the type of the external data (either DataFile, DataStream or DataBytes properties) for component.
DataURI Property (XMLVerifier Component)
Specifies a detached data resource URI.
Syntax
Default Value
""
Remarks
Specifies a URI used for data being signed, usually the data filename if stored along with a detached signature.
Encoding Property (XMLVerifier Component)
Specifies XML encoding.
Syntax
Default Value
""
Remarks
Use this property to specify the encoding to apply to the XML documents.
FIPSMode Property (XMLVerifier Component)
Reserved.
Syntax
Default Value
False
Remarks
This property is reserved for future use.
InputBytes Property (XMLVerifier Component)
Use this property to pass the input to component in the byte array form.
Syntax
Remarks
Assign a byte array containing the data to be processed to this property.
This property is not available at design time.
InputFile Property (XMLVerifier Component)
A signed XML file.
Syntax
Default Value
""
Remarks
Provide a path to the signed XML document in this property.
InputStream Property (XMLVerifier Component)
A stream containing the signed XML document.
Syntax
public System.IO.Stream InputStream { get; set; }
Public Property InputStream As System.IO.Stream
Default Value
null
Remarks
Use this property to pass a signed document to the component in a stream.
This property is not available at design time.
KnownCertificates Property (XMLVerifier Component)
Additional certificates for chain validation.
Syntax
public CertificateList KnownCertificates { get; }
Public Property KnownCertificates As CertificateList
Remarks
Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually.
The purpose of certificates to be added to this collection is roughly equivalent to that of Intermediate Certification Authorities system store in Windows.
Do not add trust anchors or root certificates to this collection: add them to TrustedCertificates instead.
This property is not available at design time.
OutputBytes Property (XMLVerifier Component)
Use this property to read the output the component object has produced.
Syntax
Remarks
Read the contents of this property after the operation is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.
This property is read-only and not available at design time.
OutputFile Property (XMLVerifier Component)
The file where the modified signed document will be saved.
Syntax
Default Value
""
Remarks
Provide the full path to the file where the modified signed document should be saved.
OutputStream Property (XMLVerifier Component)
A stream where to save the modified signed document.
Syntax
public System.IO.Stream OutputStream { get; set; }
Public Property OutputStream As System.IO.Stream
Default Value
null
Remarks
Use this property to specify a stream to write the modified signed document to.
This property is not available at design time.
References Property (XMLVerifier Component)
References covered by the signature.
Syntax
public XMLReferenceList References { get; }
Public ReadOnly Property References As XMLReferenceList
Remarks
Use this property to get the references to the data covered by the signature.
This property is read-only and not available at design time.
Signatures Property (XMLVerifier Component)
All signatures found in the XML document.
Syntax
public XMLSignatureList Signatures { get; }
Public ReadOnly Property Signatures As XMLSignatureList
Remarks
This property contains a list of all signatures made over the XML document.
This property is read-only and not available at design time.
XPathNamespaces Property (XMLVerifier Component)
Specifies namespaces for the XPath expression.
Syntax
public XMLNamespaceList XPathNamespaces { get; }
Public Property XPathNamespaces As XMLNamespaceList
Remarks
This property contains a list of prefixes and namespaceURIs that are used in XPath expression with TargetXMLElement property of the references.
This property is not available at design time.
Close Method (XMLVerifier Component)
Closes an opened document.
Syntax
Remarks
Use this method to close a previously opened document. Set SaveChanges to true to apply any changes made.
Config Method (XMLVerifier Component)
Sets or retrieves a configuration setting.
Syntax
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
DoAction Method (XMLVerifier Component)
Performs an additional action.
Syntax
Remarks
DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier 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;....
GetInnerXML Method (XMLVerifier Component)
Get the inner XML content of the selected XML element.
Syntax
Remarks
Call this method to get the inner XML content of the selected XML element.
GetOuterXML Method (XMLVerifier Component)
Get the outer XML content of the selected XML element.
Syntax
Remarks
Call this method to get the outer XML content of the selected XML element.
GetTextContent Method (XMLVerifier Component)
Get the text content of the selected XML element.
Syntax
Remarks
Call this method to get the text content of the selected XML element.
Open Method (XMLVerifier Component)
Opens a document for verifying or removing signatures.
Syntax
public void Open();
Public Sub Open()
Remarks
Use this method to open a document for verifying or removing signatures. When finished, call Close to complete or discard the operation.
Revalidate Method (XMLVerifier Component)
Revalidates a signature in accordance with current settings.
Syntax
Remarks
Use this method to re-validate a signature in the opened XML document.
SetInnerXML Method (XMLVerifier Component)
Set the inner XML content of the selected XML element.
Syntax
Remarks
Call this method to set the inner XML content of the selected XML element.
SetTextContent Method (XMLVerifier Component)
Set the text content of the selected XML element.
Syntax
Remarks
Call this method to set the text content of the selected XML element.
Unsign Method (XMLVerifier Component)
Deletes a signature from the document.
Syntax
Remarks
Use this method to delete an existing signature from the document. Use SigIndex parameter to specify the signature to be removed.
Verify Method (XMLVerifier Component)
Verifies a signed XML document.
Syntax
public void Verify();
Public Sub 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.
VerifyDetached Method (XMLVerifier Component)
Verifies a detached signature over external XML data.
Syntax
public void VerifyDetached();
Public Sub VerifyDetached()
Remarks
Call this method to verify a signature over external (detached) data provided via DataStream or DataFile.
DocumentLoaded Event (XMLVerifier Component)
This event is fired when the document has been loaded into memory.
Syntax
public event OnDocumentLoadedHandler OnDocumentLoaded; public delegate void OnDocumentLoadedHandler(object sender, XmlverifierDocumentLoadedEventArgs e); public class XmlverifierDocumentLoadedEventArgs : EventArgs { public bool Cancel { get; set; } }
Public Event OnDocumentLoaded As OnDocumentLoadedHandler Public Delegate Sub OnDocumentLoadedHandler(sender As Object, e As XmlverifierDocumentLoadedEventArgs) Public Class XmlverifierDocumentLoadedEventArgs Inherits EventArgs Public Property Cancel As Boolean End Class
Remarks
The handler for this event is a good place to check document properties, which may be useful when preparing the signature, for example, the document format.
Set Cancel to true to terminate document processing on this stage.
Error Event (XMLVerifier Component)
Information about errors during signature verification.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, XmlverifierErrorEventArgs e); public class XmlverifierErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As XmlverifierErrorEventArgs) Public Class XmlverifierErrorEventArgs Inherits EventArgs Public ReadOnly Property ErrorCode As Integer Public ReadOnly Property Description As String End Class
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 Component)
This event notifies the application about an underlying control flow event.
Syntax
public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, XmlverifierNotificationEventArgs e); public class XmlverifierNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } }
Public Event OnNotification As OnNotificationHandler Public Delegate Sub OnNotificationHandler(sender As Object, e As XmlverifierNotificationEventArgs) Public Class XmlverifierNotificationEventArgs Inherits EventArgs Public ReadOnly Property EventID As String Public ReadOnly Property EventParam As String End Class
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in 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 Component)
Marks the end of a reference validation.
Syntax
public event OnReferenceValidatedHandler OnReferenceValidated; public delegate void OnReferenceValidatedHandler(object sender, XmlverifierReferenceValidatedEventArgs e); public class XmlverifierReferenceValidatedEventArgs : EventArgs { public int ReferenceIndex { get; } public string ID { get; } public string URI { get; } public string RefType { get; } public bool DigestValid { get; } }
Public Event OnReferenceValidated As OnReferenceValidatedHandler Public Delegate Sub OnReferenceValidatedHandler(sender As Object, e As XmlverifierReferenceValidatedEventArgs) Public Class XmlverifierReferenceValidatedEventArgs Inherits EventArgs Public ReadOnly Property ReferenceIndex As Integer Public ReadOnly Property ID As String Public ReadOnly Property URI As String Public ReadOnly Property RefType As String Public ReadOnly Property DigestValid As Boolean End Class
Remarks
The component 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 Component)
Asks the application to resolve a reference.
Syntax
public event OnResolveReferenceHandler OnResolveReference; public delegate void OnResolveReferenceHandler(object sender, XmlverifierResolveReferenceEventArgs e); public class XmlverifierResolveReferenceEventArgs : EventArgs { public int ReferenceIndex { get; } public string URI { get; } }
Public Event OnResolveReference As OnResolveReferenceHandler Public Delegate Sub OnResolveReferenceHandler(sender As Object, e As XmlverifierResolveReferenceEventArgs) Public Class XmlverifierResolveReferenceEventArgs Inherits EventArgs Public ReadOnly Property ReferenceIndex As Integer Public ReadOnly Property URI As String End Class
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 Component)
Signifies the start of signature validation.
Syntax
public event OnSignatureFoundHandler OnSignatureFound; public delegate void OnSignatureFoundHandler(object sender, XmlverifierSignatureFoundEventArgs e); public class XmlverifierSignatureFoundEventArgs : EventArgs { public int Index { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public bool CertFound { get; } public bool ValidateSignature { get; set; } public bool ValidateChain { get; set; } }
Public Event OnSignatureFound As OnSignatureFoundHandler Public Delegate Sub OnSignatureFoundHandler(sender As Object, e As XmlverifierSignatureFoundEventArgs) Public Class XmlverifierSignatureFoundEventArgs Inherits EventArgs Public ReadOnly Property Index As Integer Public ReadOnly Property IssuerRDN As String Public ReadOnly Property SerialNumber As Byte() Public ReadOnly Property SubjectKeyID As Byte() Public ReadOnly Property CertFound As Boolean Public Property ValidateSignature As Boolean Public Property ValidateChain As Boolean End Class
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 component 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 Component)
Reports the signature validation result.
Syntax
public event OnSignatureValidatedHandler OnSignatureValidated; public delegate void OnSignatureValidatedHandler(object sender, XmlverifierSignatureValidatedEventArgs e); public class XmlverifierSignatureValidatedEventArgs : EventArgs { public int SigIndex { get; } public string IssuerRDN { get; } public byte[] SerialNumber { get; } public byte[] SubjectKeyID { get; } public int ValidationResult { get; } }
Public Event OnSignatureValidated As OnSignatureValidatedHandler Public Delegate Sub OnSignatureValidatedHandler(sender As Object, e As XmlverifierSignatureValidatedEventArgs) Public Class XmlverifierSignatureValidatedEventArgs Inherits EventArgs Public ReadOnly Property SigIndex As Integer Public ReadOnly Property IssuerRDN As String Public ReadOnly Property SerialNumber As Byte() Public ReadOnly Property SubjectKeyID As Byte() Public ReadOnly Property ValidationResult As Integer End Class
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 |
Certificate Type
Provides details of an individual X.509 certificate.
Remarks
This type provides access to X.509 certificate details.
Fields
Bytes Byte() |
Returns raw certificate data in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CA Boolean |
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CAKeyID Byte() |
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CRLDistributionPoints String |
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Curve String |
Specifies the elliptic curve of the EC public key.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Fingerprint Byte() |
Contains the fingerprint (a hash imprint) of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FriendlyName String |
Contains an associated alias (friendly name) of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HashAlgorithm String |
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Issuer String |
The common name of the certificate issuer (CA), typically a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IssuerRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeyAlgorithm String |
Specifies the public key algorithm of this certificate.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeyBits Integer |
Returns the length of the public key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeyFingerprint Byte() |
Returns a fingerprint of the public key contained in the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeyUsage Integer |
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:
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
KeyValid Boolean |
Returns True if the certificate's key is cryptographically valid, and False otherwise. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OCSPLocations String |
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OCSPNoCheck Boolean |
Accessor to the value of the certificates ocsp-no-check extension. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Origin Integer |
Returns the origin of this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PolicyIDs String |
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyBytes Byte() |
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyExists Boolean |
Indicates whether the certificate has an associated private key. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PrivateKeyExtractable Boolean |
Indicates whether the private key is extractable |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PublicKeyBytes Byte() |
Contains the certificate's public key in DER format. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
QualifiedStatements QualifiedStatementsTypes |
Returns the qualified status of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SelfSigned Boolean |
Indicates whether the certificate is self-signed (root) or signed by an external CA. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SerialNumber Byte() |
Returns the certificate's serial number. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SigAlgorithm String |
Indicates the algorithm that was used by the CA to sign this certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Subject String |
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SubjectAlternativeName String |
Returns or sets the value of the Subject Alternative Name extension of the certificate. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SubjectKeyID Byte() |
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SubjectRDN String |
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ValidFrom String |
The time point at which the certificate becomes valid, in UTC. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ValidTo String |
The time point at which the certificate expires, in UTC. |
Constructors
public Certificate( bytes, startIndex, count, password);
Public Certificate(ByVal Bytes As , ByVal StartIndex As , ByVal Count As , ByVal Password As )
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
public Certificate( certBytes, certStartIndex, certCount, keyBytes, keyStartIndex, keyCount, password);
Public Certificate(ByVal CertBytes As , ByVal CertStartIndex As , ByVal CertCount As , ByVal KeyBytes As , ByVal KeyStartIndex As , ByVal KeyCount As , ByVal Password As )
Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.
public Certificate( bytes, startIndex, count);
Public Certificate(ByVal Bytes As , ByVal StartIndex As , ByVal Count As )
Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.
public Certificate( path, password);
Public Certificate(ByVal Path As , ByVal Password As )
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.
public Certificate( certPath, keyPath, password);
Public Certificate(ByVal CertPath As , ByVal KeyPath As , ByVal Password As )
Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.
public Certificate( path);
Public Certificate(ByVal Path As )
Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.
public Certificate( stream);
Public Certificate(ByVal Stream As )
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.
public Certificate( stream, password);
Public Certificate(ByVal Stream As , ByVal Password As )
Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.
public Certificate( certStream, keyStream, password);
Public Certificate(ByVal CertStream As , ByVal KeyStream As , ByVal Password As )
Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.
public Certificate();
Public Certificate()
Creates a new object with default field values.
XMLNamespace Type
Represents an XML namespace map for XPath expressions.
Remarks
This class defines the correspondence between Prefixes and namespace URIs.
Fields
Prefix String |
A user-defined prefix value of a namespace. |
URI String |
A user-defined URI value of a namespace. |
Constructors
public XMLNamespace();
Public XMLNamespace()
Creates a new XML namespace object.
XMLReference Type
Represents an XML reference element.
Remarks
XMLReference specifies the digest algorithm and digest value, and, optionally: an identifier of the object being signed, the type of the object, and/or a list of transforms to be applied prior to digesting.
Fields
AutoGenerateElementId Boolean |
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. |
||||||||||||||||||||||||||||||||||||
CanonicalizationMethod XMLCanonicalizationMethods |
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.
|
||||||||||||||||||||||||||||||||||||
CustomElementId String |
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. |
||||||||||||||||||||||||||||||||||||
DigestValue Byte() |
Use this property to get or set the value of the digest calculated over the referenced data. This field 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. |
||||||||||||||||||||||||||||||||||||
HashAlgorithm String |
Specifies the hash algorithm to be used. Supported values:
|
||||||||||||||||||||||||||||||||||||
HasURI Boolean |
Specifies whether the URI is set (even when it is empty). |
||||||||||||||||||||||||||||||||||||
ID String |
A user-defined identifier (ID) attribute of this Reference element. |
||||||||||||||||||||||||||||||||||||
InclusiveNamespacesPrefixList String |
Use this property to specify InclusiveNamespaces PrefixList for exclusive canonicalization transform of the reference. See XML-Signature Syntax and Processing specification for details. |
||||||||||||||||||||||||||||||||||||
ReferenceType String |
The Reference's type attribute as defined in XMLDSIG specification. |
||||||||||||||||||||||||||||||||||||
SignatureIndex Integer |
Returns the index of the owner signature, if applicable. Use this property to establish the index of the associated signature object in the signature collection. |
||||||||||||||||||||||||||||||||||||
TargetData Byte() |
Contains the referenced external data when the digest value is not explicitly specified. This field 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. |
||||||||||||||||||||||||||||||||||||
TargetType XMLReferenceTargetTypes |
The reference's target type to use. Use this property to specify the reference's target type to use when forming the signature. |
||||||||||||||||||||||||||||||||||||
TargetXMLElement String |
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:
|
||||||||||||||||||||||||||||||||||||
URI String |
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. |
||||||||||||||||||||||||||||||||||||
UseBase64Transform Boolean |
Specifies whether Base64 transform is included in transform chain. |
||||||||||||||||||||||||||||||||||||
UseEnvelopedSignatureTransform Boolean |
Specifies whether enveloped signature transform is included in transform chain. |
||||||||||||||||||||||||||||||||||||
UseXPathFilter2Transform Boolean |
Specifies whether XPath Filter 2.0 transform is included in transform chain. |
||||||||||||||||||||||||||||||||||||
UseXPathTransform Boolean |
Specifies whether XPath transform is included in transform chain. |
||||||||||||||||||||||||||||||||||||
XPathExpression String |
Use this property to specify XPath expression for XPath transform of the reference. |
||||||||||||||||||||||||||||||||||||
XPathFilter2Expressions String |
Use this property to specify XPointer expression(s) for XPath Filter 2.0 transform of the reference. TBD |
||||||||||||||||||||||||||||||||||||
XPathFilter2Filters String |
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:
|
||||||||||||||||||||||||||||||||||||
XPathFilter2PrefixList String |
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. |
||||||||||||||||||||||||||||||||||||
XPathPrefixList String |
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. |
Constructors
public XMLReference();
Public XMLReference()
Creates a new XML reference element.
public XMLReference( ID);
Public XMLReference(ByVal ID As )
Creates a new XML reference element from its ID .
public XMLReference( ID, URI);
Public XMLReference(ByVal ID As , ByVal URI As )
Creates a new XML reference element from its ID and URI reference to the external data.
XMLSignature Type
The component is a container for an XML signature.
Remarks
XML document may include any number of XML signatures. component stores on of them.
Fields
CanonicalizationMethod XMLCanonicalizationMethods |
The XML canonicalization method that was used for signing. Supported canonicalization methods:
|
||||||||||||||||||||||||||||||||||||
CertificateIndex Integer |
Returns the index of the signing certificate in the Certificates collection Use this property to look up the signing certificate in the Certificates collection. |
||||||||||||||||||||||||||||||||||||
HashAlgorithm String |
The hash algorithm used for signing.
|
||||||||||||||||||||||||||||||||||||
IssuerRDN String |
The Relative Distinguished Name of the signing certificate's issuer. A collection of information, in the form of [OID, Value] pairs, about the company that issued the signing certificate. |
||||||||||||||||||||||||||||||||||||
SerialNumber Byte() |
The serial number of the timestamp. |
||||||||||||||||||||||||||||||||||||
SignatureBytes Byte() |
Returns the binary representation of the ASiC signature. |
||||||||||||||||||||||||||||||||||||
SignatureType XMLSignatureTypes |
The signature type to employ when signing the document. This property specifies the signature type to be used when signing the document. Supported values:
|
||||||||||||||||||||||||||||||||||||
SignatureValidationResult XMLSignatureValidities |
Contains the signature validation result. Use this property to check the result of the most recent XML signature validation.
|
||||||||||||||||||||||||||||||||||||
SubjectKeyID Byte() |
Contains the subject key identifier of the signing certificate. 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 by a SHA-1 hash of the bit string of the subject public key. |
||||||||||||||||||||||||||||||||||||
SubjectRDN String |
Contains information about the person owning the signing certificate. Only certificates with given subject information will be enumerated during the search operation. Information is stored in the form of [Object Identifier, Value] pairs. |
||||||||||||||||||||||||||||||||||||
XMLElement String |
Defines the XML element of the signature. Defines the XML element of the signature. |
Constructors
public XMLSignature();
Public XMLSignature()
Creates a new XML signature object.
Config Settings (XMLVerifier Component)
The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.XMLVerifier Config 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 component.
The following data types are supported:
|
|||||||||||||||||||
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.Use this property to set the HMAC key. The component uses base16 (hex) encoding for this configuration value. | |||||||||||||||||||
HMACSigningUsed: Whether HMAC signing was used.This config property returns true if HMAC-based algorithm was used to create the signature. | |||||||||||||||||||
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. | |||||||||||||||||||
ObjectSignaturePropertiesCount: The number of the signature properties elements.Returns the number of the ds:SignatureProperties elements available. | |||||||||||||||||||
ObjectSignaturePropertiesID[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. | |||||||||||||||||||
ObjectSignaturePropertiesObjectIndex[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. | |||||||||||||||||||
ObjectSignaturePropertiesXML[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. | |||||||||||||||||||
ObjectSignaturePropertyCount: The number of the signature property elements.Returns the number of the ds:SignatureProperty elements available. | |||||||||||||||||||
ObjectSignaturePropertyID[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. | |||||||||||||||||||
ObjectSignaturePropertyPropertiesIndex[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. | |||||||||||||||||||
ObjectSignaturePropertyTarget[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. | |||||||||||||||||||
ObjectSignaturePropertyXML[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. | |||||||||||||||||||
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:
|
|||||||||||||||||||
SignatureID: Contains the ID for Signature element.This property contains the identifier (ID) attribute of the ds:Signature element. | |||||||||||||||||||
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 Config 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 component.
Supported values are:
|
|||||||||||||||||||||||||||||||
Cookies: Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. | |||||||||||||||||||||||||||||||
DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. | |||||||||||||||||||||||||||||||
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 components 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 components. | |||||||||||||||||||||||||||||||
LogDestination:
Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
|
|||||||||||||||||||||||||||||||
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:
|
|||||||||||||||||||||||||||||||
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:
|
|||||||||||||||||||||||||||||||
LogFlushMode:
Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined:
|
|||||||||||||||||||||||||||||||
LogLevel:
Specifies the debug log level.Use this property to provide the desired debug log level.
Supported values are:
|
|||||||||||||||||||||||||||||||
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:
|
|||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||
UseOwnDNSResolver: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. | |||||||||||||||||||||||||||||||
UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. | |||||||||||||||||||||||||||||||
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 Component)
XMLVerifier Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Component 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) |