Package br.ufsc.labsec.signature.conformanceVerifier.xades

Class XadesSignature

java.lang.Object

br.ufsc.labsec.signature.conformanceVerifier.xades.XadesSignature

All Implemented Interfaces:

Signature<Element>, GenericXadesSignature, SignatureObject

Direct Known Subclasses:

CounterSignature

public class XadesSignature
extends Object
implements GenericXadesSignature

Esta classe representa uma assinatura do tipo XAdES. Implementa GenericXadesSignature.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ATTR_AUTHORITIES_CERT_VALUES
protected static String	ATTRIBUTE_CERTIFICATE_REFS
protected static String	ATTRIBUTE_CERTIFICATE_REFSV2
protected static String	ATTRIBUTE_REVOCATION_REFS
protected static String	ATTRIBUTE_REVOCATION_VALUES
protected static String	CERTIFICATE_VALUES
protected static String	COLON
protected static String	COMPLETE_CERTIFICATE_REFS
protected static String	COMPLETE_CERTIFICATE_REFSV2
protected static String	COMPLETE_REVOCATION_REFS
protected static String	COUNTER_SIGNATURE
protected static String	DOM
protected static String	ID
protected static String	KEY_INFO
protected static String	OBJECT
protected static String	QUALIFYING_PROPERTIES
protected static String	REFERENCE
protected static String	REVOCATION_VALUES
protected static String	SIG_POLICY_QUALIFIERS
protected static String	SIGNATURE
protected static String	SIGNATURE_POLICY_IDENTIFIER
protected static String	SIGNATURE_TIME_STAMP
protected static String	SIGNATURE_VALUE
protected Element	signatureElement	O nodo XML da assinatura
protected static String	SIGNED_DATA_OBJECT_PROPERTIES
protected static String	SIGNED_INFO
protected static String	SIGNED_PROPERTIES
protected static String	SIGNED_SIGNATURE_PROPERTIES
protected static String	SIGNING_CERTIFICATE
protected static String	SPURI
protected Date	timeReference
protected static String	TYPE
protected static String	UNSIGNED_DATA_OBJECT_PROPERTIES
protected static String	UNSIGNED_PROPERTIES
protected static String	UNSIGNED_SIGNATURE_PROPERTIES
protected static String	XADES_ARCHIVE_TIME_STAMP
protected static String	XADES_COUNTER_SIGNATURE
protected Document	xml	O documento de assinatura

Constructor Summary

Constructors

Constructor	Description
XadesSignature(Document xml, Element signature, XadesSignatureContainer xadesSignatureContainer)	Constrói uma assinatura XAdES a partir da representação DOM do documento XML assinado, e do elemento que representa a assinatura no documento.

Method Summary

