com.entrust.toolkit.archive

Class ArchiveResults

java.lang.Object

com.entrust.toolkit.archive.ArchiveResults

public class ArchiveResults
extends java.lang.Object

This class contains the results of decoding an Entrust Archive. It cannot be created directly, it is only available by calling ArchiveInputStream.getArchiveResults() after all the data in the stream has been processed and ArchiveInputStream.getArchiveResults() is called.

It is only possible to get the results if the data in the ArchiveInputStream was successfully decoded. This class contains

• The status of the CRC, used to check data integrity
• The status of the signature verification
• The revocation status of the originator's verification certificate
• The revocation status of the originator's encryption certificate

All of these conditions should be checked before the plaintext is trusted. The plaintext is still made available if any of these conditions fail, but its trustworthiness is not assured.

Since:

7.0

See Also:

ArchiveInputStream

Method Summary

Modifier and Type	Method and Description
PemOptions	getArchiveOptions() Returns the options used when the Archive was created.
CertificationException	getEncryptionCertificateException() Returns any exception thrown when validating the encryption certificate of the Archive creator.
X509Certificate	getOriginatorEncryptionCertificate() Returns the encryption certificate of the message originator.
X509Certificate	getOriginatorVerificationCertificate() Returns the verification certificate of the message signer.
java.security.SignatureException	getSignatureException() Returns any Exception that may have occurred during signature validation, or null if there was no exception.
CertificationException	getVerificationCertificateException() Returns any exception thrown when validating the verification certificate of the Archive signer.
boolean	isCrcOk() Check if the data CRC is okay.
boolean	isSignatureValid() Returns whether or not the signature on a signed Archive was valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isCrcOk

public boolean isCrcOk()

Check if the data CRC is okay. A return value of false means the data contained in the Archive was tampered with in some way, and cannot be relied on.

Returns:

true if the CRC value in the Archive header matches the computed CRC, false otherwise.

isSignatureValid

public boolean isSignatureValid()

Returns whether or not the signature on a signed Archive was valid. For Archives that have not been signed, this method will return false.

Returning false for signed Archives usually means the data contained in the Archive was tampered with and cannot be relied on.

Returns:

whether or not the signature on a signed Archive was valid.

getSignatureException

public java.security.SignatureException getSignatureException()

Returns any Exception that may have occurred during signature validation, or null if there was no exception. Returning a non-null value almost certainly means the data contained in the Archive was tampered with and cannot be relied on.

Returns:

any exception thrown during signature verification.

getOriginatorEncryptionCertificate

public X509Certificate getOriginatorEncryptionCertificate()

Returns the encryption certificate of the message originator. Returns null if the Archive was not encrypted.

Returns:

an X509Certificate object containing the encryption certificate of the message originator.

getEncryptionCertificateException

public CertificationException getEncryptionCertificateException()

Returns any exception thrown when validating the encryption certificate of the Archive creator. Returns null if the Archive was not encrypted, or the certificate is valid.

Some exceptions are more serious than others, and it is up to the application how they should be dealt with. For example, a LifespanException is less serious than a RevocationException.

Returns:

any exception thrown when validating the encryption certificate

See Also:

CertificationException

getOriginatorVerificationCertificate

public X509Certificate getOriginatorVerificationCertificate()

Returns the verification certificate of the message signer. Returns null if the Archive was not signed.

Returns:

an X509Certificate object containing the verification certificate of the message signer.

getVerificationCertificateException

public CertificationException getVerificationCertificateException()

Returns any exception thrown when validating the verification certificate of the Archive signer. Returns null if the Archive was not signed, or the certificate is valid.

Some exceptions are more serious than others, and it is up to the application how they should be dealt with. For example, a LifespanException is less serious than a RevocationException.

Returns:

any exception thrown when validating the verification certificate

See Also:

CertificationException

getArchiveOptions

public PemOptions getArchiveOptions()

Returns the options used when the Archive was created. These will indicate whether or not the message was signed, encrypted, compressed, Base64 encoded, and which encryption algorithm was used for encrypted messages.

Returns:

the options used to secure the Archive.