org.bouncycastle.openpgp.api

Class OpenPGPDetachedSignatureProcessor

java.lang.Object

org.bouncycastle.openpgp.api.OpenPGPDetachedSignatureProcessor

public class OpenPGPDetachedSignatureProcessor
extends java.lang.Object

High-Level Processor for Messages Signed Using Detached OpenPGP Signatures.

To use this class, first instantiate the processor, optionally passing in a concrete OpenPGPImplementation and OpenPGPPolicy. Then, pass in any detached signatures you want to verify using addSignatures(InputStream). Next, provide the expected issuers OpenPGPCertificates for signature verification using addVerificationCertificate(OpenPGPCertificate). Signatures for which no certificate was provided, and certificates for which no signature was added, are ignored. Optionally, you can specify a validity date range for the signatures using verifyNotBefore(Date) and verifyNotAfter(Date). Signatures outside this range will be ignored as invalid. Lastly, provide an InputStream containing the original plaintext data, over which you want to verify the detached signatures using process(InputStream). As a result you will receive a list containing all processed OpenPGPDocumentSignatures. For these, you can check validity by calling OpenPGPSignature.OpenPGPDocumentSignature.isValid().

Constructor Summary

Constructors

Constructor and Description
OpenPGPDetachedSignatureProcessor() Instantiate a signature processor using the default OpenPGPImplementation and its OpenPGPPolicy.
OpenPGPDetachedSignatureProcessor(OpenPGPImplementation implementation) Instantiate a signature processor using a custom OpenPGPImplementation and its OpenPGPPolicy.
OpenPGPDetachedSignatureProcessor(OpenPGPImplementation implementation, OpenPGPPolicy policy) Instantiate a signature processor using a custom OpenPGPImplementation and custom OpenPGPPolicy.

Method Summary

Modifier and Type	Method and Description
OpenPGPDetachedSignatureProcessor	addSignature(PGPSignature signature) Add a single detached signature to the processor.
OpenPGPDetachedSignatureProcessor	addSignatures(java.io.InputStream inputStream) Read one or more detached signatures from the provided InputStream and add them to the processor.
OpenPGPDetachedSignatureProcessor	addSignatures(PGPSignatureList signatures) Add one or more detached signatures from the given PGPSignatureList to the processor.
OpenPGPDetachedSignatureProcessor	addVerificationCertificate(OpenPGPCertificate certificate) Add an issuers OpenPGPCertificate for signature verification.
java.util.List<OpenPGPSignature.OpenPGPDocumentSignature>	process(java.io.InputStream inputStream) Process the plaintext data from the given InputStream and return a list of processed detached signatures.
OpenPGPDetachedSignatureProcessor	setExceptionCallback(OpenPGPMessageProcessor.PGPExceptionCallback callback) Add a callback to which any OpenPGP-related exceptions are forwarded.
OpenPGPDetachedSignatureProcessor	verifyNotAfter(java.util.Date date) Reject detached signatures made after the given date.
OpenPGPDetachedSignatureProcessor	verifyNotBefore(java.util.Date date) Reject detached signatures made before date.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenPGPDetachedSignatureProcessor

public OpenPGPDetachedSignatureProcessor()

Instantiate a signature processor using the default OpenPGPImplementation and its OpenPGPPolicy.

OpenPGPDetachedSignatureProcessor

public OpenPGPDetachedSignatureProcessor(OpenPGPImplementation implementation)

Instantiate a signature processor using a custom OpenPGPImplementation and its OpenPGPPolicy.

Parameters:

implementation - custom OpenPGP implementation

OpenPGPDetachedSignatureProcessor

public OpenPGPDetachedSignatureProcessor(OpenPGPImplementation implementation,
                                         OpenPGPPolicy policy)

Instantiate a signature processor using a custom OpenPGPImplementation and custom OpenPGPPolicy.

Parameters:

implementation - custom OpenPGP implementation

policy - custom OpenPGP policy

Method Detail

addSignatures

public OpenPGPDetachedSignatureProcessor addSignatures(java.io.InputStream inputStream)
                                                throws java.io.IOException

Read one or more detached signatures from the provided InputStream and add them to the processor.

Parameters:

inputStream - input stream of armored or unarmored detached OpenPGP signatures

Returns:

this

Throws:

java.io.IOException - if something goes wrong reading from the stream

addSignatures

public OpenPGPDetachedSignatureProcessor addSignatures(PGPSignatureList signatures)

Add one or more detached signatures from the given PGPSignatureList to the processor.

Parameters:

signatures - detached signature list

Returns:

this

addSignature

public OpenPGPDetachedSignatureProcessor addSignature(PGPSignature signature)

Add a single detached signature to the processor.

Parameters:

signature - detached signature

Returns:

this

addVerificationCertificate

public OpenPGPDetachedSignatureProcessor addVerificationCertificate(OpenPGPCertificate certificate)

Add an issuers OpenPGPCertificate for signature verification.

Parameters:

certificate - OpenPGP certificate

Returns:

this

verifyNotBefore

public OpenPGPDetachedSignatureProcessor verifyNotBefore(java.util.Date date)

Reject detached signatures made before

date

. By default, this value is set to the beginning of time.

Parameters:

date - date

Returns:

this

verifyNotAfter

public OpenPGPDetachedSignatureProcessor verifyNotAfter(java.util.Date date)

Reject detached signatures made after the given

date

. By default, this value is set to the current time at instantiation time, in order to prevent verification of signatures from the future.

Parameters:

date - date

Returns:

this

process

public java.util.List<OpenPGPSignature.OpenPGPDocumentSignature> process(java.io.InputStream inputStream)
                                                                  throws java.io.IOException

Process the plaintext data from the given InputStream and return a list of processed detached signatures. Note: This list will NOT contain any malformed signatures, or signatures for which no verification key was found. Correctness of these signatures can be checked via OpenPGPSignature.OpenPGPDocumentSignature.isValid().

Parameters:

inputStream - data over which the detached signatures are calculated

Returns:

list of processed detached signatures

Throws:

java.io.IOException - if the data cannot be processed

setExceptionCallback

public OpenPGPDetachedSignatureProcessor setExceptionCallback(OpenPGPMessageProcessor.PGPExceptionCallback callback)

Add a callback to which any OpenPGP-related exceptions are forwarded. Useful for debugging purposes.

Parameters:

callback - callback

Returns:

this