org.imixs.signature.pdf

Class SigningService

java.lang.Object

org.imixs.signature.pdf.SigningService

public class SigningService
extends Object

The SignatureService provides methods to sign a PDF document on a X509 certificate. The service adds a digital signature and also a visual signature. The method 'signPDF' expects a Imixs FileData object containing the content of the PDF file to be signed.

The service expects the existence of a valid X509 certificate stored in the keystore.

The service supports the following environment variables:

• SIGNATURE_KEYSTORE_PATH - path from which the keystore is loaded
• SIGNATURE_KEYSTORE_PASSWORD - the password used to check the integrity of the keystore, the password used to unlock the keystore
• SIGNATURE_ROOTCERT_ALIAS - the root cert alias
• SIGNATURE_ROOTCERT_PASSWORD - the root cert password (optional)

See also here: https://jvmfy.com/2018/11/17/how-to-digitally-sign-pdf-files/ https://github.com/apache/pdfbox/blob/trunk/examples/src/main/java/org/apache/pdfbox/examples/signature/CreateVisibleSignature2.java https://ordina-jworks.github.io/security/2019/08/14/Using-Lets-Encrypt-Certificates-In-Java.html

Version:

1.0

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_SIGNATURE_ROOTCERT_ALIAS
static String	ENV_SIGNATURE_ROOTCERT_PASSWORD
static String	ENV_SIGNATURE_TSA_URL

Constructor Summary

Constructors

Constructor and Description
SigningService()

Method Summary

Modifier and Type	Method and Description
byte[]	signPDF(byte[] inputFileData, String certAlias, String certPassword, boolean externalSigning) Method Opens the keystore with the given password and creates a new signed PDF file based on the given PDF File and a signature image.
byte[]	signPDF(byte[] inputFileData, String certAlias, String certPassword, boolean externalSigning, Rectangle2D humanRect, int page, String signatureFieldName, byte[] imageFile, String reason) Sign pdf file and create new file that ends with "_signed.pdf".

Methods inherited from class java.lang.Object

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

Field Detail

ENV_SIGNATURE_TSA_URL

public static final String ENV_SIGNATURE_TSA_URL

See Also:

Constant Field Values

ENV_SIGNATURE_ROOTCERT_ALIAS

public static final String ENV_SIGNATURE_ROOTCERT_ALIAS

See Also:

Constant Field Values

ENV_SIGNATURE_ROOTCERT_PASSWORD

public static final String ENV_SIGNATURE_ROOTCERT_PASSWORD

See Also:

Constant Field Values

Constructor Detail

SigningService

public SigningService()

Method Detail

signPDF

public byte[] signPDF(byte[] inputFileData,
                      String certAlias,
                      String certPassword,
                      boolean externalSigning)
               throws CertificateVerificationException,
                      SigningException

Method Opens the keystore with the given password and creates a new signed PDF file based on the given PDF File and a signature image.

generate pkcs12-keystore-file with

keytool -storepass 123456 -storetype PKCS12 -keystore file.p12 -genkey -alias client -keyalg RSA

Parameters:

inputFileData - A byte array containing the source PDF document.

certAlias - Certificate alias name to be used for signing

certPassword - optional private key password

externalSigning - optional boolean flag to trigger an external signing process

Returns:

A byte array containing the singed PDF document

Throws:

SigningException

CertificateVerificationException

signPDF

public byte[] signPDF(byte[] inputFileData,
                      String certAlias,
                      String certPassword,
                      boolean externalSigning,
                      Rectangle2D humanRect,
                      int page,
                      String signatureFieldName,
                      byte[] imageFile,
                      String reason)
               throws CertificateVerificationException,
                      SigningException

Sign pdf file and create new file that ends with "_signed.pdf".

Parameters:

inputFileData - A byte array containing the source PDF document.

certAlias - Certificate alias name to be used for signing

certPassword - optional private key password

externalSigning - optional boolean flag to trigger an external signing process

humanRect - rectangle from a human viewpoint (coordinates start at top left)

page - page number (beginning with 1) to place the visual signature

tsaUrl - optional TSA url

signatureFieldName - optional name of an existing (unsigned) signature field

imageFile - optional image file

reason - workflow status

Returns:

A byte array containing the singed PDF document

Throws:

CertificateVerificationException

SigningException