Módulo XML

Descrição detalhada

Assinatura XML, incluindo Nota Fiscal Eletrônica (NF-e).

Consulte a documentação técnica do HSM sobre detalhes de funcionamento, especificações utilizadas, licenças e nome comercial do módulo.

Assinatura XML, incluindo Nota Fiscal Eletrônica (NF-e). Mais...

Funções
byte[]	signXML (byte bHashMode, int nFlags, String strKeyId, String strCertId, byte[] baUnsignedXml, byte[] baFilter) throws TacException
	Assina digitalmente um documento XML usando os padrões de assinatura digital XML do W3C.
byte[]	signXML (String strPrivKeyName, int nHashAlg, String strCertId, byte[] baUnsignedXml, byte[] baFilter) throws TacException
	Assina digitalmente um documento XML usando os padrões de assinatura digital XML do W3C.
byte[]	signXML (byte[] hKey, byte[] hHash, String strCertId, int nUnsignedXml, byte[] baUnsignedXml, int[] naSignedXmlSize, int nFilterSize, byte[] baFilter) throws TacException
	Assina digitalmente um documento XML usando os padrões de assinatura digital XML do W3C.

Funções

signXML() [1/3]

byte[] signXML	(	byte	bHashMode,
		int	nFlags,
		String	strKeyId,
		String	strCertId,
		byte[]	baUnsignedXml,
		byte[]	baFilter ) throws TacException

Assina digitalmente um documento XML usando os padrões de assinatura digital XML do W3C.

Parâmetros

bHashMode	Tipo de hash utilizado na assinatura. Os valores da tabela abaixo são aceitos. Valor Significado TacNDJavaLib.ALG_MD5_InclC14N MD5 com canonicalização InclC14N TacNDJavaLib.ALG_SHA1_InclC14N SHA1 com canonicalização InclC14N TacNDJavaLib.ALG_SHA256_InclC14N SHA256 com canonicalização InclC14N TacNDJavaLib.ALG_SHA384_InclC14N SHA384 com canonicalização InclC14N TacNDJavaLib.ALG_SHA512_InclC14N SHA512 com canonicalização InclC14N TacNDJavaLib.ALG_SHA224_InclC14N SHA224 com canonicalização InclC14N TacNDJavaLib.ALG_MD5_ExclC14N MD5 com canonicalização ExclC14N TacNDJavaLib.ALG_SHA1_ExclC14N SHA1 com canonicalização ExclC14N TacNDJavaLib.ALG_MD5_InclC14NWithComments MD5 com canonicalização InclC14NWithComments TacNDJavaLib.ALG_SHA1_InclC14NWithComments SHA1 com canonicalização InclC14NWithComments TacNDJavaLib.ALG_MD5_ExclC14NWithComments MD5 com canonicalização ExclC14NWithComments TacNDJavaLib.ALG_SHA1_ExclC14NWithComments SHA1 com canonicalização ExclC14NWithComments TacNDJavaLib.ALG_SHA256_ExclC14N SHA256 com canonicalização ExclC14N TacNDJavaLib.ALG_SHA256_InclC14NWithComments SHA256 com canonicalização InclC14NWithComment TacNDJavaLib.ALG_SHA256_ExclC14NWithComments SHA256 com canonicalização ExclC14NWithComment TacNDJavaLib.ALG_SHA384_ExclC14N SHA384 com canonicalização ExclC14N TacNDJavaLib.ALG_SHA384_InclC14NWithComments SHA384 com canonicalização InclC14NWithComment TacNDJavaLib.ALG_SHA384_ExclC14NWithComments SHA384 com canonicalização ExclC14NWithComment TacNDJavaLib.ALG_SHA512_ExclC14N SHA512 com canonicalização ExclC14N TacNDJavaLib.ALG_SHA512_InclC14NWithComments SHA512 com canonicalização InclC14NWithComment TacNDJavaLib.ALG_SHA512_ExclC14NWithComments SHA512 com canonicalização ExclC14NWithComment TacNDJavaLib.ALG_SHA224_ExclC14N SHA224 com canonicalização ExclC14N TacNDJavaLib.ALG_SHA224_InclC14NWithComments SHA224 com canonicalização InclC14NWithComment TacNDJavaLib.ALG_SHA224_ExclC14NWithComments SHA224 com canonicalização ExclC14NWithComment.
nFlags	Flags contendo as opções de assinatura. A tabela abaixo é aceita. Valor Significado TacNDJavaLib.XML_SIGN_FLAGS_NOL Desabilita a geração de XML de apenas 1 linha("single line"). Esta opção gera o XML de saída em múltiplas linhas.
strKeyId	Nome da chave privada no HSM.
strCertId	Nome do certificado no HSM.
baUnsignedXml	XML a ser assinado.
baFilter	Filtro para assinatura digital de partes do documento XML. A utilização de filtro é opcional. Veja Uso dos filtros XML.

Retorna

Array de bytes XML original assinado digitalmente no formato especificado.

Exceções

TacException

Lança exceção no caso de erros na assinatura

signXML() [2/3]

byte[] signXML	(	String	strPrivKeyName,
		int	nHashAlg,
		String	strCertId,
		byte[]	baUnsignedXml,
		byte[]	baFilter ) throws TacException

Assina digitalmente um documento XML usando os padrões de assinatura digital XML do W3C.

Recebe os parâmetros no formato de byte array.

Parâmetros

strPrivKeyName	Identificador interno ao HSM referente a chave a ser utilizada para assinatura do documento XML.
nHashAlg	Algoritmo de hash utilizado. A tabela abaixo é aceita. Valor Significado TacNDJavaLib.ALG_MD5 Usa TacNDJavaLib.ALG_MD5_InclC14N. TacNDJavaLib.ALG_SHA1 Usa TacNDJavaLib.ALG_SHA1_InclC14N. TacNDJavaLib.ALG_SHA256 Usa TacNDJavaLib.ALG_SHA256_InclC14N.
strCertId	Identificador interno ao HSM referente ao certificado digital a ser utilizado para assinatura do documento XML.
baUnsignedXml	Parâmetro contendo o XML a ser assinado.
baFilter	Filtro para assinatura digital de partes do documento XML. A utilização de filtro é opcional. Veja Uso dos filtros XML.

Retorna

Array de bytes contendo o documento XML original assinado digitalmente no formato especificado.

Exceções

TacException

Lança exceção no caso de erros na assinatura

signXML() [3/3]

byte[] signXML	(	byte[]	hKey,
		byte[]	hHash,
		String	strCertId,
		int	nUnsignedXml,
		byte[]	baUnsignedXml,
		int[]	naSignedXmlSize,
		int	nFilterSize,
		byte[]	baFilter ) throws TacException

Assina digitalmente um documento XML usando os padrões de assinatura digital XML do W3C.

Recebe os parâmetros no formato string.

Parâmetros

hKey	Identificador interno ao HSM referente a chave a ser utilizada para assinatura do documento XML.
hHash	Algoritmo de hash utilizado.
strCertId	Identificador interno ao HSM referente ao certificado digital a ser utilizado para assinatura do documento XML.
nUnsignedXml	Parâmetro contendo o XML a ser assinado.
baUnsignedXml
naSignedXmlSize
nFilterSize
baFilter

Retorna

Exceções

TacException

Lança exceção no caso de erros na assinatura