XAdESVerifier Component

Properties   Methods   Events   Config Settings   Errors  

The XAdESVerifier component verifies XAdES-compliant signatures

Syntax

nsoftware.SecureBlackbox.XAdESVerifier

Remarks

Use this control to validate XAdES signatures. XAdESVerifier verifier = new XAdESVerifier(); // Select the file which contains the signed message verifier.setInputFile("signedFile.xml"); verifier.open(); if (verifier.getSignatures().item(0).getSignatureType() == XAdESSignature.cxstDetached){ // To verify a detached signature, we need // to provide both the signature and the original data verifier.setDataFile("MyFile.xml"); verifier.verifyDetached(); } else { // To verify an enveloping signature, we need // to provide the location to extract the data verifier.setOutputFile("output.exe"); verifier.verify(); } // The outcome of the cryptographic signature validation for (int idx = 0; idx < verifier.getSignatures().size() ; idx++) { switch (verifier.getSignatures().item(0).getSignatureValidationResult()) { case XAdESSignature.svtValid: System.out.println("The signature is valid."); break; case XAdESSignature.svtUnknown: System.out.println("Signature verification failed: Unknown signature."); break; case XAdESSignature.svtFailure: case XAdESSignature.svtCorrupted: System.out.println("Signature verification failed: The signature is corrupt or invalid."); break; case XAdESSignature.svtSignerNotFound: System.out.println("Signature verification failed: The signature does not contain a signer."); break; default: System.out.println("Signature verification failed."); break; } }

Property List

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

Method List

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

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.

Config Settings

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

AllSignaturesValid Property (XAdESVerifier Component)

The cumulative validity of all signatures.

Syntax

• C#
• VB.NET

public bool AllSignaturesValid { get; }

Public ReadOnly Property AllSignaturesValid As Boolean

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

Specifies whether component should validate any present signatures when the document is opened.

Syntax

• C#
• VB.NET

public bool AutoValidateSignatures { get; set; }

Public Property AutoValidateSignatures As Boolean

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.

BlockedCertificates Property (XAdESVerifier Component)

The certificates that must be rejected as trust anchors.

Syntax

• C#
• VB.NET

public CertificateList BlockedCertificates { get; }

Public Property BlockedCertificates As CertificateList

Remarks

Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation.

This property is not available at design time.

Certificates Property (XAdESVerifier Component)

A collection of certificates included in the electronic signature.

Syntax

• C#
• VB.NET

public CertificateList Certificates { get; }

Public ReadOnly Property Certificates As CertificateList

Remarks

This property includes a collection of certificates of the currently selected info.

This collection is indexed from 0 to count -1.

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

CheckTrustedLists Property (XAdESVerifier Component)

Specifies whether the component should attempt to validate chain trust via a known Trusted List.

Syntax

• C#
• VB.NET

public bool CheckTrustedLists { get; set; }

Public Property CheckTrustedLists As Boolean

Default Value

False

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

CRLs Property (XAdESVerifier Component)

A collection of certificate revocation lists embedded into the signature by the signer.

Syntax

• C#
• VB.NET

public CRLList CRLs { get; }

Public ReadOnly Property CRLs As CRLList

Remarks

Use this property to access the CRLs embedded into the signature by the signer.

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

DataBytes Property (XAdESVerifier Component)

Use this property to pass the external data to component in the byte array form.

Syntax

• C#
• VB.NET

public byte[] DataBytes { get; set; }

Public Property DataBytes As Byte()

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

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

Syntax

• C#
• VB.NET

public string DataFile { get; set; }

Public Property DataFile As String

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

Standalone data covered by the signature.

Syntax

• C#
• VB.NET

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

Specifies the external data type.

Syntax

• C#
• VB.NET

public XAdESVerifierDataTypes DataType { get; set; }

enum XAdESVerifierDataTypes {
  cxdtXML,
  cxdtBinary,
  cxdtBase64
}

Public Property DataType As XadesverifierDataTypes

Enum XAdESVerifierDataTypes
  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 (XAdESVerifier Component)

Specifies a detached data resource URI.

Syntax

