es.accv.arangi.base.signature

Class XAdESSignature

java.lang.Object

es.accv.arangi.base.ArangiObject

es.accv.arangi.base.signature.Signature

es.accv.arangi.base.signature.XAdESSignature

All Implemented Interfaces:

ISignature

Direct Known Subclasses:

XAdESBESSignature, XAdESTSignature, XAdESXLSignature

public abstract class XAdESSignature
extends Signature

Clase base de los tipos de firma XAdES.

Author:

José M Gutiérrez

Field Summary

Fields

Modifier and Type	Field and Description
static es.mityc.firmaJava.libreria.xades.XAdESSchemas	DEFAULT_XADES_SCHEMA Esquema de XAdES para realizar las firmas
static java.lang.String	DEFAULT_XADES_SCHEMA_URI URI del esquema de XAdES para realizar las firmas
static java.lang.String	DEFAULT_XML_ENCODING Encoding de los XML construidos

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
XAdESSignature()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAttachedDocument() Devuelve el documento contenido en la firma attached.
Certificate[]	getCertificates() Devuelve los certificados con los que se han realizado las firmas
java.lang.String	getDocumentDescription() Obtiene la descripción del documento, siempre que al firmar se añadiese este tag dentro del DataObjectFormat.
java.lang.String	getDocumentEncoding() Obtiene la codificación del documento, siempre que al firmar se añadiese este tag dentro del DataObjectFormat.
java.lang.String	getDocumentMIMEType() Obtiene el tipo MIME del documento, siempre que al firmar se añadiese este tag dentro del DataObjectFormat.
org.w3c.dom.Document	getDOM() Obtiene la firma XAdES como un documento DOM.
java.lang.String	getEncoding() Obtiene la codificación del XML que contiene el XAdES
static ISignature	getSignatureInstance(byte[] bSignature) Método para poder validar con el método Signature.validateSignature.
java.lang.String	getSignaturePolicyIdentifier() Obtiene como una cadena de texto el campo SignaturePolicyIdentifier.
ArangiXAdESProductionPlace	getSignatureProductionPlace() Obtiene como una cadena de texto el campo SignaturePolicyIdentifier.
java.util.Date[]	getSigningTimes() Obtiene las fechas de las firmas de acuerdo al tag firmado 'SigningTime'.
static XAdESSignature	getXAdESObject(byte[] signature) Método que obtiene un objeto de una de las 3 clases de firmas XAdES en base a la firma que se pasa como parámetro.
static XAdESSignature	getXAdESObject(org.w3c.dom.Document signature) Método que obtiene un objeto de una de las 3 clases de firmas XAdES en base a la firma que se pasa como parámetro.
static XAdESSignature	getXAdESObject(java.io.File signature) Método que obtiene un objeto de una de las 3 clases de firmas XAdES en base a la firma que se pasa como parámetro.
static XAdESSignature	getXAdESObject(java.io.InputStream isSignature) Método que obtiene un objeto de una de las 3 clases de firmas XAdES en base a la firma que se pasa como parámetro.
ValidationResult[]	isValid(CAList caList) Comprueba que las firmas son correctas en firmas attached y sus certificados son válidos.
ValidationResult[]	isValid(IDocument document, CAList caList) Comprueba que las firmas son correctas y sus certificados son válidos.
ValidationResult[]	isValid(IDocument document, java.util.List<CertificateValidationService> validationServices) Comprueba que las firmas son correctas y sus certificados son válidos.
ValidationResult[]	isValid(java.util.List<CertificateValidationService> validationServices) Comprueba que las firmas son correctas en firmas attached y sus certificados son válidos.
ValidationResult[]	isValidSignatureOnly() Comprueba que las firmas son correctas en firmas attached, sin validar los certificados de las mismas.
ValidationResult[]	isValidSignatureOnly(IDocument document) Comprueba que las firmas son correctas, sin validar los certificados de las mismas.
void	save(java.io.File file) Guarda la firma XAdES en un fichero
void	save(java.io.OutputStream out) Guarda la firma en un stream de escritura.
byte[]	toByteArray() Devuelve la firma XAdES como un array de bytes

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