Modifier and Type	Method	Description
void	addUnsignedAttribute(SignatureAttribute<Element> attribute)	Adiciona um atributo à lista de atributos não-assinados
static void	addX509DataContent(Collection<Certificate> certificates, Collection<X509CRL> crls, X509Data x509Data)	Adiciona os certificados e CRLs, presentes na estrutura X509Data, nas listas dadas
protected org.bouncycastle.cms.SignerId	buildSignerIdentifier(X500Principal issuerName, BigInteger serialNumber)	Constrói um objeto da classe SignerId.
protected void	calculateArchiveTimeStampHashValue(OutputStream octetStream, Time time)	Passos para cálculo do hash do carimbo do tempo de arquivamento, conforme o documento ETSI TS 101 903 V1.4.1 (2009-06) seção 8.2.1
String	getAlgorithmFromSignature()
String	getAlgorithmOid()	Retorna o identificador do algoritmo de assinatura (OID) utilizado na assinatura.
byte[]	getArchiveTimeStampHashValue(String hashAlgorithmName)	Calcula o valor de hash do carimbo de tempo de arquivamento
byte[]	getArchiveTimeStampHashValue(String hashAlgorithmName, Time time)	Calcula o valor de hash do carimbo de tempo de arquivamento
List<String>	getAttributeList()	Retorna a lista de atributos presente na assinatura.
List<Certificate>	getCertificatesAtKeyInfo()	Retorna os certificados da estrutura KeyInfo
XadesSignatureContainer	getContainer()	Retorna o contêiner da assinatura XAdES
List<XadesSignature>	getCounterSignatures()	Retorna uma lista de contra-assinatura
List<X509CRL>	getCrls()	Retorna as CRLs da assinatura
Element	getEncodedAttribute(String attributeId)	Retorna o primeiro atributo da assinatura
Element	getEncodedAttribute(String attributeId, Integer index)	Retorna o atributo correspondente ao identificador dado
FileFormat	getFormat()
XadesSignatureContainer	getSignatureContainer()
Element	getSignatureElement()	Informa em qual Element especifico está a representação da assinatura
String	getSignatureMethod()
String	getSignaturePolicyHashValue(SignaturePolicyInterface signaturePolicyInterface)	Retorna o valor de hash no nodo da política de assinatura
String	getSignaturePolicyIdentifier(SignaturePolicyInterface signaturePolicyInterface)	Retorna o identificador da política de assinatura
String	getSignaturePolicyUri(SignaturePolicyInterface signaturePolicyInterface)	Retorna a URI da política de assinatura
String	getSignatureValueAttribute()	Obtém o valor do atributo Id da tag SignatureValue
byte[]	getSignatureValueHash(String algorithm)	Retorna o valor de hash da assinatura
List<String>	getSignedAttributeList()	Retorna a lista de atributos assinados
Certificate	getSigningCertificate()	Retorna o certificado do assinante
String	getSubjectName()	Retorna o nome do assinante
Date	getTimeReference()
List<String>	getUnsignedAttributeList()	Retorna a lista de atributos não-assinados
Document	getXml()	Retorna a assinatura em forma de Document para que se possa navegar por ela mais livremente.
int	hashCode()
boolean	hasImpliedPolicy(SignaturePolicyInterface signaturePolicyInterface)
protected boolean	hasSigningCertificate(CounterSignature counterSignature)	Verifica se existe a propriedade SigningCertificate na contra assinatura
boolean	hasValidKeyInfo(List<Reference> references, DOMValidateContext validateContext)	Verifica se o estado do ds:KeyInfo permite a ausência de um XAdES:SignedProperties na assinatura
boolean	hasValidKeyInfoElement(X509Certificate signerCertificate)
boolean	isArchiveTimeStampHashValue(String hashAlgorithmName, Time time, byte[] expected)
boolean	isEnveloped()	Verifica se a assinatura Xades é do tipo envelopada por meio da URI da w3 dentro dos nodos com a tag Transform
boolean	isExternalSignedData()	Verifica se o conteúdo assinado é externo
boolean	isSignatureValueHashValid(String algorithm, byte[] expected)
void	removeUnsignedAttribute(String attributeId, int index)	Remove o nodo do atributo não-assinado no arquivo
void	replaceUnsignedAttribute(SignatureAttribute<Element> attribute, int index)	Substitui um atributo não-assinado
byte[]	resolveAttributeContentToBeHashed(List<String> mandatoryAttrs, List<String> optionalAttrs, String namespace, String target, boolean withSignature)
void	setTimeReference(Date timeReference)
boolean	verify(X509Certificate signerCertificate, SignatureReport sigReport, boolean isComplete, boolean isIcpBr)	Verifica a assinatura XAdES baseado no documento(http://www.w3.org/TR/XAdES/) e anexa ao report.

Methods inherited from class java.lang.Object

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

Field Details

SIGNED_SIGNATURE_PROPERTIES

protected static final String SIGNED_SIGNATURE_PROPERTIES

See Also:

Constant Field Values

COLON

protected static final String COLON

See Also:

Constant Field Values

UNSIGNED_PROPERTIES

protected static final String UNSIGNED_PROPERTIES

See Also:

Constant Field Values

XADES_COUNTER_SIGNATURE

protected static final String XADES_COUNTER_SIGNATURE

See Also:

Constant Field Values

SIGNING_CERTIFICATE

protected static final String SIGNING_CERTIFICATE

See Also:

Constant Field Values

SIGNED_PROPERTIES

protected static final String SIGNED_PROPERTIES

See Also:

Constant Field Values

DOM

protected static final String DOM

See Also:

Constant Field Values

XADES_ARCHIVE_TIME_STAMP

protected static final String XADES_ARCHIVE_TIME_STAMP

See Also:

Constant Field Values

REFERENCE

protected static final String REFERENCE

See Also:

Constant Field Values

SPURI

protected static final String SPURI

See Also:

Constant Field Values

SIG_POLICY_QUALIFIERS

protected static final String SIG_POLICY_QUALIFIERS

See Also:

Constant Field Values

SIGNED_INFO

protected static final String SIGNED_INFO

See Also:

Constant Field Values

KEY_INFO

protected static final String KEY_INFO

See Also:

Constant Field Values

ID

protected static final String ID

See Also:

Constant Field Values

SIGNATURE

protected static final String SIGNATURE

See Also:

Constant Field Values

COUNTER_SIGNATURE

protected static final String COUNTER_SIGNATURE

See Also:

Constant Field Values

SIGNATURE_VALUE

protected static final String SIGNATURE_VALUE

See Also:

Constant Field Values

OBJECT

protected static final String OBJECT

See Also:

Constant Field Values

QUALIFYING_PROPERTIES

protected static final String QUALIFYING_PROPERTIES

See Also:

Constant Field Values

SIGNATURE_TIME_STAMP

protected static final String SIGNATURE_TIME_STAMP

See Also:

Constant Field Values

COMPLETE_CERTIFICATE_REFS

protected static final String COMPLETE_CERTIFICATE_REFS

See Also:

Constant Field Values

COMPLETE_CERTIFICATE_REFSV2

protected static final String COMPLETE_CERTIFICATE_REFSV2

See Also:

Constant Field Values

COMPLETE_REVOCATION_REFS

protected static final String COMPLETE_REVOCATION_REFS

See Also:

Constant Field Values

ATTRIBUTE_CERTIFICATE_REFS

protected static final String ATTRIBUTE_CERTIFICATE_REFS

See Also:

Constant Field Values

ATTRIBUTE_CERTIFICATE_REFSV2

protected static final String ATTRIBUTE_CERTIFICATE_REFSV2

See Also:

Constant Field Values

ATTRIBUTE_REVOCATION_REFS

protected static final String ATTRIBUTE_REVOCATION_REFS

See Also:

Constant Field Values

TYPE

protected static final String TYPE

See Also:

Constant Field Values

SIGNATURE_POLICY_IDENTIFIER

protected static final String SIGNATURE_POLICY_IDENTIFIER

See Also:

Constant Field Values

UNSIGNED_DATA_OBJECT_PROPERTIES

protected static final String UNSIGNED_DATA_OBJECT_PROPERTIES

See Also:

Constant Field Values

UNSIGNED_SIGNATURE_PROPERTIES

protected static final String UNSIGNED_SIGNATURE_PROPERTIES

See Also:

Constant Field Values

SIGNED_DATA_OBJECT_PROPERTIES

protected static final String SIGNED_DATA_OBJECT_PROPERTIES

See Also:

Constant Field Values

REVOCATION_VALUES

protected static final String REVOCATION_VALUES

See Also:

Constant Field Values

CERTIFICATE_VALUES

protected static final String CERTIFICATE_VALUES

See Also:

Constant Field Values

ATTR_AUTHORITIES_CERT_VALUES

protected static final String ATTR_AUTHORITIES_CERT_VALUES

See Also:

Constant Field Values

ATTRIBUTE_REVOCATION_VALUES

protected static final String ATTRIBUTE_REVOCATION_VALUES

See Also:

Constant Field Values

xml

protected Document xml

O documento de assinatura

signatureElement

protected Element signatureElement

O nodo XML da assinatura

timeReference

protected Date timeReference

Constructor Details

XadesSignature

public XadesSignature(Document xml,
Element signature,
XadesSignatureContainer xadesSignatureContainer)

Constrói uma assinatura XAdES a partir da representação DOM do documento XML assinado, e do elemento que representa a assinatura no documento.

Parameters:

xml - A representação DOM de um documento XML

signature - O elemento que representa a assinatura no documento

xadesSignatureContainer - O contêiner de assinatura XAdES

Method Details

setTimeReference

public void setTimeReference(Date timeReference)

getTimeReference

public Date getTimeReference()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getSignatureElement

public Element getSignatureElement()

Informa em qual Element especifico está a representação da assinatura

Returns:

O nodo que contém a assinatura na estrutura XML do documento assinado

getSignatureMethod

public String getSignatureMethod()
                          throws SignatureException

Throws:

SignatureException

hasValidKeyInfo

public boolean hasValidKeyInfo(List<Reference> references,
DOMValidateContext validateContext)

Verifica se o estado do ds:KeyInfo permite a ausência de um XAdES:SignedProperties na assinatura

Parameters:

references - Lista de referências do SignedInfo

validateContext - Contexto contendo assinatura e chave pública de verificação

Returns:

Verdadeiro se permite a ausência, falso se exige a presença do XAdES:SignedProperties

getAlgorithmFromSignature

public String getAlgorithmFromSignature()

verify

public boolean verify(X509Certificate signerCertificate,
SignatureReport sigReport,
boolean isComplete,
boolean isIcpBr)
               throws VerificationException

Verifica a assinatura XAdES baseado no documento(http://www.w3.org/TR/XAdES/) e anexa ao report.

Specified by:

verify in interface GenericXadesSignature

Parameters:

signerCertificate - O certificado do signatário

sigReport - O relátorio da assinatura

isComplete - Se o relatório deve ser completo ou simples

isIcpBr - Se a cadeia de certificados é Icp-BR para fazer ExtensionsReport

Returns:

Indica se a assinatura XAdES está de acordo com os padrões do documento (http://www.w3.org/TR/XAdES/)

Throws:

VerificationException - Exceção em caso de erro durante a verificação

getXml

public Document getXml()

Retorna a assinatura em forma de Document para que se possa navegar por ela mais livremente. Obs.: A referência interna é passada, por isso se for causado algum erro na assinatura através do document, esse erros posteriomente aparecerão dentro do XadesSignature também.

Returns:

A assinatura na representação DOM

getAttributeList

public List<String> getAttributeList()

Retorna a lista de atributos presente na assinatura.

Specified by:

getAttributeList in interface Signature<Element>

Returns:

A lista de atributos na assinatura

getSignedAttributeList

public List<String> getSignedAttributeList()

Description copied from interface: Signature

Retorna a lista de atributos assinados

Specified by:

getSignedAttributeList in interface Signature<Element>

Returns:

lista de atributos assinados

getUnsignedAttributeList

public List<String> getUnsignedAttributeList()

Description copied from interface: Signature

Retorna a lista de atributos não-assinados

Specified by:

getUnsignedAttributeList in interface Signature<Element>

Returns:

lista de atributos não-assinados

getEncodedAttribute

public Element getEncodedAttribute(String attributeId,
Integer index)
                            throws SignatureAttributeNotFoundException

Retorna o atributo correspondente ao identificador dado

Specified by:

getEncodedAttribute in interface Signature<Element>

Parameters:

attributeId - O identificador do atributo

index - O índice do atributo

Returns:

O atributo correspondente ao identificador dado

Throws:

SignatureAttributeNotFoundException - Exceção caso o atributo não seja encontrado

getSignatureContainer

public XadesSignatureContainer getSignatureContainer()

getEncodedAttribute

public Element getEncodedAttribute(String attributeId)
                            throws SignatureAttributeNotFoundException

Retorna o primeiro atributo da assinatura

Specified by:

getEncodedAttribute in interface GenericXadesSignature

Parameters:

attributeId - O identificador do atributo

Returns:

O primeiro atributo da assinatura

Throws:

SignatureAttributeNotFoundException - atributo não encontrado

hasImpliedPolicy

public boolean hasImpliedPolicy(SignaturePolicyInterface signaturePolicyInterface)

getSignaturePolicyIdentifier

public String getSignaturePolicyIdentifier(SignaturePolicyInterface signaturePolicyInterface)

Retorna o identificador da política de assinatura

Specified by:

getSignaturePolicyIdentifier in interface GenericXadesSignature

Returns:

O identificador da política de assinatura

isExternalSignedData

public boolean isExternalSignedData()

Verifica se o conteúdo assinado é externo

Specified by:

isExternalSignedData in interface GenericXadesSignature

Returns:

Indica se o conteúdo assinado é externo

getSignatureValueHash

public byte[] getSignatureValueHash(String algorithm)
                             throws PbadException,
NoSuchAlgorithmException

Retorna o valor de hash da assinatura

Specified by:

getSignatureValueHash in interface GenericXadesSignature

Parameters:

algorithm - O algoritmo a ser utilizado para o cálculo de hash

Returns:

Array de bytes com valor de hash da assinatura

Throws:

PbadException - Exceção em caso de erro no cálculo

NoSuchAlgorithmException

isSignatureValueHashValid

public boolean isSignatureValueHashValid(String algorithm,
byte[] expected)
                                  throws PbadException

Throws:

PbadException

addUnsignedAttribute

public void addUnsignedAttribute(SignatureAttribute<Element> attribute)
                          throws SignatureAttributeException

Adiciona um atributo à lista de atributos não-assinados

Specified by:

addUnsignedAttribute in interface Signature<Element>

Parameters:

attribute - O atributo a ser adicionado

Throws:

DOMException - Exceção em caso de erro na estrutura do XML

SignatureAttributeException - Exceção em caso de erro no atributo

replaceUnsignedAttribute

public void replaceUnsignedAttribute(SignatureAttribute<Element> attribute,
int index)
                              throws SignatureAttributeException

Description copied from interface: Signature

Substitui um atributo não-assinado

Specified by:

replaceUnsignedAttribute in interface Signature<Element>

Parameters:

attribute - atributo a ser substituído

index - índice do atributo a ser substituído

Throws:

SignatureAttributeException

getCounterSignatures

public List<XadesSignature> getCounterSignatures()

Retorna uma lista de contra-assinatura

Specified by:

getCounterSignatures in interface Signature<Element>

Returns:

A lista de contra-assinaturas

buildSignerIdentifier

protected org.bouncycastle.cms.SignerId buildSignerIdentifier(X500Principal issuerName,
BigInteger serialNumber)

Constrói um objeto da classe SignerId.

Parameters:

issuerName - Nome do emissor do certificado

serialNumber - Número do serial do certificado

Returns:

O SignerId gerado

hasSigningCertificate

protected boolean hasSigningCertificate(CounterSignature counterSignature)

Verifica se existe a propriedade SigningCertificate na contra assinatura

Parameters:

counterSignature - A contra assinatura

Returns:

Indica se existe a propriedade SigningCertificate

getSignatureValueAttribute

public String getSignatureValueAttribute()

Obtém o valor do atributo Id da tag SignatureValue

Returns:

Valor do atributo Id da tag SignatureValue

getSignaturePolicyUri

public String getSignaturePolicyUri(SignaturePolicyInterface signaturePolicyInterface)

Retorna a URI da política de assinatura

Specified by:

getSignaturePolicyUri in interface GenericXadesSignature

Returns:

A URI da política de assinatura

getSignaturePolicyHashValue

public String getSignaturePolicyHashValue(SignaturePolicyInterface signaturePolicyInterface)

Retorna o valor de hash no nodo da política de assinatura

Specified by:

getSignaturePolicyHashValue in interface GenericXadesSignature

Returns:

O hash da política de assinatura

removeUnsignedAttribute

public void removeUnsignedAttribute(String attributeId,
int index)
                             throws SignatureAttributeException

Remove o nodo do atributo não-assinado no arquivo

Parameters:

attributeId - O identificador do atributo a ser removido

index - O índice do atributo

Throws:

SignatureAttributeException - Exceção caso o atributo não seja encontrado

getArchiveTimeStampHashValue

public byte[] getArchiveTimeStampHashValue(String hashAlgorithmName)
                                    throws PbadException

Calcula o valor de hash do carimbo de tempo de arquivamento

Specified by:

getArchiveTimeStampHashValue in interface GenericXadesSignature

Parameters:

hashAlgorithmName - O algoritmo a ser utilizado no cálculo

Returns:

O valor de hash do carimbo

Throws:

PbadException - Exceção em caso de erro na canonização

getArchiveTimeStampHashValue

public byte[] getArchiveTimeStampHashValue(String hashAlgorithmName,
Time time)
                                    throws PbadException

Calcula o valor de hash do carimbo de tempo de arquivamento

Specified by:

getArchiveTimeStampHashValue in interface GenericXadesSignature

Parameters:

hashAlgorithmName - O algoritmo a ser utilizado no cálculo

time - O horário do carimbo

Returns:

O valor de hash do carimbo

Throws:

PbadException - Exceção em caso de erro na canonização

isArchiveTimeStampHashValue

public boolean isArchiveTimeStampHashValue(String hashAlgorithmName,
Time time,
byte[] expected)
                                    throws PbadException

Throws:

PbadException

calculateArchiveTimeStampHashValue

protected void calculateArchiveTimeStampHashValue(OutputStream octetStream,
Time time)
                                           throws CanonicalizationException,
SignatureAttributeException

Passos para cálculo do hash do carimbo do tempo de arquivamento, conforme o documento ETSI TS 101 903 V1.4.1 (2009-06) seção 8.2.1

Parameters:

octetStream - Onde está sendo escrito os bytes contatenados do hash

time - A data do carimbo do tempo

Throws:

SignatureAttributeException - Exceção em caso de erro nos atributos da assinatura

EncodingException - Exceção em caso de erro na canonização

CanonicalizationException

getContainer

public XadesSignatureContainer getContainer()

Retorna o contêiner da assinatura XAdES

Specified by:

getContainer in interface GenericXadesSignature

Returns:

O contêiner da assinatura XAdES

getSigningCertificate

public Certificate getSigningCertificate()

Retorna o certificado do assinante

Returns:

O certificado do assinante

getCertificatesAtKeyInfo

public List<Certificate> getCertificatesAtKeyInfo()

Retorna os certificados da estrutura KeyInfo

Returns:

Os certificados da estrutura KeyInfo ou nulo em caso de erro

getCrls

public List<X509CRL> getCrls()

Retorna as CRLs da assinatura

Returns:

As CRLs da assinatura

Throws:

CRLException - Exceção em caso de erro na manipulação das CRLs

addX509DataContent

public static void addX509DataContent(Collection<Certificate> certificates,
Collection<X509CRL> crls,
X509Data x509Data)

Adiciona os certificados e CRLs, presentes na estrutura X509Data, nas listas dadas

Parameters:

certificates - A lista de certificados

crls - A lista de CRLs

x509Data - A estrutura X509Data

getSubjectName

public String getSubjectName()

Retorna o nome do assinante

Returns:

O nome do assinante

isEnveloped

public boolean isEnveloped()

Verifica se a assinatura Xades é do tipo envelopada por meio da URI da w3 dentro dos nodos com a tag Transform

Returns:

se ela é envelopada

getFormat

public FileFormat getFormat()

Specified by:

getFormat in interface Signature<Element>

hasValidKeyInfoElement

public boolean hasValidKeyInfoElement(X509Certificate signerCertificate)

resolveAttributeContentToBeHashed

public byte[] resolveAttributeContentToBeHashed(List<String> mandatoryAttrs,
List<String> optionalAttrs,
String namespace,
String target,
boolean withSignature)
                                         throws PbadException

Throws:

PbadException

getAlgorithmOid

public String getAlgorithmOid()

Retorna o identificador do algoritmo de assinatura (OID) utilizado na assinatura.

Specified by:

getAlgorithmOid in interface Signature<Element>

Returns:

Uma string contendo o OID do algoritmo de assinatura.