Apache PDFBox 3.0.4 · org.apache.pdfbox.examples.signature.CreateSignatureBase

Modifier and Type	Field and Description
private Certificate[]	certificateChain
private boolean	externalSigning
private PrivateKey	privateKey
private String	tsaUrl

Access	Constructor and Description
public	CreateSignatureBase(KeyStore is a pkcs12 keystore. keystore, char[] is the pin for the keystore / private key 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
public Certificate[]	getCertificateChain()
public boolean	isExternalSigning()
public final void	setCertificateChain(final Certificate[] certificateChain)
public void	setExternalSigning(boolean `true` if external signing should be performed externalSigning) Set if external signing scenario should be used.
public final void	setPrivateKey(PrivateKey privateKey)
public void	setTsaUrl(String tsaUrl)
public byte[]	sign(InputStream is the content as a (Filter)InputStream content) Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface.sign. SignatureInterface sample implementation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

certificateChain	back to summary
private Certificate[] certificateChain

externalSigning	back to summary
private boolean externalSigning

privateKey	back to summary
private PrivateKey privateKey

tsaUrl	back to summary
private String tsaUrl

Constructor Detail

CreateSignatureBase	back to summary
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:KeyStore is a pkcs12 keystore. pin:char[] is the pin for the keystore / private key Exceptions KeyStoreException: if the keystore has not been initialized (loaded) UnrecoverableKeyException: if the given password is wrong NoSuchAlgorithmException: if the algorithm for recovering the key cannot be found IOException: if no certificate could be found CertificateException: if the certificate is not valid as signing time

CreateSignatureBase

back to summary

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:KeyStore: is a pkcs12 keystore.
pin:char[]: is the pin for the keystore / private key

Exceptions

KeyStoreException:: if the keystore has not been initialized (loaded)
UnrecoverableKeyException:: if the given password is wrong
NoSuchAlgorithmException:: if the algorithm for recovering the key cannot be found
IOException:: if no certificate could be found
CertificateException:: if the certificate is not valid as signing time

Method Detail

getCertificateChain	back to summary
public Certificate[] getCertificateChain()

isExternalSigning	back to summary
public boolean isExternalSigning()

setCertificateChain	back to summary
public final void setCertificateChain(final Certificate[] certificateChain)

setExternalSigning back to summary

setExternalSigning	back to summary
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:boolean `true` if external signing should be performed

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:boolean: true if external signing should be performed

setPrivateKey	back to summary
public final void setPrivateKey(PrivateKey privateKey)

setTsaUrl	back to summary
public void setTsaUrl(String tsaUrl)

sign	back to summary
public byte[] sign(InputStream content) throws IOException Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface.sign. SignatureInterface sample 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. If you want to create the hash and the signature separately (e.g. to transfer only the hash to an external application), read this answer or this answer. Parameters content:InputStream Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface.sign. is the content as a (Filter)InputStream Returns:byte[] Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface.sign. signature as a byte array Annotations @Override Exceptions IOException: Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface.sign. if the signature could not be created

sign

back to summary

public byte[] sign(InputStream content) throws IOException

Implements org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface.sign.

SignatureInterface sample 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. If you want to create the hash and the signature separately (e.g. to transfer only the hash to an external application), read this answer or this answer.

Parameters

content:InputStream

Doc from org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureInterface.sign.

is the content as a (Filter)InputStream

Returns:byte[]