JAdESSigner Component

Properties   Methods   Events   Config Settings   Errors  

The JAdESSigner component signs Javascript content electronically.

Syntax

nsoftware.SecureBlackbox.Jadessigner

Remarks

JAdESSigner supports a range of digital signature formats over Javascript content, including JSON Web Signatures (JWS) and ETSI JSON Advanced Electronic Signatures (JAdES).

Standards and technologies supported

JAdESSigner can create signatures that match the following standards:

• Generic JSON Web Signatures (JWS) (RFC7515)
• JAdES: all profiles are supported (BES, EPES, T, LTV, B-B, B-T, and others) (ETSI TS 119 182-1)
• Timestamps using external TSAs.
• All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others).

Configuring the signature spec

JWS and JAdES signatures can come in all sorts of flavours, with the primary factors being the signature format (how exactly the signed data is represented in bytes) and completeness (the extent of the trust information that is included in the signature). You can use the properties of your JAdESSigner object to configure these and other parameters. Typically, the service or software that you need to communicate with will provide you with a list of requirements that your JSON signature needs to satisfy. In some cases, they will also send you an example signature that you may use as a guide.

Typically, you will need to adjust the following categories of settings:

• Level (plain JWS, B, T, LT, or LTA). This can be adjusted with the Level property.
• Timestamp requirement: provide the address of your online TSA service via TimestampServer property.
• When creating LT/LTA signatures, tune up validation parameters via RevocationCheck, OfflineMode, and IgnoreChainValidationErrors properties.
• Configure the signature representation parameters such as CompactForm, Detached or FlattenedSignature.

The above are the most important settings from each category; you may need to adjust more specific settings, such as EPES policy parameters (such as PolicyID) or ContentType, to fine-tune your signature.

Signing certificates

JAdESSigner can use certificates residing on different media. Besides generic certificates stored in PFX or PEM files (A1), it can operate with non-exportable certificates residing on hardware media (A3), system stores/keychains, or in the cloud.

Non-exportable certificates can be accessed transparently via a Windows CSP or a PKCS#11 driver, if supplied by the certificate issuer. Proprietary or less interoperable media can be communicated with the external signing feature (see below).

Use CertificateManager and CertificateStorage components to load the signing certificate. Assign the certificate to SigningCertificate property, and optionally provide the remainder of its chain via the SigningChain property.

In the default configuration, JAdESSigner will do its best to collect the trust elements (certificates, CRLs, OCSP responses) required by the chosen signature level automatically. It will use all available sources, including the system stores, the chain validation cache, and the signature itself (when upgrading an existing signature). However, there can be situations where only some (or even none) of the trust elements are available in the public locations. This is particularly the case for internal, experimental, or test PKI environments. In such cases you might need to locate the missing elements manually and provide them to JAdESSigner via the KnownCertificates, KnownCRLs, and KnownOCSPs properties. You can also provide any trust anchors not included in the public Trusted Root directory via the TrustedCertificates collection.

Note: If signing with a non-exportable key (such as residing on a hardware device or in the cloud), please make sure you keep the original CertificateStorage object open until the signing is completed. This is because the storage component provides a 'bridge' to the private key. If the storage is closed prematurely, this bridge is destroyed, and the private key can't be used.

Signing the JSON

Now that you have configured the signature and certificate settings, you can proceed to signing. You can provide the JSON input in one of the following forms: as a file (assign the path to InputFile property), as a stream (assign to InputStream property), as a string (InputString), or as a byte array (assign to InputBytes). Similarly, the output can be collected in one of the same forms, either by passing the destination path or stream via OutputFile and OutputStream respectively, or by reading the resulting document bytes from the OutputBytes or OutputString property after the signing.

Having set up the input and output, call the component's Sign method. This will initiate the signing process. Depending on the settings, the signing may be as straightforward as calculating the document hash and signing it with the private key (e.g. when creating a B-level signature), or it may involve advanced chain validation routines (LT or LTA). During the latter the component contacts a number of external trust information sources (CA, CRL, and OCSP servers) to establish the validity of the signing certificate.

If a TSA server was provided via the TimestampServer property, the component will contact it too to timestamp the new signature.

During the signing JAdESSigner may fire events to let your code know of certain conditions. It may fire TLSCertValidate if one of the HTTP endpoints involved during the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate chain to be validated.

External signing and DCAuth