Methods inherited from interface es.accv.arangi.base.signature.ISignature

getSignatureType

Field Detail

DEFAULT_XADES_SCHEMA

public static final es.mityc.firmaJava.libreria.xades.XAdESSchemas DEFAULT_XADES_SCHEMA

Esquema de XAdES para realizar las firmas

DEFAULT_XADES_SCHEMA_URI

public static final java.lang.String DEFAULT_XADES_SCHEMA_URI

URI del esquema de XAdES para realizar las firmas

DEFAULT_XML_ENCODING

public static final java.lang.String DEFAULT_XML_ENCODING

Encoding de los XML construidos

See Also:

Constant Field Values

Constructor Detail

XAdESSignature

public XAdESSignature()

Method Detail

getSigningTimes

public java.util.Date[] getSigningTimes()

Obtiene las fechas de las firmas de acuerdo al tag firmado 'SigningTime'. No se incluye la fecha de las contrafirmas. Esta fecha se obtiene del ordenador en el que se realizó la firma, por lo que no es de confianza.

Returns:

Fechas de las firmas

getDocumentDescription

public java.lang.String getDocumentDescription()

Obtiene la descripción del documento, siempre que al firmar se añadiese este tag dentro del DataObjectFormat. Si no se añadió devolverá null.

Returns:

Descripción del documento firmado o null

getDocumentMIMEType

public java.lang.String getDocumentMIMEType()

Obtiene el tipo MIME del documento, siempre que al firmar se añadiese este tag dentro del DataObjectFormat. Si no se añadió devolverá null.

Returns:

Tipo MIME del documento firmado o null

getDocumentEncoding

public java.lang.String getDocumentEncoding()

Obtiene la codificación del documento, siempre que al firmar se añadiese este tag dentro del DataObjectFormat. Si no se añadió devolverá null.

Returns:

Tipo MIME del documento firmado o null

getDOM

public org.w3c.dom.Document getDOM()

Obtiene la firma XAdES como un documento DOM.

Returns:

XML DOM

getXAdESObject

public static XAdESSignature getXAdESObject(java.io.File signature)
                                     throws SignatureException,
                                            XMLDocumentException,
                                            java.io.FileNotFoundException

Método que obtiene un objeto de una de las 3 clases de firmas XAdES en base a la firma que se pasa como parámetro. Para obtener de qué tipo de XAdES se trata se recurrirá a las clases del MITyC.

Parameters:

signature - Firma XAdES

Returns:

Objeto de firma XAdES adecuado a la firma pasada como parámetro

Throws:

java.io.FileNotFoundException - El fichero no existe

XMLDocumentException - El fichero no es un XML

SignatureException - El XML no es un XAdES

getXAdESObject

public static XAdESSignature getXAdESObject(java.io.InputStream isSignature)
                                     throws SignatureException,
                                            XMLDocumentException

Método que obtiene un objeto de una de las 3 clases de firmas XAdES en base a la firma que se pasa como parámetro. Para obtener de qué tipo de XAdES se trata se recurrirá a las clases del MITyC.

Parameters:

isSignature - Firma XAdES

Returns:

Objeto de firma XAdES adecuado a la firma pasada como parámetro

Throws:

XMLDocumentException - El fichero no es un XML

SignatureException - El XML no es un XAdES

getXAdESObject

public static XAdESSignature getXAdESObject(byte[] signature)
                                     throws SignatureException,
                                            XMLDocumentException

Método que obtiene un objeto de una de las 3 clases de firmas XAdES en base a la firma que se pasa como parámetro. Para obtener de qué tipo de XAdES se trata se recurrirá a las clases del MITyC.

Parameters:

signature - Firma XAdES

Returns:

Objeto de firma XAdES adecuado a la firma pasada como parámetro

Throws:

XMLDocumentException

SignatureException

getXAdESObject

public static XAdESSignature getXAdESObject(org.w3c.dom.Document signature)
                                     throws SignatureException

