es.accv.arangi.base.signature

Class XAdESBESSignature

java.lang.Object

es.accv.arangi.base.ArangiObject

es.accv.arangi.base.signature.Signature

es.accv.arangi.base.signature.XAdESSignature

es.accv.arangi.base.signature.XAdESBESSignature

All Implemented Interfaces:

ISignature

public class XAdESBESSignature
extends XAdESSignature

Clase que maneja firmas en formato XAdES-BES de acuerdo al estándar ETSI TS 101 903

Ejemplo de uso:

KeyStoreManager manager = new KeyStoreManager (..., ...);
String alias = ...;
InputStreamDocument documentTexto = new InputStreamDocument (new FileInputStream (...));
InputStreamDocument documentXML = new InputStreamDocument (new FileInputStream (...));
File file = new File (...);
URL url = new URL (...);

//-- Genera una firma attached. El documento se guardará en la firma en base64
XAdESBESSignature signature1 = XAdESBESSignature.signAttached(manager, alias, documentTexto);

//-- Genera una firma detached que referencia al fichero en disco
XAdESBESSignature signature2 = XAdESBESSignature.signDetached(manager, alias, file);

//-- Genera una firma detached que referencia a "2011/04/29/certificados/CER-2584665.pdf"
XAdESBESSignature signature3 = XAdESBESSignature.signDetached(manager, alias, file, "2011/04/29/certificados/CER-2584665.pdf");

//-- Genera una firma detached que referencia al fichero ubicado en la URL
XAdESBESSignature signature4 = XAdESBESSignature.signDetached(manager, alias, url);

//-- Genera una firma attached dentro del propio documento
XAdESBESSignature signature5 = XAdESBESSignature.signAttached(manager, alias, documentoXML, "titulo", "documento");



Author:

José M Gutiérrez

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SIGNATURE_TYPE Tipo de la firma

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

DEFAULT_XADES_SCHEMA, DEFAULT_XADES_SCHEMA_URI, DEFAULT_XML_ENCODING

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
XAdESBESSignature(byte[] signature) Construye el objeto en base a un array de bytes.
XAdESBESSignature(org.w3c.dom.Document xmlDocument) Construye el objeto en base a un XML que tiene el formato XAdES-BES
XAdESBESSignature(java.io.File xmlFile) Construye el objeto en base a un fichero XAdES-BES
XAdESBESSignature(java.io.InputStream isSignature) Construye el objeto en base a un stream de lectura.

Method Summary

Methods