JAdESSigner, like many other components included in the product, supports two methods of signing with external keys. These methods are fully independent of each other: you can choose the one that suits your scenario best.

Synchronous method: ExternalSign

This is a simpler method that basically lets you infiltrate into the signing routine by taking care of the hash signing operation. The component does the rest of the job (hash calculation, preparation of signature objects, CRL/OCSP retrieval).

To initiate this method, call SignExternal instead of Sign. When the hash is ready, it will be passed back to your code with ExternalSign event. Your event handler needs to sign the hash with the private key and return the created signature back to the component - which will embed it into the document.

You don't need your signing certificate to contain an associated private key when using this method. The certificate itself (its public copy) may be needed though, as it is included in the hash calculation.

This method is synchronous, meaning SignExternal provides you the results immediately upon its completion.

Asynchronous method: DCAuth

DCAuth is a SecureBlackbox know-how technology. This protocol was designed to allow sharing of private keys across environments, allowing the signer and the private key to reside on different systems. It works in the following way:

• The signing party - such as JAdESSigner - initiates the operation using SignAsyncBegin call. This produces two outcomes: a pre-signed content (a JSON body with a blank signature placeholder), and a request state (an object containing a hash that needs to be signed). At this point the JAdESSigner instance can be released, and the process itself terminated (which may be useful when run as part of a web page).
• The request state is passed to the private key holder party. The private key holder passes the request state to a DCAuth object, which parses the request state, extracts the hash, and signs it. The output of DCAuth processing is another object, response state, which contains the signature. The private key holder then sends the response state back to the signing party.
• The signing party re-creates the signing controls, and passes the response state, together with the pre-signed content, to the signer's SignAsyncEnd method. SignAsyncEnd extracts the signature from the response state and incorporates it into the pre-signed object, hereby completing the signature.

This method is asynchronous in that sense that, from the signing party's viewpoint, it splits the signing operation into the pre-signing and completion stages which can be performed independently from each other and in different execution contexts. This makes this method particularly helpful for use in web pages and other scenarios where the signing key is not available in real time.

Fine-grained chain validation setup

Chain validation is a sophisticated, multi-faceted procedure that involves a lot of variables. Depending on the configuration of your operating environment, the specifics of the PKI framework being used, and the validation policy you need to follow, you may want to tune up your chain validation parameters so they fit them best. A summary of such parameters is given below.

• RevocationCheck lets you choose between and/or prioritize revocation origins. OCSP sources are often preferred to CRL because of their real-time capability and the smaller size of validation tokens they produce.
• OfflineMode is a master switch that stops the component from looking for any validation tokens online. If this property is switched on, the component will only use the KnownCertificates, TrustedCertificates, KnownCRLs, and KnownOCSPs collections to look for the missing validation material.
• IgnoreChainValidationErrors makes the component ignore any major validation issues it encounters (such us an untrusted chain or missing CRL). This option is handy for debugging and for creating signatures in the environments where the signing certificate is not trusted.
• KnownCertificates, KnownCRLs, and KnownOCSPs let you provide your own validation material. This may be useful when working in OfflineMode, where the signer has no access to the validation sources, or where the validation material has already been collected.
• TrustedCertificates lets you provide a list of trust anchors, either as a complement to the system's or as an alternative to it.
• BlockedCertificates lets you provide a list of blocked/distrusted certificates. Any CA certificate contained in it will be deemed untrusted/invalid.

The following parameters are not directly related to chain validation, but may have an implicit effect on it.

• Proxy, SocketSettings, and TLSSettings let you tune up the connectivity and TLS options in accordance with local preferences.
• TLSClientChain lets you provide the client certificate and its chain for TLS client authentication.
• Subscribe to TLSCertValidate to validate any TLS certificates of the services involved in chain validation.

The results of the chain validation procedure, upon its completion, are published in the following properties:

• ChainValidationResult contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined.
• ChainValidationDetails provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate.
• ValidationLog contains the detailed chain validation log. The log can often be very helpful in nailing down various validation issues.

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.

AutoValidateSignatures Property (JAdESSigner Component)

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

Syntax

• C#
• VB.NET

public bool AutoValidateSignatures { get; set; }

Public Property AutoValidateSignatures As Boolean

Default Value

False

Remarks

This setting is switched off by default to speed up JSON processing. Even if the JWS/JAdES signature is loaded with this property set to false, you can validate the signatures manually on a later stage using the Revalidate method.