• C#
• VB.NET

public string DataURI { get; set; }

Public Property DataURI As String

Default Value

""

Remarks

Specifies a URI used for data being signed, usually the data filename if stored along with a detached signature.

Encoding Property (XAdESVerifier Component)

Specifies XML encoding.

Syntax

• C#
• VB.NET

public string Encoding { get; set; }

Public Property Encoding As String

Default Value

""

Remarks

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

FIPSMode Property (XAdESVerifier Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

IgnoreChainValidationErrors Property (XAdESVerifier Component)

Makes the component tolerant to chain validation errors.

Syntax

• C#
• VB.NET

public bool IgnoreChainValidationErrors { get; set; }

Public Property IgnoreChainValidationErrors As Boolean

Default Value

False

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

InputBytes Property (XAdESVerifier Component)

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

Syntax

• C#
• VB.NET

public byte[] InputBytes { get; set; }

Public Property InputBytes As Byte()

Remarks

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

This property is not available at design time.

InputFile Property (XAdESVerifier Component)

A path to the signed XML file.

Syntax

• C#
• VB.NET

public string InputFile { get; set; }

Public Property InputFile As String

Default Value

""

Remarks

Provide the path to the XML document to verify.

InputStream Property (XAdESVerifier Component)

A stream containing the signed document.

Syntax

• C#
• VB.NET

public System.IO.Stream InputStream { get; set; }

Public Property InputStream As System.IO.Stream

Default Value

null

Remarks

Use this property to pass the signed document to a component in a stream.

This property is not available at design time.

KnownCertificates Property (XAdESVerifier Component)

Additional certificates for chain validation.

Syntax

• C#
• VB.NET

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 the certificates to be added to this collection is roughly equivalent to that of the 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.

KnownCRLs Property (XAdESVerifier Component)

Additional CRLs for chain validation.

Syntax

• C#
• VB.NET

public CRLList KnownCRLs { get; }

Public Property KnownCRLs As CRLList

Remarks

Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document.

This property is not available at design time.

KnownOCSPs Property (XAdESVerifier Component)

Additional OCSP responses for chain validation.

Syntax

• C#
• VB.NET

public OCSPResponseList KnownOCSPs { get; }

Public Property KnownOCSPs As OCSPResponseList

Remarks

Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document.

This property is not available at design time.

OCSPs Property (XAdESVerifier Component)

A collection of OCSP responses embedded into the signature.

Syntax

• C#
• VB.NET

public OCSPResponseList OCSPs { get; }

Public ReadOnly Property OCSPs As OCSPResponseList

Remarks

Use this property to access the OCSP responses embedded into the signature by its creator.

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

OfflineMode Property (XAdESVerifier Component)

Switches the component to offline mode.

Syntax

• C#
• VB.NET

public bool OfflineMode { get; set; }

Public Property OfflineMode As Boolean

Default Value

False

Remarks

When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

OutputBytes Property (XAdESVerifier Component)

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

Syntax

• C#
• VB.NET

public byte[] OutputBytes { get; }

Public ReadOnly Property OutputBytes As Byte()

Remarks

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

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

OutputFile Property (XAdESVerifier Component)

The file where the modified signed document will be saved.

Syntax

• C#
• VB.NET

public string OutputFile { get; set; }

Public Property OutputFile As String

Default Value

""

Remarks

Provide the full path to the file where the modified signed document should be saved.

OutputStream Property (XAdESVerifier Component)

A stream where to save the modified signed document.

Syntax

• C#
• VB.NET

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.

Profile Property (XAdESVerifier Component)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

• C#
• VB.NET

public string Profile { get; set; }

Public Property Profile As String

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Proxy Property (XAdESVerifier Component)

The proxy server settings.

Syntax

• C#
• VB.NET

public ProxySettings Proxy { get; }

Public ReadOnly Property Proxy As ProxySettings

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

References Property (XAdESVerifier Component)

References covered by the signature.

Syntax

• C#
• VB.NET

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.

RevocationCheck Property (XAdESVerifier Component)

Specifies the kind(s) of revocation check to perform for all chain certificates.

Syntax

• C#
• VB.NET

public XAdESVerifierRevocationChecks RevocationCheck { get; set; }

enum XAdESVerifierRevocationChecks {
  crcNone,
  crcAuto,
  crcAllCRL,
  crcAllOCSP,
  crcAllCRLAndOCSP,
  crcAnyCRL,
  crcAnyOCSP,
  crcAnyCRLOrOCSP,
  crcAnyOCSPOrCRL
}

Public Property RevocationCheck As XadesverifierRevocationChecks

Enum XAdESVerifierRevocationChecks
  crcNone
  crcAuto
  crcAllCRL
  crcAllOCSP
  crcAllCRLAndOCSP
  crcAnyCRL
  crcAnyOCSP
  crcAnyCRLOrOCSP
  crcAnyOCSPOrCRL
End Enum

Default Value

1

Remarks

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Signatures Property (XAdESVerifier Component)

All signatures found in the XML document.

Syntax

• C#
• VB.NET

public XAdESSignatureList Signatures { get; }

Public ReadOnly Property Signatures As XAdESSignatureList

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.

SocketSettings Property (XAdESVerifier Component)

Manages network connection settings.

Syntax

• C#
• VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

Timestamps Property (XAdESVerifier Component)

Contains a collection of timestamps for the processed document.

Syntax

• C#
• VB.NET

public TimestampInfoList Timestamps { get; }

Public ReadOnly Property Timestamps As TimestampInfoList

Remarks

Use this property to access the timestamps included in the processed document.

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

TLSClientChain Property (XAdESVerifier Component)

The TLS client certificate chain.

Syntax

• C#
• VB.NET

public CertificateList TLSClientChain { get; }

Public Property TLSClientChain As CertificateList

Remarks

Assign a certificate chain to this property to enable TLS client authentication in the component. Note that the client's end-entity certificate should have a private key associated with it.

Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.

This property is not available at design time.

TLSServerChain Property (XAdESVerifier Component)

The TLS server's certificate chain.

Syntax

• C#
• VB.NET

public CertificateList TLSServerChain { get; }

Public ReadOnly Property TLSServerChain As CertificateList

Remarks

Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.

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

TLSSettings Property (XAdESVerifier Component)

Manages TLS layer settings.

Syntax

• C#
• VB.NET

public TLSSettings TLSSettings { get; }

Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

TrustedCertificates Property (XAdESVerifier Component)

A list of trusted certificates for chain validation.

Syntax

• C#
• VB.NET

public CertificateList TrustedCertificates { get; }

Public Property TrustedCertificates As CertificateList

Remarks

Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root 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 this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust.

This property is not available at design time.

ValidationMoment Property (XAdESVerifier Component)

The time point at which signature validity is to be established.

Syntax

• C#
• VB.NET

public string ValidationMoment { get; set; }

Public Property ValidationMoment As String

Default Value

""

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

AddKnownNamespace Method (XAdESVerifier Component)

Adds known prefix and correspondent namespace URI.

Syntax

• C#
• VB.NET

public void AddKnownNamespace(string prefix, string URI);

Public Sub AddKnownNamespace(ByVal Prefix As String, ByVal URI As String)

Remarks

Use this method to add a known prefix and namespace URI that are used in XPath expression within XMLElement/XMLNode property, and within TargetXMLElement and XPathPrefixList properties of the references.

Close Method (XAdESVerifier Component)

Closes an opened document.

Syntax

• C#
• VB.NET

public void Close(bool saveChanges);

Public Sub Close(ByVal SaveChanges As Boolean)

Remarks

Use this method to close a previously opened document. Set SaveChanges to true to apply any changes made.

Config Method (XAdESVerifier Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

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

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

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 (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetInnerXML Method (XAdESVerifier Component)

Get the inner XML content of the selected XML element.

Syntax

• C#
• VB.NET

public string GetInnerXML(string XPath);

Public Function GetInnerXML(ByVal XPath As String) As String

Remarks

Call this method to get the inner XML content of the selected XML element.

GetOuterXML Method (XAdESVerifier Component)

Get the outer XML content of the selected XML element.

Syntax

• C#
• VB.NET

public string GetOuterXML(string XPath);

Public Function GetOuterXML(ByVal XPath As String) As String

Remarks

Call this method to get the outer XML content of the selected XML element.

GetSignedData Method (XAdESVerifier Component)

Returns the part of the XML document that is covered by the signature.

Syntax

• C#
• VB.NET

public void GetSignedData(string sigLabel, int refIndex);

Public Sub GetSignedData(ByVal SigLabel As String, ByVal RefIndex As Integer)

Remarks

Use this method to retrieve the part of the XML document or data that is covered by the SigLabel signature and referenced by RefIndex reference.

GetTextContent Method (XAdESVerifier Component)

Get the text content of the selected XML element.

Syntax

• C#
• VB.NET

public string GetTextContent(string XPath);

Public Function GetTextContent(ByVal XPath As String) As String

Remarks

Call this method to get the text content of the selected XML element.

Open Method (XAdESVerifier Component)

Opens a document for verifying or removing signatures.

Syntax

• C#
• VB.NET

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.

Reset Method (XAdESVerifier Component)

Resets the component settings.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

Revalidate Method (XAdESVerifier Component)

Revalidates a signature in accordance with current settings.

Syntax

• C#
• VB.NET

public void Revalidate(string sigLabel, bool detached);

Public Sub Revalidate(ByVal SigLabel As String, ByVal Detached As Boolean)

Remarks

Use this method to re-validate a signature in the opened XML document.

SelectInfo Method (XAdESVerifier Component)

Select signature information for a specific entity.

Syntax

• C#
• VB.NET

public void SelectInfo(string entityLabel, int infoType, bool clearSelection);

Public Sub SelectInfo(ByVal EntityLabel As String, ByVal InfoType As Integer, ByVal ClearSelection As Boolean)

Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to SelectInfo and keeping ClearSelection set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

SetInnerXML Method (XAdESVerifier Component)

Set the inner XML content of the selected XML element.

Syntax

• C#
• VB.NET

public void SetInnerXML(string XPath, string value);

Public Sub SetInnerXML(ByVal XPath As String, ByVal Value As String)

Remarks

Call this method to set the inner XML content of the selected XML element.

SetTextContent Method (XAdESVerifier Component)

Set the text content of the selected XML element.

Syntax

• C#
• VB.NET

public void SetTextContent(string XPath, string value);

Public Sub SetTextContent(ByVal XPath As String, ByVal Value As String)

Remarks

Call this method to set the text content of the selected XML element.

Unsign Method (XAdESVerifier Component)

Deletes a signature from the document.

Syntax

• C#
• VB.NET

public void Unsign(string sigLabel);

Public Sub Unsign(ByVal SigLabel As String)

Remarks

Use this method to delete an existing signature from the document. Use SigLabel parameter to specify the signature to be removed.

Verify Method (XAdESVerifier Component)

Verifies a signed XML document.

Syntax

• C#
• VB.NET

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

Verifies a detached signature over external XML data.

Syntax

• C#
• VB.NET

public void VerifyDetached();

Public Sub VerifyDetached()

Remarks

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

ChainElementDownload Event (XAdESVerifier Component)

Fires when there is a need to download a chain element from an online source.

Syntax

• C#
• VB.NET

public event OnChainElementDownloadHandler OnChainElementDownload;

public delegate void OnChainElementDownloadHandler(object sender, XAdESVerifierChainElementDownloadEventArgs e);

public class XAdESVerifierChainElementDownloadEventArgs : EventArgs {
  public int Kind { get; }
  public string CertRDN { get; }
  public string CACertRDN { get; }
  public string Location { get; }
  public int Action { get; set; }
}

Public Event OnChainElementDownload As OnChainElementDownloadHandler

Public Delegate Sub OnChainElementDownloadHandler(sender As Object, e As XAdESVerifierChainElementDownloadEventArgs)

Public Class XAdESVerifierChainElementDownloadEventArgs Inherits EventArgs
  Public ReadOnly Property Kind As Integer
  Public ReadOnly Property CertRDN As String
  Public ReadOnly Property CACertRDN As String
  Public ReadOnly Property Location As String
  Public Property Action As Integer
End Class

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.

ChainElementNeeded Event (XAdESVerifier Component)

Fires when an element required to validate the chain was not located.

Syntax

• C#
• VB.NET

public event OnChainElementNeededHandler OnChainElementNeeded;

public delegate void OnChainElementNeededHandler(object sender, XAdESVerifierChainElementNeededEventArgs e);

public class XAdESVerifierChainElementNeededEventArgs : EventArgs {
  public int Kind { get; }
  public string CertRDN { get; }
  public string CACertRDN { get; }
}

Public Event OnChainElementNeeded As OnChainElementNeededHandler

Public Delegate Sub OnChainElementNeededHandler(sender As Object, e As XAdESVerifierChainElementNeededEventArgs)

Public Class XAdESVerifierChainElementNeededEventArgs Inherits EventArgs
  Public ReadOnly Property Kind As Integer
  Public ReadOnly Property CertRDN As String
  Public ReadOnly Property CACertRDN As String
End Class

Remarks

Subscribe to this event to be notified about missing validation elements. Use the KnownCRLs, KnownCertificates, and KnownOCSPs properties in the event handler to provide the missing piece.

ChainElementStore Event (XAdESVerifier Component)

This event is fired when a chain element (certificate, CRL, or OCSP response) should be stored along with a signature.

Syntax

• C#
• VB.NET

public event OnChainElementStoreHandler OnChainElementStore;

public delegate void OnChainElementStoreHandler(object sender, XAdESVerifierChainElementStoreEventArgs e);

public class XAdESVerifierChainElementStoreEventArgs : EventArgs {
  public int Kind { get; }
  public byte[] Body { get; }
  public string URI { get; set; }
}

Public Event OnChainElementStore As OnChainElementStoreHandler

Public Delegate Sub OnChainElementStoreHandler(sender As Object, e As XAdESVerifierChainElementStoreEventArgs)

Public Class XAdESVerifierChainElementStoreEventArgs Inherits EventArgs
  Public ReadOnly Property Kind As Integer
  Public ReadOnly Property Body As Byte()
  Public Property URI As String
End Class

Remarks

This event could occur if you are verifying XAdES-C form or higher. The Body parameter contains the element in binary form that should be stored along with a signature. Use the URI parameter to provide an URI of the stored element.

ChainValidated Event (XAdESVerifier Component)

Reports the completion of a certificate chain validation.

Syntax

• C#
• VB.NET

public event OnChainValidatedHandler OnChainValidated;

public delegate void OnChainValidatedHandler(object sender, XAdESVerifierChainValidatedEventArgs e);

public class XAdESVerifierChainValidatedEventArgs : EventArgs {
  public int Index { get; }
  public string EntityLabel { get; }
  public string SubjectRDN { get; }
  public int ValidationResult { get; }
  public int ValidationDetails { get; }
  public bool Cancel { get; set; }
}

Public Event OnChainValidated As OnChainValidatedHandler

Public Delegate Sub OnChainValidatedHandler(sender As Object, e As XAdESVerifierChainValidatedEventArgs)

Public Class XAdESVerifierChainValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property EntityLabel As String
  Public ReadOnly Property SubjectRDN As String
  Public ReadOnly Property ValidationResult As Integer
  Public ReadOnly Property ValidationDetails As Integer
  Public Property Cancel As Boolean
End Class

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.

ChainValidationProgress Event (XAdESVerifier Component)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Syntax

• C#
• VB.NET

public event OnChainValidationProgressHandler OnChainValidationProgress;

public delegate void OnChainValidationProgressHandler(object sender, XAdESVerifierChainValidationProgressEventArgs e);

public class XAdESVerifierChainValidationProgressEventArgs : EventArgs {
  public string EventKind { get; }
  public string CertRDN { get; }
  public string CACertRDN { get; }
  public int Action { get; set; }
}

Public Event OnChainValidationProgress As OnChainValidationProgressHandler

Public Delegate Sub OnChainValidationProgressHandler(sender As Object, e As XAdESVerifierChainValidationProgressEventArgs)

Public Class XAdESVerifierChainValidationProgressEventArgs Inherits EventArgs
  Public ReadOnly Property EventKind As String
  Public ReadOnly Property CertRDN As String
  Public ReadOnly Property CACertRDN As String
  Public Property Action As Integer
End Class

Remarks

Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.

DocumentLoaded Event (XAdESVerifier Component)

This event is fired when the document has been loaded into memory.

Syntax

• C#
• VB.NET

public event OnDocumentLoadedHandler OnDocumentLoaded;

public delegate void OnDocumentLoadedHandler(object sender, XAdESVerifierDocumentLoadedEventArgs e);

public class XAdESVerifierDocumentLoadedEventArgs : EventArgs {
  public bool Cancel { get; set; }
}

Public Event OnDocumentLoaded As OnDocumentLoadedHandler

Public Delegate Sub OnDocumentLoadedHandler(sender As Object, e As XAdESVerifierDocumentLoadedEventArgs)

Public Class XAdESVerifierDocumentLoadedEventArgs 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 (XAdESVerifier Component)

Information about errors during signature verification.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, XAdESVerifierErrorEventArgs e);

public class XAdESVerifierErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As XAdESVerifierErrorEventArgs)

Public Class XAdESVerifierErrorEventArgs 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 (XAdESVerifier Component)

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, XAdESVerifierNotificationEventArgs e);

