es.accv.arangi.signature

Class PAdESLTVSignature

java.lang.Object

es.accv.arangi.base.ArangiObject

es.accv.arangi.base.signature.Signature

es.accv.arangi.base.signature.BasePDFSignature

es.accv.arangi.base.signature.PAdESLTVSignature

es.accv.arangi.signature.PAdESLTVSignature

All Implemented Interfaces:

es.accv.arangi.base.signature.ISignature

public class PAdESLTVSignature
extends es.accv.arangi.base.signature.PAdESLTVSignature

Clase para manejar firmas en PDF (PAdES-A) según los estándares ETSI TS 102 778-4 V1.2.1 y ETSI TS 119 144-2 V1.1.1, basado en la norma ISO 32000-1

Por motivos de compatibilidad la clase sigue llamándose PAdESLTVSignature aunque sería más correcto llamarla PAdESASignature, ya que siempre se trabajará con sellos de tiempo de documento, que son lo que diferencia a un PAdES-LTV de un PAdES-A según la norma ETSI TS 119 144-2.

La norma ETSI TS 119 144-2 exige añadir más información de validación que la que se establecía en la ETSI TS 102 778-4. Por ello, las firmas realizadas con versiones de Arangí anteriores a la 1.1.4 no serán consideradas válidas por dicha versión o versiones posteriores. Para evitar este incoveniente a aquellos desarrollos que se hayan realizado con versiones antiguas es posible activar un flag estático antes de la validación que permitirá que en las validaciones no se tenga en cuenta la información extra exigida por la nueva norma:

olderVersionsAllowed = true;

Este tipo de firmas cumplen con los requisitos para ser firmas longevas. En ellas se incluye toda la información necesaria para validar los certificados de las firmas. También se añade un sello de tiempos para el documento que da garantias sobre la fecha en la que se realizaron las firmas.

Las últimas versiones de Adobe Acrobat ya utilizan este tipo de firmas, aunque existen algunas diferencias entre las firmas PAdES-LTV obtenidas por Adobe y las normas de la ETSI. En la documentación de Arangí debe haber una explicación de cuales son estas diferencias.

Para evitar problemas de saturación de memoria con ficheros PDF muy grandes, esta clase siempre trabajará sobre un objeto java.io.File. Si el objeto no se inicializa con un fichero se creará un archivo temporal en la carpeta temporal de Arangi: getArangiTemporalFolder.

Existen dos métodos para obtener una firma PAdES-LTV, dependiendo de si se desea una firma visible o invisible. En el caso de las firmas visibles hay que proporcionar al método las coordenadas de las esquinas inferior izquierda y superior derecha, así como el número de página donde se desea ubicar la firma. También es posible asociar una imagen a la firma.

KeyStoreManager manager = new KeyStoreManager (...,...);
ByteArrayDocument documentPDF = new ByteArrayDocument (...);

//-- Firma invisible
PAdESLTVSignature signatureInv = PAdESLTVSignature.sign (new ACCVDeviceManager[] {manager},documentPDF, "Porque quiero firmarlo");

//-- Firma visible
PAdESLTVSignature signatureVis = PAdESLTVSignature.sign (new ACCVDeviceManager[] {manager},documentPDF, "Porque quiero firmarlo", true, Util.readStream(ClassLoader.getSystemResourceAsStream("signature/chip.gif")), 100, 100, 300, 200, 1);

En la página 1 de la segunda firma, en la ubicación indicada por las coordenadas, se verá la imagen chip.gif como una firma realizada sobre el PDF.

El primer parámetro de la firma es un array de managers, ya que es posible realizar varias firmas a la vez. Es importante destacar que una vez se han añadido los campos que hacen de un PDF firmado un PAdES-LTV ya no es posible volver a firmar el documento. Si un documento se va firmar por varias personas de forma no simultanea lo que se debe hacer es realizar las firmas en un PDF con firma simple y, tras la última firma completar a PAdES-LTV. Por supuesto, entre el principio y el fin del proceso ninguno de los certificados implicados podrá caducar o ser revocado.

//-- Primera firma
KeyStoreManager manager1 = new KeyStoreManager (...,...);
ByteArrayDocument documentPDF = new ByteArrayDocument (...);
PDFSignature signature = PDFSignature.sign (new ACCVDeviceManager[] {manager1},documentPDF, "Firma 1");

