org.apache.pdfbox.examples.signature

Class CreateSignatureBase

java.lang.Object

org.apache.pdfbox.examples.signature.CreateSignatureBase

All Implemented Interfaces:

SignatureInterface

Direct Known Subclasses:

CreateSignature, CreateVisibleSignature, CreateVisibleSignature2

public abstract class CreateSignatureBase
extends Object
implements SignatureInterface

Constructor Summary

Constructors

Constructor and Description
CreateSignatureBase(KeyStore keystore, char[] pin) Initialize the signature creator with a keystore (pkcs12) and pin that should be used for the signature.

Method Summary

Modifier and Type	Method and Description
boolean	isExternalSigning()
void	setCertificateChain(Certificate[] certificateChain)
void	setExternalSigning(boolean externalSigning) Set if external signing scenario should be used.
void	setPrivateKey(PrivateKey privateKey)
void	setTsaUrl(String tsaUrl)
byte[]	sign(InputStream content) SignatureInterface implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSignatureBase

public CreateSignatureBase(KeyStore keystore,
                           char[] pin)
                    throws KeyStoreException,
                           UnrecoverableKeyException,
                           NoSuchAlgorithmException,
                           IOException,
                           CertificateException

Initialize the signature creator with a keystore (pkcs12) and pin that should be used for the signature.

Parameters:

keystore - is a pkcs12 keystore.

pin - is the pin for the keystore / private key

Throws:

KeyStoreException - if the keystore has not been initialized (loaded)

NoSuchAlgorithmException - if the algorithm for recovering the key cannot be found

UnrecoverableKeyException - if the given password is wrong

CertificateException - if the certificate is not valid as signing time

IOException - if no certificate could be found

Method Detail

setPrivateKey

public final void setPrivateKey(PrivateKey privateKey)

setCertificateChain

public final void setCertificateChain(Certificate[] certificateChain)

setTsaUrl

public void setTsaUrl(String tsaUrl)

sign

public byte[] sign(InputStream content)
            throws IOException

SignatureInterface implementation. This method will be called from inside of the pdfbox and create the PKCS #7 signature. The given InputStream contains the bytes that are given by the byte range. This method is for internal use only. Use your favorite cryptographic library to implement PKCS #7 signature creation.

Specified by:

sign in interface SignatureInterface

Parameters:

content - is the content as a (Filter)InputStream

Returns:

signature as a byte array

Throws:

IOException

setExternalSigning

public void setExternalSigning(boolean externalSigning)

Set if external signing scenario should be used. If false, SignatureInterface would be used for signing.

Default: false

Parameters:

externalSigning - true if external signing should be performed

isExternalSigning

public boolean isExternalSigning()