es.accv.arangi.base.signature

Class CMSPKCS7Signature

java.lang.Object

es.accv.arangi.base.ArangiObject

es.accv.arangi.base.signature.Signature

es.accv.arangi.base.signature.CMSPKCS7Signature

All Implemented Interfaces:

ISignature

Direct Known Subclasses:

CMSSignature, PKCS7Signature

public abstract class CMSPKCS7Signature
extends Signature

Clase que se encarga de realizar firmas en formato CMS y PKCS#7.

El formato CMS deriva de la versión 1.5 de PKCS#7, documentada en la RFC-2315. Desde entonces ha sufrido varios cambios hasta su última versión, que viene definida en la RFC-3852. Aunque existen diferencias entre los dos formatos, básicamente una firma CMS es igual a una firma PKCS#7 con algunas extensiones.

Las clases de Bouncy Castle tratan los dos formatos como uno sólo: CMS. En Arangi se va a seguir este principio, aunque conservando una clase para cada formato, principalmente por las diferencias que puede haber en firmas en navegadores: IExplorer firma en CMS y Firefox en PKCS#7.

Author:

José M Gutiérrez

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OID_CMS_TIMESTAMP Constante con el OID donde se encuentra el sello de tiempos en un CMS
static java.lang.String	OID_DATA Constante con el OID de la sección 'data' en formato DER

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
CMSPKCS7Signature(byte[] signature) Obtiene la firma de un array de bytes.
CMSPKCS7Signature(byte[][] signatureBytes, Certificate[] certificates) Construye una firma en formato CMS(PKCS#7) en base a los bytes de las firmas y los certificados con los que se realizaron éstas, con el algoritmo de firma por defecto (SHA1WithRSA).
CMSPKCS7Signature(byte[][] signatureBytes, Certificate[] certificates, IDocument document) Construye un firma en formato CMS(PKCS#7) en base a los bytes de las firmas y los certificados con los que se realizaron éstas, con el algoritmo de firma por defecto (SHA1WithRSA).
CMSPKCS7Signature(byte[][] signatureBytes, Certificate[] certificates, IDocument document, java.lang.String[] digitalSignatureAlgorithms) Construye un firma en formato CMS(PKCS#7) en base a los bytes de las firmas y los certificados con los que se realizaron éstas, con el algoritmo de firma indicado.
CMSPKCS7Signature(byte[][] signatureBytes, Certificate[] certificates, java.lang.String[] digitalSignatureAlgorithms) Construye un firma en formato CMS(PKCS#7) en base a los bytes de las firmas y los certificados con los que se realizaron éstas, con los algoritmos de firma indicados.
CMSPKCS7Signature(java.io.File fileSignature) Obtiene la firma de un fichero.
CMSPKCS7Signature(java.io.InputStream isSignature) Obtiene la firma de un stream de lectura.

Method Summary

Methods

Modifier and Type	Method and Description
Certificate[]	getCertificates() Devuelve los certificados con los que se ha realizado la firma
IDocument	getDocument()
static ISignature	getSignatureInstance(byte[] bSignature) Método para poder validar con el método Signature.validateSignature.
byte[][]	getSignaturesBytes() Obtiene los bytes resultantes del proceso de firma para cada uno de los certificados.
TimeStamp	getTimeStamp() Obtiene el sello de tiempos de la firma.
boolean	isAttached() Método que indica si la firma es attached (el documento se halla contenido en ella)
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.
ValidationResult[]	isValidSignatureOnlyWithHash(byte[] hash) Valida únicamente la correspondencia entre la firma y el hash, sin validar los certificados de la firma
ValidationResult[]	isValidWithHash(byte[] hash, CAList caList) Comprueba que la firma es válida a partir del hash del documento
ValidationResult[]	isValidWithHash(byte[] hash, CAList caList, java.util.List<CertificateValidationService> validationServices) Comprueba que la firma es válida a partir del hash del documento
ValidationResult[]	isValidWithHash(byte[] hash, java.util.List<CertificateValidationService> validationServices) Comprueba que la firma es válida a partir del hash del documento
void	save(java.io.File file) Guarda la firma en disco
void	save(java.io.OutputStream out) Guarda la firma en un stream de escritura.
byte[]	toByteArray() Obtiene la firma en formato CMS (PKCS#7) como un array de bytes
void	transform() Transforma un CMS o PKCS#7 para que el OID del mismo sea 1.2.840.113549.1.7.2

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

OID_DATA

public static final java.lang.String OID_DATA

Constante con el OID de la sección 'data' en formato DER

See Also:

Constant Field Values

OID_CMS_TIMESTAMP

public static final java.lang.String OID_CMS_TIMESTAMP

Constante con el OID donde se encuentra el sello de tiempos en un CMS

See Also:

Constant Field Values

Constructor Detail

CMSPKCS7Signature

public CMSPKCS7Signature(java.io.File fileSignature)
                  throws NormalizeCertificateException,
                         SignatureException,
                         java.io.IOException

Obtiene la firma de un fichero.

Parameters:

fileSignature - Fichero con la firma en formato CMS (PKCS#7)

Throws:

java.io.IOException - Error leyendo el fichero o la firma proporcionada no parece estar en formato DER

NormalizeCertificateException - El certificado de la firma no puede ser normalizado al formato esperado por el proveedor criptográfico de Arangi

SignatureException - Error obteniendo los certificados de la firma

CMSPKCS7Signature

public CMSPKCS7Signature(java.io.InputStream isSignature)
                  throws NormalizeCertificateException,
                         SignatureException,
                         java.io.IOException

Obtiene la firma de un stream de lectura.

Parameters:

isSignature - Stream de lectura a la firma en formato CMS (PKCS#7)

Throws:

java.io.IOException - Error leyendo el stream de lectura o la firma proporcionada no parece estar en formato DER

NormalizeCertificateException - El certificado de la firma no puede ser normalizado al formato esperado por el proveedor criptográfico de Arangi

SignatureException - Error obteniendo los certificados de la firma

CMSPKCS7Signature

public CMSPKCS7Signature(byte[] signature)
                  throws NormalizeCertificateException,
                         SignatureException

Obtiene la firma de un array de bytes.

Parameters:

signature - Firma en formato CMS (PKCS#7)

Throws:

NormalizeCertificateException - El certificado de la firma no puede ser normalizado al formato esperado por el proveedor criptográfico de Arangi

SignatureException - Error obteniendo los certificados de la firma

CMSPKCS7Signature

public CMSPKCS7Signature(byte[][] signatureBytes,
                 Certificate[] certificates)
                  throws SignatureException

Construye una firma en formato CMS(PKCS#7) en base a los bytes de las firmas y los certificados con los que se realizaron éstas, con el algoritmo de firma por defecto (SHA1WithRSA).

Parameters:

signatureBytes - Bytes de las firmas

certificates - Certificados con los que se realizó la firma

Throws:

SignatureException - Error construyendo la firma

CMSPKCS7Signature

public CMSPKCS7Signature(byte[][] signatureBytes,
                 Certificate[] certificates,
                 java.lang.String[] digitalSignatureAlgorithms)
                  throws SignatureException

Construye un firma en formato CMS(PKCS#7) en base a los bytes de las firmas y los certificados con los que se realizaron éstas, con los algoritmos de firma indicados.

Parameters:

signatureBytes - Bytes de las firmas

certificates - Certificados con los que se realizó la firma

digitalSignatureAlgorithms - Algoritmos de firma

Throws:

java.security.NoSuchAlgorithmException - El algoritmo de firma no existe en Arangi

SignatureException - Error construyendo la firma

CMSPKCS7Signature

public CMSPKCS7Signature(byte[][] signatureBytes,
                 Certificate[] certificates,
                 IDocument document)
                  throws SignatureException

Construye un firma en formato CMS(PKCS#7) en base a los bytes de las firmas y los certificados con los que se realizaron éstas, con el algoritmo de firma por defecto (SHA1WithRSA). El documento se añadira a la firma (attached).

Parameters:

signatureBytes - Bytes de las firmas

certificates - Certificados con los que se realizó la firma

document - Documento que se ha firmado

Throws:

SignatureException - Error construyendo la firma

CMSPKCS7Signature

public CMSPKCS7Signature(byte[][] signatureBytes,
                 Certificate[] certificates,
                 IDocument document,
                 java.lang.String[] digitalSignatureAlgorithms)
                  throws SignatureException

Construye un firma en formato CMS(PKCS#7) en base a los bytes de las firmas y los certificados con los que se realizaron éstas, con el algoritmo de firma indicado. El documento se añadira a la firma (attached).

Parameters:

signatureBytes - Bytes de la firma

certificates - Certificados con los que se realizó la firma

digitalSignatureAlgorithms - Algoritmos de firma

document - Documento que se ha firmado

Throws:

SignatureException - Error construyendo la firma

Method Detail

getSignaturesBytes

public byte[][] getSignaturesBytes()

Obtiene los bytes resultantes del proceso de firma para cada uno de los certificados. No hay que confundir la respuesta de este método con la respuesta dada por toByteArray.

Por ejemplo, en un objeto CMS, el método toByteArray devolverá un CMS, mientras que este método devolverá los bytes de la firma contenida dentro del CMS.

Returns:

Bytes de la firma para cada certificado

getCertificates

public Certificate[] getCertificates()

Description copied from interface: ISignature

Devuelve los certificados con los que se ha realizado la firma

Returns:

Certificados con los que se ha realizado la firma

getDocument

public IDocument getDocument()

isAttached

public boolean isAttached()

Método que indica si la firma es attached (el documento se halla contenido en ella)

Returns:

Cierto si la firma es attached

isValidSignatureOnly

public ValidationResult[] isValidSignatureOnly()
                                        throws HashingException,
                                               SignatureException,
                                               NoDocumentToSignException

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:

HashingException - Error obteniendo el hash del documento

SignatureException - Error tratando el objeto firma

NoDocumentToSignException - La firma no es attached por lo que no hay documento con el que validarla. Utilizar este mismo método pero pasándole el documento que originó la 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

isValidSignatureOnlyWithHash

public ValidationResult[] isValidSignatureOnlyWithHash(byte[] hash)
                                                throws SignatureException

Valida únicamente la correspondencia entre la firma y el hash, sin validar los certificados de la firma

Parameters:

hash - Hash del documento que originó la firma

Returns:

Validación de la firma

Throws:

SignatureException - Error tratando la firma

isValid

public ValidationResult[] isValid(CAList caList)
                           throws NoDocumentToSignException,
                                  SignatureException,
                                  NormalizeCertificateException,
                                  HashingException

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:

NoDocumentToSignException - La firma no es attached por lo que no hay documento con el que validarla. Utilizar este mismo método pero pasándole el documento que originó la firma

SignatureException - Error tratando el objeto firma

NormalizeCertificateException - Alguno de los certificados no puede ser normalizado al formato reconocido por el proveedor criptográfico de Arangí o su firma no es correcta o no puede ser analizada

HashingException - Error obteniendo el hash del documento

isValid

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

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

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

HashingException - Error obteniendo el hash del documento

isValidWithHash

public ValidationResult[] isValidWithHash(byte[] hash,
                                 CAList caList)
                                   throws SignatureException,
                                          NormalizeCertificateException

Comprueba que la firma es válida a partir del hash del documento

Parameters:

hash - Hash del documento

caList - Lista de CAs

Returns:

Validación de la firma

Throws:

SignatureException - Error tratando la firma

NormalizeCertificateException - No se puede normalizar el certificado de firma al proveedor criptográfico de Arangí

isValidWithHash

public ValidationResult[] isValidWithHash(byte[] hash,
                                 CAList caList,
                                 java.util.List<CertificateValidationService> validationServices)
                                   throws SignatureException,
                                          NormalizeCertificateException

Comprueba que la firma es válida a partir del hash del documento

Parameters:

hash - Hash del documento

caList - Lista de CAs

validationServices - Lista de servicios de validación

Returns:

Validación de la firma

Throws:

SignatureException - Error tratando la firma

NormalizeCertificateException - No se puede normalizar el certificado de firma al proveedor criptográfico de Arangí

isValid

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

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:

HashingException - Error obteniendo el hash del documento

SignatureException - Error tratando el objeto firma

NormalizeCertificateException - Alguno de los certificados no puede ser normalizado al formato reconocido por el proveedor criptográfico de Arangí o su firma no es correcta o no puede ser analizada

NoDocumentToSignException - La firma no es attached por lo que no hay documento con el que validarla. Utilizar este mismo método pero pasándole el documento que originó la firma

isValid

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

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:

HashingException - Error obteniendo el hash del documento

SignatureException - Error tratando el objeto firma

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

isValidWithHash

public ValidationResult[] isValidWithHash(byte[] hash,
                                 java.util.List<CertificateValidationService> validationServices)
                                   throws SignatureException,
                                          NormalizeCertificateException

Comprueba que la firma es válida a partir del hash del documento

Parameters:

hash - Hash del documento

validationServices - Lista de servicios de validación

Returns:

Validación de la firma

Throws:

SignatureException - Error tratando la firma

NormalizeCertificateException - No se puede normalizar el certificado de firma al proveedor criptográfico de Arangí

getTimeStamp

public TimeStamp getTimeStamp()
                       throws MalformedTimeStampException

Obtiene el sello de tiempos de la firma.

Returns:

Sello de tiempos de la firma. Si no hay devuelve null.

Throws:

MalformedTimeStampException - El objeto contenido en la firma no parece ser un sello de tiempo

save

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

Guarda la firma en disco

Parameters:

file - Fichero donde se guardará la firma

Throws:

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

toByteArray

public byte[] toByteArray()

Obtiene la firma en formato CMS (PKCS#7) como un array de bytes

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 CMS o PKCS#7, devuelve un objeto de alguno de estos tipos.

Parameters:

bSignature - Firma como array de bytes

Returns:

CMS o PKCS#7

Throws:

java.lang.Exception - El parámetro no es un CMS o PKCS#7

transform

public void transform()
               throws java.lang.Exception

Transforma un CMS o PKCS#7 para que el OID del mismo sea 1.2.840.113549.1.7.2

Throws:

java.lang.Exception - No se ha podido realizar la transformación