//-- Segunda firma (días más tarde)
KeyStoreManager manager2 = new KeyStoreManager (...,...);
documentPDF = new ByteArrayDocument (signature.toByteArray());
signature = PDFSignature.sign (new ACCVDeviceManager[] {manager2},documentPDF, "Firma 2");

//-- Completar la firma para que sea PAdES-LTV
PAdESLTVSignature padesLTV = PAdESLTVSignature.completeToPAdESLTV(signature);



La validez de una firma longeva se halla limitada a la vida del certificado del último sello de tiempos de documento que contiene el PDF, aunque erroneamente se suele pensar que una firma longeva puede validarse eternamente. Por ejemplo, el certificado de la TSA de la ACCV caducará el 18 de Noviembre de 2016, lo que implica que a partir de esa fecha las firmas PAdES-LTV realizadas con la TSA de la ACCV dejarán de ser válidas. Con el objeto de alargar la vida de una firma longeva será necesario realizar un resellado de la misma cuando se cambie el certificado de la TSA. Este sería el código para realizar un resellado:

ByteArrayDocument document = new ByteArrayDocument (...);
PAdESLTVSignature signature = new PAdESLTVSignature(document);
signature.addDocumentTimeStamp();
signature.save(...);


Author:

José M Gutiérrez

Nested Class Summary

Nested classes/interfaces inherited from class es.accv.arangi.base.signature.PAdESLTVSignature

es.accv.arangi.base.signature.PAdESLTVSignature.TimeStampDictionary

Field Summary

Fields inherited from class es.accv.arangi.base.signature.PAdESLTVSignature

olderVersionsAllowed

Fields inherited from class es.accv.arangi.base.ArangiObject

arangiTemporalFolder, CRYPTOGRAPHIC_PROVIDER, CRYPTOGRAPHIC_PROVIDER_NAME, DEFAULT_HASHING_ALGORITHM, DEFAULT_SIGNING_ALGORITHM, NUM_RETRIES

Constructor Summary

Constructors

Constructor and Description
PAdESLTVSignature(byte[] pdfContentBytes) Inicializa el objeto con el contenido de un fichero PDF firmado.
PAdESLTVSignature(java.io.File pdfFile) Inicializa el objeto con un fichero PDF firmado.
PAdESLTVSignature(es.accv.arangi.base.document.IDocument document) Inicializa el objeto con un documento que debe contener un fichero PDF firmado.
PAdESLTVSignature(java.io.InputStream streamPDF) Inicializa el objeto con un stream de lectura al contenido de un fichero PDF firmado.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocumentTimeStamp() Añade un sello de tiempos al documento PDF (document time-stamp).
static PAdESLTVSignature	completeToPAdESLTV(es.accv.arangi.base.signature.PDFSignature signature) Método que completa un fichero PDF firmado a PAdES-LTV.
es.accv.arangi.base.util.validation.ValidationResult[]	isValid() Determina si la firma es válida
static PAdESLTVSignature	sign(ACCVDeviceManager[] managers, es.accv.arangi.base.document.IDocument pdfDocument, java.lang.String reason) Obtiene un objeto PDFSignature tras firmar un documento PDF.
static PAdESLTVSignature	sign(ACCVDeviceManager[] managers, es.accv.arangi.base.document.IDocument pdfDocument, java.lang.String digitalSignatureAlgorithm, java.lang.String reason, boolean isVisible, byte[] image, float llX, float llY, float urX, float urY, int page) Obtiene un objeto PDFSignature tras firmar un documento PDF.

Methods inherited from class es.accv.arangi.base.signature.PAdESLTVSignature

addDocumentTimeStamp, addDocumentTimeStamp, addDocumentTimeStamp, addDocumentTimeStamp, completeToPAdESLTV, completeToPAdESLTV, completeToPAdESLTV, completeToPAdESLTV, getOrderedDocumentTimestamp, getSignatureType, getTimeStampCertificateExpiration, isOnlyOCSPResponsesInDSS, isValid, isValid, isValid, isValid, setOnlyOCSPResponsesInDSS, sign, sign, sign

Methods inherited from class es.accv.arangi.base.signature.BasePDFSignature

close, getCertificates, getPDFObject, getPDFObject, getPDFObject, getSignatureInstance, isValidSignatureOnly, isValidSignatureOnly, save, save, toByteArray

Methods inherited from class es.accv.arangi.base.signature.Signature