Método que obtiene un objeto de una de las 3 clases de firmas XAdES en base a la firma que se pasa como parámetro. Para obtener de qué tipo de XAdES se trata se recurrirá a las clases del MITyC.

Parameters:

signature - Firma XAdES

Returns:

Objeto de firma XAdES adecuado a la firma pasada como parámetro

Throws:

SignatureException - El XML no es un XAdES

SignatureException - No se puede obtener el tipo de XAdES, posiblemente porque no se trata de una firma XAdES

getSignatureInstance

public static ISignature getSignatureInstance(byte[] bSignature)
                                       throws java.lang.Exception

Método para poder validar con el método Signature.validateSignature.

Analiza el parámetro y, si se trata de un objeto XAdES, devuelve un objeto del tipo adecuado.

Parameters:

bSignature - Firma como array de bytes

Returns:

XAdES

Throws:

java.lang.Exception - El parámetro no es un XAdES

getCertificates

public Certificate[] getCertificates()

Devuelve los certificados con los que se han realizado las firmas

Returns:

Certificados con los que se ha realizado las firmas

getAttachedDocument

public java.lang.String getAttachedDocument()
                                     throws SignatureException,
                                            SignatureNotFoundException

Devuelve el documento contenido en la firma attached. La cadena devuelta por este método será la representación en base64 del documento original.

Returns:

Documento contenido en la firma attached o null si la firma es detached

Throws:

SignatureException - Error obteniendo el documento de la firma

SignatureNotFoundException - No se encuentra ninguna firma dentro del fichero XML

isValid

public ValidationResult[] isValid(CAList caList)
                           throws SignatureException

Description copied from interface: ISignature

Comprueba que las firmas son correctas en firmas attached y sus certificados son válidos.

Sobre la validación de certificados hay que tener en cuenta:

• Si existe sello de tiempos, éste sólo será valido mientras el certificado no haya caducado. Después, es imposible obtener la información de revocación por lo que este método devolverá un resultado falso
• Si la firma incluye información de revocación (CRLs o respuestas OCSP) ésta si que se tendrá en cuenta aunque el certificado haya caducado: concepto de firma longeva

IMPORTANTE: este método sólo puede ser utilizado si la firma es attached (el documento que originó la firma se incluye en ésta). Si no es así utilizar este mismo método pero pasándole el documento que originó la firma.

Parameters:

caList - Lista de certificados de CA admitidos por la aplicación que usa Arangi

Returns:

Para cada certificado resultado de comprobar si la firma es correcta y el certificado es válido

Throws:

SignatureException - Error tratando el objeto firma

isValid

public ValidationResult[] isValid(IDocument document,
                         CAList caList)
                           throws SignatureException

Description copied from interface: ISignature

Comprueba que las firmas son correctas y sus certificados son válidos.

Sobre la validación de certificados hay que tener en cuenta:

• Si existe sello de tiempos, éste sólo será valido mientras el certificado no haya caducado. Después, es imposible obtener la información de revocación por lo que este método devolverá un resultado falso
• Si la firma incluye información de revocación (CRLs o respuestas OCSP) ésta si que se tendrá en cuenta aunque el certificado haya caducado: concepto de firma longeva

Parameters:

document - Documento que originó la firma

caList - Lista de certificados de CA admitidos por la aplicación que usa Arangi

Returns:

Para cada certificado resultado de comprobar si la firma es correcta y el certificado es válido

Throws:

SignatureException - Error tratando el objeto firma

isValid

public ValidationResult[] isValid(java.util.List<CertificateValidationService> validationServices)
                           throws SignatureException

Description copied from interface: ISignature

Comprueba que las firmas son correctas en firmas attached y sus certificados son válidos.

Sobre la validación de certificados hay que tener en cuenta:

