com.lacunasoftware.restpki

Class PadesSignatureStarter

java.lang.Object

com.lacunasoftware.restpki.SignatureStarter

com.lacunasoftware.restpki.PadesSignatureStarter

public class PadesSignatureStarter
extends SignatureStarter

Class used to perform the first of the two steps required to perform a PAdES signature.

Note on confidentiality: the PDF to be signed is stored on the server between the first and second steps, but never unencrypted. The content is encrypted using AES-128 and the key is not stored on the server, it is instead mixed into the token that is returned and which is necessary on the second step. In other words, the server stores the PDF but is unable to read it on its own, therefore the PDF contents cannot be compromised, even in the event of a complete data leakage.

Field Summary

Fields inherited from class com.lacunasoftware.restpki.SignatureStarter

callbackArgument, certificate, certificateInfo, client, done, securityContextId, signaturePolicyId

Constructor Summary

Constructors

Constructor and Description
PadesSignatureStarter(RestPkiClient client) Create a new instance using the given RestPkiClient.

Method Summary

Modifier and Type	Method and Description
void	addPdfMark(PdfMark pdfMark) Adds a new PDF mark to the list
void	setBypassMarksIfSigned(boolean bypassMarksIfSigned) Denotes whether to bypass the PDF marks if the PDF is already signed (default true).
void	setMeasurementUnits(PadesMeasurementUnits measurementUnits) Optional, sets the unit of measurement used to edit the pdf marks and visual representations
void	setPageOptimization(PadesPageOptimization pageOptimization) Optional, sets the page size used to calculate the conversion between centimeter measurements and PDF points.
void	setPdfMarks(java.util.List<PdfMark> pdfMarks) Optional, sets the setting to mark the pdf with the signature
void	setPdfToSign(byte[] content) Sets the PDF to be signed
void	setPdfToSign(java.io.InputStream stream) Sets the PDF to be signed
void	setPdfToSign(java.nio.file.Path path) Sets the file path of the PDF to be signed
void	setPdfToSign(java.lang.String path) Sets the file path of the PDF to be signed
void	setVisualRepresentation(PadesVisualRepresentation visualRepresentation) Optional, sets the settings for the signature's visual representation.
ClientSideSignatureInstructions	start() Performs the first step, should be called after setting the necessary parameters.
java.lang.String	startWithWebPki() Performs the first step, should be called after setting the necessary parameters.

Methods inherited from class com.lacunasoftware.restpki.SignatureStarter

getCertificateInfo, setCallbackArgument, setSecurityContext, setSignaturePolicy, setSignerCertificate

Methods inherited from class java.lang.Object

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

Constructor Detail

PadesSignatureStarter

public PadesSignatureStarter(RestPkiClient client)

Create a new instance using the given RestPkiClient.

Parameters:

client - the RestPkiClient which shall be used.

Method Detail

setPdfToSign

public void setPdfToSign(java.io.InputStream stream)
                  throws java.io.IOException

Sets the PDF to be signed

Parameters:

stream - a pre-opened InputStream linked to the PDF that will be signed. The stream is NOT closed by this method.

Throws:

java.io.IOException - if an error occurs while reading the stream.

setPdfToSign

public void setPdfToSign(byte[] content)

Sets the PDF to be signed

Parameters:

content - Binary content of the PDF

setPdfToSign

public void setPdfToSign(java.lang.String path)
                  throws java.io.IOException

Sets the file path of the PDF to be signed

Parameters:

path - File path of the PDF to be signed.

Throws:

java.io.IOException - if an error occurs while reading the file.

setPdfToSign

public void setPdfToSign(java.nio.file.Path path)
                  throws java.io.IOException

Sets the file path of the PDF to be signed

Parameters:

path - File path of the PDF to be signed.

Throws:

java.io.IOException - if an error occurs while reading the file.

setBypassMarksIfSigned

public void setBypassMarksIfSigned(boolean bypassMarksIfSigned)

Denotes whether to bypass the PDF marks if the PDF is already signed (default true). PDF marks can only be added if the PDF has no previous signatures. This property controls the behavior when PDF marks are requested but the PDF already contains signatures. If true (default), the marks are simply bypassed. If false, an error is returned.

Parameters:

bypassMarksIfSigned - Chosen behavior

setPageOptimization

public void setPageOptimization(PadesPageOptimization pageOptimization)

Optional, sets the page size used to calculate the conversion between centimeter measurements and PDF points. If omitted, the page size is automatically detected between A4, Legal or Letter.

Parameters:

pageOptimization - Page size and orientation

setMeasurementUnits

public void setMeasurementUnits(PadesMeasurementUnits measurementUnits)

Optional, sets the unit of measurement used to edit the pdf marks and visual representations

Parameters:

measurementUnits - Unit of Measurement

setVisualRepresentation

public void setVisualRepresentation(PadesVisualRepresentation visualRepresentation)

Optional, sets the settings for the signature's visual representation.

Parameters:

visualRepresentation - The visual representation's settings.

setPdfMarks

public void setPdfMarks(java.util.List<PdfMark> pdfMarks)

Optional, sets the setting to mark the pdf with the signature

Parameters:

pdfMarks - List with PDF marks

addPdfMark

public void addPdfMark(PdfMark pdfMark)

Adds a new PDF mark to the list

Parameters:

pdfMark - PDF mark

start

public ClientSideSignatureInstructions start()
                                      throws RestException

Performs the first step, should be called after setting the necessary parameters. If you intend to use the Web PKI component on the client-side, use the startWithRestPki() method instead.

Specified by:

start in class SignatureStarter

Returns:

An instance of ClientSideSignatureInstructions with the information necessary to perform the client-side signature and later call the server back with the results.

Throws:

RestException - if an error occurs when calling REST PKI

startWithWebPki

public java.lang.String startWithWebPki()
                                 throws RestException

Performs the first step, should be called after setting the necessary parameters. This method should be used if the Web PKI component is being used on the client-side.

Specified by:

startWithWebPki in class SignatureStarter

Returns:

The token that should be passed on the signWithRestPki method of the Web PKI component (on the client-side logic).

Throws:

RestException - if an error occurs when calling REST PKI