addRecognizerClass, getSignatureObject, getType, validateSignature, validateSignature, validateSignature, validateSignature, validateSignature, validateSignature, validateSignatureOnly, validateSignatureOnly

Methods inherited from class es.accv.arangi.base.ArangiObject

getArangiTemporalFolder, getCryptographicProvider, saveTemporalFile, saveToArangiTemporalFolder

Methods inherited from class java.lang.Object

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

Constructor Detail

PAdESLTVSignature

public PAdESLTVSignature(byte[] pdfContentBytes)
                  throws es.accv.arangi.base.exception.signature.PDFDocumentException,
                         es.accv.arangi.base.exception.signature.SignatureNotFoundException,
                         java.io.IOException

Inicializa el objeto con el contenido de un fichero PDF firmado.

Parameters:

pdfContentBytes - Array de bytes con el contenido del fichero PDF firmado

Throws:

es.accv.arangi.base.exception.signature.PDFDocumentException - El fichero no es un PDF correcto o bien no puede ser leído

es.accv.arangi.base.exception.signature.SignatureNotFoundException - El fichero es un PDF pero no está firmado

java.io.IOException - No se puede crear el fichero temporal

PAdESLTVSignature

public PAdESLTVSignature(java.io.File pdfFile)
                  throws es.accv.arangi.base.exception.signature.PDFDocumentException,
                         es.accv.arangi.base.exception.signature.SignatureNotFoundException

Inicializa el objeto con un fichero PDF firmado.

Parameters:

pdfFile - Fichero PDF firmado

Throws:

es.accv.arangi.base.exception.signature.PDFDocumentException - El fichero no es un PDF correcto o bien no puede ser leído

es.accv.arangi.base.exception.signature.SignatureNotFoundException - El fichero es un PDF pero no está firmado

PAdESLTVSignature

public PAdESLTVSignature(es.accv.arangi.base.document.IDocument document)
                  throws es.accv.arangi.base.exception.signature.PDFDocumentException,
                         es.accv.arangi.base.exception.signature.SignatureNotFoundException,
                         java.io.IOException

Inicializa el objeto con un documento que debe contener un fichero PDF firmado.

Parameters:

document - Documento con el contenido del fichero PDF firmado

Throws:

es.accv.arangi.base.exception.signature.PDFDocumentException - El fichero no es un PDF correcto o bien no puede ser leído

es.accv.arangi.base.exception.signature.SignatureNotFoundException - El fichero es un PDF pero no está firmado

java.io.IOException - No se puede crear el fichero temporal

PAdESLTVSignature

public PAdESLTVSignature(java.io.InputStream streamPDF)
                  throws es.accv.arangi.base.exception.signature.PDFDocumentException,
                         es.accv.arangi.base.exception.signature.SignatureNotFoundException,
                         java.io.IOException

Inicializa el objeto con un stream de lectura al contenido de un fichero PDF firmado.

Parameters:

streamPDF - Stream de lectura al contenido del fichero PDF firmado

Throws:

es.accv.arangi.base.exception.signature.PDFDocumentException - El fichero no es un PDF correcto o bien no puede ser leído

es.accv.arangi.base.exception.signature.SignatureNotFoundException - El fichero es un PDF pero no está firmado

java.io.IOException - No se puede crear el fichero temporal

Method Detail

sign

public static PAdESLTVSignature sign(ACCVDeviceManager[] managers,
                     es.accv.arangi.base.document.IDocument pdfDocument,
                     java.lang.String reason)
                              throws es.accv.arangi.base.exception.device.AliasNotFoundException,
                                     es.accv.arangi.base.exception.device.LoadingObjectException,
                                     es.accv.arangi.base.exception.signature.PDFDocumentException,
                                     es.accv.arangi.base.exception.signature.SignatureException,
                                     es.accv.arangi.base.exception.signature.RetrieveOCSPException,
                                     es.accv.arangi.base.exception.document.HashingException,
                                     es.accv.arangi.base.exception.certificate.CertificateCANotFoundException,
                                     es.accv.arangi.base.exception.signature.InvalidCertificateException,
                                     es.accv.arangi.base.exception.certificate.NormalizeCertificateException

Obtiene un objeto PDFSignature tras firmar un documento PDF. La firma es invisible.

Parameters:

managers - Dispositivos criptográfico que realizarán la firma

pdfDocument - Documento PDF a firmar

reason - Texto que aparecerá junto a la firma como razón. Si se pasa un valor nulo se escribirá un texto por defecto.