• Si existe sello de tiempos, éste sólo será valido mientras el certificado no haya caducado. Después, es imposible obtener la información de revocación por lo que este método devolverá un resultado falso
• Si la firma incluye información de revocación (CRLs o respuestas OCSP) ésta si que se tendrá en cuenta aunque el certificado haya caducado: concepto de firma longeva
• La validación se llevará a cabo a través de los servicios de validación pasados como parámetro.

IMPORTANTE: este método sólo puede ser utilizado si la firma es attached (el documento que originó la firma se incluye en ésta). Si no es así utilizar este mismo método pero pasándole el documento que originó la firma.

Parameters:

validationServices - Lista de servicios de validación

Returns:

Para cada certificado resultado de comprobar si la firma es correcta y el certificado es válido

Throws:

SignatureException - Error tratando el objeto firma

isValid

public ValidationResult[] isValid(IDocument document,
                         java.util.List<CertificateValidationService> validationServices)
                           throws SignatureException

Description copied from interface: ISignature

Comprueba que las firmas son correctas y sus certificados son válidos.

Sobre la validación de certificados hay que tener en cuenta:

• Si existe sello de tiempos, éste sólo será valido mientras el certificado no haya caducado. Después, es imposible obtener la información de revocación por lo que este método devolverá un resultado falso
• Si la firma incluye información de revocación (CRLs o respuestas OCSP) ésta si que se tendrá en cuenta aunque el certificado haya caducado: concepto de firma longeva
• La validación se llevará a cabo a través de los servicios de validación pasados como parámetro.

Parameters:

document - Documento que originó la firma

validationServices - Lista de servicios de validación

Returns:

Para cada certificado resultado de comprobar si la firma es correcta y el certificado es válido

Throws:

SignatureException - Error tratando el objeto firma

isValidSignatureOnly

public ValidationResult[] isValidSignatureOnly()
                                        throws SignatureException

Description copied from interface: ISignature

Comprueba que las firmas son correctas en firmas attached, sin validar los certificados de las mismas.

IMPORTANTE: este método sólo puede ser utilizado si la firma es attached (el documento que originó la firma se incluye en ésta). Si no es así utilizar este mismo método pero pasándole el documento que originó la firma.

Returns:

Para cada certificado resultado de validar la firma

Throws:

SignatureException - Error tratando el objeto firma

isValidSignatureOnly

public ValidationResult[] isValidSignatureOnly(IDocument document)
                                        throws HashingException,
                                               SignatureException

Description copied from interface: ISignature

Comprueba que las firmas son correctas, sin validar los certificados de las mismas.

Parameters:

document - Documento que originó la firma

Returns:

Para cada certificado resultado de validar la firma

Throws:

HashingException - Error obteniendo el hash del documento

SignatureException - Error tratando el objeto firma

getEncoding

public java.lang.String getEncoding()

Obtiene la codificación del XML que contiene el XAdES

Returns:

Codificación del XML que contiene el XAdES

getSignaturePolicyIdentifier

public java.lang.String getSignaturePolicyIdentifier()

Obtiene como una cadena de texto el campo SignaturePolicyIdentifier.

Returns:

campo SignaturePolicyIdentifier o null si la firma no es EPES

getSignatureProductionPlace

public ArangiXAdESProductionPlace getSignatureProductionPlace()

Obtiene como una cadena de texto el campo SignaturePolicyIdentifier.

Returns:

campo getSignatureProductionPlace o null si la firma no es EPES

save

public void save(java.io.File file)
          throws java.io.IOException

Guarda la firma XAdES en un fichero

Parameters:

file - Fichero donde se guardará la firma

Throws:

java.io.FileNotFoundException - No se puede escribir en el fichero

XMLDocumentException - Errores en la transformación de DOM a un stream de escritura

java.io.IOException - Errores de entrada / salida

save

public void save(java.io.OutputStream out)
          throws java.io.IOException

Guarda la firma en un stream de escritura.

Parameters:

out - Stream de escritura

Throws:

java.io.IOException - Errores de entrada / salida o durante la transformación DOM a XML

toByteArray

public byte[] toByteArray()

Devuelve la firma XAdES como un array de bytes

Returns:

Firma como array de bytes