Modifier and Type	Method and Description
void	coSign(DeviceManager manager, java.lang.String alias) Añade una Cofirma a la firma XAdES-BES.
void	coSign(DeviceManager manager, java.lang.String alias, IDocument signedDoc, java.lang.String digitalSignatureAlgorithm) Añade una Cofirma a la firma XAdES-BES.
void	counterSign(DeviceManager manager, java.lang.String alias) La definición de las contrafirmas en XAdES puede observarse en el punto 7.2.4 del estándar de la ETSI.
void	counterSign(DeviceManager manager, java.lang.String alias, Certificate signatureToCounterSignCertificate, java.lang.String digitalSignatureAlgorithm) La definición de las contrafirmas en XAdES puede observarse en el punto 7.2.4 del estándar de la ETSI.
java.lang.String	getSignatureType() Devuelve una cadena de texto con el tipo de la firma
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, java.io.File document) Deprecated. Usar signAttached
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, java.io.File document, java.lang.String digitalSignatureAlgorithm, XAdESDataObjectFormat dof, java.lang.String[] claimedRoles) Deprecated. Usar signAttached
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, IDocument document) Deprecated. Usar signAttached
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, IDocument document, java.lang.String idToSign, java.lang.String signatureParent) Deprecated. Usar signAttached
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, IDocument document, java.lang.String digitalSignatureAlgorithm, java.lang.String idToSign, java.lang.String signatureParent, XAdESDataObjectFormat dof, java.lang.String[] claimedRoles) Deprecated. Usar signAttached
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, IDocument document, java.lang.String digitalSignatureAlgorithm, XAdESDataObjectFormat dof, java.lang.String[] claimedRoles) Deprecated. Usar signAttached
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, IDocument document, XAdESAttachedSignatureOptions options) Realiza una firma XAdES-BES attached (el documento se incluye en la firma).
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, java.net.URL document) Deprecated. Usar signAttached
static XAdESBESSignature	signAttached(DeviceManager manager, java.lang.String alias, java.net.URL document, java.lang.String digitalSignatureAlgorithm, XAdESDataObjectFormat dof, java.lang.String[] claimedRoles) Deprecated. Usar signAttached
static XAdESBESSignature	signDetached(DeviceManager manager, java.lang.String alias, java.io.File document) Deprecated. Usar signDetached
static XAdESBESSignature	signDetached(DeviceManager manager, java.lang.String alias, java.io.File document, java.lang.String digitalSignatureAlgorithm, XAdESDataObjectFormat dof, java.lang.String[] claimedRoles) Deprecated. Usar signDetached
static XAdESBESSignature	signDetached(DeviceManager manager, java.lang.String alias, IDocument document, java.lang.String reference) Deprecated. Usar signDetached
static XAdESBESSignature	signDetached(DeviceManager manager, java.lang.String alias, IDocument document, java.lang.String digitalSignatureAlgorithm, java.lang.String reference, XAdESDataObjectFormat dof, java.lang.String[] claimedRoles) Deprecated. Usar signDetached
static XAdESBESSignature	signDetached(DeviceManager manager, java.lang.String alias, IDocument document, java.lang.String reference, XAdESDetachedSignatureOptions options) Realiza una firma XAdES-BES detached (el fichero no se incluirá en la firma).
static XAdESBESSignature	signDetached(DeviceManager manager, java.lang.String alias, java.net.URL urlDocument) Deprecated. Usar signDetached
static XAdESBESSignature	signDetached(DeviceManager manager, java.lang.String alias, java.net.URL urlDocument, java.lang.String digitalSignatureAlgorithm, XAdESDataObjectFormat dof, java.lang.String[] claimedRoles) Deprecated. Usar signDetached

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

getAttachedDocument, getCertificates, getDocumentDescription, getDocumentEncoding, getDocumentMIMEType, getDOM, getEncoding, getSignatureInstance, getSignaturePolicyIdentifier, getSignatureProductionPlace, getSigningTimes, getXAdESObject, getXAdESObject, getXAdESObject, getXAdESObject, isValid, isValid, isValid, isValid, 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

Field Detail

SIGNATURE_TYPE

public static final java.lang.String SIGNATURE_TYPE

Tipo de la firma

See Also:

Constant Field Values

Constructor Detail

XAdESBESSignature

public XAdESBESSignature(org.w3c.dom.Document xmlDocument)

Construye el objeto en base a un XML que tiene el formato XAdES-BES

Parameters:

xmlDocument - Documento XML

XAdESBESSignature

public XAdESBESSignature(java.io.File xmlFile)
                  throws java.io.FileNotFoundException,
                         XMLDocumentException

Construye el objeto en base a un fichero XAdES-BES

Parameters:

xmlFile - Fichero XAdES-BES

Throws:

java.io.FileNotFoundException - El fichero no existe

XMLDocumentException - El fichero no parece un XML válido

XAdESBESSignature

public XAdESBESSignature(byte[] signature)
                  throws XMLDocumentException

Construye el objeto en base a un array de bytes.

Parameters:

signature - Firma XAdES-BES

Throws:

XMLDocumentException - El fichero no parece un XML válido

XAdESBESSignature

public XAdESBESSignature(java.io.InputStream isSignature)
                  throws XMLDocumentException

Construye el objeto en base a un stream de lectura.

Parameters:

isSignature - Stream de lectura a una firma XAdES-BES

Throws:

XMLDocumentException - El fichero no parece un XML válido

Method Detail

signDetached