Returns:

Documento PDF firmado, con sello de tiempos y respuesta OCSP

Throws:

es.accv.arangi.base.exception.device.AliasNotFoundException - El alias donde se encuentra la clave privada usada para realizar la firma no existe

es.accv.arangi.base.exception.device.LoadingObjectException - No ha sido posible cargar la clave privada usada para realizar la firma

es.accv.arangi.base.exception.signature.PDFDocumentException - El documento no es un fichero PDF o es un PDF mal formado

es.accv.arangi.base.exception.signature.SignatureException - No se puede realizar la firma

es.accv.arangi.base.exception.signature.RetrieveOCSPException - No es posible obtener una respuesta OCSP para asociarla a la firma

es.accv.arangi.base.exception.document.HashingException - Excepción obteniendo el hash que será sellado por la TSA

es.accv.arangi.base.exception.certificate.CertificateCANotFoundException - La lista de certificado de CA no contiene el emisor del certificado de firma o existe pero tiene un formato no normalizable por el proveedor criptográfico de Arangi

es.accv.arangi.base.exception.signature.InvalidCertificateException - El certificado con el que se firma está revocado

es.accv.arangi.base.exception.certificate.NormalizeCertificateException - Alguno de los certificados de firma o de sus cadenas de certificación no puede ser normalizado

sign

public static PAdESLTVSignature sign(ACCVDeviceManager[] managers,
                     es.accv.arangi.base.document.IDocument pdfDocument,
                     java.lang.String digitalSignatureAlgorithm,
                     java.lang.String reason,
                     boolean isVisible,
                     byte[] image,
                     float llX,
                     float llY,
                     float urX,
                     float urY,
                     int page)
                              throws es.accv.arangi.base.exception.device.AliasNotFoundException,
                                     es.accv.arangi.base.exception.device.LoadingObjectException,
                                     es.accv.arangi.base.exception.signature.PDFDocumentException,
                                     es.accv.arangi.base.exception.signature.SignatureException,
                                     es.accv.arangi.base.exception.signature.RetrieveOCSPException,
                                     es.accv.arangi.base.exception.document.HashingException,
                                     es.accv.arangi.base.exception.certificate.CertificateCANotFoundException,
                                     es.accv.arangi.base.exception.signature.InvalidCertificateException,
                                     es.accv.arangi.base.exception.certificate.NormalizeCertificateException,
                                     es.accv.arangi.base.exception.signature.AlgorithmNotSuitableException

Obtiene un objeto PDFSignature tras firmar un documento PDF.

Si la firma es visible se le puede asociar una imagen. El punto 0,0 de la página se encuentra en la esquina inferior izquierda de la misma. Un página tiene aproximadamente unas dimensiones de 580x850.

Parameters:

managers - Dispositivos criptográfico que realizarán la firma

pdfDocument - Documento PDF a firmar

digitalSignatureAlgorithm - Algoritmo de firma (si nulo algoritmo por defecto)

reason - Texto que aparecerá junto a la firma como razón. Si se pasa un valor nulo se escribirá un texto por defecto.

isVisible - Si tiene un valor cierto se creará una firma visible.

image - Imagen de la firma. Puede tener un valor nulo.

llX - Posición X de la esquina inferior izquierda de la firma en la página (caso de ser visible)

llY - Posición Y de la esquina inferior izquierda de la firma en la página (caso de ser visible)

urX - Posición X de la esquina superior derecha de la firma en la página (caso de ser visible)

urY - Posición Y de la esquina superior derecha de la firma en la página (caso de ser visible)

page - Página en la que se situará la firma si ésta es visible (1 es la primera página)

Returns:

Documento PDF firmado, con sello de tiempos y respuesta OCSP

Throws:

es.accv.arangi.base.exception.device.AliasNotFoundException - El alias donde se encuentra la clave privada usada para realizar la firma no existe

es.accv.arangi.base.exception.device.LoadingObjectException - No ha sido posible cargar la clave privada usada para realizar la firma

es.accv.arangi.base.exception.signature.PDFDocumentException - El documento no es un fichero PDF o es un PDF mal formado

es.accv.arangi.base.exception.signature.SignatureException - No se puede realizar la firma

es.accv.arangi.base.exception.signature.RetrieveOCSPException - No es posible obtener una respuesta OCSP para asociarla a la firma

