MessageTimestampVerifier Class

Properties   Methods   Events   Config Settings   Errors  

The MessageTimestampVerifier class verifies message timestamps.

Syntax

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 class with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

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

Certificates Property (MessageTimestampVerifier Class)

A collection of certificates included in the electronic signature.

Syntax

public CertificateList getCertificates();

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.

Please refer to the Certificate type for a complete list of fields.

DataBytes Property (MessageTimestampVerifier Class)

Use this property to pass the timestamped data to class in the byte array form.

Syntax

public byte[] getDataBytes();


public void setDataBytes(byte[] dataBytes);

Remarks

Assign a byte array containing the original timestamped data to this property.

This property is not available at design time.

DataFile Property (MessageTimestampVerifier Class)

The name of the file containing the originally timestamped data.

Syntax

public String getDataFile();


public void setDataFile(String dataFile);

Default Value

""

Remarks

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

DataFileName Property (MessageTimestampVerifier Class)

Returns the data filename as recorded in the timestamp.

Syntax

public String getDataFileName();

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

A stream containing the originally timestamped data.

Syntax

public java.io.InputStream getDataStream();


public void setDataStream(java.io.InputStream dataStream);

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

Returns the data URI as recorded in the timestamp.

Syntax

public String getDataURI();

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

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

InputBytes Property (MessageTimestampVerifier Class)

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

Syntax

public byte[] getInputBytes();


public void setInputBytes(byte[] inputBytes);

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

Path to the file containing the timestamped message.

Syntax

public String getInputFile();


public void setInputFile(String inputFile);

Default Value

""

Remarks

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

InputStream Property (MessageTimestampVerifier Class)

The stream containing the timestamped message.

Syntax

public java.io.InputStream getInputStream();


public void setInputStream(java.io.InputStream inputStream);

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

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

Syntax

public byte[] getOutputBytes();

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

Path to the file to save the extracted data to.

Syntax

public String getOutputFile();


public void setOutputFile(String outputFile);

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

The stream to save the extracted data to.

Syntax

public java.io.OutputStream getOutputStream();


public void setOutputStream(java.io.OutputStream outputStream);

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

The signature validation result.

Syntax

public int getSignatureValidationResult();



Enumerated values:
  public final static int svtValid = 0;
  public final static int svtUnknown = 1;
  public final static int svtCorrupted = 2;
  public final static int svtSignerNotFound = 3;
  public final static int svtFailure = 4;

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

The certificate that was used to create the signature.

Syntax

public Certificate getSigningCertificate();

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.

Please refer to the Certificate type for a complete list of fields.

TimestampFormat Property (MessageTimestampVerifier Class)

Returns the format of the processed timestamp.

Syntax

public int getTimestampFormat();



Enumerated values:
  public final static int mtfUnknown = 0;
  public final static int mtfRFC5544 = 1;
  public final static int mtfCMS = 2;
  public final static int mtfTSPReply = 3;

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

Contains the certified signing time.

Syntax

public String getValidatedSigningTime();

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

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. 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 Class)

Verifies a timestamped message.

Syntax

public void 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 Class)

Verifies a detached timestamped message.

Syntax

public void 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 Class)

Information about errors during PKCS#7 message encryption.

Syntax

public class DefaultMessagetimestampverifierEventListener implements MessagetimestampverifierEventListener {
  ...
  public void error(MessagetimestampverifierErrorEvent e) {}
  ...
}

public class MessagetimestampverifierErrorEvent {
  public int errorCode;
  public String description;
}

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

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

Syntax

public class DefaultMessagetimestampverifierEventListener implements MessagetimestampverifierEventListener {
  ...
  public void notification(MessagetimestampverifierNotificationEvent e) {}
  ...
}

public class MessagetimestampverifierNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, 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

public Certificate( bytes,  startIndex,  count,  password);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( certBytes,  certStartIndex,  certCount,  keyBytes,  keyStartIndex,  keyCount,  password);

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

public Certificate( bytes,  startIndex,  count);

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

public Certificate( path,  password);

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

public Certificate( certPath,  keyPath,  password);

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

public Certificate( path);

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

public Certificate( stream);

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

public Certificate( stream,  password);

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

public Certificate( certStream,  keyStream,  password);

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

public Certificate();

Creates a new object with default field values.

Config Settings (Messagetimestampverifier Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

MessageTimestampVerifier Config Settings

Base Config Settings

Trappable Errors (Messagetimestampverifier Class)

MessageTimestampVerifier Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)