public class XAdESVerifierNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As XAdESVerifierNotificationEventArgs)

Public Class XAdESVerifierNotificationEventArgs 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 the 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.

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

ReferenceValidated Event (XAdESVerifier Component)

Marks the end of a reference validation.

Syntax

• C#
• VB.NET

public event OnReferenceValidatedHandler OnReferenceValidated;

public delegate void OnReferenceValidatedHandler(object sender, XAdESVerifierReferenceValidatedEventArgs e);

public class XAdESVerifierReferenceValidatedEventArgs : 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 XAdESVerifierReferenceValidatedEventArgs)

Public Class XAdESVerifierReferenceValidatedEventArgs 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 (XAdESVerifier Component)

Asks the application to resolve a reference.

Syntax

• C#
• VB.NET

public event OnResolveReferenceHandler OnResolveReference;

public delegate void OnResolveReferenceHandler(object sender, XAdESVerifierResolveReferenceEventArgs e);

public class XAdESVerifierResolveReferenceEventArgs : EventArgs {
  public int ReferenceIndex { get; }
  public string URI { get; }
}

Public Event OnResolveReference As OnResolveReferenceHandler

Public Delegate Sub OnResolveReferenceHandler(sender As Object, e As XAdESVerifierResolveReferenceEventArgs)