es.accv.arangi.base.exception.document.HashingException - Excepción obteniendo el hash que será sellado por la TSA

es.accv.arangi.base.exception.certificate.CertificateCANotFoundException - La lista de certificado de CA no contiene el emisor del certificado de firma o existe pero tiene un formato no normalizable por el proveedor criptográfico de Arangi

es.accv.arangi.base.exception.signature.InvalidCertificateException - El certificado con el que se firma está revocado

es.accv.arangi.base.exception.certificate.NormalizeCertificateException - Alguno de los certificados de firma o de sus cadenas de certificación no puede ser normalizado

es.accv.arangi.base.exception.signature.AlgorithmNotSuitableException - El algoritmo de firma pasado no sirve para realizar la firma

completeToPAdESLTV

public static PAdESLTVSignature completeToPAdESLTV(es.accv.arangi.base.signature.PDFSignature signature)
                                            throws es.accv.arangi.base.exception.signature.SignatureException,
                                                   es.accv.arangi.base.exception.signature.RetrieveOCSPException,
                                                   es.accv.arangi.base.exception.signature.InvalidCertificateException,
                                                   es.accv.arangi.base.exception.certificate.NormalizeCertificateException,
                                                   es.accv.arangi.base.exception.signature.PDFDocumentException,
                                                   es.accv.arangi.base.exception.certificate.CertificateCANotFoundException,
                                                   es.accv.arangi.base.exception.document.HashingException

Método que completa un fichero PDF firmado a PAdES-LTV. La firma del PDF firmado ha de ser correcta y los certificados han de ser válidos en este momento.

Parameters:

signature - PDF firmado

Returns:

PAdES-LTV

Throws:

es.accv.arangi.base.exception.signature.PDFDocumentException - El documento no es un fichero PDF o es un PDF mal formado

es.accv.arangi.base.exception.signature.SignatureException - Error completando la firma

es.accv.arangi.base.exception.signature.RetrieveOCSPException - No es posible obtener una respuesta OCSP para asociarla a la firma

es.accv.arangi.base.exception.document.HashingException - Excepción obteniendo el hash que será sellado por la TSA

es.accv.arangi.base.exception.certificate.CertificateCANotFoundException - La lista de certificado de CA no contiene el emisor del certificado de firma o existe pero tiene un formato no normalizable por el proveedor criptográfico de Arangi

es.accv.arangi.base.exception.signature.InvalidCertificateException - El certificado con el que se firma está revocado

es.accv.arangi.base.exception.certificate.NormalizeCertificateException - Alguno de los certificados de firma o de sus cadenas de certificación no puede ser normalizado

addDocumentTimeStamp

public void addDocumentTimeStamp()
                          throws es.accv.arangi.base.exception.signature.SignatureException,
                                 es.accv.arangi.base.exception.signature.RetrieveOCSPException,
                                 es.accv.arangi.base.exception.timestamp.ResponseTimeStampException,
                                 es.accv.arangi.base.exception.certificate.CertificateCANotFoundException

Añade un sello de tiempos al documento PDF (document time-stamp).

Throws:

es.accv.arangi.base.exception.signature.SignatureException - Error leyendo o guardando objetos de la firma

es.accv.arangi.base.exception.signature.RetrieveOCSPException - No es posible obtener una respuesta OCSP para el certificado del último sello de tiempos del documento

es.accv.arangi.base.exception.timestamp.ResponseTimeStampException - No es posible obtener una respuesta del servidor de sello de tiempos

es.accv.arangi.base.exception.certificate.CertificateCANotFoundException - El certificado del último sello de tiempos del documento no pertenece a ninguna de las Autoridades de Certificación de confianza

isValid

public es.accv.arangi.base.util.validation.ValidationResult[] isValid()
                                                               throws es.accv.arangi.base.exception.document.HashingException,
                                                                      es.accv.arangi.base.exception.signature.SignatureException,
                                                                      es.accv.arangi.base.exception.certificate.NormalizeCertificateException

Determina si la firma es válida

Returns:

Cierto si la firma es válida

Throws:

es.accv.arangi.base.exception.signature.SignatureException - Error tratando el objeto firma

es.accv.arangi.base.exception.document.HashingException - Error obteniendo el hash del documento

es.accv.arangi.base.exception.certificate.NormalizeCertificateException - Alguno de los certificados no puede ser normalizado al formato reconocido por el proveedor criptográfico de Arangi o su firma no es correcta o no puede ser analizada