public static XAdESBESSignature signDetached(DeviceManager manager,
                             java.lang.String alias,
                             java.io.File document)
                                      throws LoadingObjectException,
                                             SignatureException,
                                             NoDocumentToSignException

Deprecated. Usar signDetached

Realiza una firma XAdES-BES detached (el fichero no se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier', 'signatureProductionPlace' y 'signerRole'.

La referencia a la que apuntará la firma será el path del fichero.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Fichero a firmar

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

NoDocumentToSignException - El fichero a firmar no existe o es nulo

signDetached

public static XAdESBESSignature signDetached(DeviceManager manager,
                             java.lang.String alias,
                             java.io.File document,
                             java.lang.String digitalSignatureAlgorithm,
                             XAdESDataObjectFormat dof,
                             java.lang.String[] claimedRoles)
                                      throws LoadingObjectException,
                                             SignatureException,
                                             NoDocumentToSignException

Deprecated. Usar signDetached

Realiza una firma XAdES-BES detached (el fichero no se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier' y 'signatureProductionPlace'.

La referencia a la que apuntará la firma será el path del fichero.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Fichero a firmar

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

dof - Información para construir el tag DataObjectFormat (puede ser null)

claimedRoles - Roles de la firma (puede ser null)

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

NoDocumentToSignException - El fichero a firmar no existe o es nulo

signDetached

public static XAdESBESSignature signDetached(DeviceManager manager,
                             java.lang.String alias,
                             java.net.URL urlDocument)
                                      throws LoadingObjectException,
                                             SignatureException,
                                             NoDocumentToSignException

Deprecated. Usar signDetached

Realiza una firma XAdES-BES detached (el fichero no se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier', 'signatureProductionPlace' y 'signerRole'.

La referencia a la que apuntará la firma será la URL del documento.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

urlDocument - Documento a firmar. Se encuentra en una URL accesible.

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

NoDocumentToSignException - La URL es nula o no existe

signDetached

public static XAdESBESSignature signDetached(DeviceManager manager,
                             java.lang.String alias,
                             java.net.URL urlDocument,
                             java.lang.String digitalSignatureAlgorithm,
                             XAdESDataObjectFormat dof,
                             java.lang.String[] claimedRoles)
                                      throws LoadingObjectException,
                                             SignatureException,
                                             NoDocumentToSignException

Deprecated. Usar signDetached

Realiza una firma XAdES-BES detached (el fichero no se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier' y 'signatureProductionPlace'.

La referencia a la que apuntará la firma será la URL del documento.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

urlDocument - Documento a firmar. Se encuentra en una URL accesible.

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

dof - Información para construir el tag DataObjectFormat (puede ser null)

claimedRoles - Roles de la firma (puede ser null)

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

NoDocumentToSignException - La URL es nula o no existe

signDetached

public static XAdESBESSignature signDetached(DeviceManager manager,
                             java.lang.String alias,
                             IDocument document,
                             java.lang.String reference)
                                      throws LoadingObjectException,
                                             SignatureException

Deprecated. Usar signDetached

Realiza una firma XAdES-BES detached (el fichero no se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier', 'signatureProductionPlace' y 'signerRole'.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Contenido a firmar

reference - Referencia a la que apuntará la firma

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

signDetached

public static XAdESBESSignature signDetached(DeviceManager manager,
                             java.lang.String alias,
                             IDocument document,
                             java.lang.String digitalSignatureAlgorithm,
                             java.lang.String reference,
                             XAdESDataObjectFormat dof,
                             java.lang.String[] claimedRoles)
                                      throws LoadingObjectException,
                                             SignatureException

Deprecated. Usar signDetached

Realiza una firma XAdES-BES detached (el fichero no se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier' y 'signatureProductionPlace'.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Contenido a firmar

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

reference - Referencia a la que apuntará la firma

dof - Información para construir el tag DataObjectFormat (puede ser null)

claimedRoles - Roles de la firma (puede ser null)

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

signDetached

public static XAdESBESSignature signDetached(DeviceManager manager,
                             java.lang.String alias,
                             IDocument document,
                             java.lang.String reference,
                             XAdESDetachedSignatureOptions options)
                                      throws LoadingObjectException,
                                             SignatureException

Realiza una firma XAdES-BES detached (el fichero no se incluirá en la firma).

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Contenido a firmar

reference - Referencia a la que apuntará la firma

options - Opciones de la firma

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             IDocument document,
                             java.lang.String idToSign,
                             java.lang.String signatureParent)
                                      throws XMLDocumentException,
                                             LoadingObjectException,
                                             SignatureException

Deprecated. Usar signAttached

Realiza una firma XAdES-BES attached (el documento se incluye en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier', 'signatureProductionPlace' y 'signerRole'. Si el documento es un XML y los parámetros idToSign y signatureParent no son nulos la firma y los campos propios de XAdES se añadirán al XML. En caso contrario el fichero XAdES resultante seguirá la plantilla de Arangí, por ejemplo:
<arangi-xades>
<document>...</document> <ds:Signature>...</ds:Signature> </arangi-xades>


Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Documento a firmar

idToSign - Valor del atributo 'ID' que indica lo que se firmará dentro del documento. Si tiene valor nulo el XML de la firma tendrá el formato por defecto de las firmas XAdES de Arangí.

signatureParent - Nombre del tag que será el padre de los nodos de firma. Si tiene valor nulo la firma colgará del nodo raíz.

Returns:

Firma XADES-BES

Throws:

XMLDocumentException - Error montando el fichero XML

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             IDocument document,
                             java.lang.String digitalSignatureAlgorithm,
                             java.lang.String idToSign,
                             java.lang.String signatureParent,
                             XAdESDataObjectFormat dof,
                             java.lang.String[] claimedRoles)
                                      throws XMLDocumentException,
                                             LoadingObjectException,
                                             SignatureException

Deprecated. Usar signAttached

Realiza una firma XAdES-BES attached (el documento se incluye en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier' y 'signatureProductionPlace' Si el documento es un XML y los parámetros idToSign y signatureParent no son nulos la firma y los campos propios de XAdES se añadirán al XML. En caso contrario el fichero XAdES resultante seguirá la plantilla de Arangí, por ejemplo:
<arangi-xades>
<document>...</document> <ds:Signature>...</ds:Signature> </arangi-xades>


Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Documento a firmar

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

idToSign - Valor del atributo 'ID' que indica lo que se firmará dentro del documento. Si tiene valor nulo el XML de la firma tendrá el formato por defecto de las firmas XAdES de Arangí.

signatureParent - Nombre del tag que será el padre de los nodos de firma. Si tiene valor nulo la firma colgará del nodo raíz.

dof - Información para construir el tag DataObjectFormat (puede ser null)

claimedRoles - Roles de la firma (puede ser null)

Returns:

Firma XADES-BES

Throws:

XMLDocumentException - Error montando el fichero XML

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             IDocument document)
                                      throws XMLDocumentException,
                                             LoadingObjectException,
                                             SignatureException

Deprecated. Usar signAttached

Realiza una firma XAdES-BES attached (el documento se incluye en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier', 'signatureProductionPlace' y 'signerRole'.

El fichero XAdES seguirá la plantilla de Arangí. Ejemplo:
<arangi-xades>
<document>...</document> <ds:Signature>...</ds:Signature> </arangi-xades>


Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Documento a firmar

Returns:

Firma XADES-BES

Throws:

XMLDocumentException - Error montando el fichero XML

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             IDocument document,
                             java.lang.String digitalSignatureAlgorithm,
                             XAdESDataObjectFormat dof,
                             java.lang.String[] claimedRoles)
                                      throws XMLDocumentException,
                                             LoadingObjectException,
                                             SignatureException

Deprecated. Usar signAttached

Realiza una firma XAdES-BES attached (el documento se incluye en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier' y 'signatureProductionPlace'

El fichero XAdES seguirá la plantilla de Arangí. Ejemplo:
<arangi-xades>
<document>...</document> <ds:Signature>...</ds:Signature> </arangi-xades>


Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Documento a firmar

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

dof - Información para construir el tag DataObjectFormat (puede ser null)

claimedRoles - Roles de la firma (puede ser null)

Returns:

Firma XADES-BES

Throws:

XMLDocumentException - Error montando el fichero XML

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             java.io.File document)
                                      throws LoadingObjectException,
                                             SignatureException,
                                             NoDocumentToSignException,
                                             XMLDocumentException

Deprecated. Usar signAttached

Realiza una firma XAdES-BES attached (el fichero se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier', 'signatureProductionPlace' y 'signerRole'.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Fichero a firmar

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

NoDocumentToSignException - El fichero a firmar no existe o es nulo

XMLDocumentException - Error montando el fichero XML

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             java.io.File document,
                             java.lang.String digitalSignatureAlgorithm,
                             XAdESDataObjectFormat dof,
                             java.lang.String[] claimedRoles)
                                      throws LoadingObjectException,
                                             SignatureException,
                                             NoDocumentToSignException,
                                             XMLDocumentException

Deprecated. Usar signAttached

Realiza una firma XAdES-BES attached (el fichero se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier' y 'signatureProductionPlace'.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Fichero a firmar

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

dof - Información para construir el tag DataObjectFormat (puede ser null)

claimedRoles - Roles de la firma (puede ser null)

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

NoDocumentToSignException - El fichero a firmar no existe o es nulo

XMLDocumentException - Error montando el fichero XML

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             java.net.URL document)
                                      throws LoadingObjectException,
                                             SignatureException,
                                             NoDocumentToSignException,
                                             XMLDocumentException

Deprecated. Usar signAttached

Realiza una firma XAdES-BES attached (el fichero se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier', 'signatureProductionPlace' y 'signerRole'.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Documento a firmar. Se encuentra en una URL accesible.

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

NoDocumentToSignException - El fichero a firmar no existe o es nulo

XMLDocumentException - Error montando el fichero XML

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             java.net.URL document,
                             java.lang.String digitalSignatureAlgorithm,
                             XAdESDataObjectFormat dof,
                             java.lang.String[] claimedRoles)
                                      throws LoadingObjectException,
                                             SignatureException,
                                             NoDocumentToSignException,
                                             XMLDocumentException

Deprecated. Usar signAttached

Realiza una firma XAdES-BES attached (el fichero se incluirá en la firma). No completa los campos no obligatorios del tag 'SignedSignatureProperties':'signaturePolicyIdentifier' y 'signatureProductionPlace'.

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Documento a firmar. Se encuentra en una URL accesible.

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

dof - Información para construir el tag DataObjectFormat (puede ser null)

claimedRoles - Roles de la firma (puede ser null)

Returns:

Firma XADES-BES

Throws:

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

NoDocumentToSignException - El fichero a firmar no existe o es nulo

XMLDocumentException - Error montando el fichero XML

signAttached

public static XAdESBESSignature signAttached(DeviceManager manager,
                             java.lang.String alias,
                             IDocument document,
                             XAdESAttachedSignatureOptions options)
                                      throws XMLDocumentException,
                                             LoadingObjectException,
                                             SignatureException

Realiza una firma XAdES-BES attached (el documento se incluye en la firma).

Parameters:

manager - Dispositivo criptográfico que realizará la firma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

document - Documento a firmar

options - Opciones para la firma

Returns:

Firma XADES-BES

Throws:

XMLDocumentException - Error montando el fichero XML

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No se puede realizar la firma

counterSign

public void counterSign(DeviceManager manager,
               java.lang.String alias)
                 throws LoadingObjectException,
                        CounterSignatureException

La definición de las contrafirmas en XAdES puede observarse en el punto 7.2.4 del estándar de la ETSI.

Este método realiza una contrafirma para la última firma del XAdES. Es útil cuando se sabe que el XAdES contiene sólo una firma.

Como resultado el XAdES a la que hace referencia este objeto se modificará para añadir la contrafirma.

Parameters:

manager - Dispositivo criptográfico que realizará la contrafirma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

Throws:

LoadingObjectException - No es posible obtener la clave privada o el certificado del alias

CounterSignatureException - Errores durante el proceso de contrafirma

counterSign

public void counterSign(DeviceManager manager,
               java.lang.String alias,
               Certificate signatureToCounterSignCertificate,
               java.lang.String digitalSignatureAlgorithm)
                 throws LoadingObjectException,
                        CounterSignatureException

La definición de las contrafirmas en XAdES puede observarse en el punto 7.2.4 del estándar de la ETSI.

Este método realiza una contrafirma para la firma cuyo certificado se pasa en el parámetro 'signatureToCounterSignCertificate'. Es útil cuando se quiere contrafirmar un XAdES que contiene varias firmas. Para saber qué firma se desea contrafirmar se puede llamar primero a getCertificates para ver los certificados de cada una de las firmas que contiene el XAdES.

Como resultado el XAdES a la que hace referencia este objeto se modificará para añadir la contrafirma.

Parameters:

manager - Dispositivo criptográfico que realizará la contrafirma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

signatureToCounterSignCertificate - Certificado de la firma que se contrafirmará

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

Throws:

LoadingObjectException - No es posible obtener la clave privada o el certificado del alias

CounterSignatureException - Errores durante el proceso de contrafirma

coSign

public void coSign(DeviceManager manager,
          java.lang.String alias)
            throws SignatureNotFoundException,
                   NoDocumentToSignException,
                   HashingException,
                   LoadingObjectException,
                   SignatureException,
                   NoCoincidentDocumentException

Añade una Cofirma a la firma XAdES-BES. Realizará una firma de las mismas características que la primera que encuentre (attached o dettached).

Si la firma es dettached i la referencia al documento que hay en la firma no es una URL será necesario usar el método #coSign(DeviceManager, String, IDocument) al que le proporcionaremos este documento.

Parameters:

manager - Dispositivo criptográfico que realizará la cofirma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

Throws:

SignatureNotFoundException - No existe ninguna firma que cofirmar

NoDocumentToSignException - El fichero a firmar no existe o es nulo

HashingException - Error realizando el hash del documento

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No ha sido posible parsear la firma XAdES o no se puede realizar la cofirma

NoCoincidentDocumentException - El documento que se quiere firmar no se corresponde con el de la firma XAdES

coSign

public void coSign(DeviceManager manager,
          java.lang.String alias,
          IDocument signedDoc,
          java.lang.String digitalSignatureAlgorithm)
            throws SignatureNotFoundException,
                   NoDocumentToSignException,
                   HashingException,
                   LoadingObjectException,
                   SignatureException,
                   NoCoincidentDocumentException

Añade una Cofirma a la firma XAdES-BES. Realizará una firma de las mismas características que la primera que encuentre (attached o dettached).

Este método es útil si la firma es dettached i la referencia al documento que hay en la firma no es una URL.

Parameters:

manager - Dispositivo criptográfico que realizará la cofirma

alias - Alias donde se encuentra la clave privada dentro del dispositivo

signedDoc - contenido a firmar. El mismo utilizado en la generación de las otras firmas.

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

Throws:

SignatureNotFoundException - No existe ninguna firma que cofirmar

NoDocumentToSignException - El fichero a firmar no existe o es nulo

HashingException - Error realizando el hash del documento

LoadingObjectException - No ha sido posible cargar la clave privada o el certificado usados para realizar la firma

SignatureException - No ha sido posible parsear la firma XAdES o no se puede realizar la cofirma

NoCoincidentDocumentException - El documento que se quiere firmar no se corresponde con el de la firma XAdES

getSignatureType

public java.lang.String getSignatureType()

Devuelve una cadena de texto con el tipo de la firma

Returns:

Cadena de texto con el tipo de la firma