BlockedCertificates Property (JAdESSigner 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 (JAdESSigner 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

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.

CompactForm Property (JAdESSigner Component)

Specifies if the JWS compact serialization to be used.

Syntax

• C#
• VB.NET

public bool CompactForm { get; set; }

Public Property CompactForm As Boolean

Default Value

False

Remarks

When this property is set to "true" value, the JAdES component will use the JWS compact serialization format when saving a signature.

The JWS compact serialization format is a compact, Url safe representation of a JWS (JSON Web Signature) or JWE (JSON Web Encryption) object, used for transmitting security tokens.

The JWS compact serialization format supports only one signature without unprotected header (only JWS or JAdES BaselineB signature).

ContentType Property (JAdESSigner Component)

Specifies payload content type.

Syntax

• C#
• VB.NET

public string ContentType { get; set; }

Public Property ContentType As String

Default Value

""

Remarks

Use this property to indicate the content type of the JWS Payload.

This property provides a way for the application to disambiguate among different kinds of objects that might be present in the payload, but it is typically not used when the kind of object is already known. The value of this property is a string that conforms to the Internet Media Type (MIME) format, such as "text/plain" or "application/json".

It is optional to use this property and it is recommended to omit the "application/" prefix of the media type value when it is not needed. The recipient of the signed message should treat the value as if "application/" were prepended to it, unless it already contains a '/'.

CRLs Property (JAdESSigner 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 (JAdESSigner Component)

Use this property to pass a payload or an object 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 a JWS payload or an object data to be processed to this property.

This property is not available at design time.

DataFile Property (JAdESSigner Component)

A path to a file containing a payload or an object data.

Syntax

• C#
• VB.NET

public string DataFile { get; set; }

Public Property DataFile As String

Default Value

""

Remarks

Use this property to provide a JWS payload or an object data to be processed.

DataStream Property (JAdESSigner Component)

A stream containing a payload or an object data.

Syntax

• C#
• VB.NET

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

Public Property DataStream As System.IO.Stream

Default Value

null

Remarks

Use this property to provide a JWS payload or an object data to be processed.

This property is not available at design time.

DataString Property (JAdESSigner Component)

Use this property to pass a payload or an object data to component in the string form.

Syntax

• C#
• VB.NET

public string DataString { get; set; }

Public Property DataString As String

Default Value

""

Remarks

Assign a string containing a JWS payload or an object data to be processed to this property.

This property is not available at design time.

Detached Property (JAdESSigner Component)

Specifies whether a detached signature should be produced or verified.

Syntax

• C#
• VB.NET

public bool Detached { get; set; }

Public Property Detached As Boolean

Default Value

False

Remarks

Use this property to specify whether a detached signature should be produced or verified.

When this property is set to "true" value, the JWS payload will be detached from the signature and may either be a single detached object or the result of concatenating multiple detached data objects. In other words, the JWS payload and the signature are stored in separate objects.

If this property is set to "true" value, the user must provide the detached content via the DataFile or DataStream or DataBytes or DataString properties.

When Detached is set to "false" value, the JWS payload is included with the signature as a single object.

ExternalCrypto Property (JAdESSigner Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

ExtractPayload Property (JAdESSigner Component)

Specifies whether a payload should be extracted.

Syntax

• C#
• VB.NET

public bool ExtractPayload { get; set; }

Public Property ExtractPayload As Boolean

Default Value

False

Remarks

Use this property to specify whether a payload should be extracted when signature loaded. This applies only to non-detached signatures with a payload.

When this property is set to "true" value, the JWS payload will be extracted from the signature.

The user must provide the OutputFile or OutputStream properties with a filename or stream where to save the payload, if none is provided then payload is returned via OutputBytes or OutputString properties.

FIPSMode Property (JAdESSigner 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.

FlattenedSignature Property (JAdESSigner Component)

Specifies if the flattened signature to be used.

Syntax

• C#
• VB.NET

public bool FlattenedSignature { get; set; }

Public Property FlattenedSignature As Boolean

Default Value

True

Remarks

This property determines whether to use the flattened JWS JSON serialization format. This format is optimized for the single digital signature case and flattens the general JWS JSON serialization syntax by removing the "signatures" member and instead placing the "protected", "header", and "signature" members at the top-level JSON object (at the same level as the "payload" member).

When the FlattenedSignature property is set to "true" value, the signature will be represented using the flattened JWS JSON serialization format, but it is only applicable when there is a single signature involved.

When the property is set to "false" value, the signature will be represented using the general JWS JSON serialization format.

IgnoreChainValidationErrors Property (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner Component)

The file to be signed.

Syntax

• C#
• VB.NET

public string InputFile { get; set; }

Public Property InputFile As String

Default Value

""

Remarks

Provide the path to the JSON to be signed.

InputStream Property (JAdESSigner Component)

Stream containing the JWS/JAdES signature.

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 feed the JWS/JAdES signature to the component via a stream.

This property is not available at design time.

InputString Property (JAdESSigner Component)

Use this property to pass the input to component in the string form.

Syntax

• C#
• VB.NET

public string InputString { get; set; }

Public Property InputString As String

Default Value

""

Remarks

Assign a string containing the data to be processed to this property.

This property is not available at design time.

KnownCertificates Property (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner 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.

NewSignature Property (JAdESSigner Component)

Provides access to new signature properties.

Syntax

• C#
• VB.NET

public JAdESSignature NewSignature { get; }

Public ReadOnly Property NewSignature As JAdESSignature

Remarks

Use this property to tune-up signature properties.

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

OCSPs Property (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner Component)

Defines where to save the signature.

Syntax

• C#
• VB.NET

public string OutputFile { get; set; }

Public Property OutputFile As String

Default Value

""

Remarks

Specifies the path where the JWS/JAdES signature should be saved.

OutputStream Property (JAdESSigner Component)

The stream where the signature would be saved.

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 save the JWS/JAdES signature to the stream.

This property is not available at design time.

OutputString Property (JAdESSigner Component)

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

Syntax

• C#
• VB.NET

public string OutputString { get; }

Public ReadOnly Property OutputString As String

Default Value

""

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.

Profile Property (JAdESSigner 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 (JAdESSigner 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.

RevocationCheck Property (JAdESSigner Component)

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

Syntax

• C#
• VB.NET

public JadessignerRevocationChecks RevocationCheck { get; set; }

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

Public Property RevocationCheck As JadessignerRevocationChecks

Enum JadessignerRevocationChecks
  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 (JAdESSigner Component)

Provides details of all signatures found in the JWS/JAdES signature.

Syntax

• C#
• VB.NET

public JAdESSignatureList Signatures { get; }

Public ReadOnly Property Signatures As JAdESSignatureList

Remarks

Use this property to get the details of all the signatures identified in the JWS/JAdES signature.

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

SigningCertificate Property (JAdESSigner Component)

The certificate to be used for signing.

Syntax

• C#
• VB.NET

public Certificate SigningCertificate { get; set; }

Public Property SigningCertificate As Certificate

Remarks

Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature.

This property is not available at design time.

SigningChain Property (JAdESSigner Component)

The signing certificate chain.

Syntax

• C#
• VB.NET

public CertificateList SigningChain { get; }

Public Property SigningChain As CertificateList

Remarks

Use this property to provide the chain for the signing certificate. Use the SigningCertificate property, if it is available, to provide the signing certificate itself.

This property is not available at design time.

SocketSettings Property (JAdESSigner 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 (JAdESSigner 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.

TimestampServer Property (JAdESSigner Component)

The address of the timestamping server.

Syntax

• C#
• VB.NET

public string TimestampServer { get; set; }

Public Property TimestampServer As String

Default Value

""

Remarks

Use this property to set the address of the TSA (Time Stamping Authority) server which should be used for timestamping the signature.

TLSClientChain Property (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner 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 (JAdESSigner 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.

AddSignedHTTPHeaderField Method (JAdESSigner Component)

Use this method to add HTTP header field.

Syntax

• C#
• VB.NET

public void AddSignedHTTPHeaderField(string fieldName);

Public Sub AddSignedHTTPHeaderField(ByVal FieldName As String)

Remarks

This method allows you to add HTTP header field to the list of fields that will be signed. The method takes one parameter: the name of the header field.

This method changes the type of signed data to HttpHeaders mechanism and triggers the HTTPHeaderFieldNeeded event when the value of the HTTP header field is needed.

Use "(request target)" value as a field name to add request method and target URI into the list of fields that will be signed.

AddSignedObject Method (JAdESSigner Component)

Use this method to add an object.

Syntax

• C#
• VB.NET

public void AddSignedObject(string URI, string contentType);

Public Sub AddSignedObject(ByVal URI As String, ByVal ContentType As String)

Remarks

This method allows you to add an object to the list of objects that will be signed. The signed object is identified by its URI.

This method changes the type of signed data to ObjectByURI mechanism and triggers the ObjectNeeded event when the data of the object is needed.

AddSignedObjectHash Method (JAdESSigner Component)

Use this method to add an object hash.

Syntax

• C#
• VB.NET

public void AddSignedObjectHash(string URI, string contentType, byte[] hash);

Public Sub AddSignedObjectHash(ByVal URI As String, ByVal ContentType As String, ByVal Hash As Byte())

Remarks

This method allows you to add an object hash to the list of objects that will be signed. The signed object is identified by its URI.

This method changes the type of signed data to ObjectByURIHash mechanism and triggers the ObjectValidate event when the object must be validated. Also, it triggers the ObjectNeeded event when the data of the object is needed this could occur while adding/validating SignedData or Archive timestamps.

AddTimestampValidationData Method (JAdESSigner Component)

Use this method to add timestamp validation data to the signature.

Syntax

• C#
• VB.NET

public void AddTimestampValidationData(int sigIndex);

Public Sub AddTimestampValidationData(ByVal SigIndex As Integer)

Remarks

Call this method to add certificates and revocation information used to validate timestamp's signer certificates at a particular time.

AddValidationDataRefs Method (JAdESSigner Component)

Use this method to add signature validation references to the signature.

Syntax

• C#
• VB.NET

public void AddValidationDataRefs(int sigIndex);

Public Sub AddValidationDataRefs(ByVal SigIndex As Integer)

Remarks

Call this method to add references to certificates and revocation information used to validate a signature at a particular time.

AddValidationDataValues Method (JAdESSigner Component)

Use this method to add signature validation values to the signature.

Syntax

• C#
• VB.NET

public void AddValidationDataValues(int sigIndex);

Public Sub AddValidationDataValues(ByVal SigIndex As Integer)

Remarks

Call this method to add certificates and revocation information used to validate a signature at a particular time.

Close Method (JAdESSigner Component)

Closes an opened JWS/JAdES signature.

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 JWS/JAdES signature. Set SaveChanges to true to apply any changes made.

Config Method (JAdESSigner 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.

CreateNew Method (JAdESSigner Component)

Create a new JSON for signing.

Syntax

• C#
• VB.NET

public void CreateNew();

Public Sub CreateNew()

Remarks

Use this method to create a new JSON for signing. When finished, call Close to complete or discard the operation.

DoAction Method (JAdESSigner 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;....

ExtractAsyncData Method (JAdESSigner Component)

Extracts user data from the DC signing service response.

Syntax

• C#
• VB.NET

public string ExtractAsyncData(string asyncReply);

Public Function ExtractAsyncData(ByVal AsyncReply As String) As String

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

Open Method (JAdESSigner Component)

Opens a JSON for signing or updating.

Syntax

• C#
• VB.NET

public void Open();

Public Sub Open()

Remarks

Use this method to open a JSON for signing or updating. When finished, call Close to complete or discard the operation.

Revalidate Method (JAdESSigner Component)

Revalidates a signature in accordance with current settings.

Syntax

• C#
• VB.NET

public void Revalidate(int sigIndex);

Public Sub Revalidate(ByVal SigIndex As Integer)

Remarks

Use this method to re-validate a signature in the opened JWS/JAdES signature.

Sign Method (JAdESSigner Component)

Creates a new JAdES/JWS signature over the provided data.

Syntax

• C#
• VB.NET

public void Sign();

Public Sub Sign()

Remarks

Call this method to produce a new signature over the provided data.

SignAsyncBegin Method (JAdESSigner Component)

Initiates the asynchronous signing operation.

Syntax

• C#
• VB.NET

public string SignAsyncBegin();

Public Function SignAsyncBegin() As String

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in OutputFile (or OutputStream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to InputFile (or InputStream), and call SignAsyncEnd to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to SignAsyncEnd and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth component), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignAsyncEnd Method (JAdESSigner Component)

Completes the asynchronous signing operation.

Syntax

• C#
• VB.NET

public void SignAsyncEnd(string asyncReply);

Public Sub SignAsyncEnd(ByVal AsyncReply As String)

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior SignAsyncBegin call to InputFile (or InputStream). The method will embed the signature into the pre-signed document, and save the complete signed document to OutputFile (or OutputStream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the SigningCertificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (SignAsyncBegin) stage.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the SignAsyncBegin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth component), which processes it and produces a matching signature state. The async state produced by the server is then passed to the SignAsyncEnd method.

SignExternal Method (JAdESSigner Component)

Signs the data using an external signing facility.

Syntax

• C#
• VB.NET

public void SignExternal();

Public Sub SignExternal()

Remarks

Call this method to delegate the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

When all preparations are done and hash is computed, the component fires ExternalSign event which allows to pass the hash value for signing.

Timestamp Method (JAdESSigner Component)

Use this method to add timestamp.

Syntax

• C#
• VB.NET

public void Timestamp(int sigIndex, int timestampType);

Public Sub Timestamp(ByVal SigIndex As Integer, ByVal TimestampType As Integer)

Remarks

Call this method to timestamp the signature. Use the TimestampServer property to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. Use the TimestampType parameter to specify the type of timestamp to create

Supported timestamp types:

Upgrade Method (JAdESSigner Component)

Upgrades existing JAdES signature to a new level.

Syntax

• C#
• VB.NET

public void Upgrade(int sigIndex, int toLevel);

Public Sub Upgrade(ByVal SigIndex As Integer, ByVal ToLevel As Integer)

Remarks

Use this method to upgrade JAdES signature to a new level specified by ToLevel. Signatures can normally be upgraded from less sophisticated levels (B, T, LT) to more sophisticated (T, LT, LTA).

Supported levels:

ChainElementDownload Event (JAdESSigner 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, JadessignerChainElementDownloadEventArgs e);

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

Public Class JadessignerChainElementDownloadEventArgs 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 (JAdESSigner 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, JadessignerChainElementNeededEventArgs e);

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

Public Class JadessignerChainElementNeededEventArgs 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 (JAdESSigner 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, JadessignerChainElementStoreEventArgs e);

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

Public Class JadessignerChainElementStoreEventArgs 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 (JAdESSigner Component)

Reports the completion of a certificate chain validation.

Syntax

• C#
• VB.NET

public event OnChainValidatedHandler OnChainValidated;

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

public class JadessignerChainValidatedEventArgs : EventArgs {
  public int Index { get; }
  public string SubjectRDN { get; }
  public int ValidationResult { get; }
  public int ValidationDetails { get; }
}

Public Event OnChainValidated As OnChainValidatedHandler

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

Public Class JadessignerChainValidatedEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property SubjectRDN As String
  Public ReadOnly Property ValidationResult As Integer
  Public ReadOnly Property ValidationDetails As Integer
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 (JAdESSigner 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, JadessignerChainValidationProgressEventArgs e);

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

Public Class JadessignerChainValidationProgressEventArgs 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.

Error Event (JAdESSigner Component)

Information about errors during signing.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class JadessignerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

This event is fired in case of exceptional conditions during the JSON processing.

ErrorCode contains an error code and Description contains a textual description of the error.

ExternalSign Event (JAdESSigner Component)

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

Syntax

• C#
• VB.NET

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, JadessignerExternalSignEventArgs e);

public class JadessignerExternalSignEventArgs : EventArgs {
  public string OperationId { get; }
  public string HashAlgorithm { get; }
  public string Pars { get; }
  public string Data { get; }
  public string SignedData { get; set; }
}

Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As JadessignerExternalSignEventArgs)

Public Class JadessignerExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property Data As String
  Public Property SignedData As String
End Class

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The component uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

HTTPHeaderFieldNeeded Event (JAdESSigner Component)

This event is fired when HTTP header field value is required.

Syntax

• C#
• VB.NET

public event OnHTTPHeaderFieldNeededHandler OnHTTPHeaderFieldNeeded;

public delegate void OnHTTPHeaderFieldNeededHandler(object sender, JadessignerHTTPHeaderFieldNeededEventArgs e);

public class JadessignerHTTPHeaderFieldNeededEventArgs : EventArgs {
  public string FieldName { get; }
  public string FieldValues { get; set; }
}

Public Event OnHTTPHeaderFieldNeeded As OnHTTPHeaderFieldNeededHandler

Public Delegate Sub OnHTTPHeaderFieldNeededHandler(sender As Object, e As JadessignerHTTPHeaderFieldNeededEventArgs)

Public Class JadessignerHTTPHeaderFieldNeededEventArgs Inherits EventArgs
  Public ReadOnly Property FieldName As String
  Public Property FieldValues As String
End Class

Remarks

This event is triggered when the type of signed data is HttpHeaders mechanism (jasdtHttpHeaders). It indicates that a HTTP header field value is needed.

For "(request target)" field name value return request method and target URI seperated by space character. For example: "GET https://nsoftware.com/sbb/"

Loaded Event (JAdESSigner Component)

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

Syntax

• C#
• VB.NET

public event OnLoadedHandler OnLoaded;

public delegate void OnLoadedHandler(object sender, JadessignerLoadedEventArgs e);

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

Public Event OnLoaded As OnLoadedHandler

Public Delegate Sub OnLoadedHandler(sender As Object, e As JadessignerLoadedEventArgs)

Public Class JadessignerLoadedEventArgs Inherits EventArgs
  Public Property Cancel As Boolean
End Class

Remarks

The handler for this event is a good place to check JWS/JAdES signature properties, which may be useful when preparing the signature.

Set Cancel to true to terminate JSON processing on this stage.

Notification Event (JAdESSigner 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, JadessignerNotificationEventArgs e);

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

Public Event OnNotification As OnNotificationHandler

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

Public Class JadessignerNotificationEventArgs 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:

ObjectNeeded Event (JAdESSigner Component)

This event is fired when object is required.

Syntax

• C#
• VB.NET

public event OnObjectNeededHandler OnObjectNeeded;

public delegate void OnObjectNeededHandler(object sender, JadessignerObjectNeededEventArgs e);

public class JadessignerObjectNeededEventArgs : EventArgs {
  public string URI { get; }
  public string ContentType { get; }
  public bool Base64 { get; set; }
}

Public Event OnObjectNeeded As OnObjectNeededHandler

Public Delegate Sub OnObjectNeededHandler(sender As Object, e As JadessignerObjectNeededEventArgs)

Public Class JadessignerObjectNeededEventArgs Inherits EventArgs
  Public ReadOnly Property URI As String
  Public ReadOnly Property ContentType As String
  Public Property Base64 As Boolean
End Class

Remarks

This event is triggered when the type of signed data is ObjectIdByURI mechanism (jasdtObjectIdByURI). It is fired to request the data to be signed/verified.

The event handler must pass object data to the component via DataFile or DataStream or DataBytes or DataString property.

ObjectValidate Event (JAdESSigner Component)

This event is fired when object should be verified by user.

Syntax

• C#
• VB.NET

public event OnObjectValidateHandler OnObjectValidate;

public delegate void OnObjectValidateHandler(object sender, JadessignerObjectValidateEventArgs e);

public class JadessignerObjectValidateEventArgs : EventArgs {
  public string URI { get; }
  public string ContentType { get; }
  public string HashAlgorithm { get; }
  public byte[] Hash { get; }
  public bool Base64 { get; }
  public bool Valid { get; set; }
}

Public Event OnObjectValidate As OnObjectValidateHandler

Public Delegate Sub OnObjectValidateHandler(sender As Object, e As JadessignerObjectValidateEventArgs)

Public Class JadessignerObjectValidateEventArgs Inherits EventArgs
  Public ReadOnly Property URI As String
  Public ReadOnly Property ContentType As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Hash As Byte()
  Public ReadOnly Property Base64 As Boolean
  Public Property Valid As Boolean
End Class

Remarks

This event is triggered when the type of signed data is ObjectIdByURIHash mechanism (jasdtObjectIdByURIHash). It is fired to validate the detached object.

The event handler must pass the object validity to the component via Valid parameter.

SignatureFound Event (JAdESSigner Component)

Signifies the start of signature validation.

Syntax

• C#
• VB.NET

public event OnSignatureFoundHandler OnSignatureFound;

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

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

Public Class JadessignerSignatureFoundEventArgs 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 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 (JAdESSigner Component)

Marks the completion of the signature validation routine.

Syntax

• C#
• VB.NET

public event OnSignatureValidatedHandler OnSignatureValidated;

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

public class JadessignerSignatureValidatedEventArgs : EventArgs {
  public int Index { 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 JadessignerSignatureValidatedEventArgs)

Public Class JadessignerSignatureValidatedEventArgs 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 ValidationResult As Integer
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 (JAdESSigner Component)

Signifies the start of a timestamp validation routine.

Syntax

• C#
• VB.NET

public event OnTimestampFoundHandler OnTimestampFound;

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

public class JadessignerTimestampFoundEventArgs : EventArgs {
  public int Index { 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 JadessignerTimestampFoundEventArgs)

Public Class JadessignerTimestampFoundEventArgs 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 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.

TimestampRequest Event (JAdESSigner Component)

Fires when the component is ready to request a timestamp from an external TSA.

Syntax

• C#
• VB.NET

public event OnTimestampRequestHandler OnTimestampRequest;

public delegate void OnTimestampRequestHandler(object sender, JadessignerTimestampRequestEventArgs e);

public class JadessignerTimestampRequestEventArgs : EventArgs {
  public string TSA { get; }
  public string TimestampRequest { get; }
  public string TimestampResponse { get; set; }
  public bool SuppressDefault { get; set; }
}

Public Event OnTimestampRequest As OnTimestampRequestHandler

Public Delegate Sub OnTimestampRequestHandler(sender As Object, e As JadessignerTimestampRequestEventArgs)

Public Class JadessignerTimestampRequestEventArgs Inherits EventArgs
  Public ReadOnly Property TSA As String
  Public ReadOnly Property TimestampRequest As String
  Public Property TimestampResponse As String
  Public Property SuppressDefault As Boolean
End Class

Remarks

Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The TSA parameter indicates the timestamping service being used. It matches the value passed to the TimestampServer property. Set the SuppressDefault parameter to false if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.

TimestampValidated Event (JAdESSigner Component)

Reports the completion of the timestamp validation routine.

Syntax

• C#
• VB.NET

public event OnTimestampValidatedHandler OnTimestampValidated;

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

public class JadessignerTimestampValidatedEventArgs : EventArgs {
  public int Index { 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 Event OnTimestampValidated As OnTimestampValidatedHandler

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

Public Class JadessignerTimestampValidatedEventArgs 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 Time As String
  Public ReadOnly Property ValidationResult As Integer
  Public ReadOnly Property ChainValidationResult As Integer
  Public ReadOnly Property ChainValidationDetails As Integer
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 (JAdESSigner 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, JadessignerTLSCertNeededEventArgs e);

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

Public Event OnTLSCertNeeded As OnTLSCertNeededHandler

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

Public Class JadessignerTLSCertNeededEventArgs 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 (JAdESSigner 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, JadessignerTLSCertValidateEventArgs e);

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

Public Class JadessignerTLSCertValidateEventArgs 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 (JAdESSigner Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

• C#
• VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

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

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

Public Class JadessignerTLSEstablishedEventArgs 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 (JAdESSigner 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, JadessignerTLSHandshakeEventArgs e);

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

Public Event OnTLSHandshake As OnTLSHandshakeHandler

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

Public Class JadessignerTLSHandshakeEventArgs 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 (JAdESSigner Component)

Reports the graceful closure of a TLS connection.

Syntax

• C#
• VB.NET

public event OnTLSShutdownHandler OnTLSShutdown;

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

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

Public Event OnTLSShutdown As OnTLSShutdownHandler

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

Public Class JadessignerTLSShutdownEventArgs 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

Provides details of an individual X.509 certificate.

Remarks

This type 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)

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.

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

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.

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

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.

• C#
• VB.NET

public Certificate(string path, string password);

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

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.

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

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.

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

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

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

• C#
• VB.NET

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

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

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

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

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.

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a new object with default field values.

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)

Creates a CRL object from a memory buffer. Bytes is a buffer containing raw (DER) CRL data, StartIndex and Count specify the starting position and the length of the CRL data in the buffer, respectively.

• C#
• VB.NET

public CRL(string location);

Public CRL(ByVal Location As String)

Creates a CRL object by downloading it from a remote location.

• C#
• VB.NET

public CRL(System.IO.Stream stream);

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

Creates a CRL object from data contained in a stream.

• C#
• VB.NET

public CRL();

Public CRL()

Creates an empty CRL object.

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

• C#
• VB.NET

public ExternalCrypto();

Public ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

JAdESSignature Type

The component is a container for an JWS/JAdES signature.

Remarks

JSON message may include any number of JWS/JAdES signatures. component stores one of them.

Fields