Public Class XAdESVerifierResolveReferenceEventArgs 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 (XAdESVerifier Component)

Signifies the start of signature validation.

Syntax

• C#
• VB.NET

public event OnSignatureFoundHandler OnSignatureFound;

public delegate void OnSignatureFoundHandler(object sender, XAdESVerifierSignatureFoundEventArgs e);

public class XAdESVerifierSignatureFoundEventArgs : EventArgs {
  public int Index { get; }
  public string EntityLabel { 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 XAdESVerifierSignatureFoundEventArgs)

Public Class XAdESVerifierSignatureFoundEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property EntityLabel As String
  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 parameter 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 the KnownCertificates property.

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

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

SignatureValidated Event (XAdESVerifier Component)

Marks the completion of the signature validation routine.

Syntax

• C#
• VB.NET

public event OnSignatureValidatedHandler OnSignatureValidated;

public delegate void OnSignatureValidatedHandler(object sender, XAdESVerifierSignatureValidatedEventArgs e);

public class XAdESVerifierSignatureValidatedEventArgs : EventArgs {
  public int Index { get; }
  public string EntityLabel { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public int ValidationResult { get; }
  public bool Cancel { get; set; }
}

Public Event OnSignatureValidated As OnSignatureValidatedHandler

Public Delegate Sub OnSignatureValidatedHandler(sender As Object, e As XAdESVerifierSignatureValidatedEventArgs)

Public Class XAdESVerifierSignatureValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property EntityLabel As String
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  Public ReadOnly Property ValidationResult As Integer
  Public Property Cancel As Boolean
End Class

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

TimestampFound Event (XAdESVerifier Component)

Signifies the start of a timestamp validation routine.

Syntax

• C#
• VB.NET

public event OnTimestampFoundHandler OnTimestampFound;

public delegate void OnTimestampFoundHandler(object sender, XAdESVerifierTimestampFoundEventArgs e);

public class XAdESVerifierTimestampFoundEventArgs : EventArgs {
  public int Index { get; }
  public string EntityLabel { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public bool CertFound { get; }
  public bool ValidateTimestamp { get; set; }
  public bool ValidateChain { get; set; }
}

Public Event OnTimestampFound As OnTimestampFoundHandler

Public Delegate Sub OnTimestampFoundHandler(sender As Object, e As XAdESVerifierTimestampFoundEventArgs)

Public Class XAdESVerifierTimestampFoundEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property EntityLabel As String
  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 ValidateTimestamp As Boolean
  Public Property ValidateChain As Boolean
End Class

Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.

The CertFound parameter 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 the KnownCertificates property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the ValidationResult and ChainValidationResult properties respectively.

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

TimestampValidated Event (XAdESVerifier Component)

Reports the completion of the timestamp validation routine.

Syntax

• C#
• VB.NET

public event OnTimestampValidatedHandler OnTimestampValidated;

public delegate void OnTimestampValidatedHandler(object sender, XAdESVerifierTimestampValidatedEventArgs e);

public class XAdESVerifierTimestampValidatedEventArgs : EventArgs {
  public int Index { get; }
  public string EntityLabel { get; }
  public string IssuerRDN { get; }
  public byte[] SerialNumber { get; }
  public byte[] SubjectKeyID { get; }
  public string Time { get; }
  public int ValidationResult { get; }
  public int ChainValidationResult { get; }
  public int ChainValidationDetails { get; }
  public bool Cancel { get; set; }
}

Public Event OnTimestampValidated As OnTimestampValidatedHandler

Public Delegate Sub OnTimestampValidatedHandler(sender As Object, e As XAdESVerifierTimestampValidatedEventArgs)

Public Class XAdESVerifierTimestampValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property EntityLabel As String
  Public ReadOnly Property IssuerRDN As String
  Public ReadOnly Property SerialNumber As Byte()
  Public ReadOnly Property SubjectKeyID As Byte()
  Public ReadOnly Property Time As String
  Public ReadOnly Property ValidationResult As Integer
  Public ReadOnly Property ChainValidationResult As Integer
  Public ReadOnly Property ChainValidationDetails As Integer
  Public Property Cancel As Boolean
End Class

Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

TLSCertNeeded Event (XAdESVerifier Component)

Fires when a remote TLS party requests a client certificate.

Syntax

• C#
• VB.NET

public event OnTLSCertNeededHandler OnTLSCertNeeded;

public delegate void OnTLSCertNeededHandler(object sender, XAdESVerifierTLSCertNeededEventArgs e);

public class XAdESVerifierTLSCertNeededEventArgs : EventArgs {
  public string Host { get; }
  public string CANames { get; }
}

Public Event OnTLSCertNeeded As OnTLSCertNeededHandler

Public Delegate Sub OnTLSCertNeededHandler(sender As Object, e As XAdESVerifierTLSCertNeededEventArgs)

Public Class XAdESVerifierTLSCertNeededEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public ReadOnly Property CANames As String
End Class

Remarks

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

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

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

TLSCertValidate Event (XAdESVerifier Component)

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

Syntax

• C#
• VB.NET

public event OnTLSCertValidateHandler OnTLSCertValidate;

public delegate void OnTLSCertValidateHandler(object sender, XAdESVerifierTLSCertValidateEventArgs e);

public class XAdESVerifierTLSCertValidateEventArgs : EventArgs {
  public string ServerHost { get; }
  public string ServerIP { get; }
  public bool Accept { get; set; }
}

Public Event OnTLSCertValidate As OnTLSCertValidateHandler

Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As XAdESVerifierTLSCertValidateEventArgs)

Public Class XAdESVerifierTLSCertValidateEventArgs Inherits EventArgs
  Public ReadOnly Property ServerHost As String
  Public ReadOnly Property ServerIP As String
  Public Property Accept As Boolean
End Class

Remarks

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

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

TLSEstablished Event (XAdESVerifier Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

• C#
• VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

public delegate void OnTLSEstablishedHandler(object sender, XAdESVerifierTLSEstablishedEventArgs e);

public class XAdESVerifierTLSEstablishedEventArgs : EventArgs {
  public string Host { get; }
  public string Version { get; }
  public string Ciphersuite { get; }
  public byte[] ConnectionId { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSEstablished As OnTLSEstablishedHandler

Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As XAdESVerifierTLSEstablishedEventArgs)

Public Class XAdESVerifierTLSEstablishedEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public ReadOnly Property Version As String
  Public ReadOnly Property Ciphersuite As String
  Public ReadOnly Property ConnectionId As Byte()
  Public Property Abort As Boolean
End Class

Remarks

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

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

TLSHandshake Event (XAdESVerifier Component)

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

Syntax

• C#
• VB.NET

public event OnTLSHandshakeHandler OnTLSHandshake;

public delegate void OnTLSHandshakeHandler(object sender, XAdESVerifierTLSHandshakeEventArgs e);

public class XAdESVerifierTLSHandshakeEventArgs : EventArgs {
  public string Host { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSHandshake As OnTLSHandshakeHandler

Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As XAdESVerifierTLSHandshakeEventArgs)

Public Class XAdESVerifierTLSHandshakeEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
  Public Property Abort As Boolean
End Class

Remarks

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

TLSShutdown Event (XAdESVerifier Component)

Reports the graceful closure of a TLS connection.

Syntax

• C#
• VB.NET

public event OnTLSShutdownHandler OnTLSShutdown;

public delegate void OnTLSShutdownHandler(object sender, XAdESVerifierTLSShutdownEventArgs e);

public class XAdESVerifierTLSShutdownEventArgs : EventArgs {
  public string Host { get; }
}

Public Event OnTLSShutdown As OnTLSShutdownHandler

Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As XAdESVerifierTLSShutdownEventArgs)

Public Class XAdESVerifierTLSShutdownEventArgs Inherits EventArgs
  Public ReadOnly Property Host As String
End Class

Remarks

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

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields

Constructors

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

• C#
• VB.NET

public Certificate();

Public Certificate()

CRL Type

Represents a Certificate Revocation List.

Remarks

CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons.

Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations.

Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid.

Fields

Constructors

• C#
• VB.NET

public CRL(byte[] bytes, int startIndex, int count);

Public CRL(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

• C#
• VB.NET

public CRL(string location);

Public CRL(ByVal Location As String)

• C#
• VB.NET

public CRL(System.IO.Stream stream);

Public CRL(ByVal Stream As System.IO.Stream)

• C#
• VB.NET

public CRL();

Public CRL()

OCSPResponse Type

Represents a single OCSP response originating from an OCSP responder.

Remarks

OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs).

An OCSP response is a snapshot of the certificate status at a given time.

Fields

Constructors

• C#
• VB.NET

public OCSPResponse(byte[] bytes, int startIndex, int count);

Public OCSPResponse(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

• C#
• VB.NET

public OCSPResponse(string location);

Public OCSPResponse(ByVal Location As String)

• C#
• VB.NET

public OCSPResponse(System.IO.Stream stream);

Public OCSPResponse(ByVal Stream As System.IO.Stream)

• C#
• VB.NET

public OCSPResponse();

Public OCSPResponse()

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

Constructors

• C#
• VB.NET

public ProxySettings();

Public ProxySettings()

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

Constructors

• C#
• VB.NET

public SocketSettings();

Public SocketSettings()

TimestampInfo Type

A container for timestamp information.

Remarks

The TimestampInfo object contains details of a third-party timestamp and the outcome of its validation.

Fields