MessageTimestampVerifier Component

Properties   Methods   Events   Config Settings   Errors  

The MessageTimestampVerifier component verifies message timestamps.

Syntax

nsoftware.SecureBlackbox.Messagetimestampverifier

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

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.

Certificates Property (MessageTimestampVerifier 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.

DataBytes Property (MessageTimestampVerifier Component)

Use this property to pass the timestamped 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 original timestamped data to this property.

This property is not available at design time.

DataFile Property (MessageTimestampVerifier Component)

The name of the file containing the originally timestamped data.

Syntax

• C#
• VB.NET

public string DataFile { get; set; }

Public Property DataFile As String

Default Value

""

Remarks

Use this property to provide the original data when validating detached timestamps with VerifyDetached.

DataFileName Property (MessageTimestampVerifier Component)

Returns the data filename as recorded in the timestamp.

Syntax

• C#
• VB.NET

public string DataFileName { get; }

Public ReadOnly Property DataFileName As String

Default Value

""

Remarks

This read-only property returns the file name of the timestamped data as recorded in the timestamp by its creator. It only carries an informational purpose.

This property is read-only.

DataStream Property (MessageTimestampVerifier Component)

A stream containing the originally timestamped 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 the original data when validating detached timestamps with VerifyDetached.

This property is not available at design time.

DataURI Property (MessageTimestampVerifier Component)

Returns the data URI as recorded in the timestamp.

Syntax

• C#
• VB.NET

public string DataURI { get; }

Public ReadOnly Property DataURI As String

Default Value

""

Remarks

This read-only property returns the URI of the timestamped data as recorded in the timestamp by its creator. It only carries an informational purpose.

This property is read-only.

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

InputBytes Property (MessageTimestampVerifier 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 (MessageTimestampVerifier Component)

Path to the file containing the timestamped message.

Syntax

• C#
• VB.NET

public string InputFile { get; set; }

Public Property InputFile As String

Default Value

""

Remarks

Use this property to provide a file containing the timestamped data, either enveloping or detached.

InputStream Property (MessageTimestampVerifier Component)

The stream containing the timestamped message.

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 provide a stream containing the timestamped message.

This property is not available at design time.

OutputBytes Property (MessageTimestampVerifier 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 (MessageTimestampVerifier Component)

Path to the file to save the extracted data to.

Syntax

• C#
• VB.NET

public string OutputFile { get; set; }

Public Property OutputFile As String

Default Value

""

Remarks

Use this property when validating enveloping timestamps to specify the output file where the extracted message should be saved.

OutputStream Property (MessageTimestampVerifier Component)

The stream to save the extracted data to.

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 when verifying enveloping timestamps to provide the stream to save the extracted data to.

This property is not available at design time.

SignatureValidationResult Property (MessageTimestampVerifier Component)

The signature validation result.

Syntax

• C#
• VB.NET

public MessagetimestampverifierSignatureValidationResults SignatureValidationResult { get; }

enum MessagetimestampverifierSignatureValidationResults {
  svtValid,
  svtUnknown,
  svtCorrupted,
  svtSignerNotFound,
  svtFailure
}

Public ReadOnly Property SignatureValidationResult As MessagetimestampverifierSignatureValidationResults

Enum MessagetimestampverifierSignatureValidationResults
  svtValid
  svtUnknown
  svtCorrupted
  svtSignerNotFound
  svtFailure
End Enum

Default Value

0

Remarks

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

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

SigningCertificate Property (MessageTimestampVerifier Component)

The certificate that was used to create the signature.

Syntax

• C#
• VB.NET

public Certificate SigningCertificate { get; }

Public ReadOnly Property SigningCertificate As Certificate

Remarks

Use this property to access the certificate that was used to create the signature. This property might not be available if the signer chose not to include the certificate into the signature.

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

TimestampFormat Property (MessageTimestampVerifier Component)

Returns the format of the processed timestamp.

Syntax

• C#
• VB.NET

public MessagetimestampverifierTimestampFormats TimestampFormat { get; }

enum MessagetimestampverifierTimestampFormats {
  mtfUnknown,
  mtfRFC5544,
  mtfCMS,
  mtfTSPReply
}

Public ReadOnly Property TimestampFormat As MessagetimestampverifierTimestampFormats

Enum MessagetimestampverifierTimestampFormats
  mtfUnknown
  mtfRFC5544
  mtfCMS
  mtfTSPReply
End Enum

Default Value

0

Remarks

Use this property to check the format of the processed timestamp blob.

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

ValidatedSigningTime Property (MessageTimestampVerifier Component)

Contains the certified signing time.

Syntax

• C#
• VB.NET

public string ValidatedSigningTime { get; }

Public ReadOnly Property ValidatedSigningTime As String

Default Value

""

Remarks

Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.

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

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

Verify Method (MessageTimestampVerifier Component)

Verifies a timestamped message.

Syntax

• C#
• VB.NET

public void Verify();

Public Sub Verify()

Remarks

Use this method to verify the enveloping timestamped message provided via InputFile (or InputStream). The original message will be extracted and saved to OutputFile (OutputStream).

Use VerifyDetached to verify detached timestamps.

VerifyDetached Method (MessageTimestampVerifier Component)

Verifies a detached timestamped message.

Syntax

• C#
• VB.NET

public void VerifyDetached();

Public Sub VerifyDetached()

Remarks

Use this method to verify the detached timestamped message provided via InputFile (or InputStream). Please provide the original data via DataFile or DataStream property. You do not need to provide OutputFile and OutputStream, as no data is extracted during this call.

Use Verify to verify enveloping timestamps.

Error Event (MessageTimestampVerifier Component)

Information about errors during PKCS#7 message encryption.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class MessagetimestampverifierErrorEventArgs 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 message processing.

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 the Messages section.

Notification Event (MessageTimestampVerifier 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, MessagetimestampverifierNotificationEventArgs e);

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

Public Event OnNotification As OnNotificationHandler

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

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

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.

Config Settings (MessageTimestampVerifier Component)

MessageTimestampVerifier Config Settings

Base Config Settings

Trappable Errors (MessageTimestampVerifier Component)

MessageTimestampVerifier Errors